/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-11-26 22:22:20 UTC
  • mto: (518.1.8 mandos-persistent)
  • mto: This revision was merged to the branch mainline in revision 524.
  • Revision ID: teddy@recompile.se-20111126222220-1ubwjpb5ugqnrhec
Directory with persistent state can now be changed with the "statedir"
option.  The state directory /var/lib/mandos now gets created on
installation.  Added documentation about "restore" and "statedir"
options.

* Makefile (USER, GROUP, STATEDIR): New.
  (maintainer-clean): Also remove "statedir".
  (run-server): Replaced "--no-restore" with "--statedir=statedir".
  (statedir): New.
  (install-server): Make $(STATEDIR) directory.
* debian/mandos.dirs (var/lib/mandos): Added.
* debian/mandos.postinst: Fix ownership of /var/lib/mandos.
* mandos: New --statedir option.
  (stored_state_path): Not global anymore.
  (stored_state_file): New global.
* mandos.conf: Fix whitespace.
  (restore, statedir): Added.
* mandos.conf.xml (OPTIONS, EXAMPLE): Added "restore" and "statedir".
  mandos.xml (SYNOPSIS, OPTIONS): Added "--statedir".
  (FILES): Added "/var/lib/mandos".

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 "2011-11-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>
34
38
      <holder>Teddy Hogeborn</holder>
35
39
      <holder>Björn Påhlsson</holder>
36
40
    </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>
 
41
    <xi:include href="legalnotice.xml"/>
60
42
  </refentryinfo>
61
 
 
 
43
  
62
44
  <refmeta>
63
45
    <refentrytitle>&COMMANDNAME;</refentrytitle>
64
46
    <manvolnum>8</manvolnum>
67
49
  <refnamediv>
68
50
    <refname><command>&COMMANDNAME;</command></refname>
69
51
    <refpurpose>
70
 
      Sends encrypted passwords to authenticated Mandos clients
 
52
      Gives encrypted passwords to authenticated Mandos clients
71
53
    </refpurpose>
72
54
  </refnamediv>
73
 
 
 
55
  
74
56
  <refsynopsisdiv>
75
57
    <cmdsynopsis>
76
58
      <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>
 
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>
94
102
    </cmdsynopsis>
95
103
    <cmdsynopsis>
96
104
      <command>&COMMANDNAME;</command>
97
105
      <group choice="req">
98
 
        <arg choice="plain">-h</arg>
99
 
        <arg choice="plain">--help</arg>
 
106
        <arg choice="plain"><option>--help</option></arg>
 
107
        <arg choice="plain"><option>-h</option></arg>
100
108
      </group>
101
109
    </cmdsynopsis>
102
110
    <cmdsynopsis>
103
111
      <command>&COMMANDNAME;</command>
104
 
      <arg choice="plain">--version</arg>
 
112
      <arg choice="plain"><option>--version</option></arg>
105
113
    </cmdsynopsis>
106
114
    <cmdsynopsis>
107
115
      <command>&COMMANDNAME;</command>
108
 
      <arg choice="plain">--check</arg>
 
116
      <arg choice="plain"><option>--check</option></arg>
109
117
    </cmdsynopsis>
110
118
  </refsynopsisdiv>
111
 
 
 
119
  
112
120
  <refsect1 id="description">
113
121
    <title>DESCRIPTION</title>
114
122
    <para>
115
123
      <command>&COMMANDNAME;</command> is a server daemon which
116
124
      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.
 
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.
125
135
    </para>
126
 
 
127
136
  </refsect1>
128
137
  
129
138
  <refsect1 id="purpose">
130
139
    <title>PURPOSE</title>
131
 
 
132
140
    <para>
133
141
      The purpose of this is to enable <emphasis>remote and unattended
134
142
      rebooting</emphasis> of client host computer with an
135
143
      <emphasis>encrypted root file system</emphasis>.  See <xref
136
144
      linkend="overview"/> for details.
137
145
    </para>
138
 
 
139
146
  </refsect1>
140
147
  
141
148
  <refsect1 id="options">
142
149
    <title>OPTIONS</title>
143
 
 
144
150
    <variablelist>
145
151
      <varlistentry>
 
152
        <term><option>--help</option></term>
146
153
        <term><option>-h</option></term>
147
 
        <term><option>--help</option></term>
148
154
        <listitem>
149
155
          <para>
150
156
            Show a help message and exit
151
157
          </para>
152
158
        </listitem>
153
159
      </varlistentry>
154
 
 
 
160
      
155
161
      <varlistentry>
 
162
        <term><option>--interface</option>
 
163
        <replaceable>NAME</replaceable></term>
156
164
        <term><option>-i</option>
157
165
        <replaceable>NAME</replaceable></term>
158
 
        <term><option>--interface</option>
