/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos.xml

merge

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">
4
5
<!ENTITY COMMANDNAME "mandos">
5
 
<!ENTITY TIMESTAMP "2017-02-23">
6
 
<!ENTITY % common SYSTEM "common.ent">
7
 
%common;
 
6
<!ENTITY TIMESTAMP "2008-08-29">
8
7
]>
9
8
 
10
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
11
 
   <refentryinfo>
 
10
  <refentryinfo>
12
11
    <title>Mandos Manual</title>
13
12
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
14
13
    <productname>Mandos</productname>
15
 
    <productnumber>&version;</productnumber>
 
14
    <productnumber>&VERSION;</productnumber>
16
15
    <date>&TIMESTAMP;</date>
17
16
    <authorgroup>
18
17
      <author>
19
18
        <firstname>Björn</firstname>
20
19
        <surname>Påhlsson</surname>
21
20
        <address>
22
 
          <email>belorn@recompile.se</email>
 
21
          <email>belorn@fukt.bsnet.se</email>
23
22
        </address>
24
23
      </author>
25
24
      <author>
26
25
        <firstname>Teddy</firstname>
27
26
        <surname>Hogeborn</surname>
28
27
        <address>
29
 
          <email>teddy@recompile.se</email>
 
28
          <email>teddy@fukt.bsnet.se</email>
30
29
        </address>
31
30
      </author>
32
31
    </authorgroup>
33
32
    <copyright>
34
33
      <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>
44
34
      <holder>Teddy Hogeborn</holder>
45
35
      <holder>Björn Påhlsson</holder>
46
36
    </copyright>
47
 
    <xi:include href="legalnotice.xml"/>
 
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>
48
60
  </refentryinfo>
49
 
  
 
61
 
50
62
  <refmeta>
51
63
    <refentrytitle>&COMMANDNAME;</refentrytitle>
52
64
    <manvolnum>8</manvolnum>
55
67
  <refnamediv>
56
68
    <refname><command>&COMMANDNAME;</command></refname>
57
69
    <refpurpose>
58
 
      Gives encrypted passwords to authenticated Mandos clients
 
70
      Sends encrypted passwords to authenticated Mandos clients
59
71
    </refpurpose>
60
72
  </refnamediv>
61
 
  
 
73
 
62
74
  <refsynopsisdiv>
63
75
    <cmdsynopsis>
64
76
      <command>&COMMANDNAME;</command>
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>
 
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>
115
94
    </cmdsynopsis>
116
95
    <cmdsynopsis>
117
96
      <command>&COMMANDNAME;</command>
118
97
      <group choice="req">
119
 
        <arg choice="plain"><option>--help</option></arg>
120
 
        <arg choice="plain"><option>-h</option></arg>
 
98
        <arg choice="plain">-h</arg>
 
99
        <arg choice="plain">--help</arg>
121
100
      </group>
122
101
    </cmdsynopsis>
123
102
    <cmdsynopsis>
124
103
      <command>&COMMANDNAME;</command>
125
 
      <arg choice="plain"><option>--version</option></arg>
 
104
      <arg choice="plain">--version</arg>
126
105
    </cmdsynopsis>
127
106
    <cmdsynopsis>
128
107
      <command>&COMMANDNAME;</command>
129
 
      <arg choice="plain"><option>--check</option></arg>
 
108
      <arg choice="plain">--check</arg>
130
109
    </cmdsynopsis>
131
110
  </refsynopsisdiv>
132
 
  
 
111
 
133
112
  <refsect1 id="description">
134
113
    <title>DESCRIPTION</title>
135
114
    <para>
136
115
      <command>&COMMANDNAME;</command> is a server daemon which
137
116
      handles incoming request for passwords for a pre-defined list of
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.
 
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.
148
125
    </para>
 
126
 
149
127
  </refsect1>
150
128
  
151
129
  <refsect1 id="purpose">
152
130
    <title>PURPOSE</title>
 
131
 
153
132
    <para>
154
133
      The purpose of this is to enable <emphasis>remote and unattended
155
134
      rebooting</emphasis> of client host computer with an
156
135
      <emphasis>encrypted root file system</emphasis>.  See <xref
157
136
      linkend="overview"/> for details.
158
137
    </para>
 
138
 
159
139
  </refsect1>
160
140
  
161
141
  <refsect1 id="options">
162
142
    <title>OPTIONS</title>
 
143
 
163
144
    <variablelist>
164
145
      <varlistentry>
 
146
        <term><option>-h</option></term>
165
147
        <term><option>--help</option></term>
166
 
        <term><option>-h</option></term>
167
148
        <listitem>
168
149
          <para>
169
150
            Show a help message and exit
170
151
          </para>
171
152
        </listitem>
172
153
      </varlistentry>
173
 
      
 
154
 
174
155
      <varlistentry>
 
156
        <term><option>-i</option>
 
157
        <replaceable>NAME</replaceable></term>
175
158
        <term><option>--interface</option>
176
159
        <replaceable>NAME</replaceable></term>
177
 
        <term><option>-i</option>
178
 
        <replaceable>NAME</replaceable></term>
179
160
        <listitem>
