/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: 2008-08-29 07:30:17 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080829073017-tvryowganbf75zp5
* mandos-clients.conf.xml (SEE ALSO): Alphabetized, as per
                                      man-pages(7).
* mandos-keygen.xml: - '' -
* mandos.conf.xml: - '' -
* mandos.xml: - '' -
* plugin-runner.xml: - '' -
* plugins.d/password-request.xml (SEE ALSO): Changed from an
                                             <itemizedlist> to a
                                             <para>, as per
                                             man-pages(7).  Also
                                             alphabetize.

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