/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to mandos.xml

  • Committer: Teddy Hogeborn
  • Date: 2013-12-31 16:02:18 UTC
  • mto: (237.7.272 trunk)
  • mto: This revision was merged to the branch mainline in revision 307.
  • Revision ID: teddy@recompile.se-20131231160218-plmmb0o0iifkd5l2
Specify BusName in systemd service file.

* mandos.service (BusName): Uncommented.

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