/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: 2008-08-30 11:31:37 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080830113137-v0inyj0limprzfwn
* mandos-options.xml (priority): Added <acronym> tags.

* mandos.xml (NAME): Improved wording.

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 "2015-12-06">
6
 
<!ENTITY % common SYSTEM "common.ent">
7
 
%common;
 
6
<!ENTITY TIMESTAMP "2008-08-30">
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
34
      <holder>Teddy Hogeborn</holder>
43
35
      <holder>Björn Påhlsson</holder>
44
36
    </copyright>
45
 
    <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>
46
60
  </refentryinfo>
47
 
  
 
61
 
48
62
  <refmeta>
49
63
    <refentrytitle>&COMMANDNAME;</refentrytitle>
50
64
    <manvolnum>8</manvolnum>
56
70
      Gives encrypted passwords to authenticated Mandos clients
57
71
    </refpurpose>
58
72
  </refnamediv>
59
 
  
 
73
 
60
74
  <refsynopsisdiv>
61
75
    <cmdsynopsis>
62
76
      <command>&COMMANDNAME;</command>
63
 
      <group>
64
 
        <arg choice="plain"><option>--interface
65
 
        <replaceable>NAME</replaceable></option></arg>
66
 
        <arg choice="plain"><option>-i
67
 
        <replaceable>NAME</replaceable></option></arg>
68
 
      </group>
69
 
      <sbr/>
70
 
      <group>
71
 
        <arg choice="plain"><option>--address
72
 
        <replaceable>ADDRESS</replaceable></option></arg>
73
 
        <arg choice="plain"><option>-a
74
 
        <replaceable>ADDRESS</replaceable></option></arg>
75
 
      </group>
76
 
      <sbr/>
77
 
      <group>
78
 
        <arg choice="plain"><option>--port
79
 
        <replaceable>PORT</replaceable></option></arg>
80
 
        <arg choice="plain"><option>-p
81
 
        <replaceable>PORT</replaceable></option></arg>
82
 
      </group>
83
 
      <sbr/>
84
 
      <arg><option>--priority
85
 
      <replaceable>PRIORITY</replaceable></option></arg>
86
 
      <sbr/>
87
 
      <arg><option>--servicename
88
 
      <replaceable>NAME</replaceable></option></arg>
89
 
      <sbr/>
90
 
      <arg><option>--configdir
91
 
      <replaceable>DIRECTORY</replaceable></option></arg>
92
 
      <sbr/>
93
 
      <arg><option>--debug</option></arg>
94
 
      <sbr/>
95
 
      <arg><option>--debuglevel
96
 
      <replaceable>LEVEL</replaceable></option></arg>
97
 
      <sbr/>
98
 
      <arg><option>--no-dbus</option></arg>
99
 
      <sbr/>
100
 
      <arg><option>--no-ipv6</option></arg>
101
 
      <sbr/>
102
 
      <arg><option>--no-restore</option></arg>
103
 
      <sbr/>
104
 
      <arg><option>--statedir
105
 
      <replaceable>DIRECTORY</replaceable></option></arg>
106
 
      <sbr/>
107
 
      <arg><option>--socket
108
 
      <replaceable>FD</replaceable></option></arg>
109
 
      <sbr/>
110
 
      <arg><option>--foreground</option></arg>
111
 
      <sbr/>
112
 
      <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>
113
94
    </cmdsynopsis>
114
95
    <cmdsynopsis>
115
96
      <command>&COMMANDNAME;</command>
116
97
      <group choice="req">
117
 
        <arg choice="plain"><option>--help</option></arg>
118
 
        <arg choice="plain"><option>-h</option></arg>
 
98
        <arg choice="plain">-h</arg>
 
99
        <arg choice="plain">--help</arg>
119
100
      </group>
120
101
    </cmdsynopsis>
121
102
    <cmdsynopsis>
122
103
      <command>&COMMANDNAME;</command>
123
 
      <arg choice="plain"><option>--version</option></arg>
 
104
      <arg choice="plain">--version</arg>
124
105
    </cmdsynopsis>
125
106
    <cmdsynopsis>
126
107
      <command>&COMMANDNAME;</command>
127
 
      <arg choice="plain"><option>--check</option></arg>
 
108
      <arg choice="plain">--check</arg>
128
109
    </cmdsynopsis>
129
110
  </refsynopsisdiv>
130
 
  
 
111
 
131
112
  <refsect1 id="description">
132
113
    <title>DESCRIPTION</title>
133
114
    <para>
134
115
      <command>&COMMANDNAME;</command> is a server daemon which
135
116
      handles incoming request for passwords for a pre-defined list of
