/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 17:16:33 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080830171633-rjyuhsemikw6lg2w
* mandos-keygen.xml (SYNOPSIS): Fixed tags.  Unify short and long
                                options.
* plugins.d/password-request.xml (SYNOPSIS): - '' -

* mandos-clients.conf.xml: Removed extra white space.
* plugin-runner.xml: - '' -
* plugins.d/password-prompt.xml: - '' -
* mandos-keygen.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 "2016-03-05">
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
 
      <year>2014</year>
41
 
      <year>2015</year>
42
 
      <year>2016</year>
43
34
      <holder>Teddy Hogeborn</holder>
44
35
      <holder>Björn Påhlsson</holder>
45
36
    </copyright>
46
 
    <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>
47
60
  </refentryinfo>
48
 
  
 
61
 
49
62
  <refmeta>
50
63
    <refentrytitle>&COMMANDNAME;</refentrytitle>
51
64
    <manvolnum>8</manvolnum>
57
70
      Gives encrypted passwords to authenticated Mandos clients
58
71
    </refpurpose>
59
72
  </refnamediv>
60
 
  
 
73
 
61
74
  <refsynopsisdiv>
62
75
    <cmdsynopsis>
63
76
      <command>&COMMANDNAME;</command>
64
 
      <group>
65
 
        <arg choice="plain"><option>--interface
66
 
        <replaceable>NAME</replaceable></option></arg>
67
 
        <arg choice="plain"><option>-i
68
 
        <replaceable>NAME</replaceable></option></arg>
69
 
      </group>
70
 
      <sbr/>
71
 
      <group>
72
 
        <arg choice="plain"><option>--address
73
 
        <replaceable>ADDRESS</replaceable></option></arg>
74
 
        <arg choice="plain"><option>-a
75
 
        <replaceable>ADDRESS</replaceable></option></arg>
76
 
      </group>
77
 
      <sbr/>
78
 
      <group>
79
 
        <arg choice="plain"><option>--port
80
 
        <replaceable>PORT</replaceable></option></arg>
81
 
        <arg choice="plain"><option>-p
82
 
        <replaceable>PORT</replaceable></option></arg>
83
 
      </group>
84
 
      <sbr/>
85
 
      <arg><option>--priority
86
 
      <replaceable>PRIORITY</replaceable></option></arg>
87
 
      <sbr/>
88
 
      <arg><option>--servicename
89
 
      <replaceable>NAME</replaceable></option></arg>
90
 
      <sbr/>
91
 
      <arg><option>--configdir
92
 
      <replaceable>DIRECTORY</replaceable></option></arg>
93
 
      <sbr/>
94
 
      <arg><option>--debug</option></arg>
95
 
      <sbr/>
96
 
      <arg><option>--debuglevel
97
 
      <replaceable>LEVEL</replaceable></option></arg>
98
 
      <sbr/>
99
 
      <arg><option>--no-dbus</option></arg>
100
 
      <sbr/>
101
 
      <arg><option>--no-ipv6</option></arg>
102
 
      <sbr/>
103
 
      <arg><option>--no-restore</option></arg>
104
 
      <sbr/>
105
 
      <arg><option>--statedir
106
 
      <replaceable>DIRECTORY</replaceable></option></arg>
107
 
      <sbr/>
108
 
      <arg><option>--socket
109
 
      <replaceable>FD</replaceable></option></arg>
110
 
      <sbr/>
111
 
      <arg><option>--foreground</option></arg>
112
 
      <sbr/>
113
 
      <arg><option>--no-zeroconf</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>
114
94
    </cmdsynopsis>
115
95
    <cmdsynopsis>
116
96
      <command>&COMMANDNAME;</command>
117
97
      <group choice="req">
118
 
        <arg choice="plain"><option>--help</option></arg>
119
 
        <arg choice="plain"><option>-h</option></arg>
 
98
        <arg choice="plain">-h</arg>
 