159
 
        <replaceable>NAME</replaceable></term>
160
166
        <listitem>
161
167
          <xi:include href="mandos-options.xml" xpointer="interface"/>
162
168
        </listitem>
163
169
      </varlistentry>
164
 
 
 
170
      
165
171
      <varlistentry>
166
 
        <term><literal>-a</literal>, <literal>--address <replaceable>
167
 
        ADDRESS</replaceable></literal></term>
 
172
        <term><option>--address
 
173
        <replaceable>ADDRESS</replaceable></option></term>
 
174
        <term><option>-a
 
175
        <replaceable>ADDRESS</replaceable></option></term>
168
176
        <listitem>
169
177
          <xi:include href="mandos-options.xml" xpointer="address"/>
170
178
        </listitem>
171
179
      </varlistentry>
172
 
 
 
180
      
173
181
      <varlistentry>
174
 
        <term><literal>-p</literal>, <literal>--port <replaceable>
175
 
        PORT</replaceable></literal></term>
 
182
        <term><option>--port
 
183
        <replaceable>PORT</replaceable></option></term>
 
184
        <term><option>-p
 
185
        <replaceable>PORT</replaceable></option></term>
176
186
        <listitem>
177
187
          <xi:include href="mandos-options.xml" xpointer="port"/>
178
188
        </listitem>
179
189
      </varlistentry>
180
 
 
 
190
      
181
191
      <varlistentry>
182
 
        <term><literal>--check</literal></term>
 
192
        <term><option>--check</option></term>
183
193
        <listitem>
184
194
          <para>
185
195
            Run the server’s self-tests.  This includes any unit
187
197
          </para>
188
198
        </listitem>
189
199
      </varlistentry>
190
 
 
 
200
      
191
201
      <varlistentry>
192
 
        <term><literal>--debug</literal></term>
 
202
        <term><option>--debug</option></term>
193
203
        <listitem>
194
204
          <xi:include href="mandos-options.xml" xpointer="debug"/>
195
205
        </listitem>
196
206
      </varlistentry>
197
 
 
198
 
      <varlistentry>
199
 
        <term><literal>--priority <replaceable>
200
 
        PRIORITY</replaceable></literal></term>
 
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>
201
229
        <listitem>
202
230
          <xi:include href="mandos-options.xml" xpointer="priority"/>
203
231
        </listitem>
204
232
      </varlistentry>
205
 
 
 
233
      
206
234
      <varlistentry>
207
 
        <term><literal>--servicename <replaceable>NAME</replaceable>
208
 
        </literal></term>
 
235
        <term><option>--servicename
 
236
        <replaceable>NAME</replaceable></option></term>
209
237
        <listitem>
210
238
          <xi:include href="mandos-options.xml"
211
239
                      xpointer="servicename"/>
212
240
        </listitem>
213
241
      </varlistentry>
214
 
 
 
242
      
215
243
      <varlistentry>
216
 
        <term><literal>--configdir <replaceable>DIR</replaceable>
217
 
        </literal></term>
 
244
        <term><option>--configdir
 
245
        <replaceable>DIRECTORY</replaceable></option></term>
218
246
        <listitem>
219
247
          <para>
220
248
            Directory to search for configuration files.  Default is
226
254
          </para>
227
255
        </listitem>
228
256
      </varlistentry>
229
 
 
 
257
      
230
258
      <varlistentry>
231
 
        <term><literal>--version</literal></term>
 
259
        <term><option>--version</option></term>
232
260
        <listitem>
233
261
          <para>
234
262
            Prints the program version and exit.
235
263
          </para>
236
264
        </listitem>
237
265
      </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>
238
298
    </variablelist>
239
299
  </refsect1>
240
 
 
 
300
  
241
301
  <refsect1 id="overview">
242
302
    <title>OVERVIEW</title>
243
303
    <xi:include href="overview.xml"/>
244
304
    <para>
245
305
      This program is the server part.  It is a normal server program
246
306
      and will run in a normal system environment, not in an initial
247
 
      RAM disk environment.
 
307
      <acronym>RAM</acronym> disk environment.
248
308
    </para>
249
309
  </refsect1>
250
 
 
 
310
  
251
311
  <refsect1 id="protocol">
252
312
    <title>NETWORK PROTOCOL</title>
253
313
    <para>
305
365
      </row>
306
366
    </tbody></tgroup></table>
307
367
  </refsect1>
308
 
 
 
368
  
309
369
  <refsect1 id="checking">
310
370
    <title>CHECKING</title>
311
371
    <para>
312
372
      The server will, by default, continually check that the clients
313
373
      are still up.  If a client has not been confirmed as being up
314
374
      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>
 
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>
318
393
      <refentrytitle>mandos-clients.conf</refentrytitle>
