/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to mandos.xml

  • Committer: teddy at bsnet
  • Date: 2011-11-12 18:14:55 UTC
  • mto: (237.7.70 trunk)
  • mto: This revision was merged to the branch mainline in revision 290.
  • Revision ID: teddy@fukt.bsnet.se-20111112181455-8m6z4qrrib33bl2c
* plugins.d/mandos-client.c (SYNOPSIS, OPTIONS): Document
                                                 "--network-hook-dir"
                                                 option.

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">
 
5
<!ENTITY TIMESTAMP "2011-10-22">
 
6
<!ENTITY % common SYSTEM "common.ent">
 
7
%common;
6
8
]>
7
9
 
8
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
9
 
  <refentryinfo>
10
 
    <title>&COMMANDNAME;</title>
 
11
   <refentryinfo>
 
12
    <title>Mandos Manual</title>
11
13
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
12
 
    <productname>&COMMANDNAME;</productname>
13
 
    <productnumber>&VERSION;</productnumber>
 
14
    <productname>Mandos</productname>
 
15
    <productnumber>&version;</productnumber>
 
16
    <date>&TIMESTAMP;</date>
14
17
    <authorgroup>
15
18
      <author>
16
19
        <firstname>Björn</firstname>
17
20
        <surname>Påhlsson</surname>
18
21
        <address>
19
 
          <email>belorn@fukt.bsnet.se</email>
 
22
          <email>belorn@recompile.se</email>
20
23
        </address>
21
24
      </author>
22
25
      <author>
23
26
        <firstname>Teddy</firstname>
24
27
        <surname>Hogeborn</surname>
25
28
        <address>
26
 
          <email>teddy@fukt.bsnet.se</email>
 
29
          <email>teddy@recompile.se</email>
27
30
        </address>
28
31
      </author>
29
32
    </authorgroup>
30
33
    <copyright>
31
34
      <year>2008</year>
 
35
      <year>2009</year>
 
36
      <year>2010</year>
 
37
      <year>2011</year>
32
38
      <holder>Teddy Hogeborn</holder>
33
39
      <holder>Björn Påhlsson</holder>
34
40
    </copyright>
35
 
    <legalnotice>
36
 
      <para>
37
 
        This manual page is free software: you can redistribute it
38
 
        and/or modify it under the terms of the GNU General Public
39
 
        License as published by the Free Software Foundation,
40
 
        either version 3 of the License, or (at your option) any
41
 
        later version.
42
 
      </para>
43
 
 
44
 
      <para>
45
 
        This manual page is distributed in the hope that it will
46
 
        be useful, but WITHOUT ANY WARRANTY; without even the
47
 
        implied warranty of MERCHANTABILITY or FITNESS FOR A
48
 
        PARTICULAR PURPOSE.  See the GNU General Public License
49
 
        for more details.
50
 
      </para>
51
 
 
52
 
      <para>
53
 
        You should have received a copy of the GNU General Public
54
 
        License along with this program; If not, see
55
 
        <ulink url="http://www.gnu.org/licenses/"/>.
56
 
      </para>
57
 
    </legalnotice>
 
41
    <xi:include href="legalnotice.xml"/>
58
42
  </refentryinfo>
59
 
 
 
43
  
60
44
  <refmeta>
61
45
    <refentrytitle>&COMMANDNAME;</refentrytitle>
62
46
    <manvolnum>8</manvolnum>
65
49
  <refnamediv>
66
50
    <refname><command>&COMMANDNAME;</command></refname>
67
51
    <refpurpose>
68
 
      Sends encrypted passwords to authenticated Mandos clients
 
52
      Gives encrypted passwords to authenticated Mandos clients
69
53
    </refpurpose>
70
54
  </refnamediv>
71
 
 
 
55
  
72
56
  <refsynopsisdiv>
73
57
    <cmdsynopsis>
74
58
      <command>&COMMANDNAME;</command>
75
 
      <arg>--interface<arg choice="plain">NAME</arg></arg>