136
 
      client host computers. For an introduction, see
137
 
      <citerefentry><refentrytitle>intro</refentrytitle>
138
 
      <manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
139
 
      uses Zeroconf to announce itself on the local network, and uses
140
 
      TLS to communicate securely with and to authenticate the
141
 
      clients.  The Mandos server uses IPv6 to allow Mandos clients to
142
 
      use IPv6 link-local addresses, since the clients will probably
143
 
      not have any other addresses configured (see <xref
144
 
      linkend="overview"/>).  Any authenticated client is then given
145
 
      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.
146
125
    </para>
 
126
 
147
127
  </refsect1>
148
128
  
149
129
  <refsect1 id="purpose">
150
130
    <title>PURPOSE</title>
 
131
 
151
132
    <para>
152
133
      The purpose of this is to enable <emphasis>remote and unattended
153
134
      rebooting</emphasis> of client host computer with an
154
135
      <emphasis>encrypted root file system</emphasis>.  See <xref
155
136
      linkend="overview"/> for details.
156
137
    </para>
 
138
 
157
139
  </refsect1>
158
140
  
159
141
  <refsect1 id="options">
160
142
    <title>OPTIONS</title>
 
143
 
161
144
    <variablelist>
162
145
      <varlistentry>
 
146
        <term><option>-h</option></term>
163
147
        <term><option>--help</option></term>
164
 
        <term><option>-h</option></term>
165
148
        <listitem>
166
149
          <para>
167
150
            Show a help message and exit
168
151
          </para>
169
152
        </listitem>
170
153
      </varlistentry>
171
 
      
 
154
 
172
155
      <varlistentry>
 
156
        <term><option>-i</option>
 
157
        <replaceable>NAME</replaceable></term>
173
158
        <term><option>--interface</option>
174
159
        <replaceable>NAME</replaceable></term>
175
 
        <term><option>-i</option>
176
 
        <replaceable>NAME</replaceable></term>
177
160
        <listitem>
178
161
          <xi:include href="mandos-options.xml" xpointer="interface"/>
179
162
        </listitem>
180
163
      </varlistentry>
181
 
      
 
164
 
182
165
      <varlistentry>
183
 
        <term><option>--address
184
 
        <replaceable>ADDRESS</replaceable></option></term>
185
 
        <term><option>-a
186
 
        <replaceable>ADDRESS</replaceable></option></term>
 
166
        <term><literal>-a</literal>, <literal>--address <replaceable>
 
167
        ADDRESS</replaceable></literal></term>
187
168
        <listitem>
188
169
          <xi:include href="mandos-options.xml" xpointer="address"/>
189
170
        </listitem>
190
171
      </varlistentry>
191
 
      
 
172
 
192
173
      <varlistentry>
193
 
        <term><option>--port
194
 
        <replaceable>PORT</replaceable></option></term>
195
 
        <term><option>-p
196
 
        <replaceable>PORT</replaceable></option></term>
 
174
        <term><literal>-p</literal>, <literal>--port <replaceable>
 
175
        PORT</replaceable></literal></term>
197
176
        <listitem>
198
177
          <xi:include href="mandos-options.xml" xpointer="port"/>
199
178
        </listitem>
200
179
      </varlistentry>
201
 
      
 
180
 
202
181
      <varlistentry>
203
 
        <term><option>--check</option></term>
 
182
        <term><literal>--check</literal></term>
204
183
        <listitem>
205
184
          <para>
206
185
            Run the server’s self-tests.  This includes any unit
208
187
          </para>
209
188
        </listitem>
210
189
      </varlistentry>
211
 
      
 
190
 
212
191
      <varlistentry>
213
 
        <term><option>--debug</option></term>
 
192
        <term><literal>--debug</literal></term>
214
193
        <listitem>
215
194
          <xi:include href="mandos-options.xml" xpointer="debug"/>
216
195
        </listitem>
217
196
      </varlistentry>
218
 
      
219
 
      <varlistentry>
220
 
        <term><option>--debuglevel
221
 
        <replaceable>LEVEL</replaceable></option></term>
222
 
        <listitem>
223
 
          <para>
224
 
            Set the debugging log level.
225
 
            <replaceable>LEVEL</replaceable> is a string, one of
226
 
            <quote><literal>CRITICAL</literal></quote>,
227
 
            <quote><literal>ERROR</literal></quote>,
228
 
            <quote><literal>WARNING</literal></quote>,
229
 
            <quote><literal>INFO</literal></quote>, or
230
 
            <quote><literal>DEBUG</literal></quote>, in order of
231
 
            increasing verbosity.  The default level is
232
 
            <quote><literal>WARNING</literal></quote>.
