/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: 2012-06-23 00:58:49 UTC
  • Revision ID: teddy@recompile.se-20120623005849-02wj82cng433rt2k
* clients.conf: Convert all time intervals to new RFC 3339 syntax.
* mandos: All client options for time intervals now take an RFC 3339
          duration.
  (rfc3339_duration_to_delta): New function.
  (string_to_delta): Try rfc3339_duration_to_delta first.
* mandos-clients.conf.xml (OPTIONS/timeout): Document new format.
  (EXAMPLE): Update to new interval format.
  (SEE ALSO): Reference RFC 3339.

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 "2012-06-17">
 
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
 
    <title>&COMMANDNAME;</title>
 
11
   <refentryinfo>
 
12
    <title>Mandos Manual</title>
12
13
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
13
 
    <productname>&COMMANDNAME;</productname>
14
 
    <productnumber>&VERSION;</productnumber>
 
14
    <productname>Mandos</productname>
 
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>
34
39
      <holder>Teddy Hogeborn</holder>
35
40
      <holder>Björn Påhlsson</holder>
36
41
    </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>
 
42
    <xi:include href="legalnotice.xml"/>
60
43
  </refentryinfo>
61
 
 
 
44
  
62
45
  <refmeta>
63
46
    <refentrytitle>&COMMANDNAME;</refentrytitle>
64
47
    <manvolnum>8</manvolnum>
67
50
  <refnamediv>
68
51
    <refname><command>&COMMANDNAME;</command></refname>
69
52
    <refpurpose>
70
 
      Sends encrypted passwords to authenticated Mandos clients
 
53
      Gives encrypted passwords to authenticated Mandos clients
71
54
    </refpurpose>
72
55
  </refnamediv>
73
 
 
 
56
  
74
57
  <refsynopsisdiv>
75
58
    <cmdsynopsis>
76
59
      <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>
 
60
      <group>
 
61
        <arg choice="plain"><option>--interface
 
62
        <replaceable>NAME</replaceable></option></arg>
 
63
        <arg choice="plain"><option>-i
 
64
        <replaceable>NAME</replaceable></option></arg>
 
65
      </group>
 
66
      <sbr/>
 
67
      <group>
 
68
        <arg choice="plain"><option>--address
 
69
        <replaceable>ADDRESS</replaceable></option></arg>
 
70
        <arg choice="plain"><option>-a
 
71
        <replaceable>ADDRESS</replaceable></option></arg>
 
72
      </group>
 
73
      <sbr/>
 
74
      <group>
 
75
        <arg choice="plain"><option>--port
 
76
        <replaceable>PORT</replaceable></option></arg>
 
77
        <arg choice="plain"><option>-p
 
78
        <replaceable>PORT</replaceable></option></arg>
 
79
      </group>
 
80
      <sbr/>
 
81
      <arg><option>--priority
 
82
      <replaceable>PRIORITY</replaceable></option></arg>
 
83
      <sbr/>
 
84
      <arg><option>--servicename
 
85
      <replaceable>NAME</replaceable></option></arg>
 
86
      <sbr/>
 
87
      <arg><option>--configdir
 
88
      <replaceable>DIRECTORY</replaceable></option></arg>
 
89
      <sbr/>
 
90
      <arg><option>--debug</option></arg>
 
91
      <sbr/>
 
92
      <arg><option>--debuglevel
 
93
      <replaceable>LEVEL</replaceable></option></arg>
 
94
      <sbr/>
 
95
      <arg><option>--no-dbus</option></arg>
 
96
      <sbr/>
 
97
      <arg><option>--no-ipv6</option></arg>
 
98
      <sbr/>
 
99
      <arg><option>--no-restore</option></arg>
 
100
      <sbr/>
 
101
      <arg><option>--statedir
 
102
      <replaceable>DIRECTORY</replaceable></option></arg>
 
103
      <sbr/>
 
104
      <arg><option>--socket
 
105
      <replaceable>FD</replaceable></option></arg>
 
106
      <sbr/>
 
107
      <arg><option>--foreground</option></arg>
94
108
    </cmdsynopsis>
95
109
    <cmdsynopsis>
