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