/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: 2016-03-17 20:40:55 UTC
  • Revision ID: teddy@recompile.se-20160317204055-bhsh5xsidq7w5cxu
Client: Fix plymouth agent; broken since 1.7.2.

Fix an very old memory bug in the plymouth agent (which has been
present since its apperance in version 1.2), but which was only
recently detected at run time due to the new -fsanitize=address
compile- time flag, which has been used since version 1.7.2.  This
detection of a memory access violation causes the program to abort,
making the Plymouth graphical boot system unable to accept interactive
input of passwords when using the Mandos client.

* plugins.d/plymouth.c (exec_and_wait): Fix memory allocation bug when
  allocating new_argv.  Also tolerate a zero-length argv.

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 "2016-03-05">
 
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
 
    <title>&COMMANDNAME;</title>
 
11
   <refentryinfo>
 
12
    <title>Mandos Manual</title>
12
13
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
13
 
    <productname>&COMMANDNAME;</productname>
14
 
    <productnumber>&VERSION;</productnumber>
 
14
    <productname>Mandos</productname>
 
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>
 
40
      <year>2014</year>
 
41
      <year>2015</year>
 
42
      <year>2016</year>
34
43
      <holder>Teddy Hogeborn</holder>
35
44
      <holder>Björn Påhlsson</holder>
36
45
    </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>
 
46
    <xi:include href="legalnotice.xml"/>
60
47
  </refentryinfo>
61
 
 
 
48
  
62
49
  <refmeta>
63
50
    <refentrytitle>&COMMANDNAME;</refentrytitle>
64
51
    <manvolnum>8</manvolnum>
67
54
  <refnamediv>
68
55
    <refname><command>&COMMANDNAME;</command></refname>
69
56
    <refpurpose>
70
 
      Sends encrypted passwords to authenticated Mandos clients
 
57
      Gives encrypted passwords to authenticated Mandos clients
71
58
    </refpurpose>
72
59
  </refnamediv>
73
 
 
 
60
  
74
61
  <refsynopsisdiv>
75
62
    <cmdsynopsis>
76
63
      <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>
 
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>
94
114
    </cmdsynopsis>
95
115
    <cmdsynopsis>
96
116
      <command>&COMMANDNAME;</command>
97
117
      <group choice="req">
98
 
        <arg choice="plain">-h</arg>
99
 
        <arg choice="plain">--help</arg>
 
118
        <arg choice="plain"><option>--help</option></arg>
 
119
        <arg choice="plain"><option>-h</option></arg>
100
120
      </group>
101
121
    </cmdsynopsis>
102
122
    <cmdsynopsis>
103
123
      <command>&COMMANDNAME;</command>
104
 
      <arg choice="plain">--version</arg>
 
124
      <arg choice="plain"><option>--version</option></arg>
105
125
    </cmdsynopsis>
106
126
    <cmdsynopsis>
107
127
      <command>&COMMANDNAME;</command>
108
 
      <arg choice="plain">--check</arg>
 
128
      <arg choice="plain"><option>--check</option></arg>
109
129
    </cmdsynopsis>
110
130
  </refsynopsisdiv>
111
 
 
 
131
  
112
132
  <refsect1 id="description">
113
133
    <title>DESCRIPTION</title>
114
134
    <para>
115
135
      <command>&COMMANDNAME;</command> is a server daemon which
116
136
      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.
 
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.
125
147
    </para>
126
 
 
127
148
  </refsect1>
128
149
  
129
150
  <refsect1 id="purpose">
130
151
    <title>PURPOSE</title>
131
 
 
132
152
    <para>
133
153
      The purpose of this is to enable <emphasis>remote and unattended
134
154
      rebooting</emphasis> of client host computer with an
135
155
      <emphasis>encrypted root file system</emphasis>.  See <xref
136
156
      linkend="overview"/> for details.
137
157
    </para>
138
 
 
139
158
  </refsect1>
140
159
  
141
160
  <refsect1 id="options">
142
161
    <title>OPTIONS</title>
143
 
 
144
162
    <variablelist>
145
163
      <varlistentry>
146
 
        <term><literal>-h</literal>, <literal>--help</literal></term>
 
164
        <term><option>--help</option></term>
 
165
        <term><option>-h</option></term>
147
166
        <listitem>
148
167
          <para>
149
168
            Show a help message and exit
150
169
          </para>
151
170
        </listitem>
152
171
      </varlistentry>
153
 
 
 
172
      
154
173
      <varlistentry>
155
 
        <term><literal>-i</literal>, <literal>--interface <replaceable
156
 
        >NAME</replaceable></literal></term>
 
174
        <term><option>--interface</option>
 
175
        <replaceable>NAME</replaceable></term>
 
176
        <term><option>-i</option>
 
177
        <replaceable>NAME</replaceable></term>
157
178
        <listitem>
158
179
          <xi:include href="mandos-options.xml" xpointer="interface"/>
159
180
        </listitem>
160
181
      </varlistentry>
161
 
 
 
182
      
162
183
      <varlistentry>
163
 
        <term><literal>-a</literal>, <literal>--address <replaceable>
