/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-01 21:48:12 UTC
  • Revision ID: teddy@recompile.se-20120601214812-g7685v5oeiuhi2qw
* debian/copyright (Copyright): Join the two lines to one line.
* debian/mandos-client.README.Debian: Refer to new location of example
  network hooks.
* debian/mandos-client.docs (network-hooks.d): Removed.
* debian/mandos-client.examples: New; contains "network-hooks.d".
* debian/rules (binary-common): Added "dh_installexamples".
  (binary-common/dh_fixperms): Changed to exclude new location of
  "network-hooks.d".
* init.d-mandos (status): Support new "status" action.

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-05-26">
 
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>
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>
94
106
    </cmdsynopsis>
95
107
    <cmdsynopsis>
96
108
      <command>&COMMANDNAME;</command>
97
109
      <group choice="req">
98
 
        <arg choice="plain">-h</arg>
99
 
        <arg choice="plain">--help</arg>
 
110
        <arg choice="plain"><option>--help</option></arg>
 
111
        <arg choice="plain"><option>-h</option></arg>
100
112
      </group>
101
113
    </cmdsynopsis>
102
114
    <cmdsynopsis>
103
115
      <command>&COMMANDNAME;</command>
104
 
      <arg choice="plain">--version</arg>
 
116
      <arg choice="plain"><option>--version</option></arg>
105
117
    </cmdsynopsis>
106
118
    <cmdsynopsis>
107
119
      <command>&COMMANDNAME;</command>
108
 
      <arg choice="plain">--check</arg>
 
120
      <arg choice="plain"><option>--check</option></arg>
109
121
    </cmdsynopsis>
110
122
  </refsynopsisdiv>
111
 
 
 
123
  
112
124
  <refsect1 id="description">
113
125
    <title>DESCRIPTION</title>
114
126
    <para>
115
127
      <command>&COMMANDNAME;</command> is a server daemon which
116
128
      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.
 
129
      client host computers. For an introduction, see
 
130
      <citerefentry><refentrytitle>intro</refentrytitle>
 
131
      <manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
 
132
      uses Zeroconf to announce itself on the local network, and uses
 
133
      TLS to communicate securely with and to authenticate the
 
134
      clients.  The Mandos server uses IPv6 to allow Mandos clients to
 
135
      use IPv6 link-local addresses, since the clients will probably
 
136
      not have any other addresses configured (see <xref
 
137
      linkend="overview"/>).  Any authenticated client is then given
 
138
      the stored pre-encrypted password for that specific client.
125
139
    </para>
126
 
 
127
140
  </refsect1>
128
141
  
129
142
  <refsect1 id="purpose">
130
143
    <title>PURPOSE</title>
131
 
 
132
144
    <para>
133
145
      The purpose of this is to enable <emphasis>remote and unattended
134
146
      rebooting</emphasis> of client host computer with an
135
147
      <emphasis>encrypted root file system</emphasis>.  See <xref
136
148
      linkend="overview"/> for details.
137
149
    </para>
138
 
 
139
150
  </refsect1>
140
151
  
141
152
  <refsect1 id="options">
142
153
    <title>OPTIONS</title>
143
 
 
144
154
    <variablelist>
145
155
      <varlistentry>
146
 
        <term><literal>-h</literal>, <literal>--help</literal></term>
 
156
        <term><option>--help</option></term>
 
157
        <term><option>-h</option></term>
147
158
        <listitem>
148
159
          <para>
149
160
            Show a help message and exit
150
161
          </para>
151
162
        </listitem>
152
163
      </varlistentry>
153
 
 
 
164
      
154
165
      <varlistentry>
155
 
        <term><literal>-i</literal>, <literal>--interface <replaceable
156
 
        >NAME</replaceable></literal></term>
 
166
        <term><option>--interface</option>
 
167
        <replaceable>NAME</replaceable></term>
 
168
        <term><option>-i</option>
 
169
        <replaceable>NAME</replaceable></term>
157
170
        <listitem>
158
171
          <xi:include href="mandos-options.xml" xpointer="interface"/>
159
172
        </listitem>
160
173
      </varlistentry>
161
 
 
 
174
      
162
175
      <varlistentry>
163
 
        <term><literal>-a</literal>, <literal>--address <replaceable>
164
 
        ADDRESS</replaceable></literal></term>
 
176
        <term><option>--address
 
177
        <replaceable>ADDRESS</replaceable></option></term>
 
178
        <term><option>-a
 
179
        <replaceable>ADDRESS</replaceable></option></term>
165
180
        <listitem>
166
181
          <xi:include href="mandos-options.xml" xpointer="address"/>
167
182
        </listitem>
168
183
      </varlistentry>
169
 
 
 