96
110
      <command>&COMMANDNAME;</command>
97
111
      <group choice="req">
98
 
        <arg choice="plain">-h</arg>
99
 
        <arg choice="plain">--help</arg>
 
112
        <arg choice="plain"><option>--help</option></arg>
 
113
        <arg choice="plain"><option>-h</option></arg>
100
114
      </group>
101
115
    </cmdsynopsis>
102
116
    <cmdsynopsis>
103
117
      <command>&COMMANDNAME;</command>
104
 
      <arg choice="plain">--version</arg>
 
118
      <arg choice="plain"><option>--version</option></arg>
105
119
    </cmdsynopsis>
106
120
    <cmdsynopsis>
107
121
      <command>&COMMANDNAME;</command>
108
 
      <arg choice="plain">--check</arg>
 
122
      <arg choice="plain"><option>--check</option></arg>
109
123
    </cmdsynopsis>
110
124
  </refsynopsisdiv>
111
 
 
 
125
  
112
126
  <refsect1 id="description">
113
127
    <title>DESCRIPTION</title>
114
128
    <para>
115
129
      <command>&COMMANDNAME;</command> is a server daemon which
116
130
      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.
 
131
      client host computers. For an introduction, see
 
132
      <citerefentry><refentrytitle>intro</refentrytitle>
 
133
      <manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
 
134
      uses Zeroconf to announce itself on the local network, and uses
 
135
      TLS to communicate securely with and to authenticate the
 
136
      clients.  The Mandos server uses IPv6 to allow Mandos clients to
 
137
      use IPv6 link-local addresses, since the clients will probably
 
138
      not have any other addresses configured (see <xref
 
139
      linkend="overview"/>).  Any authenticated client is then given
 
140
      the stored pre-encrypted password for that specific client.
125
141
    </para>
126
 
 
127
142
  </refsect1>
128
143
  
129
144
  <refsect1 id="purpose">
130
145
    <title>PURPOSE</title>
131
 
 
132
146
    <para>
133
147
      The purpose of this is to enable <emphasis>remote and unattended
134
148
      rebooting</emphasis> of client host computer with an
135
149
      <emphasis>encrypted root file system</emphasis>.  See <xref
136
150
      linkend="overview"/> for details.
137
151
    </para>
138
 
 
139
152
  </refsect1>
140
153
  
141
154
  <refsect1 id="options">
142
155
    <title>OPTIONS</title>
143
 
 
144
156
    <variablelist>
145
157
      <varlistentry>
146
 
        <term><literal>-h</literal>, <literal>--help</literal></term>
 
158
        <term><option>--help</option></term>
 
159
        <term><option>-h</option></term>
147
160
        <listitem>
148
161
          <para>
149
162
            Show a help message and exit
150
163
          </para>
151
164
        </listitem>
152
165
      </varlistentry>
153
 
 
 
166
      
154
167
      <varlistentry>
155
 
        <term><literal>-i</literal>, <literal>--interface <replaceable
156
 
        >NAME</replaceable></literal></term>
 
168
        <term><option>--interface</option>
 
169
        <replaceable>NAME</replaceable></term>
 
170
        <term><option>-i</option>
 
171
        <replaceable>NAME</replaceable></term>
157
172
        <listitem>
158
173
          <xi:include href="mandos-options.xml" xpointer="interface"/>
159
174
        </listitem>
160
175
      </varlistentry>
161
 
 
 
176
      
162
177
      <varlistentry>
163
 
        <term><literal>-a</literal>, <literal>--address <replaceable>
164
 
        ADDRESS</replaceable></literal></term>
 
178
        <term><option>--address
 
179
        <replaceable>ADDRESS</replaceable></option></term>
 
180
        <term><option>-a
 
181
        <replaceable>ADDRESS</replaceable></option></term>
165
182
        <listitem>
166
183
          <xi:include href="mandos-options.xml" xpointer="address"/>
167
184
        </listitem>
168
185
      </varlistentry>
169
 
 
 
186
      
170
187
      <varlistentry>
171
 
        <term><literal>-p</literal>, <literal>--port <replaceable>
