/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: 2023-02-07 23:45:43 UTC
  • mfrom: (1271 trunk)
  • mto: This revision was merged to the branch mainline in revision 1272.
  • Revision ID: teddy@recompile.se-20230207234543-z9xxymrxhsncmfus
Merge from trunk

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