/mandos/trunk

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/trunk

« back to all changes in this revision

Viewing changes to mandos.xml

  • Committer: Teddy Hogeborn
  • Date: 2018-02-06 20:03:50 UTC
  • Revision ID: teddy@recompile.se-20180206200350-jzvorueb731xkph3
Update Debian Debhelper compatibility version.

* (debian/compat): Change to "10".

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos.xml
1
1
<?xml version="1.0" encoding="UTF-8"?>
2
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
3
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
 
<!ENTITY VERSION "1.0">
5
4
<!ENTITY COMMANDNAME "mandos">
6
 
<!ENTITY TIMESTAMP "2008-08-30">
 
5
<!ENTITY TIMESTAMP "2017-02-23">
 
6
<!ENTITY % common SYSTEM "common.ent">
 
7
%common;
7
8
]>
8
9
 
9
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
10
 
  <refentryinfo>
 
11
   <refentryinfo>
11
12
    <title>Mandos Manual</title>
12
13
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
13
14
    <productname>Mandos</productname>
14
 
    <productnumber>&VERSION;</productnumber>
 
15
    <productnumber>&version;</productnumber>
15
16
    <date>&TIMESTAMP;</date>
16
17
    <authorgroup>
17
18
      <author>
18
19
        <firstname>Björn</firstname>
19
20
        <surname>Påhlsson</surname>
20
21
        <address>
21
 
          <email>belorn@fukt.bsnet.se</email>
 
22
          <email>belorn@recompile.se</email>
22
23
        </address>
23
24
      </author>
24
25
      <author>
25
26
        <firstname>Teddy</firstname>
26
27
        <surname>Hogeborn</surname>
27
28
        <address>
28
 
          <email>teddy@fukt.bsnet.se</email>
 
29
          <email>teddy@recompile.se</email>
29
30
        </address>
30
31
      </author>
31
32
    </authorgroup>
32
33
    <copyright>
33
34
      <year>2008</year>
 
35
      <year>2009</year>
 
36
      <year>2010</year>
 
37
      <year>2011</year>
 
38
      <year>2012</year>
 
39
      <year>2013</year>
 
40
      <year>2014</year>
 
41
      <year>2015</year>
 
42
      <year>2016</year>
 
43
      <year>2017</year>
34
44
      <holder>Teddy Hogeborn</holder>
35
45
      <holder>Björn Påhlsson</holder>
36
46
    </copyright>
37
 
    <legalnotice>
38
 
      <para>
39
 
        This manual page is free software: you can redistribute it
40
 
        and/or modify it under the terms of the GNU General Public
41
 
        License as published by the Free Software Foundation,
42
 
        either version 3 of the License, or (at your option) any
43
 
        later version.
44
 
      </para>
45
 
 
46
 
      <para>
47
 
        This manual page is distributed in the hope that it will
48
 
        be useful, but WITHOUT ANY WARRANTY; without even the
49
 
        implied warranty of MERCHANTABILITY or FITNESS FOR A
50
 
        PARTICULAR PURPOSE.  See the GNU General Public License
51
 
        for more details.
52
 
      </para>
53
 
 
54
 
      <para>
55
 
        You should have received a copy of the GNU General Public
56
 
        License along with this program; If not, see
57
 
        <ulink url="http://www.gnu.org/licenses/"/>.
58
 
      </para>
59
 
    </legalnotice>
 
47
    <xi:include href="legalnotice.xml"/>
60
48
  </refentryinfo>
61
 
 
 
49
  
62
50
  <refmeta>
63
51
    <refentrytitle>&COMMANDNAME;</refentrytitle>
64
52
    <manvolnum>8</manvolnum>
70
58
      Gives encrypted passwords to authenticated Mandos clients
71
59
    </refpurpose>
72
60
  </refnamediv>
73
 
 
 
61
  
74
62
  <refsynopsisdiv>
75
63
    <cmdsynopsis>
76
64
      <command>&COMMANDNAME;</command>
77
 
      <arg>--interface<arg choice="plain">NAME</arg></arg>
78
 
      <arg>--address<arg choice="plain">ADDRESS</arg></arg>
79
 
      <arg>--port<arg choice="plain">PORT</arg></arg>
80
 
      <arg>--priority<arg choice="plain">PRIORITY</arg></arg>
81
 
      <arg>--servicename<arg choice="plain">NAME</arg></arg>
