/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: 2019-02-09 23:31:44 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 370.
  • Revision ID: teddy@recompile.se-20190209233144-5ewmrgezdqridssj
* TODO (Use raw public keys): Remove.

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