180
161
          <xi:include href="mandos-options.xml" xpointer="interface"/>
181
162
        </listitem>
182
163
      </varlistentry>
183
 
      
 
164
 
184
165
      <varlistentry>
185
 
        <term><option>--address
186
 
        <replaceable>ADDRESS</replaceable></option></term>
187
 
        <term><option>-a
188
 
        <replaceable>ADDRESS</replaceable></option></term>
 
166
        <term><literal>-a</literal>, <literal>--address <replaceable>
 
167
        ADDRESS</replaceable></literal></term>
189
168
        <listitem>
190
169
          <xi:include href="mandos-options.xml" xpointer="address"/>
191
170
        </listitem>
192
171
      </varlistentry>
193
 
      
 
172
 
194
173
      <varlistentry>
195
 
        <term><option>--port
196
 
        <replaceable>PORT</replaceable></option></term>
197
 
        <term><option>-p
198
 
        <replaceable>PORT</replaceable></option></term>
 
174
        <term><literal>-p</literal>, <literal>--port <replaceable>
 
175
        PORT</replaceable></literal></term>
199
176
        <listitem>
200
177
          <xi:include href="mandos-options.xml" xpointer="port"/>
201
178
        </listitem>
202
179
      </varlistentry>
203
 
      
 
180
 
204
181
      <varlistentry>
205
 
        <term><option>--check</option></term>
 
182
        <term><literal>--check</literal></term>
206
183
        <listitem>
207
184
          <para>
208
185
            Run the server’s self-tests.  This includes any unit
210
187
          </para>
211
188
        </listitem>
212
189
      </varlistentry>
213
 
      
 
190
 
214
191
      <varlistentry>
215
 
        <term><option>--debug</option></term>
 
192
        <term><literal>--debug</literal></term>
216
193
        <listitem>
217
194
          <xi:include href="mandos-options.xml" xpointer="debug"/>
218
195
        </listitem>
219
196
      </varlistentry>
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>
 
197
 
 
198
      <varlistentry>
 
199
        <term><literal>--priority <replaceable>
 
200
        PRIORITY</replaceable></literal></term>
242
201
        <listitem>
243
202
          <xi:include href="mandos-options.xml" xpointer="priority"/>
244
203
        </listitem>
245
204
      </varlistentry>
246
 
      
 
205
 
247
206
      <varlistentry>
248
 
        <term><option>--servicename
249
 
        <replaceable>NAME</replaceable></option></term>
 
207
        <term><literal>--servicename <replaceable>NAME</replaceable>
 
208
        </literal></term>
250
209
        <listitem>
251
210
          <xi:include href="mandos-options.xml"
252
211
                      xpointer="servicename"/>
253
212
        </listitem>
254
213
      </varlistentry>
255
 
      
 
214
 
256
215
      <varlistentry>
257
 
        <term><option>--configdir
258
 
        <replaceable>DIRECTORY</replaceable></option></term>
 
216
        <term><literal>--configdir <replaceable>DIR</replaceable>
 
217
        </literal></term>
259
218
        <listitem>
260
219
          <para>
261
220
            Directory to search for configuration files.  Default is
267
226
          </para>
268
227
        </listitem>
269
228
      </varlistentry>
270
 
      
 
229
 
271
230
      <varlistentry>
272
 
        <term><option>--version</option></term>
 
231
        <term><literal>--version</literal></term>
273
232
        <listitem>
274
233
          <para>
275
234
            Prints the program version and exit.
276
235
          </para>
277
236
        </listitem>
278
237
      </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
 
      
338
238
    </variablelist>
339
239
  </refsect1>
340
 
  
 
240
 
341
241
  <refsect1 id="overview">
342
242
    <title>OVERVIEW</title>
343
243
    <xi:include href="overview.xml"/>
344
244
    <para>
345
245
      This program is the server part.  It is a normal server program
346
246
      and will run in a normal system environment, not in an initial
347
 
      <acronym>RAM</acronym> disk environment.
 
247
      RAM disk environment.
348
248
    </para>
349
249
  </refsect1>
350
 
  
 
250
 
351
251
  <refsect1 id="protocol">
352
252
    <title>NETWORK PROTOCOL</title>
353
253
    <para>
405
305
      </row>
406
306
    </tbody></tgroup></table>
407
307
  </refsect1>
408
 
  
 
308
 
409
309
  <refsect1 id="checking">
410
310
    <title>CHECKING</title>
411
311
    <para>
412
312
      The server will, by default, continually check that the clients
413
313
      are still up.  If a client has not been confirmed as being up
414
314
      for some time, the client is assumed to be compromised and is no
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>
 
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>
 
318
      <refentrytitle>mandos-clients.conf</refentrytitle>
420
319
      <manvolnum>5</manvolnum></citerefentry>.
421
320
    </para>
422
321
  </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>
431
 
      <refentrytitle>mandos-clients.conf</refentrytitle>
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
 
    
442
 
  </refsect1>
443
 
  
 
322
 
444
323
  <refsect1 id="logging">
445
324
    <title>LOGGING</title>
446
325
    <para>