82
 
      <arg>--configdir<arg choice="plain">DIRECTORY</arg></arg>
83
 
      <arg>--debug</arg>
84
 
    </cmdsynopsis>
85
 
    <cmdsynopsis>
86
 
      <command>&COMMANDNAME;</command>
87
 
      <arg>-i<arg choice="plain">NAME</arg></arg>
88
 
      <arg>-a<arg choice="plain">ADDRESS</arg></arg>
89
 
      <arg>-p<arg choice="plain">PORT</arg></arg>
90
 
      <arg>--priority<arg choice="plain">PRIORITY</arg></arg>
91
 
      <arg>--servicename<arg choice="plain">NAME</arg></arg>
92
 
      <arg>--configdir<arg choice="plain">DIRECTORY</arg></arg>
93
 
      <arg>--debug</arg>
 
65
      <group>
 
66
        <arg choice="plain"><option>--interface
 
67
        <replaceable>NAME</replaceable></option></arg>
 
68
        <arg choice="plain"><option>-i
 
69
        <replaceable>NAME</replaceable></option></arg>
 
70
      </group>
 
71
      <sbr/>
 
72
      <group>
 
73
        <arg choice="plain"><option>--address
 
74
        <replaceable>ADDRESS</replaceable></option></arg>
 
75
        <arg choice="plain"><option>-a
 
76
        <replaceable>ADDRESS</replaceable></option></arg>
 
77
      </group>
 
78
      <sbr/>
 
79
      <group>
 
80
        <arg choice="plain"><option>--port
 
81
        <replaceable>PORT</replaceable></option></arg>
 
82
        <arg choice="plain"><option>-p
 
83
        <replaceable>PORT</replaceable></option></arg>
 
84
      </group>
 
85
      <sbr/>
 
86
      <arg><option>--priority
 
87
      <replaceable>PRIORITY</replaceable></option></arg>
 
88
      <sbr/>
 
89
      <arg><option>--servicename
 
90
      <replaceable>NAME</replaceable></option></arg>
 
91
      <sbr/>
 
92
      <arg><option>--configdir
 
93
      <replaceable>DIRECTORY</replaceable></option></arg>
 
94
      <sbr/>
 
95
      <arg><option>--debug</option></arg>
 
96
      <sbr/>
 
97
      <arg><option>--debuglevel
 
98
      <replaceable>LEVEL</replaceable></option></arg>
 
99
      <sbr/>
 
100
      <arg><option>--no-dbus</option></arg>
 
101
      <sbr/>
 
102
      <arg><option>--no-ipv6</option></arg>
 
103
      <sbr/>
 
104
      <arg><option>--no-restore</option></arg>
 
105
      <sbr/>
 
106
      <arg><option>--statedir
 
107
      <replaceable>DIRECTORY</replaceable></option></arg>
 
108
      <sbr/>
 
109
      <arg><option>--socket
 
110
      <replaceable>FD</replaceable></option></arg>
 
111
      <sbr/>
 
112
      <arg><option>--foreground</option></arg>
 
113
      <sbr/>
 
114
      <arg><option>--no-zeroconf</option></arg>
94
115
    </cmdsynopsis>
95
116
    <cmdsynopsis>
96
117
      <command>&COMMANDNAME;</command>
97
118
      <group choice="req">
98
 
        <arg choice="plain">-h</arg>
99
 
        <arg choice="plain">--help</arg>
 
119
        <arg choice="plain"><option>--help</option></arg>
 
120
        <arg choice="plain"><option>-h</option></arg>
100
121
      </group>
101
122
    </cmdsynopsis>
102
123
    <cmdsynopsis>
103
124
      <command>&COMMANDNAME;</command>
104
 
      <arg choice="plain">--version</arg>
 
125
      <arg choice="plain"><option>--version</option></arg>
105
126
    </cmdsynopsis>
106
127
    <cmdsynopsis>
107
128
      <command>&COMMANDNAME;</command>
108
 
      <arg choice="plain">--check</arg>
 
129
      <arg choice="plain"><option>--check</option></arg>
109
130
    </cmdsynopsis>
110
131
  </refsynopsisdiv>
111
 
 
 
132
  
112
133
  <refsect1 id="description">
113
134
    <title>DESCRIPTION</title>
114
135
    <para>
115
136
      <command>&COMMANDNAME;</command> is a server daemon which