76
 
      <arg>--address<arg choice="plain">ADDRESS</arg></arg>
77
 
      <arg>--port<arg choice="plain">PORT</arg></arg>
78
 
      <arg>--priority<arg choice="plain">PRIORITY</arg></arg>
79
 
      <arg>--servicename<arg choice="plain">NAME</arg></arg>
80
 
      <arg>--configdir<arg choice="plain">DIRECTORY</arg></arg>
81
 
      <arg>--debug</arg>
82
 
    </cmdsynopsis>
83
 
    <cmdsynopsis>
84
 
      <command>&COMMANDNAME;</command>
85
 
      <arg>-i<arg choice="plain">NAME</arg></arg>
86
 
      <arg>-a<arg choice="plain">ADDRESS</arg></arg>
87
 
      <arg>-p<arg choice="plain">PORT</arg></arg>
88
 
      <arg>--priority<arg choice="plain">PRIORITY</arg></arg>
89
 
      <arg>--servicename<arg choice="plain">NAME</arg></arg>
90
 
      <arg>--configdir<arg choice="plain">DIRECTORY</arg></arg>
91
 
      <arg>--debug</arg>
 
59
      <group>
 
60
        <arg choice="plain"><option>--interface
 
61
        <replaceable>NAME</replaceable></option></arg>
 
62
        <arg choice="plain"><option>-i
 
63
        <replaceable>NAME</replaceable></option></arg>
 
64
      </group>
 
65
      <sbr/>
 
66
      <group>
 
67
        <arg choice="plain"><option>--address
 
68
        <replaceable>ADDRESS</replaceable></option></arg>
 
69
        <arg choice="plain"><option>-a
 
70
        <replaceable>ADDRESS</replaceable></option></arg>
 
71
      </group>
 
72
      <sbr/>
 
73
      <group>
 
74
        <arg choice="plain"><option>--port
 
75
        <replaceable>PORT</replaceable></option></arg>
 
76
        <arg choice="plain"><option>-p
 
77
        <replaceable>PORT</replaceable></option></arg>
 
78
      </group>
 
79
      <sbr/>
 
80
      <arg><option>--priority
 
81
      <replaceable>PRIORITY</replaceable></option></arg>
 
82
      <sbr/>
 
83
      <arg><option>--servicename
 
84
      <replaceable>NAME</replaceable></option></arg>
 
85
      <sbr/>
 
86
      <arg><option>--configdir
 
87
      <replaceable>DIRECTORY</replaceable></option></arg>
 
88
      <sbr/>
 
89
      <arg><option>--debug</option></arg>
 
90
      <sbr/>
 
91
      <arg><option>--debuglevel
 
92
      <replaceable>LEVEL</replaceable></option></arg>
 
93
      <sbr/>
 
94
      <arg><option>--no-dbus</option></arg>
 
95
      <sbr/>
 
96
      <arg><option>--no-ipv6</option></arg>
 
97
      <sbr/>
 
98
      <arg><option>--no-restore</option></arg>
92
99
    </cmdsynopsis>
93
100
    <cmdsynopsis>
94
101
      <command>&COMMANDNAME;</command>
95
102
      <group choice="req">
96
 
        <arg choice="plain">-h</arg>
97
 
        <arg choice="plain">--help</arg>
 
103
        <arg choice="plain"><option>--help</option></arg>
 
104
        <arg choice="plain"><option>-h</option></arg>
98
105
      </group>
99
106
    </cmdsynopsis>
100
107
    <cmdsynopsis>
101
108
      <command>&COMMANDNAME;</command>
102
 
      <arg choice="plain">--version</arg>
 
109
      <arg choice="plain"><option>--version</option></arg>
103
110
    </cmdsynopsis>
104
111
    <cmdsynopsis>
105
112
      <command>&COMMANDNAME;</command>
106
 
      <arg choice="plain">--check</arg>
 
113
      <arg choice="plain"><option>--check</option></arg>
