/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 at recompile
  • Date: 2011-12-31 13:25:58 UTC
  • mto: This revision was merged to the branch mainline in revision 541.
  • Revision ID: teddy@recompile.se-20111231132558-z0dh7qgofgctmgri
* network-hooks.s/bridge: Don't use interface names directly; search
                          for interface names using their address.
  (addrtoif): New function.
* network-hooks.s/bridge.conf (PORTS): Removed.
  (PORT_ADDRESSES): New.
* network-hooks.s/wireless: Don't use interface names directly; search
                            for interface names using their address.
  (addrtoif): New function.
* network-hooks.s/wireless.conf: Specify address.

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
 
    <title>&COMMANDNAME;</title>
 
11
   <refentryinfo>
 
12
    <title>Mandos Manual</title>
12
13
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
13
 
    <productname>&COMMANDNAME;</productname>
14
 
    <productnumber>&VERSION;</productnumber>
 
14
    <productname>Mandos</productname>
 
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>
146
 
        <term><literal>-h</literal>, <literal>--help</literal></term>
 
152
        <term><option>--help</option></term>
 
153
        <term><option>-h</option></term>
147
154
        <listitem>
148
155
          <para>
149
156
            Show a help message and exit
150
157
          </para>
151
158
        </listitem>
152
159
      </varlistentry>
153
 
 
 
160
      
154
161
      <varlistentry>
155
 
        <term><literal>-i</literal>, <literal>--interface <replaceable
156
 
        >NAME</replaceable></literal></term>
 
162
        <term><option>--interface</option>
 
163
        <replaceable>NAME</replaceable></term>
 
164
        <term><option>-i</option>
 
165
        <replaceable>NAME</replaceable></term>
157
166
        <listitem>
158
167
          <xi:include href="mandos-options.xml" xpointer="interface"/>
159
168
        </listitem>
160
169
      </varlistentry>
161
 
 
 
170
      
162
171
      <varlistentry>
163
 
        <term><literal>-a</literal>, <literal>--address <replaceable>
164
 
        ADDRESS</replaceable></literal></term>
 
172
        <term><option>--address
 
173
        <replaceable>ADDRESS</replaceable></option></term>
 
174
        <term><option>-a
 
175
        <replaceable>ADDRESS</replaceable></option></term>
165
176
        <listitem>
166
177
          <xi:include href="mandos-options.xml" xpointer="address"/>
167
178
        </listitem>
168
179
      </varlistentry>
169
 
 
 
180
      
170
181
      <varlistentry>
171
 
        <term><literal>-p</literal>, <literal>--port <replaceable>
172
 
        PORT</replaceable></literal></term>
 
182
        <term><option>--port
 
183
        <replaceable>PORT</replaceable></option></term>
 
184
        <term><option>-p
 
185
        <replaceable>PORT</replaceable></option></term>
173
186
        <listitem>
174
187
          <xi:include href="mandos-options.xml" xpointer="port"/>
175
188
        </listitem>
176
189
      </varlistentry>
177
 
 
 
190
      
178
191
      <varlistentry>
179
 
        <term><literal>--check</literal></term>
 
192
        <term><option>--check</option></term>
180
193
        <listitem>
181
194
          <para>
182
195
            Run the server’s self-tests.  This includes any unit
184
197
          </para>
185
198
        </listitem>
186
199
      </varlistentry>
187
 
 
 
200
      
188
201
      <varlistentry>
189
 
        <term><literal>--debug</literal></term>
 
202
        <term><option>--debug</option></term>
190
203
        <listitem>
191
204
          <xi:include href="mandos-options.xml" xpointer="debug"/>
192
205
        </listitem>
193
206
      </varlistentry>
194
 
 
195
 
      <varlistentry>
196
 
        <term><literal>--priority <replaceable>
197
 
        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>
198
229
        <listitem>
199
230
          <xi:include href="mandos-options.xml" xpointer="priority"/>
200
231
        </listitem>
201
232
      </varlistentry>
202
 
 
 
233
      
203
234
      <varlistentry>
204
 
        <term><literal>--servicename <replaceable>NAME</replaceable>
205
 
        </literal></term>
 
235
        <term><option>--servicename
 
236
        <replaceable>NAME</replaceable></option></term>