164
 
        ADDRESS</replaceable></literal></term>
 
184
        <term><option>--address
 
185
        <replaceable>ADDRESS</replaceable></option></term>
 
186
        <term><option>-a
 
187
        <replaceable>ADDRESS</replaceable></option></term>
165
188
        <listitem>
166
189
          <xi:include href="mandos-options.xml" xpointer="address"/>
167
190
        </listitem>
168
191
      </varlistentry>
169
 
 
 
192
      
170
193
      <varlistentry>
171
 
        <term><literal>-p</literal>, <literal>--port <replaceable>
172
 
        PORT</replaceable></literal></term>
 
194
        <term><option>--port
 
195
        <replaceable>PORT</replaceable></option></term>
 
196
        <term><option>-p
 
197
        <replaceable>PORT</replaceable></option></term>
173
198
        <listitem>
174
199
          <xi:include href="mandos-options.xml" xpointer="port"/>
175
200
        </listitem>
176
201
      </varlistentry>
177
 
 
 
202
      
178
203
      <varlistentry>
179
 
        <term><literal>--check</literal></term>
 
204
        <term><option>--check</option></term>
180
205
        <listitem>
181
206
          <para>
182
207
            Run the server’s self-tests.  This includes any unit
184
209
          </para>
185
210
        </listitem>
186
211
      </varlistentry>
187
 
 
 
212
      
188
213
      <varlistentry>
189
 
        <term><literal>--debug</literal></term>
 
214
        <term><option>--debug</option></term>
190
215
        <listitem>
191
216
          <xi:include href="mandos-options.xml" xpointer="debug"/>
192
217
        </listitem>
193
218
      </varlistentry>
194
 
 
195
 
      <varlistentry>
196
 
        <term><literal>--priority <replaceable>
197
 
        PRIORITY</replaceable></literal></term>
 
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>
198
241
        <listitem>
199
242
          <xi:include href="mandos-options.xml" xpointer="priority"/>
200
243
        </listitem>
201
244
      </varlistentry>
202
 
 
 
245
      
203
246
      <varlistentry>
204
 
        <term><literal>--servicename <replaceable>NAME</replaceable>
205
 
        </literal></term>
 
247
        <term><option>--servicename
 
248
        <replaceable>NAME</replaceable></option></term>
206
249
        <listitem>
207
250
          <xi:include href="mandos-options.xml"
208
251
                      xpointer="servicename"/>
209
252
        </listitem>
210
253
      </varlistentry>
211
 
 
 
254
      
212
255
      <varlistentry>
213
 
        <term><literal>--configdir <replaceable>DIR</replaceable>
214
 
        </literal></term>
 
256
        <term><option>--configdir
 
257
        <replaceable>DIRECTORY</replaceable></option></term>
215
258
        <listitem>
216
259
          <para>
217
260
            Directory to search for configuration files.  Default is
223
266
          </para>
224
267
        </listitem>
225
268
      </varlistentry>
226
 
 
 
269
      
227
270
      <varlistentry>
228
 
        <term><literal>--version</literal></term>
 
271
        <term><option>--version</option></term>
229
272
        <listitem>
230
273
          <para>
231
274
            Prints the program version and exit.
232
275
          </para>
233
276
        </listitem>
234
277
      </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
      
235
337
    </variablelist>
236
338
  </refsect1>
237
 
 
 
339
  
238
340
  <refsect1 id="overview">
239
341
    <title>OVERVIEW</title>
240
342
    <xi:include href="overview.xml"/>
241
343
    <para>
242
344
      This program is the server part.  It is a normal server program
243
345
      and will run in a normal system environment, not in an initial
244
 
      RAM disk environment.
 
346
      <acronym>RAM</acronym> disk environment.
245
347
    </para>
246
348
  </refsect1>
247
 
 
 
349
  
248
350
  <refsect1 id="protocol">
249
351
    <title>NETWORK PROTOCOL</title>
250
352
    <para>
302
404
      </row>
303
405
    </tbody></tgroup></table>
304
406
  </refsect1>
305
 
 
 
407
  
306
408
  <refsect1 id="checking">
307
409
    <title>CHECKING</title>
308
410
    <para>
309
411
      The server will, by default, continually check that the clients
310
412
      are still up.  If a client has not been confirmed as being up
311
413
      for some time, the client is assumed to be compromised and is no
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>
 
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>
 
419
      <manvolnum>5</manvolnum></citerefentry>.
 
420
    </para>
 
421
  </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>
315
430
      <refentrytitle>mandos-clients.conf</refentrytitle>
316
 
      <manvolnum>5</manvolnum></citerefentry>.
317
 
    </para>
 
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
    
318
441
  </refsect1>
319
 
 
 
442
  
320
443
  <refsect1 id="logging">
321
444
    <title>LOGGING</title>
322
445
    <para>
323
446
      The server will send log message with various severity levels to
324
 
      <filename>/dev/log</filename>.  With the
 
447
      <filename class="devicefile">/dev/log</filename>.  With the
325
448
      <option>--debug</option> option, it will log even more messages,
326
449
      and also show them on the console.
327
450
    </para>
328
451
  </refsect1>