172
 
        PORT</replaceable></literal></term>
 
188
        <term><option>--port
 
189
        <replaceable>PORT</replaceable></option></term>
 
190
        <term><option>-p
 
191
        <replaceable>PORT</replaceable></option></term>
173
192
        <listitem>
174
193
          <xi:include href="mandos-options.xml" xpointer="port"/>
175
194
        </listitem>
176
195
      </varlistentry>
177
 
 
 
196
      
178
197
      <varlistentry>
179
 
        <term><literal>--check</literal></term>
 
198
        <term><option>--check</option></term>
180
199
        <listitem>
181
200
          <para>
182
201
            Run the server’s self-tests.  This includes any unit
184
203
          </para>
185
204
        </listitem>
186
205
      </varlistentry>
187
 
 
 
206
      
188
207
      <varlistentry>
189
 
        <term><literal>--debug</literal></term>
 
208
        <term><option>--debug</option></term>
190
209
        <listitem>
191
210
          <xi:include href="mandos-options.xml" xpointer="debug"/>
192
211
        </listitem>
193
212
      </varlistentry>
194
 
 
195
 
      <varlistentry>
196
 
        <term><literal>--priority <replaceable>
197
 
        PRIORITY</replaceable></literal></term>
 
213
      
 
214
      <varlistentry>
 
215
        <term><option>--debuglevel
 
216
        <replaceable>LEVEL</replaceable></option></term>
 
217
        <listitem>
 
218
          <para>
 
219
            Set the debugging log level.
 
220
            <replaceable>LEVEL</replaceable> is a string, one of
 
221
            <quote><literal>CRITICAL</literal></quote>,
 
222
            <quote><literal>ERROR</literal></quote>,
 
223
            <quote><literal>WARNING</literal></quote>,
 
224
            <quote><literal>INFO</literal></quote>, or
 
225
            <quote><literal>DEBUG</literal></quote>, in order of
 
226
            increasing verbosity.  The default level is
 
227
            <quote><literal>WARNING</literal></quote>.
 
228
          </para>
 
229
        </listitem>
 
230
      </varlistentry>
 
231
      
 
232
      <varlistentry>
 
233
        <term><option>--priority <replaceable>
 
234
        PRIORITY</replaceable></option></term>
198
235
        <listitem>
199
236
          <xi:include href="mandos-options.xml" xpointer="priority"/>
200
237
        </listitem>
201
238
      </varlistentry>
202
 
 
 
239
      
203
240
      <varlistentry>
204
 
        <term><literal>--servicename <replaceable>NAME</replaceable>
205
 
        </literal></term>
 
241
        <term><option>--servicename
 
242
        <replaceable>NAME</replaceable></option></term>
206
243
        <listitem>
207
244
          <xi:include href="mandos-options.xml"
208
245
                      xpointer="servicename"/>
209
246
        </listitem>
210
247
      </varlistentry>
211
 
 
 
248
      
212
249
      <varlistentry>
213
 
        <term><literal>--configdir <replaceable>DIR</replaceable>
214
 
        </literal></term>
 
250
        <term><option>--configdir
 
251
        <replaceable>DIRECTORY</replaceable></option></term>
215
252
        <listitem>
216
253
          <para>
217
254
            Directory to search for configuration files.  Default is
223
260
          </para>
224
261
        </listitem>
225
262
      </varlistentry>
226
 
 
 
263
      
227
264
      <varlistentry>
228
 
        <term><literal>--version</literal></term>
 
265
        <term><option>--version</option></term>
229
266
        <listitem>
230
267
          <para>
231
268
            Prints the program version and exit.
232
269
          </para>
233
270
        </listitem>
234
271
      </varlistentry>
 
272
      
 
273
      <varlistentry>
 
274
        <term><option>--no-dbus</option></term>
 
275
        <listitem>
 
276
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
 
277
          <para>
 
278
            See also <xref linkend="dbus_interface"/>.
 
279
          </para>
 
280
        </listitem>
 
281
      </varlistentry>
 
282
      
 
283
      <varlistentry>
 
284
        <term><option>--no-ipv6</option></term>
 
285
        <listitem>
 