184
      
170
185
      <varlistentry>
171
 
        <term><literal>-p</literal>, <literal>--port <replaceable>
172
 
        PORT</replaceable></literal></term>
 
186
        <term><option>--port
 
187
        <replaceable>PORT</replaceable></option></term>
 
188
        <term><option>-p
 
189
        <replaceable>PORT</replaceable></option></term>
173
190
        <listitem>
174
191
          <xi:include href="mandos-options.xml" xpointer="port"/>
175
192
        </listitem>
176
193
      </varlistentry>
177
 
 
 
194
      
178
195
      <varlistentry>
179
 
        <term><literal>--check</literal></term>
 
196
        <term><option>--check</option></term>
180
197
        <listitem>
181
198
          <para>
182
199
            Run the server’s self-tests.  This includes any unit
184
201
          </para>
185
202
        </listitem>
186
203
      </varlistentry>
187
 
 
 
204
      
188
205
      <varlistentry>
189
 
        <term><literal>--debug</literal></term>
 
206
        <term><option>--debug</option></term>
190
207
        <listitem>
191
208
          <xi:include href="mandos-options.xml" xpointer="debug"/>
192
209
        </listitem>
193
210
      </varlistentry>
194
 
 
195
 
      <varlistentry>
196
 
        <term><literal>--priority <replaceable>
197
 
        PRIORITY</replaceable></literal></term>
 
211
      
 
212
      <varlistentry>
 
213
        <term><option>--debuglevel
 
214
        <replaceable>LEVEL</replaceable></option></term>
 
215
        <listitem>
 
216
          <para>
 
217
            Set the debugging log level.
 
218
            <replaceable>LEVEL</replaceable> is a string, one of
 
219
            <quote><literal>CRITICAL</literal></quote>,
 
220
            <quote><literal>ERROR</literal></quote>,
 
221
            <quote><literal>WARNING</literal></quote>,
 
222
            <quote><literal>INFO</literal></quote>, or
 
223
            <quote><literal>DEBUG</literal></quote>, in order of
 
224
            increasing verbosity.  The default level is
 
225
            <quote><literal>WARNING</literal></quote>.
 
226
          </para>
 
227
        </listitem>
 
228
      </varlistentry>
 
229
      
 
230
      <varlistentry>
 
231
        <term><option>--priority <replaceable>
 
232
        PRIORITY</replaceable></option></term>
198
233
        <listitem>
199
234
          <xi:include href="mandos-options.xml" xpointer="priority"/>
200
235
        </listitem>
201
236
      </varlistentry>
202
 
 
 
237
      
203
238
      <varlistentry>
204
 
        <term><literal>--servicename <replaceable>NAME</replaceable>
205
 
        </literal></term>
 
239
        <term><option>--servicename
 
240
        <replaceable>NAME</replaceable></option></term>
206
241
        <listitem>
207
242
          <xi:include href="mandos-options.xml"
208
243
                      xpointer="servicename"/>
209
244
        </listitem>
210
245
      </varlistentry>
211
 
 
 
246
      
212
247
      <varlistentry>
213
 
        <term><literal>--configdir <replaceable>DIR</replaceable>
214
 
        </literal></term>
 
248
        <term><option>--configdir
 
249
        <replaceable>DIRECTORY</replaceable></option></term>
215
250
        <listitem>
216
251
          <para>
217
252
            Directory to search for configuration files.  Default is
223
258
          </para>
224
259
        </listitem>
225
260
      </varlistentry>
226
 
 
 
261
      
227
262
      <varlistentry>
228
 
        <term><literal>--version</literal></term>
 
263
        <term><option>--version</option></term>
229
264
        <listitem>
230
265
          <para>
231
266
            Prints the program version and exit.
232
267
          </para>
233
268
        </listitem>
234
269
      </varlistentry>
 
270
      
 
271
      <varlistentry>
 
272
        <term><option>--no-dbus</option></term>
 
273
        <listitem>
 
274
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
 
275
          <para>
 
276
            See also <xref linkend="dbus_interface"/>.
 
277
          </para>
 
278
        </listitem>
 
279
      </varlistentry>
 
280
      
 
281
      <varlistentry>
 
282
        <term><option>--no-ipv6</option></term>
 
283
        <listitem>
 
284
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
 
285
        </listitem>
 
286
      </varlistentry>
 
287
      
 
288
      <varlistentry>
 
289
        <term><option>--no-restore</option></term>
 
290
        <listitem>
 
291
          <xi:include href="mandos-options.xml" xpointer="restore"/>
 
292
          <para>
 
293
            See also <xref linkend="persistent_state"/>.
 
294
          </para>
 
295
        </listitem>
 
296
      </varlistentry>
 