107
114
    </cmdsynopsis>
108
115
  </refsynopsisdiv>
109
 
 
 
116
  
110
117
  <refsect1 id="description">
111
118
    <title>DESCRIPTION</title>
112
119
    <para>
113
120
      <command>&COMMANDNAME;</command> is a server daemon which
114
121
      handles incoming request for passwords for a pre-defined list of
115
 
      client host computers.  The Mandos server uses Zeroconf to
116
 
      announce itself on the local network, and uses TLS to
117
 
      communicate securely with and to authenticate the clients.  The
118
 
      Mandos server uses IPv6 to allow Mandos clients to use IPv6
119
 
      link-local addresses, since the clients will probably not have
120
 
      any other addresses configured (see <xref linkend="overview"/>).
121
 
      Any authenticated client is then given the stored pre-encrypted
122
 
      password for that specific client.
 
122
      client host computers. For an introduction, see
 
123
      <citerefentry><refentrytitle>intro</refentrytitle>
 
124
      <manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
 
125
      uses Zeroconf to announce itself on the local network, and uses
 
126
      TLS to communicate securely with and to authenticate the
 
127
      clients.  The Mandos server uses IPv6 to allow Mandos clients to
 
128
      use IPv6 link-local addresses, since the clients will probably
 
129
      not have any other addresses configured (see <xref
 
130
      linkend="overview"/>).  Any authenticated client is then given
 
131
      the stored pre-encrypted password for that specific client.
123
132
    </para>
124
 
 
125
133
  </refsect1>
126
134
  
127
135
  <refsect1 id="purpose">
128
136
    <title>PURPOSE</title>
129
 
 
130
137
    <para>
131
138
      The purpose of this is to enable <emphasis>remote and unattended
132
139
      rebooting</emphasis> of client host computer with an
133
140
      <emphasis>encrypted root file system</emphasis>.  See <xref
134
141
      linkend="overview"/> for details.
135
142
    </para>
136
 
 
137
143
  </refsect1>
138
144
  
139
145
  <refsect1 id="options">
140
146
    <title>OPTIONS</title>
141
 
 
142
147
    <variablelist>
143
148
      <varlistentry>
144
 
        <term><literal>-h</literal>, <literal>--help</literal></term>
 
149
        <term><option>--help</option></term>
 
150
        <term><option>-h</option></term>
145
151
        <listitem>
146
152
          <para>
147
153
            Show a help message and exit
148
154
          </para>
149
155
        </listitem>
150
156
      </varlistentry>
151
 
 
 
157
      
152
158
      <varlistentry>
153
 
        <term><literal>-i</literal>, <literal>--interface <replaceable
154
 
        >NAME</replaceable></literal></term>
 
159
        <term><option>--interface</option>
 
160
        <replaceable>NAME</replaceable></term>
 
161
        <term><option>-i</option>
 
162
        <replaceable>NAME</replaceable></term>
155
163
        <listitem>
156
164
          <xi:include href="mandos-options.xml" xpointer="interface"/>
157
165
        </listitem>
158
166
      </varlistentry>
159
 
 
 
167
      
160
168
      <varlistentry>
161
 
        <term><literal>-a</literal>, <literal>--address <replaceable>
162
 
        ADDRESS</replaceable></literal></term>
 
169
        <term><option>--address
 
170
        <replaceable>ADDRESS</replaceable></option></term>
 
171
        <term><option>-a
 
172
        <replaceable>ADDRESS</replaceable></option></term>
163
173
        <listitem>
164
174
          <xi:include href="mandos-options.xml" xpointer="address"/>
165
175
        </listitem>
166
176
      </varlistentry>
167
 
 
 
177
      
168
178
      <varlistentry>
169
 
        <term><literal>-p</literal>, <literal>--port <replaceable>
170
 
        PORT</replaceable></literal></term>
 
179
        <term><option>--port
 
180
        <replaceable>PORT</replaceable></option></term>
 