286
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
 
287
        </listitem>
 
288
      </varlistentry>
 
289
      
 
290
      <varlistentry>
 
291
        <term><option>--no-restore</option></term>
 
292
        <listitem>
 
293
          <xi:include href="mandos-options.xml" xpointer="restore"/>
 
294
          <para>
 
295
            See also <xref linkend="persistent_state"/>.
 
296
          </para>
 
297
        </listitem>
 
298
      </varlistentry>
 
299
      
 
300
      <varlistentry>
 
301
        <term><option>--statedir
 
302
        <replaceable>DIRECTORY</replaceable></option></term>
 
303
        <listitem>
 
304
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
 
305
        </listitem>
 
306
      </varlistentry>
 
307
      
 
308
      <varlistentry>
 
309
        <term><option>--socket
 
310
        <replaceable>FD</replaceable></option></term>
 
311
        <listitem>
 
312
          <xi:include href="mandos-options.xml" xpointer="socket"/>
 
313
        </listitem>
 
314
      </varlistentry>
 
315
      
 
316
      <varlistentry>
 
317
        <term><option>--foreground</option></term>
 
318
        <listitem>
 
319
          <xi:include href="mandos-options.xml"
 
320
                      xpointer="foreground"/>
 
321
        </listitem>
 
322
      </varlistentry>
 
323
      
235
324
    </variablelist>
236
325
  </refsect1>
237
 
 
 
326
  
238
327
  <refsect1 id="overview">
239
328
    <title>OVERVIEW</title>
240
329
    <xi:include href="overview.xml"/>
241
330
    <para>
242
331
      This program is the server part.  It is a normal server program
243
332
      and will run in a normal system environment, not in an initial
244
 
      RAM disk environment.
 
333
      <acronym>RAM</acronym> disk environment.
245
334
    </para>
246
335
  </refsect1>
247
 
 
 
336
  
248
337
  <refsect1 id="protocol">
249
338
    <title>NETWORK PROTOCOL</title>
250
339
    <para>
302
391
      </row>
303
392
    </tbody></tgroup></table>
304
393
  </refsect1>
305
 
 
 
394
  
306
395
  <refsect1 id="checking">
307
396
    <title>CHECKING</title>
308
397
    <para>
309
398
      The server will, by default, continually check that the clients
310
399
      are still up.  If a client has not been confirmed as being up
311
400
      for some time, the client is assumed to be compromised and is no
312
 
      longer eligible to receive the encrypted password.  The timeout,
313
 
      checker program, and interval between checks can be configured
314
 
      both globally and per client; see <citerefentry>
 
401
      longer eligible to receive the encrypted password.  (Manual
 
402
      intervention is required to re-enable a client.)  The timeout,
 
403
      extended timeout, checker program, and interval between checks
 
404
      can be configured both globally and per client; see
 
405
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
406
      <manvolnum>5</manvolnum></citerefentry>.
 
407
    </para>
 
408
  </refsect1>
 
409
  
 
410
  <refsect1 id="approval">
 
411
    <title>APPROVAL</title>
 
412
    <para>
 
413
      The server can be configured to require manual approval for a
 
414
      client before it is sent its secret.  The delay to wait for such
 
415
      approval and the default action (approve or deny) can be
 
416
      configured both globally and per client; see <citerefentry>
315
417
      <refentrytitle>mandos-clients.conf</refentrytitle>
316
 
      <manvolnum>5</manvolnum></citerefentry>.
317
 
    </para>
 
418
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
 
419
      will be approved immediately without delay.
 
420
    </para>
 
421
    <para>
 
422
      This can be used to deny a client its secret if not manually
 
423
      approved within a specified time.  It can also be used to make
 
424
      the server delay before giving a client its secret, allowing
 
425
      optional manual denying of this specific client.
 
426
    </para>
 
427
    
318
428
  </refsect1>
319
 
 
 
429
  
320
430
  <refsect1 id="logging">
321
431
    <title>LOGGING</title>
322
432
    <para>
323
433
      The server will send log message with various severity levels to
324
 
      <filename>/dev/log</filename>.  With the
 