297
      
 
298
      <varlistentry>
 
299
        <term><option>--statedir
 
300
        <replaceable>DIRECTORY</replaceable></option></term>
 
301
        <listitem>
 
302
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
 
303
        </listitem>
 
304
      </varlistentry>
 
305
      
 
306
      <varlistentry>
 
307
        <term><option>--socket
 
308
        <replaceable>FD</replaceable></option></term>
 
309
        <listitem>
 
310
          <xi:include href="mandos-options.xml" xpointer="socket"/>
 
311
        </listitem>
 
312
      </varlistentry>
 
313
      
235
314
    </variablelist>
236
315
  </refsect1>
237
 
 
 
316
  
238
317
  <refsect1 id="overview">
239
318
    <title>OVERVIEW</title>
240
319
    <xi:include href="overview.xml"/>
241
320
    <para>
242
321
      This program is the server part.  It is a normal server program
243
322
      and will run in a normal system environment, not in an initial
244
 
      RAM disk environment.
 
323
      <acronym>RAM</acronym> disk environment.
245
324
    </para>
246
325
  </refsect1>
247
 
 
 
326
  
248
327
  <refsect1 id="protocol">
249
328
    <title>NETWORK PROTOCOL</title>
250
329
    <para>
302
381
      </row>
303
382
    </tbody></tgroup></table>
304
383
  </refsect1>
305
 
 
 
384
  
306
385
  <refsect1 id="checking">
307
386
    <title>CHECKING</title>
308
387
    <para>
309
388
      The server will, by default, continually check that the clients
310
389
      are still up.  If a client has not been confirmed as being up
311
390
      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>
 
391
      longer eligible to receive the encrypted password.  (Manual
 
392
      intervention is required to re-enable a client.)  The timeout,
 
393
      extended timeout, checker program, and interval between checks
 
394
      can be configured both globally and per client; see
 
395
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
396
      <manvolnum>5</manvolnum></citerefentry>.
 
397
    </para>
 
398
  </refsect1>
 
399
  
 
400
  <refsect1 id="approval">
 
401
    <title>APPROVAL</title>
 
402
    <para>
 
403
      The server can be configured to require manual approval for a
 
404
      client before it is sent its secret.  The delay to wait for such
 
405
      approval and the default action (approve or deny) can be
 
406
      configured both globally and per client; see <citerefentry>
315
407
      <refentrytitle>mandos-clients.conf</refentrytitle>
316
 
      <manvolnum>5</manvolnum></citerefentry>.
317
 
    </para>
 
408
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
 
409
      will be approved immediately without delay.
 
410
    </para>
 
411
    <para>
 
412
      This can be used to deny a client its secret if not manually
 
413
      approved within a specified time.  It can also be used to make
 
414
      the server delay before giving a client its secret, allowing
 
415
      optional manual denying of this specific client.
 
416
    </para>
 
417
    
318
418
  </refsect1>
319
 
 
 
419
  
320
420
  <refsect1 id="logging">
321
421
    <title>LOGGING</title>
322
422
    <para>
323
423
      The server will send log message with various severity levels to
324
 
      <filename>/dev/log</filename>.  With the
 
424
      <filename class="devicefile">/dev/log</filename>.  With the
325
425
      <option>--debug</option> option, it will log even more messages,
326
426
      and also show them on the console.
327
427
    </para>
328
428
  </refsect1>
329
 
 
 
429
  
 
430
  <refsect1 id="persistent_state">
 
431
    <title>PERSISTENT STATE</title>
 
432
    <para>
 
433
      Client settings, initially read from
 
434
      <filename>clients.conf</filename>, are persistent across
 
435
      restarts, and run-time changes will override settings in
 
436
      <filename>clients.conf</filename>.  However, if a setting is
 
437
      <emphasis>changed</emphasis> (or a client added, or removed) in
 
438
      <filename>clients.conf</filename>, this will take precedence.
 
439
    </para>
 
440
  </refsect1>
 
441
  
 
442
  <refsect1 id="dbus_interface">
 
443
    <title>D-BUS INTERFACE</title>
 
444
    <para>
 
445
      The server will by default provide a D-Bus system bus interface.
 
446
      This interface will only be accessible by the root user or a
 
447
      Mandos-specific user, if such a user exists.  For documentation
 
448
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
 
449
    </para>
 
450
  </refsect1>
 
451
  
330
452
  <refsect1 id="exit_status">
331
453
    <title>EXIT STATUS</title>
332
454
    <para>
334
456
      critical error is encountered.
335
457
    </para>
336
458
  </refsect1>
337
 
 
 
459
  
338
460
  <refsect1 id="environment">
339
461
    <title>ENVIRONMENT</title>