116
137
      handles incoming request for passwords for a pre-defined list of
117
 
      client host computers.  The Mandos server uses Zeroconf to
118
 
      announce itself on the local network, and uses TLS to
119
 
      communicate securely with and to authenticate the clients.  The
120
 
      Mandos server uses IPv6 to allow Mandos clients to use IPv6
121
 
      link-local addresses, since the clients will probably not have
122
 
      any other addresses configured (see <xref linkend="overview"/>).
123
 
      Any authenticated client is then given the stored pre-encrypted
124
 
      password for that specific client.
 
138
      client host computers. For an introduction, see
 
139
      <citerefentry><refentrytitle>intro</refentrytitle>
 
140
      <manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
 
141
      uses Zeroconf to announce itself on the local network, and uses
 
142
      TLS to communicate securely with and to authenticate the
 
143
      clients.  The Mandos server uses IPv6 to allow Mandos clients to
 
144
      use IPv6 link-local addresses, since the clients will probably
 
145
      not have any other addresses configured (see <xref
 
146
      linkend="overview"/>).  Any authenticated client is then given
 
147
      the stored pre-encrypted password for that specific client.
125
148
    </para>
126
 
 
127
149
  </refsect1>
128
150
  
129
151
  <refsect1 id="purpose">
130
152
    <title>PURPOSE</title>
131
 
 
132
153
    <para>
133
154
      The purpose of this is to enable <emphasis>remote and unattended
134
155
      rebooting</emphasis> of client host computer with an
135
156
      <emphasis>encrypted root file system</emphasis>.  See <xref
136
157
      linkend="overview"/> for details.
137
158
    </para>
138
 
 
139
159
  </refsect1>
140
160
  
141
161
  <refsect1 id="options">
142
162
    <title>OPTIONS</title>
143
 
 
144
163
    <variablelist>
145
164
      <varlistentry>
 
165
        <term><option>--help</option></term>
146
166
        <term><option>-h</option></term>
147
 
        <term><option>--help</option></term>
148
167
        <listitem>
149
168
          <para>
150
169
            Show a help message and exit
151
170
          </para>
152
171
        </listitem>
153
172
      </varlistentry>
154
 
 
 
173
      
155
174
      <varlistentry>
 
175
        <term><option>--interface</option>
 
176
        <replaceable>NAME</replaceable></term>
156
177
        <term><option>-i</option>
157
178
        <replaceable>NAME</replaceable></term>
158
 
        <term><option>--interface</option>
159
 
        <replaceable>NAME</replaceable></term>
160
179
        <listitem>
161
180
          <xi:include href="mandos-options.xml" xpointer="interface"/>
162
181
        </listitem>
163
182
      </varlistentry>
164
 
 
 
183
      
165
184
      <varlistentry>
166
 
        <term><literal>-a</literal>, <literal>--address <replaceable>
167
 
        ADDRESS</replaceable></literal></term>
 
185
        <term><option>--address
 
186
        <replaceable>ADDRESS</replaceable></option></term>
 
187
        <term><option>-a
 
188
        <replaceable>ADDRESS</replaceable></option></term>
168
189
        <listitem>
169
190
          <xi:include href="mandos-options.xml" xpointer="address"/>
170
191
        </listitem>
171
192
      </varlistentry>
172
 
 
 
193
      
173
194
      <varlistentry>
174
 
        <term><literal>-p</literal>, <literal>--port <replaceable>
175
 
        PORT</replaceable></literal></term>
 
195
        <term><option>--port
 
196
        <replaceable>PORT</replaceable></option></term>
 
197
        <term><option>-p
 
198
        <replaceable>PORT</replaceable></option></term>
176
199
        <listitem>
177
200
          <xi:include href="mandos-options.xml" xpointer="port"/>
178
201
        </listitem>
179
202
      </varlistentry>
180
 
 
 
203
      
181
204
      <varlistentry>
182
 
        <term><literal>--check</literal></term>
 
205
        <term><option>--check</option></term>
183
206
        <listitem>
184
207
          <para>
185
208
            Run the server’s self-tests.  This includes any unit
187
210
          </para>
188
211
        </listitem>
189
212
      </varlistentry>
190
 
 
 
213
      
191
214
      <varlistentry>
192
 
        <term><literal>--debug</literal></term>
 
215
        <term><option>--debug</option></term>