434
      <filename class="devicefile">/dev/log</filename>.  With the
325
435
      <option>--debug</option> option, it will log even more messages,
326
436
      and also show them on the console.
327
437
    </para>
328
438
  </refsect1>
329
 
 
 
439
  
 
440
  <refsect1 id="persistent_state">
 
441
    <title>PERSISTENT STATE</title>
 
442
    <para>
 
443
      Client settings, initially read from
 
444
      <filename>clients.conf</filename>, are persistent across
 
445
      restarts, and run-time changes will override settings in
 
446
      <filename>clients.conf</filename>.  However, if a setting is
 
447
      <emphasis>changed</emphasis> (or a client added, or removed) in
 
448
      <filename>clients.conf</filename>, this will take precedence.
 
449
    </para>
 
450
  </refsect1>
 
451
  
 
452
  <refsect1 id="dbus_interface">
 
453
    <title>D-BUS INTERFACE</title>
 
454
    <para>
 
455
      The server will by default provide a D-Bus system bus interface.
 
456
      This interface will only be accessible by the root user or a
 
457
      Mandos-specific user, if such a user exists.  For documentation
 
458
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
 
459
    </para>
 
460
  </refsect1>
 
461
  
330
462
  <refsect1 id="exit_status">
331
463
    <title>EXIT STATUS</title>
332
464
    <para>
334
466
      critical error is encountered.
335
467
    </para>
336
468
  </refsect1>
337
 
 
 
469
  
338
470
  <refsect1 id="environment">
339
471
    <title>ENVIRONMENT</title>
340
472
    <variablelist>
341
473
      <varlistentry>
342
 
        <term><varname>PATH</varname></term>
 
474
        <term><envar>PATH</envar></term>
343
475
        <listitem>
344
476
          <para>
345
477
            To start the configured checker (see <xref
354
486
      </varlistentry>
355
487
    </variablelist>
356
488
  </refsect1>
357
 
 
358
 
  <refsect1 id="file">
 
489
  
 
490
  <refsect1 id="files">
359
491
    <title>FILES</title>
360
492
    <para>
361
493
      Use the <option>--configdir</option> option to change where
384
516
        </listitem>
385
517
      </varlistentry>
386
518
      <varlistentry>
387
 
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
388
 
        <listitem>
389
 
          <para>
390
 
            The file containing the process id of
391
 
            <command>&COMMANDNAME;</command>.
 
519
        <term><filename>/var/run/mandos.pid</filename></term>
 
520
        <listitem>
 
521
          <para>
 
522
            The file containing the process id of the
 
523
            <command>&COMMANDNAME;</command> process started last.
 
524
          </para>
 
525
        </listitem>
 
526
      </varlistentry>
 
527
      <varlistentry>
 
528
        <term><filename class="devicefile">/dev/log</filename></term>
 
529
      </varlistentry>
 
530
      <varlistentry>
 
531
        <term><filename
 
532
        class="directory">/var/lib/mandos</filename></term>
 
533
        <listitem>
 
534
          <para>
 
535
            Directory where persistent state will be saved.  Change
 
536
            this with the <option>--statedir</option> option.  See
 
537
            also the <option>--no-restore</option> option.
392
538
          </para>
393
539
        </listitem>
394
540
      </varlistentry>
422
568
      backtrace.  This could be considered a feature.
423
569
    </para>
424
570
    <para>
425
 
      Currently, if a client is declared <quote>invalid</quote> due to
426
 
      having timed out, the server does not record this fact onto
427
 
      permanent storage.  This has some security implications, see
428
 
      <xref linkend="CLIENTS"/>.
429
 
    </para>
430
 
    <para>
431
 
      There is currently no way of querying the server of the current
432
 
      status of clients, other than analyzing its <systemitem
433
 
      class="service">syslog</systemitem> output.
434
 
    </para>
435
 
    <para>
436
571
      There is no fine-grained control over logging and debug output.
437
572
    </para>
438
573
    <para>
439
 
      Debug mode is conflated with running in the foreground.
440
 
    </para>
441
 
    <para>
442
 
      The console log messages does not show a timestamp.
 
574
      This server does not check the expire time of clients’ OpenPGP
 
575
      keys.
443
576
    </para>
444
577
  </refsect1>
445
578
  
456
589
    <informalexample>
457
590
      <para>
458
591
        Run the server in debug mode, read configuration files from
459
 
        the <filename>~/mandos</filename> directory, and use the
460
 
        Zeroconf service name <quote>Test</quote> to not collide with
461
 
        any other official Mandos server on this host:
 
592
        the <filename class="directory">~/mandos</filename> directory,
 
593
        and use the Zeroconf service name <quote>Test</quote> to not
 
594
        collide with any other official Mandos server on this host:
462
595
      </para>
463
596
      <para>
464
597
 
480
613
      </para>
481
614
    </informalexample>
482
615
  </refsect1>
483
 
 
 
616
  
484
617
  <refsect1 id="security">
485
618
    <title>SECURITY</title>
486
 
    <refsect2 id="SERVER">
 
619
    <refsect2 id="server">
487
620
      <title>SERVER</title>
488
621
      <para>
489
622
        Running this <command>&COMMANDNAME;</command> server program
490
623
        should not in itself present any security risk to the host
491
 
        computer running it.  The program does not need any special
492
 
        privileges to run, and is designed to run as a non-root user.
 
624
        computer running it.  The program switches to a non-root user
 
625
        soon after startup.
493
626
      </para>
494
627
    </refsect2>
495
 
    <refsect2 id="CLIENTS">
 
628
    <refsect2 id="clients">
496
629
      <title>CLIENTS</title>
497
630
      <para>
498
631
        The server only gives out its stored data to clients which
505
638
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
506
639
        <manvolnum>5</manvolnum></citerefentry>)