340
462
    <variablelist>
341
463
      <varlistentry>
342
 
        <term><varname>PATH</varname></term>
 
464
        <term><envar>PATH</envar></term>
343
465
        <listitem>
344
466
          <para>
345
467
            To start the configured checker (see <xref
354
476
      </varlistentry>
355
477
    </variablelist>
356
478
  </refsect1>
357
 
 
358
 
  <refsect1 id="file">
 
479
  
 
480
  <refsect1 id="files">
359
481
    <title>FILES</title>
360
482
    <para>
361
483
      Use the <option>--configdir</option> option to change where
384
506
        </listitem>
385
507
      </varlistentry>
386
508
      <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>.
 
509
        <term><filename>/var/run/mandos.pid</filename></term>
 
510
        <listitem>
 
511
          <para>
 
512
            The file containing the process id of the
 
513
            <command>&COMMANDNAME;</command> process started last.
 
514
          </para>
 
515
        </listitem>
 
516
      </varlistentry>
 
517
      <varlistentry>
 
518
        <term><filename class="devicefile">/dev/log</filename></term>
 
519
      </varlistentry>
 
520
      <varlistentry>
 
521
        <term><filename
 
522
        class="directory">/var/lib/mandos</filename></term>
 
523
        <listitem>
 
524
          <para>
 
525
            Directory where persistent state will be saved.  Change
 
526
            this with the <option>--statedir</option> option.  See
 
527
            also the <option>--no-restore</option> option.
392
528
          </para>
393
529
        </listitem>
394
530
      </varlistentry>
422
558
      backtrace.  This could be considered a feature.
423
559
    </para>
424
560
    <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
561
      There is no fine-grained control over logging and debug output.
437
562
    </para>
438
563
    <para>
439
564
      Debug mode is conflated with running in the foreground.
440
565
    </para>
441
566
    <para>
442
 
      The console log messages does not show a timestamp.
 
567
      This server does not check the expire time of clients’ OpenPGP
 
568
      keys.
443
569
    </para>
444
570
  </refsect1>
445
571
  
456
582
    <informalexample>
457
583
      <para>
458
584
        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:
 
585
        the <filename class="directory">~/mandos</filename> directory,
 
586
        and use the Zeroconf service name <quote>Test</quote> to not
 
587
        collide with any other official Mandos server on this host:
462
588
      </para>
463
589
      <para>
464
590
 
480
606
      </para>
481
607
    </informalexample>
482
608
  </refsect1>
483
 
 
 
609
  
484
610
  <refsect1 id="security">
485
611
    <title>SECURITY</title>
486
 
    <refsect2 id="SERVER">
 
612
    <refsect2 id="server">
487
613
      <title>SERVER</title>
488
614
      <para>
489
615
        Running this <command>&COMMANDNAME;</command> server program
490
616
        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.
 
617
        computer running it.  The program switches to a non-root user
 
618
        soon after startup.
493
619
      </para>
494
620
    </refsect2>
495
 
    <refsect2 id="CLIENTS">
 
621
    <refsect2 id="clients">
496
622
      <title>CLIENTS</title>
497
623
      <para>
498
624
        The server only gives out its stored data to clients which
505
631
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
506
632
        <manvolnum>5</manvolnum></citerefentry>)
507
633
        <emphasis>must</emphasis> be made non-readable by anyone
508
 
        except the user running the server.
 
634
        except the user starting the server (usually root).
509
635
      </para>
510
636
      <para>
511
637
        As detailed in <xref linkend="checking"/>, the status of all
513
639
        compromised if they are gone for too long.
514
640
      </para>
515
641
      <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
642
        For more details on client-side security, see
533
 
        <citerefentry><refentrytitle>password-request</refentrytitle>
 
643
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
534
644
        <manvolnum>8mandos</manvolnum></citerefentry>.
535
645
      </para>
536
646
    </refsect2>
537
647
  </refsect1>
538
 
 
 
648
  
539
649
  <refsect1 id="see_also">
540
650
    <title>SEE ALSO</title>
541
651
    <para>
542
 
      <citerefentry>
543
 
        <refentrytitle>mandos-clients.conf</refentrytitle>
544
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
545
 
        <refentrytitle>mandos.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>
 
652
      <citerefentry><refentrytitle>intro</refentrytitle>
 
653
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
654
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
655
      <manvolnum>5</manvolnum></citerefentry>,
 
656
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
 
657
      <manvolnum>5</manvolnum></citerefentry>,
 
658
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
659
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
660
      <citerefentry><refentrytitle>sh</refentrytitle>
 
661
      <manvolnum>1</manvolnum></citerefentry>
551
662
    </para>
552
663
    <variablelist>
553
664
      <varlistentry>