99
        <arg choice="plain">--help</arg>
120
100
      </group>
121
101
    </cmdsynopsis>
122
102
    <cmdsynopsis>
123
103
      <command>&COMMANDNAME;</command>
124
 
      <arg choice="plain"><option>--version</option></arg>
 
104
      <arg choice="plain">--version</arg>
125
105
    </cmdsynopsis>
126
106
    <cmdsynopsis>
127
107
      <command>&COMMANDNAME;</command>
128
 
      <arg choice="plain"><option>--check</option></arg>
 
108
      <arg choice="plain">--check</arg>
129
109
    </cmdsynopsis>
130
110
  </refsynopsisdiv>
131
 
  
 
111
 
132
112
  <refsect1 id="description">
133
113
    <title>DESCRIPTION</title>
134
114
    <para>
135
115
      <command>&COMMANDNAME;</command> is a server daemon which
136
116
      handles incoming request for passwords for a pre-defined list of
137
 
      client host computers. For an introduction, see
138
 
      <citerefentry><refentrytitle>intro</refentrytitle>
139
 
      <manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
140
 
      uses Zeroconf to announce itself on the local network, and uses
141
 
      TLS to communicate securely with and to authenticate the
142
 
      clients.  The Mandos server uses IPv6 to allow Mandos clients to
143
 
      use IPv6 link-local addresses, since the clients will probably
144
 
      not have any other addresses configured (see <xref
145
 
      linkend="overview"/>).  Any authenticated client is then given
146
 
      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.
147
125
    </para>
 
126
 
148
127
  </refsect1>
149
128
  
150
129
  <refsect1 id="purpose">
151
130
    <title>PURPOSE</title>
 
131
 
152
132
    <para>
153
133
      The purpose of this is to enable <emphasis>remote and unattended
154
134
      rebooting</emphasis> of client host computer with an
155
135
      <emphasis>encrypted root file system</emphasis>.  See <xref
156
136
      linkend="overview"/> for details.
157
137
    </para>
 
138
 
158
139
  </refsect1>
159
140
  
160
141
  <refsect1 id="options">
161
142
    <title>OPTIONS</title>
 
143
 
162
144
    <variablelist>
163
145
      <varlistentry>
 
146
        <term><option>-h</option></term>
164
147
        <term><option>--help</option></term>
165
 
        <term><option>-h</option></term>
166
148
        <listitem>
167
149
          <para>
168
150
            Show a help message and exit
169
151
          </para>
170
152
        </listitem>
171
153
      </varlistentry>
172
 
      
 
154
 
173
155
      <varlistentry>
 
156
        <term><option>-i</option>
 
157
        <replaceable>NAME</replaceable></term>
174
158
        <term><option>--interface</option>
175
159
        <replaceable>NAME</replaceable></term>
176
 
        <term><option>-i</option>
177
 
        <replaceable>NAME</replaceable></term>
178
160
        <listitem>
179
161
          <xi:include href="mandos-options.xml" xpointer="interface"/>
180
162
        </listitem>
181
163
      </varlistentry>
182
 
      
 
164
 
183
165
      <varlistentry>
184
 
        <term><option>--address
185
 
        <replaceable>ADDRESS</replaceable></option></term>
186
 
        <term><option>-a
187
 
        <replaceable>ADDRESS</replaceable></option></term>
 
166
        <term><literal>-a</literal>, <literal>--address <replaceable>
 
167
        ADDRESS</replaceable></literal></term>
188
168
        <listitem>
189
169
          <xi:include href="mandos-options.xml" xpointer="address"/>
190
170
        </listitem>
191
171
      </varlistentry>
192
 
      
 
172
 
193
173
      <varlistentry>
194
 
        <term><option>--port
195
 
        <replaceable>PORT</replaceable></option></term>
196
 
        <term><option>-p
197
 
        <replaceable>PORT</replaceable></option></term>
 
174
        <term><literal>-p</literal>, <literal>--port <replaceable>
 
