/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-30 18:45:41 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080830184541-j8zru4q0rlz5a0hw
* mandos-clients.conf.xml (SYNOPSIS): Remove line breaks.
  (OPTIONS): Add <option> tags.  Moved option name to outside
             <literal>.  Moved synopsis to inside <term> tags.
             Removed <synopsis> tags.  Improve wording of "secfile"
             option.
  (EXPANSION): Improved wording slightly.

* mandos-options.xml (interface): Improve wording.

* mandos.conf.xml (SYNOPSIS): Remove line breaks.
  (OPTIONS): Add <option> tags.  Moved option name to outside
             <literal>.  Moved synopsis to inside <term> tags.
             Removed <synopsis> tags.

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-26">
6
 
<!ENTITY % common SYSTEM "common.ent">
7
 
%common;
 
6
<!ENTITY TIMESTAMP "2008-08-30">
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>
54
70
      Gives 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>
 
146
        <term><option>-h</option></term>
159
147
        <term><option>--help</option></term>
160
 
        <term><option>-h</option></term>
161
148
        <listitem>
162
149
          <para>
163
150
            Show a help message and exit
164
151
          </para>
165
152
        </listitem>
166
153
      </varlistentry>
167
 
      
 
154
 
168
155
      <varlistentry>
 
156
        <term><option>-i</option>
 
157
        <replaceable>NAME</replaceable></term>
169
158
        <term><option>--interface</option>
170
159
        <replaceable>NAME</replaceable></term>
171
 
        <term><option>-i</option>
172
 
        <replaceable>NAME</replaceable></term>
173
160
        <listitem>
174
161
          <xi:include href="mandos-options.xml" xpointer="interface"/>
175
162
        </listitem>
176
163
      </varlistentry>
177
 
      
 
164
 
178
165
      <varlistentry>
179
 
        <term><option>--address
180
 
        <replaceable>ADDRESS</replaceable></option></term>
181
 
        <term><option>-a
182
 
        <replaceable>ADDRESS</replaceable></option></term>
 
166
        <term><literal>-a</literal>, <literal>--address <replaceable>
 
167
        ADDRESS</replaceable></literal></term>
183
168
        <listitem>
184
169
          <xi:include href="mandos-options.xml" xpointer="address"/>
185
170
        </listitem>
186
171
      </varlistentry>
187
 
      
 
172
 
188
173
      <varlistentry>
189
 
        <term><option>--port
190
 
        <replaceable>PORT</replaceable></option></term>
191
 
        <term><option>-p
192
 
        <replaceable>PORT</replaceable></option></term>
 
174
        <term><literal>-p</literal>, <literal>--port <replaceable>
 
175
        PORT</replaceable></literal></term>
193
176
        <listitem>
194
177
          <xi:include href="mandos-options.xml" xpointer="port"/>
195
178
        </listitem>
196
179
      </varlistentry>
197
 
      
 
180
 
198
181
      <varlistentry>
199
 
        <term><option>--check</option></term>
 
182
        <term><literal>--check</literal></term>
200
183
        <listitem>
201
184
          <para>
202
185
            Run the server’s self-tests.  This includes any unit
204
187
          </para>
205
188
        </listitem>
206
189
      </varlistentry>
207
 
      
 
190
 
208
191
      <varlistentry>
209
 
        <term><option>--debug</option></term>
 
192
        <term><literal>--debug</literal></term>
210
193
        <listitem>
211
194
          <xi:include href="mandos-options.xml" xpointer="debug"/>
212
195
        </listitem>
213
196
      </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>
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>
 
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>
245
209
        <listitem>
246
210
          <xi:include href="mandos-options.xml"
247
211
                      xpointer="servicename"/>
248
212
        </listitem>
249
213
      </varlistentry>
250
 
      
 
214
 
251
215
      <varlistentry>
252
 
        <term><option>--configdir
253
 
        <replaceable>DIRECTORY</replaceable></option></term>
 
216
        <term><literal>--configdir <replaceable>DIR</replaceable>
 
217
        </literal></term>
254
218
        <listitem>
255
219
          <para>
256
220
            Directory to search for configuration files.  Default is
262
226
          </para>
263
227
        </listitem>
264
228
      </varlistentry>
265
 
      
 
229
 
266
230
      <varlistentry>
267
 
        <term><option>--version</option></term>
 
231
        <term><literal>--version</literal></term>
268
232
        <listitem>
269
233
          <para>
270
234
            Prints the program version and exit.
271
235
          </para>
272
236
        </listitem>
273
237
      </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
 
      
326
238
    </variablelist>
327
239
  </refsect1>
328
 
  
 
240
 
329
241
  <refsect1 id="overview">
330
242
    <title>OVERVIEW</title>
331
243
    <xi:include href="overview.xml"/>
332
244
    <para>
333
245
      This program is the server part.  It is a normal server program
334
246
      and will run in a normal system environment, not in an initial