319
 
      <manvolnum>5</manvolnum></citerefentry>.
320
 
    </para>
 
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
    
321
404
  </refsect1>
322
 
 
 
405
  
323
406
  <refsect1 id="logging">
324
407
    <title>LOGGING</title>
325
408
    <para>
329
412
      and also show them on the console.
330
413
    </para>
331
414
  </refsect1>
332
 
 
 
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
  
333
426
  <refsect1 id="exit_status">
334
427
    <title>EXIT STATUS</title>
335
428
    <para>
337
430
      critical error is encountered.
338
431
    </para>
339
432
  </refsect1>
340
 
 
 
433
  
341
434
  <refsect1 id="environment">
342
435
    <title>ENVIRONMENT</title>
343
436
    <variablelist>
344
437
      <varlistentry>
345
 
        <term><varname>PATH</varname></term>
 
438
        <term><envar>PATH</envar></term>
346
439
        <listitem>
347
440
          <para>
348
441
            To start the configured checker (see <xref
357
450
      </varlistentry>
358
451
    </variablelist>
359
452
  </refsect1>
360
 
 
361
 
  <refsect1 id="file">
 
453
  
 
454
  <refsect1 id="files">
362
455
    <title>FILES</title>
363
456
    <para>
364
457
      Use the <option>--configdir</option> option to change where
387
480
        </listitem>
388
481
      </varlistentry>
389
482
      <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>.
 
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
 
493
        class="directory">/var/lib/mandos</filename></term>
 
494
        <listitem>
 
495
          <para>
 
496
            Directory where persistent state will be saved.  Change
 
497
            this with the <option>--statedir</option> option.  See
 
498
            also the <option>--no-restore</option> option.
395
499
          </para>
396
500
        </listitem>
397
501
      </varlistentry>
425
529
      backtrace.  This could be considered a feature.
426
530
    </para>
427
531
    <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
532
      There is no fine-grained control over logging and debug output.
440
533
    </para>
441
534
    <para>
442
535
      Debug mode is conflated with running in the foreground.
443
536
    </para>
444
537
    <para>
445
 
      The console log messages does not show a timestamp.
 
538
      This server does not check the expire time of clients’ OpenPGP
 
539
      keys.
446
540
    </para>
447
541
  </refsect1>
448
542
  
459
553
    <informalexample>
460
554
      <para>
461
555
        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:
 
556
        the <filename class="directory">~/mandos</filename> directory,
 
557
        and use the Zeroconf service name <quote>Test</quote> to not
 
558
        collide with any other official Mandos server on this host:
465
559
      </para>
466
560
      <para>
467
561
 
483
577
      </para>
484
578
    </informalexample>
485
579
  </refsect1>
486
 
 
 
580
  
487
581
  <refsect1 id="security">
488
582
    <title>SECURITY</title>
489
 
    <refsect2 id="SERVER">
 
583
    <refsect2 id="server">
490
584
      <title>SERVER</title>
491
585
      <para>
492
586
        Running this <command>&COMMANDNAME;</command> server program
493
587
        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.
 
588
        computer running it.  The program switches to a non-root user
 
589
        soon after startup.
496
590
      </para>
497
591
    </refsect2>
498
 
    <refsect2 id="CLIENTS">
 
592
    <refsect2 id="clients">
499
593
      <title>CLIENTS</title>
500
594
      <para>
501
595
        The server only gives out its stored data to clients which
508
602
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
509
603
        <manvolnum>5</manvolnum></citerefentry>)
510
604
        <emphasis>must</emphasis> be made non-readable by anyone
511
 
        except the user running the server.
 
605
        except the user starting the server (usually root).
512
606
      </para>
513
607
      <para>
514
608
        As detailed in <xref linkend="checking"/>, the status of all
516
610
        compromised if they are gone for too long.
517
611
      </para>
518
612
      <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
613
        For more details on client-side security, see
536
 
        <citerefentry><refentrytitle>password-request</refentrytitle>
 
614
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
537
615
        <manvolnum>8mandos</manvolnum></citerefentry>.
538
616
      </para>
539
617
    </refsect2>
540
618
  </refsect1>
541
 
 
 
619
  
542
620
  <refsect1 id="see_also">
543
621
    <title>SEE ALSO</title>
544
622
    <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>
 
623
      <citerefentry><refentrytitle>intro</refentrytitle>
 
624
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
625
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
626
      <manvolnum>5</manvolnum></citerefentry>,
 
627
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
 
628
      <manvolnum>5</manvolnum></citerefentry>,
 
629
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
630
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
631
      <citerefentry><refentrytitle>sh</refentrytitle>
 
632
      <manvolnum>1</manvolnum></citerefentry>
554
633
    </para>
555
634
    <variablelist>
556
635
      <varlistentry>