175
        PORT</replaceable></literal></term>
198
176
        <listitem>
199
177
          <xi:include href="mandos-options.xml" xpointer="port"/>
200
178
        </listitem>
201
179
      </varlistentry>
202
 
      
 
180
 
203
181
      <varlistentry>
204
 
        <term><option>--check</option></term>
 
182
        <term><literal>--check</literal></term>
205
183
        <listitem>
206
184
          <para>
207
185
            Run the server’s self-tests.  This includes any unit
209
187
          </para>
210
188
        </listitem>
211
189
      </varlistentry>
212
 
      
 
190
 
213
191
      <varlistentry>
214
 
        <term><option>--debug</option></term>
 
192
        <term><literal>--debug</literal></term>
215
193
        <listitem>
216
194
          <xi:include href="mandos-options.xml" xpointer="debug"/>
217
195
        </listitem>
218
196
      </varlistentry>
219
 
      
220
 
      <varlistentry>
221
 
        <term><option>--debuglevel
222
 
        <replaceable>LEVEL</replaceable></option></term>
223
 
        <listitem>
224
 
          <para>
225
 
            Set the debugging log level.
226
 
            <replaceable>LEVEL</replaceable> is a string, one of
227
 
            <quote><literal>CRITICAL</literal></quote>,
228
 
            <quote><literal>ERROR</literal></quote>,
229
 
            <quote><literal>WARNING</literal></quote>,
230
 
            <quote><literal>INFO</literal></quote>, or
231
 
            <quote><literal>DEBUG</literal></quote>, in order of
232
 
            increasing verbosity.  The default level is
233
 
            <quote><literal>WARNING</literal></quote>.
234
 
          </para>
235
 
        </listitem>
236
 
      </varlistentry>
237
 
      
238
 
      <varlistentry>
239
 
        <term><option>--priority <replaceable>
240
 
        PRIORITY</replaceable></option></term>
 
197
 
 
198
      <varlistentry>
 
199
        <term><literal>--priority <replaceable>
 
200
        PRIORITY</replaceable></literal></term>
241
201
        <listitem>
242
202
          <xi:include href="mandos-options.xml" xpointer="priority"/>
243
203
        </listitem>
244
204
      </varlistentry>
245
 
      
 
205
 
246
206
      <varlistentry>
247
 
        <term><option>--servicename
248
 
        <replaceable>NAME</replaceable></option></term>
 
207
        <term><literal>--servicename <replaceable>NAME</replaceable>
 
208
        </literal></term>
249
209
        <listitem>
250
210
          <xi:include href="mandos-options.xml"
251
211
                      xpointer="servicename"/>
252
212
        </listitem>
253
213
      </varlistentry>
254
 
      
 
214
 
255
215
      <varlistentry>
256
 
        <term><option>--configdir
257
 
        <replaceable>DIRECTORY</replaceable></option></term>
 
216
        <term><literal>--configdir <replaceable>DIR</replaceable>
 
217
        </literal></term>
258
218
        <listitem>
259
219
          <para>
260
220
            Directory to search for configuration files.  Default is
266
226
          </para>
267
227
        </listitem>
268
228
      </varlistentry>
269
 
      
 
229
 
270
230
      <varlistentry>
271
 
        <term><option>--version</option></term>
 
231
        <term><literal>--version</literal></term>
272
232
        <listitem>
273
233
          <para>
274
234
            Prints the program version and exit.
275
235
          </para>
276
236
        </listitem>
277
237
      </varlistentry>
278
 
      
279
 
      <varlistentry>
280
 
        <term><option>--no-dbus</option></term>
281
 
        <listitem>
282
 
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
283
 
          <para>
284
 
            See also <xref linkend="dbus_interface"/>.
285
 
          </para>
286
 
        </listitem>
287
 
      </varlistentry>
288
 
      
289
 
      <varlistentry>
290
 
        <term><option>--no-ipv6</option></term>
