/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: 2012-06-01 18:39:03 UTC
  • mfrom: (237.8.1 release)
  • mto: (237.4.33 release)
  • mto: This revision was merged to the branch mainline in revision 593.
  • Revision ID: teddy@recompile.se-20120601183903-hydodgfmlau5d109
Tags: version-1.5.5-1
https://launchpad.net/bugs/1006645
* Makefile (version): Changed to "1.5.5".
* NEWS (Version 1.5.5): New entry.
* debian/changelog (1.5.5-1): - '' -

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