329
 
 
 
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
  
330
475
  <refsect1 id="exit_status">
331
476
    <title>EXIT STATUS</title>
332
477
    <para>
334
479
      critical error is encountered.
335
480
    </para>
336
481
  </refsect1>
337
 
 
 
482
  
338
483
  <refsect1 id="environment">
339
484
    <title>ENVIRONMENT</title>
340
485
    <variablelist>
341
486
      <varlistentry>
342
 
        <term><varname>PATH</varname></term>
 
487
        <term><envar>PATH</envar></term>
343
488
        <listitem>
344
489
          <para>
345
490
            To start the configured checker (see <xref
354
499
      </varlistentry>
355
500
    </variablelist>
356
501
  </refsect1>
357
 
 
358
 
  <refsect1 id="file">
 
502
  
 
503
  <refsect1 id="files">
359
504
    <title>FILES</title>
360
505
    <para>
361
506
      Use the <option>--configdir</option> option to change where
384
529
        </listitem>
385
530
      </varlistentry>
386
531
      <varlistentry>
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>.
392
 
          </para>
393
 
        </listitem>
394
 
      </varlistentry>
395
 
      <varlistentry>
396
 
        <term><filename>/dev/log</filename></term>
 
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>
397
557
        <listitem>
398
558
          <para>
399
559
            The Unix domain socket to where local syslog messages are
422
582
      backtrace.  This could be considered a feature.
423
583
    </para>
424
584
    <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>
436
585
      There is no fine-grained control over logging and debug output.
437
586
    </para>
438
587
    <para>
439
 
      Debug mode is conflated with running in the foreground.
440
 
    </para>
441
 
    <para>
442
 
      The console log messages does not show a timestamp.
443
 
    </para>
 
588
      This server does not check the expire time of clients’ OpenPGP
 
589
      keys.
 
590
    </para>
 
591
    <xi:include href="bugs.xml"/>
444
592
  </refsect1>
445
593
  
446
594
  <refsect1 id="example">
456
604
    <informalexample>
457
605
      <para>
458
606
        Run the server in debug mode, read configuration files from
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:
 
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
610
      </para>
463
611
      <para>
464
612
 
480
628
      </para>
481
629
    </informalexample>
482
630
  </refsect1>
483
 
 
 
631
  
484
632
  <refsect1 id="security">
485
633
    <title>SECURITY</title>
486
 
    <refsect2 id="SERVER">
 
634
    <refsect2 id="server">
487
635
      <title>SERVER</title>
488
636
      <para>
489
637
        Running this <command>&COMMANDNAME;</command> server program
490
638
        should not in itself present any security risk to the host
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.
 
639
        computer running it.  The program switches to a non-root user
 
640
        soon after startup.
493
641
      </para>
494
642
    </refsect2>
495
 
    <refsect2 id="CLIENTS">
 
643
    <refsect2 id="clients">
496
644
      <title>CLIENTS</title>
497
645
      <para>
498
646
        The server only gives out its stored data to clients which
505
653
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
506
654
        <manvolnum>5</manvolnum></citerefentry>)
507
655
        <emphasis>must</emphasis> be made non-readable by anyone
508
 
        except the user running the server.
 
656
        except the user starting the server (usually root).
509
657
      </para>
510
658
      <para>
511
659
        As detailed in <xref linkend="checking"/>, the status of all
513
661
        compromised if they are gone for too long.
514
662
      </para>
515
663
      <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>
532
664
        For more details on client-side security, see
533
 
        <citerefentry><refentrytitle>password-request</refentrytitle>
 
665
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
534
666
        <manvolnum>8mandos</manvolnum></citerefentry>.
535
667
      </para>
536
668
    </refsect2>
537
669
  </refsect1>
538
 
 
 
670
  
539
671
  <refsect1 id="see_also">
540
672
    <title>SEE ALSO</title>
541
673
    <para>
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>
 
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>
551
684
    </para>
552
685
    <variablelist>
553
686
      <varlistentry>
574
707
      </varlistentry>
575
708
      <varlistentry>
576
709
        <term>
577
 
          <ulink url="http://www.gnu.org/software/gnutls/"
578
 
          >GnuTLS</ulink>
 
710
          <ulink url="http://gnutls.org/">GnuTLS</ulink>
579
711
        </term>
580
712
      <listitem>
581
713
        <para>
619
751
      </varlistentry>
620
752
      <varlistentry>
621
753
        <term>
622
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
623
 
          Protocol Version 1.1</citetitle>
 
754
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
 
755
          Protocol Version 1.2</citetitle>
624
756
        </term>
625
757
      <listitem>
626
758
        <para>
627
 
          TLS 1.1 is the protocol implemented by GnuTLS.
 
759
          TLS 1.2 is the protocol implemented by GnuTLS.
628
760
        </para>
629
761
      </listitem>
630
762
      </varlistentry>
640
772
      </varlistentry>
641
773
      <varlistentry>
642
774
        <term>
643
 
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
644
 
          Security</citetitle>
 
775
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
 
776
          Security (TLS) Authentication</citetitle>
645
777
        </term>
646
778
      <listitem>
647
779
        <para>