291
 
        <listitem>
292
 
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
293
 
        </listitem>
294
 
      </varlistentry>
295
 
      
296
 
      <varlistentry>
297
 
        <term><option>--no-restore</option></term>
298
 
        <listitem>
299
 
          <xi:include href="mandos-options.xml" xpointer="restore"/>
300
 
          <para>
301
 
            See also <xref linkend="persistent_state"/>.
302
 
          </para>
303
 
        </listitem>
304
 
      </varlistentry>
305
 
      
306
 
      <varlistentry>
307
 
        <term><option>--statedir
308
 
        <replaceable>DIRECTORY</replaceable></option></term>
309
 
        <listitem>
310
 
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
311
 
        </listitem>
312
 
      </varlistentry>
313
 
      
314
 
      <varlistentry>
315
 
        <term><option>--socket
316
 
        <replaceable>FD</replaceable></option></term>
317
 
        <listitem>
318
 
          <xi:include href="mandos-options.xml" xpointer="socket"/>
319
 
        </listitem>
320
 
      </varlistentry>
321
 
      
322
 
      <varlistentry>
323
 
        <term><option>--foreground</option></term>
324
 
        <listitem>
325
 
          <xi:include href="mandos-options.xml"
326
 
                      xpointer="foreground"/>
327
 
        </listitem>
328
 
      </varlistentry>
329
 
      
330
 
      <varlistentry>
331
 
        <term><option>--no-zeroconf</option></term>
332
 
        <listitem>
333
 
          <xi:include href="mandos-options.xml" xpointer="zeroconf"/>
334
 
        </listitem>
335
 
      </varlistentry>
336
 
      
337
238
    </variablelist>
338
239
  </refsect1>
339
 
  
 
240
 
340
241
  <refsect1 id="overview">
341
242
    <title>OVERVIEW</title>
342
243
    <xi:include href="overview.xml"/>
343
244
    <para>
344
245
      This program is the server part.  It is a normal server program
345
246
      and will run in a normal system environment, not in an initial
346
 
      <acronym>RAM</acronym> disk environment.
 
247
      RAM disk environment.
347
248
    </para>
348
249
  </refsect1>
349
 
  
 
250
 
350
251
  <refsect1 id="protocol">
351
252
    <title>NETWORK PROTOCOL</title>
352
253
    <para>
404
305
      </row>
405
306
    </tbody></tgroup></table>
406
307
  </refsect1>
407
 
  
 
308
 
408
309
  <refsect1 id="checking">
409
310
    <title>CHECKING</title>
410
311
    <para>
411
312
      The server will, by default, continually check that the clients
412
313
      are still up.  If a client has not been confirmed as being up
413
314
      for some time, the client is assumed to be compromised and is no
414
 
      longer eligible to receive the encrypted password.  (Manual
415
 
      intervention is required to re-enable a client.)  The timeout,
416
 
      extended timeout, checker program, and interval between checks
417
 
      can be configured both globally and per client; see
418
 
      <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>
419
319
      <manvolnum>5</manvolnum></citerefentry>.
420
320
    </para>
421
321
  </refsect1>
422
 
  
423
 
  <refsect1 id="approval">
424
 
    <title>APPROVAL</title>
425
 
    <para>
426
 
      The server can be configured to require manual approval for a
427
 
      client before it is sent its secret.  The delay to wait for such
428
 
      approval and the default action (approve or deny) can be
429
 
      configured both globally and per client; see <citerefentry>
430
 
      <refentrytitle>mandos-clients.conf</refentrytitle>
431
 
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
432
 
      will be approved immediately without delay.
433
 
    </para>
434
 
    <para>
435
 
      This can be used to deny a client its secret if not manually
436
 
      approved within a specified time.  It can also be used to make
437
 
      the server delay before giving a client its secret, allowing
438
 
      optional manual denying of this specific client.
439
 
    </para>
440
 
    
441
 
  </refsect1>
442
 
  
 
