/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-10 10:46:24 UTC
  • Revision ID: teddy@recompile.se-20190210104624-u8k8r4dn08qdqlgf
Tags: version-1.8.2-1
* Makefile (version): Change to 1.8.2.
* NEWS (Version 1.8.2): Add new entry.
* debian/changelog (1.8.2-1): - '' -

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-10">
 
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
139
      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.
 
140
      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>
 
167
        <term><option>--help</option></term>
146
168
        <term><option>-h</option></term>
147
 
        <term><option>--help</option></term>
148
169
        <listitem>
149
170
          <para>
150
171
            Show a help message and exit
151
172
          </para>
152
173
        </listitem>
153
174
      </varlistentry>
154
 
 
 
175
      
155
176
      <varlistentry>
 
177
        <term><option>--interface</option>
 
178
        <replaceable>NAME</replaceable></term>
156
179
        <term><option>-i</option>
157
180
        <replaceable>NAME</replaceable></term>
158
 
        <term><option>--interface</option>
159
 
        <replaceable>NAME</replaceable></term>
160
181
        <listitem>
161
182
          <xi:include href="mandos-options.xml" xpointer="interface"/>
162
183
        </listitem>
163
184
      </varlistentry>
164
 
 
 
185
      
165
186
      <varlistentry>
166
 
        <term><literal>-a</literal>, <literal>--address <replaceable>
167
 
        ADDRESS</replaceable></literal></term>
 
187
        <term><option>--address
 
188
        <replaceable>ADDRESS</replaceable></option></term>
 
189
        <term><option>-a
 
190
        <replaceable>ADDRESS</replaceable></option></term>
168
191
        <listitem>
169
192
          <xi:include href="mandos-options.xml" xpointer="address"/>
170
193
        </listitem>
171
194
      </varlistentry>
172
 
 
 
195
      
173
196
      <varlistentry>
174
 
        <term><literal>-p</literal>, <literal>--port <replaceable>
175
 
        PORT</replaceable></literal></term>
 
197
        <term><option>--port
 
198
        <replaceable>PORT</replaceable></option></term>
 
199
        <term><option>-p
 
200
        <replaceable>PORT</replaceable></option></term>
176
201
        <listitem>
177
202
          <xi:include href="mandos-options.xml" xpointer="port"/>
178
203
        </listitem>
179
204
      </varlistentry>
180
 
 
 
205
      
181
206
      <varlistentry>
182
 
        <term><literal>--check</literal></term>
 
207
        <term><option>--check</option></term>
183
208
        <listitem>
184
209
          <para>
185
210
            Run the server’s self-tests.  This includes any unit
187
212
          </para>
188
213
        </listitem>
189
214
      </varlistentry>
190
 
 
 
215
      
191
216
      <varlistentry>
192
 
        <term><literal>--debug</literal></term>
 
217
        <term><option>--debug</option></term>
193
218
        <listitem>
194
219
          <xi:include href="mandos-options.xml" xpointer="debug"/>
195
220
        </listitem>
196
221
      </varlistentry>
197
 
 
198
 
      <varlistentry>
199
 
        <term><literal>--priority <replaceable>
200
 
        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>
201
244
        <listitem>
202
245
          <xi:include href="mandos-options.xml" xpointer="priority"/>
203
246
        </listitem>
204
247
      </varlistentry>
205
 
 
 
248
      
206
249
      <varlistentry>
207
 
        <term><literal>--servicename <replaceable>NAME</replaceable>
208
 
        </literal></term>
 
250
        <term><option>--servicename
 
251
        <replaceable>NAME</replaceable></option></term>
209
252
        <listitem>
210
253
          <xi:include href="mandos-options.xml"
211
254
                      xpointer="servicename"/>
212
255
        </listitem>
213
256
      </varlistentry>
214
 
 
 
257
      
215
258
      <varlistentry>
216
 
        <term><literal>--configdir <replaceable>DIR</replaceable>
217
 
        </literal></term>
 
259
        <term><option>--configdir
 
260
        <replaceable>DIRECTORY</replaceable></option></term>
218
261
        <listitem>
219
262
          <para>
220
263
            Directory to search for configuration files.  Default is
226
269
          </para>
227
270
        </listitem>
228
271
      </varlistentry>
229
 
 
 
272
      
230
273
      <varlistentry>
231
 
        <term><literal>--version</literal></term>
 
274
        <term><option>--version</option></term>
232
275
        <listitem>
233
276
          <para>
234
277
            Prints the program version and exit.
235
278
          </para>
236
279
        </listitem>
237
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
      
238
340
    </variablelist>
239
341
  </refsect1>
240
 
 
 
342
  
241
343
  <refsect1 id="overview">
242
344
    <title>OVERVIEW</title>
243
345
    <xi:include href="overview.xml"/>
244
346
    <para>
245
347
      This program is the server part.  It is a normal server program
246
348
      and will run in a normal system environment, not in an initial
247
 
      RAM disk environment.
 
349
      <acronym>RAM</acronym> disk environment.
248
350
    </para>
249
351
  </refsect1>
250
 
 
 