233
 
          </para>
234
 
        </listitem>
235
 
      </varlistentry>
236
 
      
237
 
      <varlistentry>
238
 
        <term><option>--priority <replaceable>
239
 
        PRIORITY</replaceable></option></term>
 
197
 
 
198
      <varlistentry>
 
199
        <term><literal>--priority <replaceable>
 
200
        PRIORITY</replaceable></literal></term>
240
201
        <listitem>
241
202
          <xi:include href="mandos-options.xml" xpointer="priority"/>
242
203
        </listitem>
243
204
      </varlistentry>
244
 
      
 
205
 
245
206
      <varlistentry>
246
 
        <term><option>--servicename
247
 
        <replaceable>NAME</replaceable></option></term>
 
207
        <term><literal>--servicename <replaceable>NAME</replaceable>
 
208
        </literal></term>
248
209
        <listitem>
249
210
          <xi:include href="mandos-options.xml"
250
211
                      xpointer="servicename"/>
251
212
        </listitem>
252
213
      </varlistentry>
253
 
      
 
214
 
254
215
      <varlistentry>
255
 
        <term><option>--configdir
256
 
        <replaceable>DIRECTORY</replaceable></option></term>
 
216
        <term><literal>--configdir <replaceable>DIR</replaceable>
 
217
        </literal></term>
257
218
        <listitem>
258
219
          <para>
259
220
            Directory to search for configuration files.  Default is
265
226
          </para>
266
227
        </listitem>
267
228
      </varlistentry>
268
 
      
 
229
 
269
230
      <varlistentry>
270
 
        <term><option>--version</option></term>
 
231
        <term><literal>--version</literal></term>
271
232
        <listitem>
272
233
          <para>
273
234
            Prints the program version and exit.
274
235
          </para>
275
236
        </listitem>
276
237
      </varlistentry>
277
 
      
278
 
      <varlistentry>
279
 
        <term><option>--no-dbus</option></term>
280
 
        <listitem>
281
 
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
282
 
          <para>
283
 
            See also <xref linkend="dbus_interface"/>.
284
 
          </para>
285
 
        </listitem>
286
 
      </varlistentry>
287
 
      
288
 
      <varlistentry>
289
 
        <term><option>--no-ipv6</option></term>
290
 
        <listitem>
291
 
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
292
 
        </listitem>
293
 
      </varlistentry>
294
 
      
295
 
      <varlistentry>
296
 
        <term><option>--no-restore</option></term>
297
 
        <listitem>
298
 
          <xi:include href="mandos-options.xml" xpointer="restore"/>
299
 
          <para>
300
 
            See also <xref linkend="persistent_state"/>.
301
 
          </para>
302
 
        </listitem>
303
 
      </varlistentry>
304
 
      
305
 
      <varlistentry>
306
 
        <term><option>--statedir
307
 
        <replaceable>DIRECTORY</replaceable></option></term>
308
 
        <listitem>
309
 
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
310
 
        </listitem>
311
 
      </varlistentry>
312
 
      
313
 
      <varlistentry>
314
 
        <term><option>--socket
315
 
        <replaceable>FD</replaceable></option></term>
316
 
        <listitem>
317
 
          <xi:include href="mandos-options.xml" xpointer="socket"/>
318
 
        </listitem>
319
 
      </varlistentry>
320
 
      
321
 
      <varlistentry>
322
 
        <term><option>--foreground</option></term>
323
 
        <listitem>
324
 
          <xi:include href="mandos-options.xml"
325
 
                      xpointer="foreground"/>
326
 
        </listitem>
327
 
      </varlistentry>
328
 
      
329
 
      <varlistentry>
330
 
        <term><option>--no-zeroconf</option></term>
331
 
        <listitem>
332
 
          <xi:include href="mandos-options.xml" xpointer="zeroconf"/>
333
 
        </listitem>
334
 
      </varlistentry>
335
 
      
336
238
    </variablelist>
337
239
  </refsect1>
338
 
  
 
240
 
339
241
  <refsect1 id="overview">
340
242
    <title>OVERVIEW</title>
341
243
    <xi:include href="overview.xml"/>
342
244
    <para>
343
245
      This program is the server part.  It is a normal server program
344
246
      and will run in a normal system environment, not in an initial
345
 
      <acronym>RAM</acronym> disk environment.
 
247
      RAM disk environment.
346
248
    </para>
347
249
  </refsect1>
348
 
  
 
250
 
349
251
  <refsect1 id="protocol">
350
252
    <title>NETWORK PROTOCOL</title>
351
253
    <para>
403
305
      </row>
404
306
    </tbody></tgroup></table>