322
 
443
323
  <refsect1 id="logging">
444
324
    <title>LOGGING</title>
445
325
    <para>
446
326
      The server will send log message with various severity levels to
447
 
      <filename class="devicefile">/dev/log</filename>.  With the
 
327
      <filename>/dev/log</filename>.  With the
448
328
      <option>--debug</option> option, it will log even more messages,
449
329
      and also show them on the console.
450
330
    </para>
451
331
  </refsect1>
452
 
  
453
 
  <refsect1 id="persistent_state">
454
 
    <title>PERSISTENT STATE</title>
455
 
    <para>
456
 
      Client settings, initially read from
457
 
      <filename>clients.conf</filename>, are persistent across
458
 
      restarts, and run-time changes will override settings in
459
 
      <filename>clients.conf</filename>.  However, if a setting is
460
 
      <emphasis>changed</emphasis> (or a client added, or removed) in
461
 
      <filename>clients.conf</filename>, this will take precedence.
462
 
    </para>
463
 
  </refsect1>
464
 
  
465
 
  <refsect1 id="dbus_interface">
466
 
    <title>D-BUS INTERFACE</title>
467
 
    <para>
468
 
      The server will by default provide a D-Bus system bus interface.
469
 
      This interface will only be accessible by the root user or a
470
 
      Mandos-specific user, if such a user exists.  For documentation
471
 
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
472
 
    </para>
473
 
  </refsect1>
474
 
  
 
332
 
475
333
  <refsect1 id="exit_status">
476
334
    <title>EXIT STATUS</title>
477
335
    <para>
479
337
      critical error is encountered.
480
338
    </para>
481
339
  </refsect1>
482
 
  
 
340
 
483
341
  <refsect1 id="environment">
484
342
    <title>ENVIRONMENT</title>
485
343
    <variablelist>
499
357
      </varlistentry>
500
358
    </variablelist>
501
359
  </refsect1>
502
 
  
503
 
  <refsect1 id="files">
 
360
 
 
361
  <refsect1 id="file">
504
362
    <title>FILES</title>
505
363
    <para>
506
364
      Use the <option>--configdir</option> option to change where
529
387
        </listitem>
530
388
      </varlistentry>
531
389
      <varlistentry>
532
 
        <term><filename>/run/mandos.pid</filename></term>
533
 
        <listitem>
534
 
          <para>
535
 
            The file containing the process id of the
536
 
            <command>&COMMANDNAME;</command> process started last.
537
 
            <emphasis >Note:</emphasis> If the <filename
538
 
            class="directory">/run</filename> directory does not
539
 
            exist, <filename>/var/run/mandos.pid</filename> will be
540
 
            used instead.
541
 
          </para>
542
 
        </listitem>
543
 
      </varlistentry>
544
 
      <varlistentry>
545
 
        <term><filename
546
 
        class="directory">/var/lib/mandos</filename></term>
547
 
        <listitem>
548
 
          <para>
549
 
            Directory where persistent state will be saved.  Change
550
 
            this with the <option>--statedir</option> option.  See
551
 
            also the <option>--no-restore</option> option.
552
 
          </para>
553
 
        </listitem>
554
 
      </varlistentry>
555
 
      <varlistentry>
556
 
        <term><filename class="devicefile">/dev/log</filename></term>
 
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>.
 
395
          </para>
 
396
        </listitem>
 
397
      </varlistentry>
 
398
      <varlistentry>
 
399
        <term><filename>/dev/log</filename></term>
557
400
        <listitem>
558
401
          <para>
559
402
            The Unix domain socket to where local syslog messages are
582
425
      backtrace.  This could be considered a feature.
583
426
    </para>
584
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>
585
439
      There is no fine-grained control over logging and debug output.
586
440
    </para>
587
441
    <para>
588
 
      This server does not check the expire time of clients’ OpenPGP
589
 
      keys.
590
 
    </para>
591
 
    <xi:include href="bugs.xml"/>
 
