/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:09:04 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080829070904-i6u8xb0aueytvfii
* mandos-clients.conf.xml (/refentry/refentryinfo/title): Changed to
                                                          "Mandos
                                                          Manual".

  (/refentry/refentryinfo/productname): Changed to "Mandos".
* mandos-keygen.xml: - '' -
* mandos.conf.xml: - '' -
* mandos.xml: - '' -
* plugin-runner.xml: - '' -
* plugins.d/password-request.xml: - '' -

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