405
307
  </refsect1>
406
 
  
 
308
 
407
309
  <refsect1 id="checking">
408
310
    <title>CHECKING</title>
409
311
    <para>
410
312
      The server will, by default, continually check that the clients
411
313
      are still up.  If a client has not been confirmed as being up
412
314
      for some time, the client is assumed to be compromised and is no
413
 
      longer eligible to receive the encrypted password.  (Manual
414
 
      intervention is required to re-enable a client.)  The timeout,
415
 
      extended timeout, checker program, and interval between checks
416
 
      can be configured both globally and per client; see
417
 
      <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>
418
319
      <manvolnum>5</manvolnum></citerefentry>.
419
320
    </para>
420
321
  </refsect1>
421
 
  
422
 
  <refsect1 id="approval">
423
 
    <title>APPROVAL</title>
424
 
    <para>
425
 
      The server can be configured to require manual approval for a
426
 
      client before it is sent its secret.  The delay to wait for such
427
 
      approval and the default action (approve or deny) can be
428
 
      configured both globally and per client; see <citerefentry>
429
 
      <refentrytitle>mandos-clients.conf</refentrytitle>
430
 
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
431
 
      will be approved immediately without delay.
432
 
    </para>
433
 
    <para>
434
 
      This can be used to deny a client its secret if not manually
435
 
      approved within a specified time.  It can also be used to make
436
 
      the server delay before giving a client its secret, allowing
437
 
      optional manual denying of this specific client.
438
 
    </para>
439
 
    
440
 
  </refsect1>
441
 
  
 
322
 
442
323
  <refsect1 id="logging">
443
324
    <title>LOGGING</title>
444
325
    <para>
445
326
      The server will send log message with various severity levels to
446
 
      <filename class="devicefile">/dev/log</filename>.  With the
 
327
      <filename>/dev/log</filename>.  With the
447
328
      <option>--debug</option> option, it will log even more messages,
448
329
      and also show them on the console.
449
330
    </para>
450
331
  </refsect1>
451
 
  
452
 
  <refsect1 id="persistent_state">
453
 
    <title>PERSISTENT STATE</title>
454
 
    <para>
455
 
      Client settings, initially read from
456
 
      <filename>clients.conf</filename>, are persistent across
457
 
      restarts, and run-time changes will override settings in
458
 
      <filename>clients.conf</filename>.  However, if a setting is
459
 
      <emphasis>changed</emphasis> (or a client added, or removed) in
460
 
      <filename>clients.conf</filename>, this will take precedence.
461
 
    </para>
462
 
  </refsect1>
463
 
  
464
 
  <refsect1 id="dbus_interface">
465
 
    <title>D-BUS INTERFACE</title>
466
 
    <para>
467
 
      The server will by default provide a D-Bus system bus interface.
468
 
      This interface will only be accessible by the root user or a
469
 
      Mandos-specific user, if such a user exists.  For documentation
470
 
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
471
 
    </para>
472
 
  </refsect1>
473
 
  
 
332
 
474
333
  <refsect1 id="exit_status">
475
334
    <title>EXIT STATUS</title>
476
335
    <para>
478
337
      critical error is encountered.
479
338
    </para>
480
339
  </refsect1>
481
 
  
 
340
 
482
341
  <refsect1 id="environment">
483
342
    <title>ENVIRONMENT</title>
484
343
    <variablelist>
485
344
      <varlistentry>
486
 
        <term><envar>PATH</envar></term>
 
345
        <term><varname>PATH</varname></term>
487
346
        <listitem>
488
347
          <para>