193
216
        <listitem>
194
217
          <xi:include href="mandos-options.xml" xpointer="debug"/>
195
218
        </listitem>
196
219
      </varlistentry>
197
 
 
198
 
      <varlistentry>
199
 
        <term><literal>--priority <replaceable>
200
 
        PRIORITY</replaceable></literal></term>
 
220
      
 
221
      <varlistentry>
 
222
        <term><option>--debuglevel
 
223
        <replaceable>LEVEL</replaceable></option></term>
 
224
        <listitem>
 
225
          <para>
 
226
            Set the debugging log level.
 
227
            <replaceable>LEVEL</replaceable> is a string, one of
 
228
            <quote><literal>CRITICAL</literal></quote>,
 
229
            <quote><literal>ERROR</literal></quote>,
 
230
            <quote><literal>WARNING</literal></quote>,
 
231
            <quote><literal>INFO</literal></quote>, or
 
232
            <quote><literal>DEBUG</literal></quote>, in order of
 
233
            increasing verbosity.  The default level is
 
234
            <quote><literal>WARNING</literal></quote>.
 
235
          </para>
 
236
        </listitem>
 
237
      </varlistentry>
 
238
      
 
239
      <varlistentry>
 
240
        <term><option>--priority <replaceable>
 
241
        PRIORITY</replaceable></option></term>
201
242
        <listitem>
202
243
          <xi:include href="mandos-options.xml" xpointer="priority"/>
203
244
        </listitem>
204
245
      </varlistentry>
205
 
 
 
246
      
206
247
      <varlistentry>
207
 
        <term><literal>--servicename <replaceable>NAME</replaceable>
208
 
        </literal></term>
 
248
        <term><option>--servicename
 
249
        <replaceable>NAME</replaceable></option></term>
209
250
        <listitem>
210
251
          <xi:include href="mandos-options.xml"
211
252
                      xpointer="servicename"/>
212
253
        </listitem>
213
254
      </varlistentry>
214
 
 
 
255
      
215
256
      <varlistentry>
216
 
        <term><literal>--configdir <replaceable>DIR</replaceable>
217
 
        </literal></term>
 
257
        <term><option>--configdir
 
258
        <replaceable>DIRECTORY</replaceable></option></term>
218
259
        <listitem>
219
260
          <para>
220
261
            Directory to search for configuration files.  Default is
226
267
          </para>
227
268
        </listitem>
228
269
      </varlistentry>
229
 
 
 
270
      
230
271
      <varlistentry>
231
 
        <term><literal>--version</literal></term>
 
272
        <term><option>--version</option></term>
232
273
        <listitem>
233
274
          <para>
234
275
            Prints the program version and exit.
235
276
          </para>
236
277
        </listitem>
237
278
      </varlistentry>
 
279
      
 
280
      <varlistentry>
 
281
        <term><option>--no-dbus</option></term>
 
282
        <listitem>
 
283
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
 
284
          <para>
 
285
            See also <xref linkend="dbus_interface"/>.
 
286
          </para>
 
287
        </listitem>
 
288
      </varlistentry>
 
289
      
 
290
      <varlistentry>
 
291
        <term><option>--no-ipv6</option></term>
 
292
        <listitem>
 
293
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
 
294
        </listitem>
 
295
      </varlistentry>
 
296
      
 
297
      <varlistentry>
 
298
        <term><option>--no-restore</option></term>
 
299
        <listitem>
 
300
          <xi:include href="mandos-options.xml" xpointer="restore"/>
 
301
          <para>
 
302
            See also <xref linkend="persistent_state"/>.
 
303
          </para>
 
304
        </listitem>
 
305
      </varlistentry>
 
306
      
 
307
      <varlistentry>
 
308
        <term><option>--statedir
 
309
        <replaceable>DIRECTORY</replaceable></option></term>
 
310
        <listitem>
 
311
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
 
312
        </listitem>
 
313
      </varlistentry>
 
314
      
 
315
      <varlistentry>
 
316
        <term><option>--socket
 
317
        <replaceable>FD</replaceable></option></term>
 
318
        <listitem>
 
319
          <xi:include href="mandos-options.xml" xpointer="socket"/>
 
320
        </listitem>
 
321
      </varlistentry>
 
322
      
 
323
      <varlistentry>
 
324
        <term><option>--foreground</option></term>
 