181
        <term><option>-p
 
182
        <replaceable>PORT</replaceable></option></term>
171
183
        <listitem>
172
184
          <xi:include href="mandos-options.xml" xpointer="port"/>
173
185
        </listitem>
174
186
      </varlistentry>
175
 
 
 
187
      
176
188
      <varlistentry>
177
 
        <term><literal>--check</literal></term>
 
189
        <term><option>--check</option></term>
178
190
        <listitem>
179
191
          <para>
180
192
            Run the server’s self-tests.  This includes any unit
182
194
          </para>
183
195
        </listitem>
184
196
      </varlistentry>
185
 
 
 
197
      
186
198
      <varlistentry>
187
 
        <term><literal>--debug</literal></term>
 
199
        <term><option>--debug</option></term>
188
200
        <listitem>
189
201
          <xi:include href="mandos-options.xml" xpointer="debug"/>
190
202
        </listitem>
191
203
      </varlistentry>
192
 
 
193
 
      <varlistentry>
194
 
        <term><literal>--priority <replaceable>
195
 
        PRIORITY</replaceable></literal></term>
 
204
      
 
205
      <varlistentry>
 
206
        <term><option>--debuglevel
 
207
        <replaceable>LEVEL</replaceable></option></term>
 
208
        <listitem>
 
209
          <para>
 
210
            Set the debugging log level.
 
211
            <replaceable>LEVEL</replaceable> is a string, one of
 
212
            <quote><literal>CRITICAL</literal></quote>,
 
213
            <quote><literal>ERROR</literal></quote>,
 
214
            <quote><literal>WARNING</literal></quote>,
 
215
            <quote><literal>INFO</literal></quote>, or
 
216
            <quote><literal>DEBUG</literal></quote>, in order of
 
217
            increasing verbosity.  The default level is
 
218
            <quote><literal>WARNING</literal></quote>.
 
219
          </para>
 
220
        </listitem>
 
221
      </varlistentry>
 
222
      
 
223
      <varlistentry>
 
224
        <term><option>--priority <replaceable>
 
225
        PRIORITY</replaceable></option></term>
196
226
        <listitem>
197
227
          <xi:include href="mandos-options.xml" xpointer="priority"/>
198
228
        </listitem>
199
229
      </varlistentry>
200
 
 
 
230
      
201
231
      <varlistentry>
202
 
        <term><literal>--servicename <replaceable>NAME</replaceable>
203
 
        </literal></term>
 
232
        <term><option>--servicename
 
233
        <replaceable>NAME</replaceable></option></term>
204
234
        <listitem>
205
235
          <xi:include href="mandos-options.xml"
206
236
                      xpointer="servicename"/>
207
237
        </listitem>
208
238
      </varlistentry>
209
 
 
 
239
      
210
240
      <varlistentry>
211
 
        <term><literal>--configdir <replaceable>DIR</replaceable>
212
 
        </literal></term>
 
241
        <term><option>--configdir
 
242
        <replaceable>DIRECTORY</replaceable></option></term>
213
243
        <listitem>
214
244
          <para>
215
245
            Directory to search for configuration files.  Default is
221
251
          </para>
222
252
        </listitem>
223
253
      </varlistentry>
224
 
 
 
254
      
225
255
      <varlistentry>
226
 
        <term><literal>--version</literal></term>
 
256
        <term><option>--version</option></term>
227
257
        <listitem>
228
258
          <para>
229
259
            Prints the program version and exit.
230
260
          </para>
231
261
        </listitem>
232
262
      </varlistentry>
 
263
      
 
264
      <varlistentry>
 
265
        <term><option>--no-dbus</option></term>
 
266
        <listitem>
 
267
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
 
268
          <para>
 
269
            See also <xref linkend="dbus_interface"/>.
 
270
          </para>
 
271
        </listitem>
 
272
      </varlistentry>
 
273
      
 
274
      <varlistentry>
 