442
      Debug mode is conflated with running in the foreground.
 
443
    </para>
 
444
    <para>
 
445
      The console log messages does not show a timestamp.
 
446
    </para>
592
447
  </refsect1>
593
448
  
594
449
  <refsect1 id="example">
604
459
    <informalexample>
605
460
      <para>
606
461
        Run the server in debug mode, read configuration files from
607
 
        the <filename class="directory">~/mandos</filename> directory,
608
 
        and use the Zeroconf service name <quote>Test</quote> to not
609
 
        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:
610
465
      </para>
611
466
      <para>
612
467
 
628
483
      </para>
629
484
    </informalexample>
630
485
  </refsect1>
631
 
  
 
486
 
632
487
  <refsect1 id="security">
633
488
    <title>SECURITY</title>
634
 
    <refsect2 id="server">
 
489
    <refsect2 id="SERVER">
635
490
      <title>SERVER</title>
636
491
      <para>
637
492
        Running this <command>&COMMANDNAME;</command> server program
638
493
        should not in itself present any security risk to the host
639
 
        computer running it.  The program switches to a non-root user
640
 
        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.
641
496
      </para>
642
497
    </refsect2>
643
 
    <refsect2 id="clients">
 
498
    <refsect2 id="CLIENTS">
644
499
      <title>CLIENTS</title>
645
500
      <para>
646
501
        The server only gives out its stored data to clients which
653
508
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
654
509
        <manvolnum>5</manvolnum></citerefentry>)
655
510
        <emphasis>must</emphasis> be made non-readable by anyone
656
 
        except the user starting the server (usually root).
 
511
        except the user running the server.
657
512
      </para>
658
513
      <para>
659
514
        As detailed in <xref linkend="checking"/>, the status of all
661
516
        compromised if they are gone for too long.
662
517
      </para>
663
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>
664
535
        For more details on client-side security, see
665
 
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
536
        <citerefentry><refentrytitle>password-request</refentrytitle>
666
537
        <manvolnum>8mandos</manvolnum></citerefentry>.
667
538
      </para>
668
539
    </refsect2>
669
540
  </refsect1>
670
 
  
 
541
 
671
542
  <refsect1 id="see_also">
672
543
    <title>SEE ALSO</title>
673
544
    <para>
674
 
      <citerefentry><refentrytitle>intro</refentrytitle>
675
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
676
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
677
 
      <manvolnum>5</manvolnum></citerefentry>,
678
 
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
679
 
      <manvolnum>5</manvolnum></citerefentry>,
680
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
681
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
682
 
      <citerefentry><refentrytitle>sh</refentrytitle>
683
 
      <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>
684
554
    </para>
685
555
    <variablelist>
686
556
      <varlistentry>
707
577
      </varlistentry>
708
578
      <varlistentry>
709
579
        <term>
710
 
          <ulink url="http://gnutls.org/">GnuTLS</ulink>
 
580
          <ulink url="http://www.gnu.org/software/gnutls/"
 
581
          >GnuTLS</ulink>
711
582
        </term>
712
583
      <listitem>
713
584
        <para>
751
622
      </varlistentry>
752
623
      <varlistentry>
753
624
        <term>
754
 
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
755
 
          Protocol Version 1.2</citetitle>
 
625
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
626
          Protocol Version 1.1</citetitle>
756
627
        </term>
757
628
      <listitem>
758
629
        <para>
759
 
          TLS 1.2 is the protocol implemented by GnuTLS.
 
630
          TLS 1.1 is the protocol implemented by GnuTLS.
760
631
        </para>
761
632
      </listitem>
762
633
      </varlistentry>
772
643
      </varlistentry>
773
644
      <varlistentry>
774
645
        <term>
775
 
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
776
 
          Security (TLS) Authentication</citetitle>
 
646
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
 
647
          Security</citetitle>
777
648
        </term>
778
649
      <listitem>
779
650
        <para>