325
        <listitem>
 
326
          <xi:include href="mandos-options.xml"
 
327
                      xpointer="foreground"/>
 
328
        </listitem>
 
329
      </varlistentry>
 
330
      
 
331
      <varlistentry>
 
332
        <term><option>--no-zeroconf</option></term>
 
333
        <listitem>
 
334
          <xi:include href="mandos-options.xml" xpointer="zeroconf"/>
 
335
        </listitem>
 
336
      </varlistentry>
 
337
      
238
338
    </variablelist>
239
339
  </refsect1>
240
 
 
 
340
  
241
341
  <refsect1 id="overview">
242
342
    <title>OVERVIEW</title>
243
343
    <xi:include href="overview.xml"/>
244
344
    <para>
245
345
      This program is the server part.  It is a normal server program
246
346
      and will run in a normal system environment, not in an initial
247
 
      RAM disk environment.
 
347
      <acronym>RAM</acronym> disk environment.
248
348
    </para>
249
349
  </refsect1>
250
 
 
 
350
  
251
351
  <refsect1 id="protocol">
252
352
    <title>NETWORK PROTOCOL</title>
253
353
    <para>
305
405
      </row>
306
406
    </tbody></tgroup></table>
307
407
  </refsect1>
308
 
 
 
408
  
309
409
  <refsect1 id="checking">
310
410
    <title>CHECKING</title>
311
411
    <para>
312
412
      The server will, by default, continually check that the clients
313
413
      are still up.  If a client has not been confirmed as being up
314
414
      for some time, the client is assumed to be compromised and is no
315
 
      longer eligible to receive the encrypted password.  The timeout,
316
 
      checker program, and interval between checks can be configured
317
 
      both globally and per client; see <citerefentry>
 
415
      longer eligible to receive the encrypted password.  (Manual
 
416
      intervention is required to re-enable a client.)  The timeout,
 
417
      extended timeout, checker program, and interval between checks
 
418
      can be configured both globally and per client; see
 
419
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
420
      <manvolnum>5</manvolnum></citerefentry>.
 
421
    </para>
 
422
  </refsect1>
 
423
  
 
424
  <refsect1 id="approval">
 
425
    <title>APPROVAL</title>
 
426
    <para>
 
427
      The server can be configured to require manual approval for a
 
428
      client before it is sent its secret.  The delay to wait for such
 
429
      approval and the default action (approve or deny) can be
 
430
      configured both globally and per client; see <citerefentry>
318
431
      <refentrytitle>mandos-clients.conf</refentrytitle>
319
 
      <manvolnum>5</manvolnum></citerefentry>.
320
 
    </para>
 
432
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
 
433
      will be approved immediately without delay.
 
434
    </para>
 
435
    <para>
 
436
      This can be used to deny a client its secret if not manually
 
437
      approved within a specified time.  It can also be used to make
 
438
      the server delay before giving a client its secret, allowing
 
439
      optional manual denying of this specific client.
 
440
    </para>
 
441
    
321
442
  </refsect1>
322
 
 
 
443
  
323
444
  <refsect1 id="logging">
324
445
    <title>LOGGING</title>
325
446
    <para>
326
447
      The server will send log message with various severity levels to
327
 
      <filename>/dev/log</filename>.  With the
 
448
      <filename class="devicefile">/dev/log</filename>.  With the
328
449
      <option>--debug</option> option, it will log even more messages,
329
450
      and also show them on the console.
330
451
    </para>
331
452
  </refsect1>
332
 
 
 
453
  
 
454
  <refsect1 id="persistent_state">
 
455
    <title>PERSISTENT STATE</title>
 
456
    <para>
 
457
      Client settings, initially read from
 
458
      <filename>clients.conf</filename>, are persistent across
 
459
      restarts, and run-time changes will override settings in
 
460
      <filename>clients.conf</filename>.  However, if a setting is
 
461
      <emphasis>changed</emphasis> (or a client added, or removed) in
 
462
      <filename>clients.conf</filename>, this will take precedence.
 
463
    </para>
 
464
  </refsect1>
 
465
  
 
466
  <refsect1 id="dbus_interface">
 
467
    <title>D-BUS INTERFACE</title>
 
468
    <para>
 
469
      The server will by default provide a D-Bus system bus interface.
 
470
      This interface will only be accessible by the root user or a
 