447
326
      The server will send log message with various severity levels to
448
 
      <filename class="devicefile">/dev/log</filename>.  With the
 
327
      <filename>/dev/log</filename>.  With the
449
328
      <option>--debug</option> option, it will log even more messages,
450
329
      and also show them on the console.
451
330
    </para>
452
331
  </refsect1>
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
 
  
 
332
 
476
333
  <refsect1 id="exit_status">
477
334
    <title>EXIT STATUS</title>
478
335
    <para>
480
337
      critical error is encountered.
481
338
    </para>
482
339
  </refsect1>
483
 
  
 
340
 
484
341
  <refsect1 id="environment">
485
342
    <title>ENVIRONMENT</title>
486
343
    <variablelist>
487
344
      <varlistentry>
488
 
        <term><envar>PATH</envar></term>
 
345
        <term><varname>PATH</varname></term>
489
346
        <listitem>
490
347
          <para>
491
348
            To start the configured checker (see <xref
500
357
      </varlistentry>
501
358
    </variablelist>
502
359
  </refsect1>
503
 
  
504
 
  <refsect1 id="files">
 
360
 
 
361
  <refsect1 id="file">
505
362
    <title>FILES</title>
506
363
    <para>
507
364
      Use the <option>--configdir</option> option to change where
530
387
        </listitem>
531
388
      </varlistentry>
532
389
      <varlistentry>
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>
 
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>
558
400
        <listitem>
559
401
          <para>
560
402
            The Unix domain socket to where local syslog messages are
583
425
      backtrace.  This could be considered a feature.
584
426
    </para>
585
427
    <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>
586
439
      There is no fine-grained control over logging and debug output.
587
440
    </para>
588
441
    <para>
589
 
      This server does not check the expire time of clients’ OpenPGP
590
 
      keys.
591
 
    </para>
592
 
    <xi:include href="bugs.xml"/>
 
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>
593
447
  </refsect1>
594
448
  
595
449
  <refsect1 id="example">
605
459
    <informalexample>
606
460
      <para>
607
461
        Run the server in debug mode, read configuration files from
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:
 
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:
611
465
      </para>
612
466
      <para>
613
467
 
629
483
      </para>
630
484
    </informalexample>
631
485
  </refsect1>
632
 
  
 
486
 
633
487
  <refsect1 id="security">
634
488
    <title>SECURITY</title>
635
 
    <refsect2 id="server">
 
489
    <refsect2 id="SERVER">
636
490
      <title>SERVER</title>
637
491
      <para>
638
492
        Running this <command>&COMMANDNAME;</command> server program
639
493
        should not in itself present any security risk to the host
640
 
        computer running it.  The program switches to a non-root user
641
 
        soon after startup.
 
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.
642
496
      </para>
643
497
    </refsect2>
644
 
    <refsect2 id="clients">
 
498
    <refsect2 id="CLIENTS">
645
499
      <title>CLIENTS</title>
646
500
      <para>
647
501
        The server only gives out its stored data to clients which
654
508
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
655
509
        <manvolnum>5</manvolnum></citerefentry>)
656
510
        <emphasis>must</emphasis> be made non-readable by anyone
657
 
        except the user starting the server (usually root).
 
511
        except the user running the server.
658
512
      </para>
659
513
      <para>
660
514
        As detailed in <xref linkend="checking"/>, the status of all
662
516
        compromised if they are gone for too long.
663
517
      </para>
664
518
      <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>
665
535
        For more details on client-side security, see
666
 
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
536
        <citerefentry><refentrytitle>password-request</refentrytitle>
667
537
        <manvolnum>8mandos</manvolnum></citerefentry>.
668
538
      </para>
669
539
    </refsect2>
670
540
  </refsect1>
671
 
  
 
541
 
672
542
  <refsect1 id="see_also">
673
543
    <title>SEE ALSO</title>
674
544
    <para>
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>
 
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>
685
554
    </para>
686
555
    <variablelist>
687
556
      <varlistentry>
708
577
      </varlistentry>
709
578
      <varlistentry>
710
579
        <term>
711
 
          <ulink url="https://gnutls.org/">GnuTLS</ulink>
 
580
          <ulink url="http://www.gnu.org/software/gnutls/"
 
581
          >GnuTLS</ulink>
712
582
        </term>
713
583
      <listitem>
714
584
        <para>
752
622
      </varlistentry>
753
623
      <varlistentry>
754
624
        <term>
755
 
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
756
 
          Protocol Version 1.2</citetitle>
 
625
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
626
          Protocol Version 1.1</citetitle>
757
627
        </term>
758
628
      <listitem>
759
629
        <para>
760
 
          TLS 1.2 is the protocol implemented by GnuTLS.
 
630
          TLS 1.1 is the protocol implemented by GnuTLS.
761
631
        </para>
762
632
      </listitem>
763
633
      </varlistentry>
773
643
      </varlistentry>
774
644
      <varlistentry>
775
645
        <term>
776
 
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
777
 
          Security (TLS) Authentication</citetitle>
 
646
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
 
647
          Security</citetitle>
778
648
        </term>
779
649
      <listitem>
780
650
        <para>