352
  
251
353
  <refsect1 id="protocol">
252
354
    <title>NETWORK PROTOCOL</title>
253
355
    <para>
260
362
      start a TLS protocol handshake with a slight quirk: the Mandos
261
363
      server program acts as a TLS <quote>client</quote> while the
262
364
      connecting Mandos client acts as a TLS <quote>server</quote>.
263
 
      The Mandos client must supply an OpenPGP certificate, and the
264
 
      fingerprint of this certificate is used by the Mandos server to
265
 
      look up (in a list read from <filename>clients.conf</filename>
266
 
      at start time) which binary blob to give the client.  No other
267
 
      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.
268
370
    </para>
269
371
    <table>
270
372
      <title>Mandos Protocol (Version 1)</title><tgroup cols="3"><thead>
290
392
        </emphasis></entry>
291
393
      </row>
292
394
      <row>
293
 
        <entry>OpenPGP public key (part of TLS handshake)</entry>
 
395
        <entry>Public key (part of TLS handshake)</entry>
294
396
        <entry>-><!-- &rarr; --></entry>
295
397
      </row>
296
398
      <row>
305
407
      </row>
306
408
    </tbody></tgroup></table>
307
409
  </refsect1>
308
 
 
 
410
  
309
411
  <refsect1 id="checking">
310
412
    <title>CHECKING</title>
311
413
    <para>
312
414
      The server will, by default, continually check that the clients
313
415
      are still up.  If a client has not been confirmed as being up
314
416
      for some time, the client is assumed to be compromised and is no
315
 
      longer eligible to receive the encrypted password.  The timeout,
316
 
      checker program, and interval between checks can be configured
317
 
      both globally and per client; see <citerefentry>
 
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>
318
433
      <refentrytitle>mandos-clients.conf</refentrytitle>
319
 
      <manvolnum>5</manvolnum></citerefentry>.
320
 
    </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
    
321
444
  </refsect1>
322
 
 
 
445
  
323
446
  <refsect1 id="logging">
324
447
    <title>LOGGING</title>
325
448
    <para>
326
449
      The server will send log message with various severity levels to
327
 
      <filename>/dev/log</filename>.  With the
 
450
      <filename class="devicefile">/dev/log</filename>.  With the
328
451
      <option>--debug</option> option, it will log even more messages,
329
452
      and also show them on the console.
330
453
    </para>
331
454
  </refsect1>
332
 
 
 
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
  
333
478
  <refsect1 id="exit_status">
334
479
    <title>EXIT STATUS</title>
335
480
    <para>
337
482
      critical error is encountered.
338
483
    </para>
339
484
  </refsect1>
340
 
 
 
485
  
341
486
  <refsect1 id="environment">
342
487
    <title>ENVIRONMENT</title>
343
488
    <variablelist>
344
489
      <varlistentry>
345
 
        <term><varname>PATH</varname></term>
 
490
        <term><envar>PATH</envar></term>
346
491
        <listitem>
347
492
          <para>
348
493
            To start the configured checker (see <xref
357
502
      </varlistentry>
358
503
    </variablelist>
359
504
  </refsect1>
360
 
 
361
 
  <refsect1 id="file">
 
505
  
 
506
  <refsect1 id="files">
362
507
    <title>FILES</title>
363
508
    <para>
364
509
      Use the <option>--configdir</option> option to change where
387
532
        </listitem>
388
533
      </varlistentry>
389
534
      <varlistentry>
390
 
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
391
 
        <listitem>
392
 
          <para>
393
 
            The file containing the process id of
394
 
            <command>&COMMANDNAME;</command>.
395
 
          </para>
396
 
        </listitem>
397
 
      </varlistentry>
398
 
      <varlistentry>
399
 
        <term><filename>/dev/log</filename></term>
 
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>
400
560
        <listitem>
401
561
          <para>
402
562
            The Unix domain socket to where local syslog messages are
425
585
      backtrace.  This could be considered a feature.
426
586
    </para>
427
587
    <para>
428
 
      Currently, if a client is declared <quote>invalid</quote> due to
429
 
      having timed out, the server does not record this fact onto
430
 
      permanent storage.  This has some security implications, see
431
 
      <xref linkend="CLIENTS"/>.
432
 
    </para>
433
 
    <para>
434
 
      There is currently no way of querying the server of the current
435
 
      status of clients, other than analyzing its <systemitem
436
 
      class="service">syslog</systemitem> output.
437
 
    </para>
438
 
    <para>
439
588
      There is no fine-grained control over logging and debug output.
440
589
    </para>
441
 
    <para>
442
 
      Debug mode is conflated with running in the foreground.
443
 
    </para>
444
 
    <para>
445
 
      The console log messages does not show a timestamp.
446
 
    </para>
 
590
    <xi:include href="bugs.xml"/>
447
591
  </refsect1>
448
592
  
449
593
  <refsect1 id="example">
459
603
    <informalexample>
460
604
      <para>
461
605
        Run the server in debug mode, read configuration files from
462
 
        the <filename>~/mandos</filename> directory, and use the
463
 
        Zeroconf service name <quote>Test</quote> to not collide with
464
 
        any other official Mandos server on this host:
 
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:
465
609
      </para>
466
610
      <para>
467
611
 
483
627
      </para>
484
628
    </informalexample>
485
629
  </refsect1>
486
 
 
 
630
  
487
631
  <refsect1 id="security">
488
632
    <title>SECURITY</title>
489
 
    <refsect2 id="SERVER">
 
633
    <refsect2 id="server">
490
634
      <title>SERVER</title>
491
635
      <para>
492
636
        Running this <command>&COMMANDNAME;</command> server program
493
637
        should not in itself present any security risk to the host
494
 
        computer running it.  The program does not need any special
495
 
        privileges to run, and is designed to run as a non-root user.
 
638
        computer running it.  The program switches to a non-root user
 
639
        soon after startup.
496
640
      </para>
497
641
    </refsect2>
498
 
    <refsect2 id="CLIENTS">
 
642
    <refsect2 id="clients">
499
643
      <title>CLIENTS</title>
500
644
      <para>
501
645
        The server only gives out its stored data to clients which
502
 
        does have the OpenPGP key of the stored fingerprint.  This is
503
 
        guaranteed by the fact that the client sends its OpenPGP
504
 
        public key in the TLS handshake; this ensures it to be
505
 
        genuine.  The server computes the fingerprint of the key
506
 
        itself and looks up the fingerprint in its list of
507
 
        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
508
652
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
509
653
        <manvolnum>5</manvolnum></citerefentry>)