335
 
      <acronym>RAM</acronym> disk environment.
 
247
      RAM disk environment.
336
248
    </para>
337
249
  </refsect1>
338
 
  
 
250
 
339
251
  <refsect1 id="protocol">
340
252
    <title>NETWORK PROTOCOL</title>
341
253
    <para>
393
305
      </row>
394
306
    </tbody></tgroup></table>
395
307
  </refsect1>
396
 
  
 
308
 
397
309
  <refsect1 id="checking">
398
310
    <title>CHECKING</title>
399
311
    <para>
400
312
      The server will, by default, continually check that the clients
401
313
      are still up.  If a client has not been confirmed as being up
402
314
      for some time, the client is assumed to be compromised and is no
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>
 
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>
 
318
      <refentrytitle>mandos-clients.conf</refentrytitle>
408
319
      <manvolnum>5</manvolnum></citerefentry>.
409
320
    </para>
410
321
  </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>
419
 
      <refentrytitle>mandos-clients.conf</refentrytitle>
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
 
    
430
 
  </refsect1>
431
 
  
 
322
 
432
323
  <refsect1 id="logging">
433
324
    <title>LOGGING</title>
434
325
    <para>
435
326
      The server will send log message with various severity levels to
436
 
      <filename class="devicefile">/dev/log</filename>.  With the
 
327
      <filename>/dev/log</filename>.  With the
437
328
      <option>--debug</option> option, it will log even more messages,
438
329
      and also show them on the console.
439
330
    </para>
440
331
  </refsect1>
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
 
  
 
332
 
464
333
  <refsect1 id="exit_status">
465
334
    <title>EXIT STATUS</title>
466
335
    <para>
468
337
      critical error is encountered.
469
338
    </para>
470
339
  </refsect1>
471
 
  
 
340
 
472
341
  <refsect1 id="environment">
473
342
    <title>ENVIRONMENT</title>
474
343
    <variablelist>
488
357
      </varlistentry>
489
358
    </variablelist>
490
359
  </refsect1>
491
 
  
492
 
  <refsect1 id="files">
 
360
 
 
361
  <refsect1 id="file">
493
362
    <title>FILES</title>
494
363
    <para>
495
364
      Use the <option>--configdir</option> option to change where
518
387
        </listitem>
519
388
      </varlistentry>
520
389
      <varlistentry>
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.
 
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>.
544
395
          </para>
545
396
        </listitem>
546
397
      </varlistentry>
574
425
      backtrace.  This could be considered a feature.
575
426
    </para>
576
427
    <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>
577
439
      There is no fine-grained control over logging and debug output.
578
440
    </para>
579
441
    <para>
580
 
      This server does not check the expire time of clients’ OpenPGP
581
 
      keys.
 
442
      Debug mode is conflated with running in the foreground.
 
443
    </para>
 
444
    <para>
 
445
      The console log messages does not show a timestamp.
582
446
    </para>
583
447
  </refsect1>
584
448
  
595
459
    <informalexample>
596
460
      <para>
597
461
        Run the server in debug mode, read configuration files from
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:
 
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:
601
465
      </para>
602
466
      <para>
603
467
 
619
483
      </para>
620
484
    </informalexample>
621
485
  </refsect1>
622
 
  
 
486
 
623
487
  <refsect1 id="security">
624
488
    <title>SECURITY</title>
625
 
    <refsect2 id="server">
 
489
    <refsect2 id="SERVER">
626
490
      <title>SERVER</title>
627
491
      <para>
628
492
        Running this <command>&COMMANDNAME;</command> server program
629
493
        should not in itself present any security risk to the host
630
 
        computer running it.  The program switches to a non-root user
631
 
        soon after startup.
 
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.
632
496
      </para>
633
497
    </refsect2>
634
 
    <refsect2 id="clients">
 
498
    <refsect2 id="CLIENTS">
635
499
      <title>CLIENTS</title>
636
500
      <para>
637
501
        The server only gives out its stored data to clients which
644
508
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
645
509
        <manvolnum>5</manvolnum></citerefentry>)
646
510
        <emphasis>must</emphasis> be made non-readable by anyone
647
 
        except the user starting the server (usually root).
 
511
        except the user running the server.
648
512
      </para>
649
513
      <para>
650
514
        As detailed in <xref linkend="checking"/>, the status of all
652
516
        compromised if they are gone for too long.
653
517
      </para>
654
518
      <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>
655
535
        For more details on client-side security, see
656
 
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
536
        <citerefentry><refentrytitle>password-request</refentrytitle>
657
537
        <manvolnum>8mandos</manvolnum></citerefentry>.
658
538
      </para>
659
539
    </refsect2>
660
540
  </refsect1>
661
 
  
 
541
 
662
542
  <refsect1 id="see_also">
663
543
    <title>SEE ALSO</title>
664
544
    <para>
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>
 
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>
675
554
    </para>
676
555
    <variablelist>
677
556
      <varlistentry>