275
        <term><option>--no-ipv6</option></term>
 
276
        <listitem>
 
277
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
 
278
        </listitem>
 
279
      </varlistentry>
 
280
      
 
281
      <varlistentry>
 
282
        <term><option>--no-restore</option></term>
 
283
        <listitem>
 
284
          <xi:include href="mandos-options.xml" xpointer="restore"/>
 
285
        </listitem>
 
286
      </varlistentry>
233
287
    </variablelist>
234
288
  </refsect1>
235
 
 
 
289
  
236
290
  <refsect1 id="overview">
237
291
    <title>OVERVIEW</title>
238
292
    <xi:include href="overview.xml"/>
239
293
    <para>
240
294
      This program is the server part.  It is a normal server program
241
295
      and will run in a normal system environment, not in an initial
242
 
      RAM disk environment.
 
296
      <acronym>RAM</acronym> disk environment.
243
297
    </para>
244
298
  </refsect1>
245
 
 
 
299
  
246
300
  <refsect1 id="protocol">
247
301
    <title>NETWORK PROTOCOL</title>
248
302
    <para>
300
354
      </row>
301
355
    </tbody></tgroup></table>
302
356
  </refsect1>
303
 
 
 
357
  
304
358
  <refsect1 id="checking">
305
359
    <title>CHECKING</title>
306
360
    <para>
307
361
      The server will, by default, continually check that the clients
308
362
      are still up.  If a client has not been confirmed as being up
309
363
      for some time, the client is assumed to be compromised and is no
310
 
      longer eligible to receive the encrypted password.  The timeout,
311
 
      checker program, and interval between checks can be configured
312
 
      both globally and per client; see <citerefentry>
 
364
      longer eligible to receive the encrypted password.  (Manual
 
365
      intervention is required to re-enable a client.)  The timeout,
 
366
      extended timeout, checker program, and interval between checks
 
367
      can be configured both globally and per client; see
 
368
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
369
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
 
370
      receiving its password will also be treated as a successful
 
371
      checker run.
 
372
    </para>
 
373
  </refsect1>
 
374
  
 
375
  <refsect1 id="approval">
 
376
    <title>APPROVAL</title>
 
377
    <para>
 
378
      The server can be configured to require manual approval for a
 
379
      client before it is sent its secret.  The delay to wait for such
 
380
      approval and the default action (approve or deny) can be
 
381
      configured both globally and per client; see <citerefentry>
313
382
      <refentrytitle>mandos-clients.conf</refentrytitle>
314
 
      <manvolnum>5</manvolnum></citerefentry>.
315
 
    </para>
 
383
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
 
384
      will be approved immediately without delay.
 
385
    </para>
 
386
    <para>
 
387
      This can be used to deny a client its secret if not manually
 
388
      approved within a specified time.  It can also be used to make
 
389
      the server delay before giving a client its secret, allowing
 
390
      optional manual denying of this specific client.
 
391
    </para>
 
392
    
316
393
  </refsect1>
317
 
 
 
394
  
318
395
  <refsect1 id="logging">
319
396
    <title>LOGGING</title>
320
397
    <para>
321
398
      The server will send log message with various severity levels to
322
 
      <filename>/dev/log</filename>.  With the
 
399
      <filename class="devicefile">/dev/log</filename>.  With the
323
400
      <option>--debug</option> option, it will log even more messages,
324
401
      and also show them on the console.
325
402
    </para>
326
403
  </refsect1>
327
 
 
 
404
  
 
405
  <refsect1 id="dbus_interface">
 
406
    <title>D-BUS INTERFACE</title>
 
407
    <para>
 
408
      The server will by default provide a D-Bus system bus interface.
 
409
      This interface will only be accessible by the root user or a
 
410
      Mandos-specific user, if such a user exists.  For documentation
 
411
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
 
412
    </para>
 
413
  </refsect1>
 
414
  
328
415
  <refsect1 id="exit_status">
329
416
    <title>EXIT STATUS</title>