206
237
        <listitem>
207
238
          <xi:include href="mandos-options.xml"
208
239
                      xpointer="servicename"/>
209
240
        </listitem>
210
241
      </varlistentry>
211
 
 
 
242
      
212
243
      <varlistentry>
213
 
        <term><literal>--configdir <replaceable>DIR</replaceable>
214
 
        </literal></term>
 
244
        <term><option>--configdir
 
245
        <replaceable>DIRECTORY</replaceable></option></term>
215
246
        <listitem>
216
247
          <para>
217
248
            Directory to search for configuration files.  Default is
223
254
          </para>
224
255
        </listitem>
225
256
      </varlistentry>
226
 
 
 
257
      
227
258
      <varlistentry>
228
 
        <term><literal>--version</literal></term>
 
259
        <term><option>--version</option></term>
229
260
        <listitem>
230
261
          <para>
231
262
            Prints the program version and exit.
232
263
          </para>
233
264
        </listitem>
234
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>
235
298
    </variablelist>
236
299
  </refsect1>
237
 
 
 
300
  
238
301
  <refsect1 id="overview">
239
302
    <title>OVERVIEW</title>
240
303
    <xi:include href="overview.xml"/>
241
304
    <para>
242
305
      This program is the server part.  It is a normal server program
243
306
      and will run in a normal system environment, not in an initial
244
 
      RAM disk environment.
 
307
      <acronym>RAM</acronym> disk environment.
245
308
    </para>
246
309
  </refsect1>
247
 
 
 
310
  
248
311
  <refsect1 id="protocol">
249
312
    <title>NETWORK PROTOCOL</title>
250
313
    <para>
302
365
      </row>
303
366
    </tbody></tgroup></table>
304
367
  </refsect1>
305
 
 
 
368
  
306
369
  <refsect1 id="checking">
307
370
    <title>CHECKING</title>
308
371
    <para>
309
372
      The server will, by default, continually check that the clients
310
373
      are still up.  If a client has not been confirmed as being up
311
374
      for some time, the client is assumed to be compromised and is no
312
 
      longer eligible to receive the encrypted password.  The timeout,
313
 
      checker program, and interval between checks can be configured
314
 
      both globally and per client; see <citerefentry>
 
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>
315
393
      <refentrytitle>mandos-clients.conf</refentrytitle>
316
 
      <manvolnum>5</manvolnum></citerefentry>.
317
 
    </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
    
318
404
  </refsect1>
319
 
 
 
405
  
320
406
  <refsect1 id="logging">
321
407
    <title>LOGGING</title>
322
408
    <para>
323
409
      The server will send log message with various severity levels to
324
 
      <filename>/dev/log</filename>.  With the
 
410
      <filename class="devicefile">/dev/log</filename>.  With the
325
411
      <option>--debug</option> option, it will log even more messages,
326
412
      and also show them on the console.
327
413
    </para>
328
414
  </refsect1>
329
 
 
 
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
  
330
426
  <refsect1 id="exit_status">
331
427
    <title>EXIT STATUS</title>
332
428
    <para>
334
430
      critical error is encountered.
335
431
    </para>
336
432
  </refsect1>
337
 
 
 
433
  
338
434
  <refsect1 id="environment">
339
435
    <title>ENVIRONMENT</title>
340
436
    <variablelist>
341
437
      <varlistentry>
342
 
        <term><varname>PATH</varname></term>
 
438
        <term><envar>PATH</envar></term>
343
439
        <listitem>
344
440
          <para>
