/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: 2014-06-15 02:48:49 UTC
  • Revision ID: teddy@recompile.se-20140615024849-68x3q8g4yzadl33s
mandos: New "--no-zeroconf" option.  Also make "--socket=0" work.

* mandos (main): New "--no-zeroconf" option.  Also do not interpret
                 socket=0 as no socket.
* mandos-options.xml (zeroconf): New.
* mandos.conf (socket, zeroconf): New.
* mandos.xml (SYNOPSIS, OPTIONS): Added "--no-zeroconf".

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