507
640
        <emphasis>must</emphasis> be made non-readable by anyone
508
 
        except the user running the server.
 
641
        except the user starting the server (usually root).
509
642
      </para>
510
643
      <para>
511
644
        As detailed in <xref linkend="checking"/>, the status of all
513
646
        compromised if they are gone for too long.
514
647
      </para>
515
648
      <para>
516
 
        If a client is compromised, its downtime should be duly noted
517
 
        by the server which would therefore declare the client
518
 
        invalid.  But if the server was ever restarted, it would
519
 
        re-read its client list from its configuration file and again
520
 
        regard all clients therein as valid, and hence eligible to
521
 
        receive their passwords.  Therefore, be careful when
522
 
        restarting servers if it is suspected that a client has, in
523
 
        fact, been compromised by parties who may now be running a
524
 
        fake Mandos client with the keys from the non-encrypted
525
 
        initial RAM image of the client host.  What should be done in
526
 
        that case (if restarting the server program really is
527
 
        necessary) is to stop the server program, edit the
528
 
        configuration file to omit any suspect clients, and restart
529
 
        the server program.
530
 
      </para>
531
 
      <para>
532
649
        For more details on client-side security, see
533
 
        <citerefentry><refentrytitle>password-request</refentrytitle>
 
650
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
534
651
        <manvolnum>8mandos</manvolnum></citerefentry>.
535
652
      </para>
536
653
    </refsect2>
537
654
  </refsect1>
538
 
 
 
655
  
539
656
  <refsect1 id="see_also">
540
657
    <title>SEE ALSO</title>
541
658
    <para>
542
 
      <citerefentry>
543
 
        <refentrytitle>mandos.conf</refentrytitle>
544
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
545
 
        <refentrytitle>mandos-clients.conf</refentrytitle>
546
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
547
 
        <refentrytitle>password-request</refentrytitle>
548
 
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
549
 
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
550
 
      </citerefentry>
 
659
      <citerefentry><refentrytitle>intro</refentrytitle>
 
660
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
661
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
662
      <manvolnum>5</manvolnum></citerefentry>,
 
663
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
 
664
      <manvolnum>5</manvolnum></citerefentry>,
 
665
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
666
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
667
      <citerefentry><refentrytitle>sh</refentrytitle>
 
668
      <manvolnum>1</manvolnum></citerefentry>
551
669
    </para>
552
670
    <variablelist>
553
671
      <varlistentry>