345
441
            To start the configured checker (see <xref
354
450
      </varlistentry>
355
451
    </variablelist>
356
452
  </refsect1>
357
 
 
358
 
  <refsect1 id="file">
 
453
  
 
454
  <refsect1 id="files">
359
455
    <title>FILES</title>
360
456
    <para>
361
457
      Use the <option>--configdir</option> option to change where
384
480
        </listitem>
385
481
      </varlistentry>
386
482
      <varlistentry>
387
 
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
388
 
        <listitem>
389
 
          <para>
390
 
            The file containing the process id of
391
 
            <command>&COMMANDNAME;</command>.
 
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.
392
502
          </para>
393
503
        </listitem>
394
504
      </varlistentry>
422
532
      backtrace.  This could be considered a feature.
423
533
    </para>
424
534
    <para>
425
 
      Currently, if a client is declared <quote>invalid</quote> due to
426
 
      having timed out, the server does not record this fact onto
427
 
      permanent storage.  This has some security implications, see
428
 
      <xref linkend="CLIENTS"/>.
429
 
    </para>
430
 
    <para>
431
 
      There is currently no way of querying the server of the current
432
 
      status of clients, other than analyzing its <systemitem
433
 
      class="service">syslog</systemitem> output.
434
 
    </para>
435
 
    <para>
436
535
      There is no fine-grained control over logging and debug output.
437
536
    </para>
438
537
    <para>
439
538
      Debug mode is conflated with running in the foreground.
440
539
    </para>
441
540
    <para>
442
 
      The console log messages does not show a timestamp.
 
541
      This server does not check the expire time of clients’ OpenPGP
 
542
      keys.
443
543
    </para>
444
544
  </refsect1>
445
545
  
456
556
    <informalexample>
457
557
      <para>
458
558
        Run the server in debug mode, read configuration files from
459
 
        the <filename>~/mandos</filename> directory, and use the
460
 
        Zeroconf service name <quote>Test</quote> to not collide with
461
 
        any other official Mandos server on this host:
 
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:
462
562
      </para>
463
563
      <para>
464
564
 
480
580
      </para>
481
581
    </informalexample>
482
582
  </refsect1>
483
 
 
 
583
  
484
584
  <refsect1 id="security">
485
585
    <title>SECURITY</title>
486
 
    <refsect2 id="SERVER">
 
586
    <refsect2 id="server">
487
587
      <title>SERVER</title>
488
588
      <para>
489
589
        Running this <command>&COMMANDNAME;</command> server program
490
590
        should not in itself present any security risk to the host
491
 
        computer running it.  The program does not need any special
492
 
        privileges to run, and is designed to run as a non-root user.
 
591
        computer running it.  The program switches to a non-root user
 
592
        soon after startup.
493
593
      </para>
494
594
    </refsect2>
495
 
    <refsect2 id="CLIENTS">
 
595
    <refsect2 id="clients">
496
596
      <title>CLIENTS</title>
497
597
      <para>
498
598
        The server only gives out its stored data to clients which
505
605
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
506
606
        <manvolnum>5</manvolnum></citerefentry>)
507
607
        <emphasis>must</emphasis> be made non-readable by anyone
508
 
        except the user running the server.
 
608
        except the user starting the server (usually root).
509
609
      </para>
510
610
      <para>
511
611
        As detailed in <xref linkend="checking"/>, the status of all
513
613
        compromised if they are gone for too long.
514
614
      </para>
515
615
      <para>
516
 
        If a client is compromised, its downtime should be duly noted
517
 
        by the server which would therefore declare the client
518
 
        invalid.  But if the server was ever restarted, it would
519
 
        re-read its client list from its configuration file and again
520
 
        regard all clients therein as valid, and hence eligible to
521
 
        receive their passwords.  Therefore, be careful when
522
 
        restarting servers if it is suspected that a client has, in
523
 
        fact, been compromised by parties who may now be running a
524
 
        fake Mandos client with the keys from the non-encrypted
525
 
        initial RAM image of the client host.  What should be done in
526
 
        that case (if restarting the server program really is
527
 
        necessary) is to stop the server program, edit the
528
 
        configuration file to omit any suspect clients, and restart
529
 
        the server program.
530
 
      </para>
531
 
      <para>
532
616
        For more details on client-side security, see
533
 
        <citerefentry><refentrytitle>password-request</refentrytitle>
 
617
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
534
618
        <manvolnum>8mandos</manvolnum></citerefentry>.
535
619
      </para>
536
620
    </refsect2>
537
621
  </refsect1>
538
 
 
 
622
  
539
623
  <refsect1 id="see_also">
540
624
    <title>SEE ALSO</title>
541
625
    <para>
542
 
      <citerefentry>
543
 
        <refentrytitle>mandos.conf</refentrytitle>
544
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
545
 
        <refentrytitle>mandos-clients.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>
 
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>
551
636
    </para>
552
637
    <variablelist>
553
638
      <varlistentry>