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