471
      Mandos-specific user, if such a user exists.  For documentation
 
472
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
 
473
    </para>
 
474
  </refsect1>
 
475
  
333
476
  <refsect1 id="exit_status">
334
477
    <title>EXIT STATUS</title>
335
478
    <para>
337
480
      critical error is encountered.
338
481
    </para>
339
482
  </refsect1>
340
 
 
 
483
  
341
484
  <refsect1 id="environment">
342
485
    <title>ENVIRONMENT</title>
343
486
    <variablelist>
357
500
      </varlistentry>
358
501
    </variablelist>
359
502
  </refsect1>
360
 
 
361
 
  <refsect1 id="file">
 
503
  
 
504
  <refsect1 id="files">
362
505
    <title>FILES</title>
363
506
    <para>
364
507
      Use the <option>--configdir</option> option to change where
387
530
        </listitem>
388
531
      </varlistentry>
389
532
      <varlistentry>
390
 
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
391
 
        <listitem>
392
 
          <para>
393
 
            The file containing the process id of
394
 
            <command>&COMMANDNAME;</command>.
395
 
          </para>
396
 
        </listitem>
397
 
      </varlistentry>
398
 
      <varlistentry>
399
 
        <term><filename>/dev/log</filename></term>
 
533
        <term><filename>/run/mandos.pid</filename></term>
 
534
        <listitem>
 
535
          <para>
 
536
            The file containing the process id of the
 
537
            <command>&COMMANDNAME;</command> process started last.
 
538
            <emphasis >Note:</emphasis> If the <filename
 
539
            class="directory">/run</filename> directory does not
 
540
            exist, <filename>/var/run/mandos.pid</filename> will be
 
541
            used instead.
 
542
          </para>
 
543
        </listitem>
 
544
      </varlistentry>
 
545
      <varlistentry>
 
546
        <term><filename
 
547
        class="directory">/var/lib/mandos</filename></term>
 
548
        <listitem>
 
549
          <para>
 
550
            Directory where persistent state will be saved.  Change
 
551
            this with the <option>--statedir</option> option.  See
 
552
            also the <option>--no-restore</option> option.
 
553
          </para>
 
554
        </listitem>
 
555
      </varlistentry>
 
556
      <varlistentry>
 
557
        <term><filename class="devicefile">/dev/log</filename></term>
400
558
        <listitem>
401
559
          <para>
402
560
            The Unix domain socket to where local syslog messages are
425
583
      backtrace.  This could be considered a feature.
426
584
    </para>
427
585
    <para>
428
 
      Currently, if a client is declared <quote>invalid</quote> due to
429
 
      having timed out, the server does not record this fact onto
430
 
      permanent storage.  This has some security implications, see
431
 
      <xref linkend="CLIENTS"/>.
432
 
    </para>
433
 
    <para>
434
 
      There is currently no way of querying the server of the current
435
 
      status of clients, other than analyzing its <systemitem
436
 
      class="service">syslog</systemitem> output.
437
 
    </para>
438
 
    <para>
439
586
      There is no fine-grained control over logging and debug output.
440
587
    </para>
441
588
    <para>
442
 
      Debug mode is conflated with running in the foreground.
443
 
    </para>
444
 
    <para>
445
 
      The console log messages does not show a timestamp.
446
 
    </para>
 
589
      This server does not check the expire time of clients’ OpenPGP
 
590
      keys.
 
591
    </para>
 
592
    <xi:include href="bugs.xml"/>
447
593
  </refsect1>
448
594
  
449
595
  <refsect1 id="example">
459
605
    <informalexample>
460
606
      <para>
461
607
        Run the server in debug mode, read configuration files from
462
 
        the <filename>~/mandos</filename> directory, and use the
463
 
        Zeroconf service name <quote>Test</quote> to not collide with
464
 
        any other official Mandos server on this host:
 
608
        the <filename class="directory">~/mandos</filename> directory,
 
609
        and use the Zeroconf service name <quote>Test</quote> to not
 
610
        collide with any other official Mandos server on this host:
465
611
      </para>
466
612
      <para>
467
613
 
483
629
      </para>
484
630
    </informalexample>
485
631
  </refsect1>
486
 
 
 
632
  
487
633
  <refsect1 id="security">
488
634
    <title>SECURITY</title>
489
 
    <refsect2 id="SERVER">
 
635
    <refsect2 id="server">