330
417
    <para>
332
419
      critical error is encountered.
333
420
    </para>
334
421
  </refsect1>
335
 
 
 
422
  
336
423
  <refsect1 id="environment">
337
424
    <title>ENVIRONMENT</title>
338
425
    <variablelist>
339
426
      <varlistentry>
340
 
        <term><varname>PATH</varname></term>
 
427
        <term><envar>PATH</envar></term>
341
428
        <listitem>
342
429
          <para>
343
430
            To start the configured checker (see <xref
352
439
      </varlistentry>
353
440
    </variablelist>
354
441
  </refsect1>
355
 
 
356
 
  <refsect1 id="file">
 
442
  
 
443
  <refsect1 id="files">
357
444
    <title>FILES</title>
358
445
    <para>
359
446
      Use the <option>--configdir</option> option to change where
382
469
        </listitem>
383
470
      </varlistentry>
384
471
      <varlistentry>
385
 
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
 
472
        <term><filename>/var/run/mandos.pid</filename></term>
386
473
        <listitem>
387
474
          <para>
388
 
            The file containing the process id of
389
 
            <command>&COMMANDNAME;</command>.
 
475
            The file containing the process id of the
 
476
            <command>&COMMANDNAME;</command> process started last.
390
477
          </para>
391
478
        </listitem>
392
479
      </varlistentry>
393
480
      <varlistentry>
394
 
        <term><filename>/dev/log</filename></term>
 
481
        <term><filename class="devicefile">/dev/log</filename></term>
395
482
        <listitem>
396
483
          <para>
397
484
            The Unix domain socket to where local syslog messages are
420
507
      backtrace.  This could be considered a feature.
421
508
    </para>
422
509
    <para>
423
 
      Currently, if a client is declared <quote>invalid</quote> due to
424
 
      having timed out, the server does not record this fact onto
425
 
      permanent storage.  This has some security implications, see
426
 
      <xref linkend="CLIENTS"/>.
427
 
    </para>
428
 
    <para>
429
 
      There is currently no way of querying the server of the current
430
 
      status of clients, other than analyzing its <systemitem
431
 
      class="service">syslog</systemitem> output.
 
510
      Currently, if a client is disabled due to having timed out, the
 
511
      server does not record this fact onto permanent storage.  This
 
512
      has some security implications, see <xref linkend="clients"/>.
432
513
    </para>
433
514
    <para>
434
515
      There is no fine-grained control over logging and debug output.
437
518
      Debug mode is conflated with running in the foreground.
438
519
    </para>
439
520
    <para>
440
 
      The console log messages does not show a timestamp.
 
521
      This server does not check the expire time of clients’ OpenPGP
 
522
      keys.
441
523
    </para>
442
524
  </refsect1>
443
525
  
448
530
        Normal invocation needs no options:
449
531
      </para>
450
532
      <para>
451
 
        <userinput>mandos</userinput>
 
533
        <userinput>&COMMANDNAME;</userinput>
452
534
      </para>
453
535
    </informalexample>
454
536
    <informalexample>
461
543
      <para>
462
544
 
463
545
<!-- do not wrap this line -->
464
 
<userinput>mandos --debug --configdir ~/mandos --servicename Test</userinput>
 
546
<userinput>&COMMANDNAME; --debug --configdir ~/mandos --servicename Test</userinput>
465
547
 
466
548
      </para>
467
549
    </informalexample>
473
555
      <para>
474
556
 
475
557
<!-- do not wrap this line -->
476
 
<userinput>mandos --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
 
558
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
477
559
 
478
560
      </para>
479
561
    </informalexample>
480
562
  </refsect1>
481
 
 
 
563
  
482
564
  <refsect1 id="security">
483
565
    <title>SECURITY</title>
484
 
    <refsect2 id="SERVER">
 
566
    <refsect2 id="server">
485
567
      <title>SERVER</title>
486
568
      <para>
487
569
        Running this <command>&COMMANDNAME;</command> server program
488
570
        should not in itself present any security risk to the host
489
 
        computer running it.  The program does not need any special
490
 
        privileges to run, and is designed to run as a non-root user.
 
571
        computer running it.  The program switches to a non-root user
 
572
        soon after startup.
491
573
      </para>
492
574
    </refsect2>
493
 
    <refsect2 id="CLIENTS">
 
575
    <refsect2 id="clients">
494
576
      <title>CLIENTS</title>
495
577
      <para>
496
578
        The server only gives out its stored data to clients which
503
585
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
504
586
        <manvolnum>5</manvolnum></citerefentry>)