489
348
            To start the configured checker (see <xref
498
357
      </varlistentry>
499
358
    </variablelist>
500
359
  </refsect1>
501
 
  
502
 
  <refsect1 id="files">
 
360
 
 
361
  <refsect1 id="file">
503
362
    <title>FILES</title>
504
363
    <para>
505
364
      Use the <option>--configdir</option> option to change where
528
387
        </listitem>
529
388
      </varlistentry>
530
389
      <varlistentry>
531
 
        <term><filename>/run/mandos.pid</filename></term>
532
 
        <listitem>
533
 
          <para>
534
 
            The file containing the process id of the
535
 
            <command>&COMMANDNAME;</command> process started last.
536
 
            <emphasis >Note:</emphasis> If the <filename
537
 
            class="directory">/run</filename> directory does not
538
 
            exist, <filename>/var/run/mandos.pid</filename> will be
539
 
            used instead.
540
 
          </para>
541
 
        </listitem>
542
 
      </varlistentry>
543
 
      <varlistentry>
544
 
        <term><filename
545
 
        class="directory">/var/lib/mandos</filename></term>
546
 
        <listitem>
547
 
          <para>
548
 
            Directory where persistent state will be saved.  Change
549
 
            this with the <option>--statedir</option> option.  See
550
 
            also the <option>--no-restore</option> option.
551
 
          </para>
552
 
        </listitem>
553
 
      </varlistentry>
554
 
      <varlistentry>
555
 
        <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>
556
400
        <listitem>
557
401
          <para>
558
402
            The Unix domain socket to where local syslog messages are
581
425
      backtrace.  This could be considered a feature.
582
426
    </para>
583
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>
584
439
      There is no fine-grained control over logging and debug output.
585
440
    </para>
586
441
    <para>
587
 
      This server does not check the expire time of clients’ OpenPGP
588
 
      keys.
 
442
      Debug mode is conflated with running in the foreground.
 
443
    </para>
 
444
    <para>
 
445
      The console log messages does not show a timestamp.
589
446
    </para>
590
447
  </refsect1>
591
448
  
602
459
    <informalexample>
603
460
      <para>
604
461
        Run the server in debug mode, read configuration files from
605
 
        the <filename class="directory">~/mandos</filename> directory,
606
 
        and use the Zeroconf service name <quote>Test</quote> to not
607
 
        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:
608
465
      </para>
609
466
      <para>
610
467
 
626
483
      </para>
627
484
    </informalexample>
628
485
  </refsect1>
629
 
  
 
486
 
630
487
  <refsect1 id="security">
631
488
    <title>SECURITY</title>
632
 
    <refsect2 id="server">
 
489
    <refsect2 id="SERVER">
633
490
      <title>SERVER</title>
634
491
      <para>
635
492
        Running this <command>&COMMANDNAME;</command> server program
636
493
        should not in itself present any security risk to the host
637
 
        computer running it.  The program switches to a non-root user
638
 
        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.
639
496
      </para>
640
497
    </refsect2>
641
 
    <refsect2 id="clients">
 
498
    <refsect2 id="CLIENTS">
642
499
      <title>CLIENTS</title>
643
500
      <para>
644
501
        The server only gives out its stored data to clients which
651
508
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
652
509
        <manvolnum>5</manvolnum></citerefentry>)
653
510
        <emphasis>must</emphasis> be made non-readable by anyone
654
 
        except the user starting the server (usually root).
 
511
        except the user running the server.
655
512
      </para>
656
513
      <para>
657
514
        As detailed in <xref linkend="checking"/>, the status of all
659
516
        compromised if they are gone for too long.
660
517
      </para>
661
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>
662
535
        For more details on client-side security, see
663
 
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
536
        <citerefentry><refentrytitle>password-request</refentrytitle>
664
537
        <manvolnum>8mandos</manvolnum></citerefentry>.
665
538
      </para>
666
539
    </refsect2>
667
540
  </refsect1>
668
 
  
 
541
 
669
542
  <refsect1 id="see_also">
670
543
    <title>SEE ALSO</title>
671
544
    <para>
672
 
      <citerefentry><refentrytitle>intro</refentrytitle>
673
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
674
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
675
 
      <manvolnum>5</manvolnum></citerefentry>,
676
 
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
677
 
      <manvolnum>5</manvolnum></citerefentry>,
678
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
679
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
680
 
      <citerefentry><refentrytitle>sh</refentrytitle>
681
 
      <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>
682
554
    </para>
683
555
    <variablelist>
684
556
      <varlistentry>
705
577
      </varlistentry>
706
578
      <varlistentry>
707
579
        <term>
708
 
          <ulink url="http://gnutls.org/">GnuTLS</ulink>
 
580
          <ulink url="http://www.gnu.org/software/gnutls/"
 
581
          >GnuTLS</ulink>
709
582
        </term>
710
583
      <listitem>
711
584
        <para>
749
622
      </varlistentry>
750
623
      <varlistentry>
751
624
        <term>
752
 
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
753
 
          Protocol Version 1.2</citetitle>
 
625
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
626
          Protocol Version 1.1</citetitle>
754
627
        </term>
755
628
      <listitem>
756
629
        <para>
757
 
          TLS 1.2 is the protocol implemented by GnuTLS.
 
630
          TLS 1.1 is the protocol implemented by GnuTLS.
758
631
        </para>
759
632
      </listitem>
760
633
      </varlistentry>
770
643
      </varlistentry>
771
644
      <varlistentry>
772
645
        <term>
773
 
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
774
 
          Security (TLS) Authentication</citetitle>
 
646
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
 
647
          Security</citetitle>
775
648
        </term>
776
649
      <listitem>
777
650
        <para>