/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: 2011-12-31 23:05:34 UTC
  • Revision ID: teddy@recompile.se-20111231230534-o5w0uhwx30gwhmk7
Updated year in copyright notices.

Show diffs side-by-side

added added

removed removed

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