490
636
      <title>SERVER</title>
491
637
      <para>
492
638
        Running this <command>&COMMANDNAME;</command> server program
493
639
        should not in itself present any security risk to the host
494
 
        computer running it.  The program does not need any special
495
 
        privileges to run, and is designed to run as a non-root user.
 
640
        computer running it.  The program switches to a non-root user
 
641
        soon after startup.
496
642
      </para>
497
643
    </refsect2>
498
 
    <refsect2 id="CLIENTS">
 
644
    <refsect2 id="clients">
499
645
      <title>CLIENTS</title>
500
646
      <para>
501
647
        The server only gives out its stored data to clients which
508
654
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
509
655
        <manvolnum>5</manvolnum></citerefentry>)
510
656
        <emphasis>must</emphasis> be made non-readable by anyone
511
 
        except the user running the server.
 
657
        except the user starting the server (usually root).
512
658
      </para>
513
659
      <para>
514
660
        As detailed in <xref linkend="checking"/>, the status of all
516
662
        compromised if they are gone for too long.
517
663
      </para>
518
664
      <para>
519
 
        If a client is compromised, its downtime should be duly noted
520
 
        by the server which would therefore declare the client
521
 
        invalid.  But if the server was ever restarted, it would
522
 
        re-read its client list from its configuration file and again
523
 
        regard all clients therein as valid, and hence eligible to
524
 
        receive their passwords.  Therefore, be careful when
525
 
        restarting servers if it is suspected that a client has, in
526
 
        fact, been compromised by parties who may now be running a
527
 
        fake Mandos client with the keys from the non-encrypted
528
 
        initial RAM image of the client host.  What should be done in
529
 
        that case (if restarting the server program really is
530
 
        necessary) is to stop the server program, edit the
531
 
        configuration file to omit any suspect clients, and restart
532
 
        the server program.
533
 
      </para>
534
 
      <para>
535
665
        For more details on client-side security, see
536
 
        <citerefentry><refentrytitle>password-request</refentrytitle>
 
666
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
537
667
        <manvolnum>8mandos</manvolnum></citerefentry>.
538
668
      </para>
539
669
    </refsect2>
540
670
  </refsect1>
541
 
 
 
671
  
542
672
  <refsect1 id="see_also">
543
673
    <title>SEE ALSO</title>
544
674
    <para>
545
 
      <citerefentry>
546
 
        <refentrytitle>mandos-clients.conf</refentrytitle>
547
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
548
 
        <refentrytitle>mandos.conf</refentrytitle>
549
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
550
 
        <refentrytitle>password-request</refentrytitle>
551
 
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
552
 
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
553
 
      </citerefentry>
 
675
      <citerefentry><refentrytitle>intro</refentrytitle>
 
676
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
677
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
678
      <manvolnum>5</manvolnum></citerefentry>,
 
679
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
 
680
      <manvolnum>5</manvolnum></citerefentry>,
 
681
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
682
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
683
      <citerefentry><refentrytitle>sh</refentrytitle>
 
684
      <manvolnum>1</manvolnum></citerefentry>
554
685
    </para>
555
686
    <variablelist>
556
687
      <varlistentry>
577
708
      </varlistentry>
578
709
      <varlistentry>
579
710
        <term>
580
 
          <ulink url="http://www.gnu.org/software/gnutls/"
581
 
          >GnuTLS</ulink>
 
711
          <ulink url="https://gnutls.org/">GnuTLS</ulink>
582
712
        </term>
583
713
      <listitem>
584
714
        <para>
622
752
      </varlistentry>
623
753
      <varlistentry>
624
754
        <term>
625
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
626
 
          Protocol Version 1.1</citetitle>
 
755
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
 
756
          Protocol Version 1.2</citetitle>
627
757
        </term>
628
758
      <listitem>
629
759
        <para>
630
 
          TLS 1.1 is the protocol implemented by GnuTLS.
 
760
          TLS 1.2 is the protocol implemented by GnuTLS.
631
761
        </para>
632
762
      </listitem>
633
763
      </varlistentry>
643
773
      </varlistentry>
644
774
      <varlistentry>
645
775
        <term>
646
 
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
647
 
          Security</citetitle>
 
776
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
 
777
          Security (TLS) Authentication</citetitle>
648
778
        </term>
649
779
      <listitem>
650
780
        <para>