510
654
        <emphasis>must</emphasis> be made non-readable by anyone
511
 
        except the user running the server.
 
655
        except the user starting the server (usually root).
512
656
      </para>
513
657
      <para>
514
658
        As detailed in <xref linkend="checking"/>, the status of all
516
660
        compromised if they are gone for too long.
517
661
      </para>
518
662
      <para>
519
 
        If a client is compromised, its downtime should be duly noted
520
 
        by the server which would therefore declare the client
521
 
        invalid.  But if the server was ever restarted, it would
522
 
        re-read its client list from its configuration file and again
523
 
        regard all clients therein as valid, and hence eligible to
524
 
        receive their passwords.  Therefore, be careful when
525
 
        restarting servers if it is suspected that a client has, in
526
 
        fact, been compromised by parties who may now be running a
527
 
        fake Mandos client with the keys from the non-encrypted
528
 
        initial RAM image of the client host.  What should be done in
529
 
        that case (if restarting the server program really is
530
 
        necessary) is to stop the server program, edit the
531
 
        configuration file to omit any suspect clients, and restart
532
 
        the server program.
533
 
      </para>
534
 
      <para>
535
663
        For more details on client-side security, see
536
 
        <citerefentry><refentrytitle>password-request</refentrytitle>
 
664
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
537
665
        <manvolnum>8mandos</manvolnum></citerefentry>.
538
666
      </para>
539
667
    </refsect2>
540
668
  </refsect1>
541
 
 
 
669
  
542
670
  <refsect1 id="see_also">
543
671
    <title>SEE ALSO</title>
544
672
    <para>
545
 
      <citerefentry>
546
 
        <refentrytitle>mandos-clients.conf</refentrytitle>
547
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
548
 
        <refentrytitle>mandos.conf</refentrytitle>
549
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
550
 
        <refentrytitle>password-request</refentrytitle>
551
 
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
552
 
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
553
 
      </citerefentry>
 
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>
554
683
    </para>
555
684
    <variablelist>
556
685
      <varlistentry>
577
706
      </varlistentry>
578
707
      <varlistentry>
579
708
        <term>
580
 
          <ulink url="http://www.gnu.org/software/gnutls/"
581
 
          >GnuTLS</ulink>
 
709
          <ulink url="https://gnutls.org/">GnuTLS</ulink>
582
710
        </term>
583
711
      <listitem>
584
712
        <para>
585
713
          GnuTLS is the library this server uses to implement TLS for
586
714
          communicating securely with the client, and at the same time
587
 
          confidently get the client’s public OpenPGP key.
 
715
          confidently get the client’s public key.
588
716
        </para>
589
717
      </listitem>
590
718
      </varlistentry>
622
750
      </varlistentry>
623
751
      <varlistentry>
624
752
        <term>
625
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
626
 
          Protocol Version 1.1</citetitle>
 
753
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
 
754
          Protocol Version 1.2</citetitle>
627
755
        </term>
628
756
      <listitem>
629
757
        <para>
630
 
          TLS 1.1 is the protocol implemented by GnuTLS.
 
758
          TLS 1.2 is the protocol implemented by GnuTLS.
631
759
        </para>
632
760
      </listitem>
633
761
      </varlistentry>
643
771
      </varlistentry>
644
772
      <varlistentry>
645
773
        <term>
646
 
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
647
 
          Security</citetitle>
648
 
        </term>
649
 
      <listitem>
650
 
        <para>
651
 
          This is implemented by GnuTLS and used by this server so
652
 
          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.
653
796
        </para>
654
797
      </listitem>
655
798
      </varlistentry>