505
587
        <emphasis>must</emphasis> be made non-readable by anyone
506
 
        except the user running the server.
 
588
        except the user starting the server (usually root).
507
589
      </para>
508
590
      <para>
509
591
        As detailed in <xref linkend="checking"/>, the status of all
512
594
      </para>
513
595
      <para>
514
596
        If a client is compromised, its downtime should be duly noted
515
 
        by the server which would therefore declare the client
516
 
        invalid.  But if the server was ever restarted, it would
517
 
        re-read its client list from its configuration file and again
518
 
        regard all clients therein as valid, and hence eligible to
519
 
        receive their passwords.  Therefore, be careful when
520
 
        restarting servers if it is suspected that a client has, in
521
 
        fact, been compromised by parties who may now be running a
522
 
        fake Mandos client with the keys from the non-encrypted
523
 
        initial RAM image of the client host.  What should be done in
524
 
        that case (if restarting the server program really is
525
 
        necessary) is to stop the server program, edit the
526
 
        configuration file to omit any suspect clients, and restart
527
 
        the server program.
 
597
        by the server which would therefore disable the client.  But
 
598
        if the server was ever restarted, it would re-read its client
 
599
        list from its configuration file and again regard all clients
 
600
        therein as enabled, and hence eligible to receive their
 
601
        passwords.  Therefore, be careful when restarting servers if
 
602
        it is suspected that a client has, in fact, been compromised
 
603
        by parties who may now be running a fake Mandos client with
 
604
        the keys from the non-encrypted initial <acronym>RAM</acronym>
 
605
        image of the client host.  What should be done in that case
 
606
        (if restarting the server program really is necessary) is to
 
607
        stop the server program, edit the configuration file to omit
 
608
        any suspect clients, and restart the server program.
528
609
      </para>
529
610
      <para>
530
611
        For more details on client-side security, see
531
 
        <citerefentry><refentrytitle>password-request</refentrytitle>
 
612
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
532
613
        <manvolnum>8mandos</manvolnum></citerefentry>.
533
614
      </para>
534
615
    </refsect2>
535
616
  </refsect1>
536
 
 
 
617
  
537
618
  <refsect1 id="see_also">
538
619
    <title>SEE ALSO</title>
539
620
    <para>
540
 
      <citerefentry>
541
 
        <refentrytitle>mandos.conf</refentrytitle>
542
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
543
 
        <refentrytitle>mandos-clients.conf</refentrytitle>
544
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
545
 
        <refentrytitle>password-request</refentrytitle>
546
 
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
547
 
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
548
 
      </citerefentry>
 
621
      <citerefentry><refentrytitle>intro</refentrytitle>
 
622
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
623
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
624
      <manvolnum>5</manvolnum></citerefentry>,
 
625
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
 
626
      <manvolnum>5</manvolnum></citerefentry>,
 
627
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
628
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
629
      <citerefentry><refentrytitle>sh</refentrytitle>
 
630
      <manvolnum>1</manvolnum></citerefentry>
549
631
    </para>
550
632
    <variablelist>
551
633
      <varlistentry>
651
733
    </variablelist>
652
734
  </refsect1>
653
735
</refentry>
 
736
<!-- Local Variables: -->
 
737
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
738
<!-- time-stamp-end: "[\"']>" -->
 
739
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
740
<!-- End: -->