/mandos/trunk

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/trunk

« back to all changes in this revision

Viewing changes to mandos.xml

  • Committer: Teddy Hogeborn
  • Date: 2008-08-22 00:16:20 UTC
  • mfrom: (24.1.57 mandos)
  • Revision ID: teddy@fukt.bsnet.se-20080822001620-vxpn1evy0t0kyvj0
* clients.conf ([DEFAULT]/checker): Update to new default value.

* mandos (Client.start_checker): Bug fix: OSError, not
                                 subprocess.OSError.
  (main): Use "fping -q -- %(host)s" instead of "fping -q --
          %%(host)s" as default value for "checker".  Always redirect
          stdin to be from /dev/null, even if in debug mode.

* mandos-clients.conf.xml (DESCRIPTION): Improved wording and refer to
                                         the EXPANSION section.
  (OPTIONS): Added synopsis and improved wording for "checker",
             "fingerprint", and "secret".  Refer to the RUNTIME
             EXPANSION section for the "checker" option.
  (EXAMPLE): Update to new default value for "checker".

* mandos-keygen (trap): Split lines and add "set +e".

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
<?xml version="1.0" encoding="UTF-8"?>
2
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
3
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
 
4
<!ENTITY VERSION "1.0">
4
5
<!ENTITY COMMANDNAME "mandos">
5
 
<!ENTITY TIMESTAMP "2019-07-24">
6
 
<!ENTITY % common SYSTEM "common.ent">
7
 
%common;
8
6
]>
9
7
 
10
8
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
11
 
   <refentryinfo>
12
 
    <title>Mandos Manual</title>
 
9
  <refentryinfo>
 
10
    <title>&COMMANDNAME;</title>
13
11
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
14
 
    <productname>Mandos</productname>
15
 
    <productnumber>&version;</productnumber>
16
 
    <date>&TIMESTAMP;</date>
 
12
    <productname>&COMMANDNAME;</productname>
 
13
    <productnumber>&VERSION;</productnumber>
17
14
    <authorgroup>
18
15
      <author>
19
16
        <firstname>Björn</firstname>
20
17
        <surname>Påhlsson</surname>
21
18
        <address>
22
 
          <email>belorn@recompile.se</email>
 
19
          <email>belorn@fukt.bsnet.se</email>
23
20
        </address>
24
21
      </author>
25
22
      <author>
26
23
        <firstname>Teddy</firstname>
27
24
        <surname>Hogeborn</surname>
28
25
        <address>
29
 
          <email>teddy@recompile.se</email>
 
26
          <email>teddy@fukt.bsnet.se</email>
30
27
        </address>
31
28
      </author>
32
29
    </authorgroup>
33
30
    <copyright>
34
31
      <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>
46
32
      <holder>Teddy Hogeborn</holder>
47
33
      <holder>Björn Påhlsson</holder>
48
34
    </copyright>
49
 
    <xi:include href="legalnotice.xml"/>
 
35
    <legalnotice>
 
36
      <para>
 
37
        This manual page is free software: you can redistribute it
 
38
        and/or modify it under the terms of the GNU General Public
 
39
        License as published by the Free Software Foundation,
 
40
        either version 3 of the License, or (at your option) any
 
41
        later version.
 
42
      </para>
 
43
 
 
44
      <para>
 
45
        This manual page is distributed in the hope that it will
 
46
        be useful, but WITHOUT ANY WARRANTY; without even the
 
47
        implied warranty of MERCHANTABILITY or FITNESS FOR A
 
48
        PARTICULAR PURPOSE.  See the GNU General Public License
 
49
        for more details.
 
50
      </para>
 
51
 
 
52
      <para>
 
53
        You should have received a copy of the GNU General Public
 
54
        License along with this program; If not, see
 
55
        <ulink url="http://www.gnu.org/licenses/"/>.
 
56
      </para>
 
57
    </legalnotice>
50
58
  </refentryinfo>
51
 
  
 
59
 
52
60
  <refmeta>
53
61
    <refentrytitle>&COMMANDNAME;</refentrytitle>
54
62
    <manvolnum>8</manvolnum>
57
65
  <refnamediv>
58
66
    <refname><command>&COMMANDNAME;</command></refname>
59
67
    <refpurpose>
60
 
      Gives encrypted passwords to authenticated Mandos clients
 
68
      Sends encrypted passwords to authenticated Mandos clients
61
69
    </refpurpose>
62
70
  </refnamediv>
63
 
  
 
71
 
64
72
  <refsynopsisdiv>
65
73
    <cmdsynopsis>
66
74
      <command>&COMMANDNAME;</command>
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>
 
75
      <arg>--interface<arg choice="plain">IF</arg></arg>
 
76
      <arg>--address<arg choice="plain">ADDRESS</arg></arg>
 
77
      <arg>--port<arg choice="plain">PORT</arg></arg>
 
78
      <arg>--priority<arg choice="plain">PRIORITY</arg></arg>
 
79
      <arg>--servicename<arg choice="plain">NAME</arg></arg>
 
80
      <arg>--configdir<arg choice="plain">DIRECTORY</arg></arg>
 
81
      <arg>--debug</arg>
 
82
    </cmdsynopsis>
 
83
    <cmdsynopsis>
 
84
      <command>&COMMANDNAME;</command>
 
85
      <arg>-i<arg choice="plain">IF</arg></arg>
 
86
      <arg>-a<arg choice="plain">ADDRESS</arg></arg>
 
87
      <arg>-p<arg choice="plain">PORT</arg></arg>
 
88
      <arg>--priority<arg choice="plain">PRIORITY</arg></arg>
 
89
      <arg>--servicename<arg choice="plain">NAME</arg></arg>
 
90
      <arg>--configdir<arg choice="plain">DIRECTORY</arg></arg>
 
91
      <arg>--debug</arg>
117
92
    </cmdsynopsis>
118
93
    <cmdsynopsis>
119
94
      <command>&COMMANDNAME;</command>
120
95
      <group choice="req">
121
 
        <arg choice="plain"><option>--help</option></arg>
122
 
        <arg choice="plain"><option>-h</option></arg>
 
96
        <arg choice="plain">-h</arg>
 
97
        <arg choice="plain">--help</arg>
123
98
      </group>
124
99
    </cmdsynopsis>
125
100
    <cmdsynopsis>
126
101
      <command>&COMMANDNAME;</command>
127
 
      <arg choice="plain"><option>--version</option></arg>
 
102
      <arg choice="plain">--version</arg>
128
103
    </cmdsynopsis>
129
104
    <cmdsynopsis>
130
105
      <command>&COMMANDNAME;</command>
131
 
      <arg choice="plain"><option>--check</option></arg>
 
106
      <arg choice="plain">--check</arg>
132
107
    </cmdsynopsis>
133
108
  </refsynopsisdiv>
134
 
  
 
109
 
135
110
  <refsect1 id="description">
136
111
    <title>DESCRIPTION</title>
137
112
    <para>
138
113
      <command>&COMMANDNAME;</command> is a server daemon which
139
114
      handles incoming request for passwords for a pre-defined list of
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.
 
115
      client host computers.  The Mandos server uses Zeroconf to
 
116
      announce itself on the local network, and uses TLS to
 
117
      communicate securely with and to authenticate the clients.  The
 
118
      Mandos server uses IPv6 to allow Mandos clients to use IPv6
 
119
      link-local addresses, since the clients will probably not have
 
120
      any other addresses configured (see <xref linkend="overview"/>).
 
121
      Any authenticated client is then given the stored pre-encrypted
 
122
      password for that specific client.
150
123
    </para>
 
124
 
151
125
  </refsect1>
152
126
  
153
127
  <refsect1 id="purpose">
154
128
    <title>PURPOSE</title>
 
129
 
155
130
    <para>
156
131
      The purpose of this is to enable <emphasis>remote and unattended
157
132
      rebooting</emphasis> of client host computer with an
158
133
      <emphasis>encrypted root file system</emphasis>.  See <xref
159
134
      linkend="overview"/> for details.
160
135
    </para>
 
136
 
161
137
  </refsect1>
162
138
  
163
139
  <refsect1 id="options">
164
140
    <title>OPTIONS</title>
 
141
 
165
142
    <variablelist>
166
143
      <varlistentry>
167
 
        <term><option>--help</option></term>
168
 
        <term><option>-h</option></term>
 
144
        <term><literal>-h</literal>, <literal>--help</literal></term>
169
145
        <listitem>
170
146
          <para>
171
147
            Show a help message and exit
172
148
          </para>
173
149
        </listitem>
174
150
      </varlistentry>
175
 
      
 
151
 
176
152
      <varlistentry>
177
 
        <term><option>--interface</option>
178
 
        <replaceable>NAME</replaceable></term>
179
 
        <term><option>-i</option>
180
 
        <replaceable>NAME</replaceable></term>
 
153
        <term><literal>-i</literal>, <literal>--interface <replaceable>
 
154
        IF</replaceable></literal></term>
181
155
        <listitem>
182
156
          <xi:include href="mandos-options.xml" xpointer="interface"/>
183
157
        </listitem>
184
158
      </varlistentry>
185
 
      
 
159
 
186
160
      <varlistentry>
187
 
        <term><option>--address
188
 
        <replaceable>ADDRESS</replaceable></option></term>
189
 
        <term><option>-a
190
 
        <replaceable>ADDRESS</replaceable></option></term>
 
161
        <term><literal>-a</literal>, <literal>--address <replaceable>
 
162
        ADDRESS</replaceable></literal></term>
191
163
        <listitem>
192
164
          <xi:include href="mandos-options.xml" xpointer="address"/>
193
165
        </listitem>
194
166
      </varlistentry>
195
 
      
 
167
 
196
168
      <varlistentry>
197
 
        <term><option>--port
198
 
        <replaceable>PORT</replaceable></option></term>
199
 
        <term><option>-p
200
 
        <replaceable>PORT</replaceable></option></term>
 
169
        <term><literal>-p</literal>, <literal>--port <replaceable>
 
170
        PORT</replaceable></literal></term>
201
171
        <listitem>
202
172
          <xi:include href="mandos-options.xml" xpointer="port"/>
203
173
        </listitem>
204
174
      </varlistentry>
205
 
      
 
175
 
206
176
      <varlistentry>
207
 
        <term><option>--check</option></term>
 
177
        <term><literal>--check</literal></term>
208
178
        <listitem>
209
179
          <para>
210
180
            Run the server’s self-tests.  This includes any unit
212
182
          </para>
213
183
        </listitem>
214
184
      </varlistentry>
215
 
      
 
185
 
216
186
      <varlistentry>
217
 
        <term><option>--debug</option></term>
 
187
        <term><literal>--debug</literal></term>
218
188
        <listitem>
219
189
          <xi:include href="mandos-options.xml" xpointer="debug"/>
220
190
        </listitem>
221
191
      </varlistentry>
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>
 
192
 
 
193
      <varlistentry>
 
194
        <term><literal>--priority <replaceable>
 
195
        PRIORITY</replaceable></literal></term>
244
196
        <listitem>
245
197
          <xi:include href="mandos-options.xml" xpointer="priority"/>
246
198
        </listitem>
247
199
      </varlistentry>
248
 
      
 
200
 
249
201
      <varlistentry>
250
 
        <term><option>--servicename
251
 
        <replaceable>NAME</replaceable></option></term>
 
202
        <term><literal>--servicename <replaceable>NAME</replaceable>
 
203
        </literal></term>
252
204
        <listitem>
253
205
          <xi:include href="mandos-options.xml"
254
206
                      xpointer="servicename"/>
255
207
        </listitem>
256
208
      </varlistentry>
257
 
      
 
209
 
258
210
      <varlistentry>
259
 
        <term><option>--configdir
260
 
        <replaceable>DIRECTORY</replaceable></option></term>
 
211
        <term><literal>--configdir <replaceable>DIR</replaceable>
 
212
        </literal></term>
261
213
        <listitem>
262
214
          <para>
263
215
            Directory to search for configuration files.  Default is
269
221
          </para>
270
222
        </listitem>
271
223
      </varlistentry>
272
 
      
 
224
 
273
225
      <varlistentry>
274
 
        <term><option>--version</option></term>
 
226
        <term><literal>--version</literal></term>
275
227
        <listitem>
276
228
          <para>
277
229
            Prints the program version and exit.
278
230
          </para>
279
231
        </listitem>
280
232
      </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
 
      
340
233
    </variablelist>
341
234
  </refsect1>
342
 
  
 
235
 
343
236
  <refsect1 id="overview">
344
237
    <title>OVERVIEW</title>
345
238
    <xi:include href="overview.xml"/>
346
239
    <para>
347
240
      This program is the server part.  It is a normal server program
348
241
      and will run in a normal system environment, not in an initial
349
 
      <acronym>RAM</acronym> disk environment.
 
242
      RAM disk environment.
350
243
    </para>
351
244
  </refsect1>
352
 
  
 
245
 
353
246
  <refsect1 id="protocol">
354
247
    <title>NETWORK PROTOCOL</title>
355
248
    <para>
362
255
      start a TLS protocol handshake with a slight quirk: the Mandos
363
256
      server program acts as a TLS <quote>client</quote> while the
364
257
      connecting Mandos client acts as a TLS <quote>server</quote>.
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.
 
258
      The Mandos client must supply an OpenPGP certificate, and the
 
259
      fingerprint of this certificate is used by the Mandos server to
 
260
      look up (in a list read from <filename>clients.conf</filename>
 
261
      at start time) which binary blob to give the client.  No other
 
262
      authentication or authorization is done by the server.
370
263
    </para>
371
264
    <table>
372
265
      <title>Mandos Protocol (Version 1)</title><tgroup cols="3"><thead>
392
285
        </emphasis></entry>
393
286
      </row>
394
287
      <row>
395
 
        <entry>Public key (part of TLS handshake)</entry>
 
288
        <entry>OpenPGP public key (part of TLS handshake)</entry>
396
289
        <entry>-><!-- &rarr; --></entry>
397
290
      </row>
398
291
      <row>
407
300
      </row>
408
301
    </tbody></tgroup></table>
409
302
  </refsect1>
410
 
  
 
303
 
411
304
  <refsect1 id="checking">
412
305
    <title>CHECKING</title>
413
306
    <para>
414
307
      The server will, by default, continually check that the clients
415
308
      are still up.  If a client has not been confirmed as being up
416
309
      for some time, the client is assumed to be compromised and is no
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>
 
310
      longer eligible to receive the encrypted password.  The timeout,
 
311
      checker program, and interval between checks can be configured
 
312
      both globally and per client; see <citerefentry>
 
313
      <refentrytitle>mandos-clients.conf</refentrytitle>
422
314
      <manvolnum>5</manvolnum></citerefentry>.
423
315
    </para>
424
316
  </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>
433
 
      <refentrytitle>mandos-clients.conf</refentrytitle>
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
 
    
444
 
  </refsect1>
445
 
  
 
317
 
446
318
  <refsect1 id="logging">
447
319
    <title>LOGGING</title>
448
320
    <para>
449
321
      The server will send log message with various severity levels to
450
 
      <filename class="devicefile">/dev/log</filename>.  With the
 
322
      <filename>/dev/log</filename>.  With the
451
323
      <option>--debug</option> option, it will log even more messages,
452
324
      and also show them on the console.
453
325
    </para>
454
326
  </refsect1>
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
 
  
 
327
 
478
328
  <refsect1 id="exit_status">
479
329
    <title>EXIT STATUS</title>
480
330
    <para>
482
332
      critical error is encountered.
483
333
    </para>
484
334
  </refsect1>
485
 
  
 
335
 
486
336
  <refsect1 id="environment">
487
337
    <title>ENVIRONMENT</title>
488
338
    <variablelist>
489
339
      <varlistentry>
490
 
        <term><envar>PATH</envar></term>
 
340
        <term><varname>PATH</varname></term>
491
341
        <listitem>
492
342
          <para>
493
343
            To start the configured checker (see <xref
502
352
      </varlistentry>
503
353
    </variablelist>
504
354
  </refsect1>
505
 
  
506
 
  <refsect1 id="files">
 
355
 
 
356
  <refsect1 id="file">
507
357
    <title>FILES</title>
508
358
    <para>
509
359
      Use the <option>--configdir</option> option to change where
532
382
        </listitem>
533
383
      </varlistentry>
534
384
      <varlistentry>
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>
 
385
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
 
386
        <listitem>
 
387
          <para>
 
388
            The file containing the process id of
 
389
            <command>&COMMANDNAME;</command>.
 
390
          </para>
 
391
        </listitem>
 
392
      </varlistentry>
 
393
      <varlistentry>
 
394
        <term><filename>/dev/log</filename></term>
560
395
        <listitem>
561
396
          <para>
562
397
            The Unix domain socket to where local syslog messages are
585
420
      backtrace.  This could be considered a feature.
586
421
    </para>
587
422
    <para>
 
423
      Currently, if a client is declared <quote>invalid</quote> due to
 
424
      having timed out, the server does not record this fact onto
 
425
      permanent storage.  This has some security implications, see
 
426
      <xref linkend="CLIENTS"/>.
 
427
    </para>
 
428
    <para>
 
429
      There is currently no way of querying the server of the current
 
430
      status of clients, other than analyzing its <systemitem
 
431
      class="service">syslog</systemitem> output.
 
432
    </para>
 
433
    <para>
588
434
      There is no fine-grained control over logging and debug output.
589
435
    </para>
590
 
    <xi:include href="bugs.xml"/>
 
436
    <para>
 
437
      Debug mode is conflated with running in the foreground.
 
438
    </para>
 
439
    <para>
 
440
      The console log messages does not show a timestamp.
 
441
    </para>
591
442
  </refsect1>
592
443
  
593
444
  <refsect1 id="example">
597
448
        Normal invocation needs no options:
598
449
      </para>
599
450
      <para>
600
 
        <userinput>&COMMANDNAME;</userinput>
 
451
        <userinput>mandos</userinput>
601
452
      </para>
602
453
    </informalexample>
603
454
    <informalexample>
604
455
      <para>
605
456
        Run the server in debug mode, read configuration files from
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:
 
457
        the <filename>~/mandos</filename> directory, and use the
 
458
        Zeroconf service name <quote>Test</quote> to not collide with
 
459
        any other official Mandos server on this host:
609
460
      </para>
610
461
      <para>
611
462
 
612
463
<!-- do not wrap this line -->
613
 
<userinput>&COMMANDNAME; --debug --configdir ~/mandos --servicename Test</userinput>
 
464
<userinput>mandos --debug --configdir ~/mandos --servicename Test</userinput>
614
465
 
615
466
      </para>
616
467
    </informalexample>
622
473
      <para>
623
474
 
624
475
<!-- do not wrap this line -->
625
 
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
 
476
<userinput>mandos --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
626
477
 
627
478
      </para>
628
479
    </informalexample>
629
480
  </refsect1>
630
 
  
 
481
 
631
482
  <refsect1 id="security">
632
483
    <title>SECURITY</title>
633
 
    <refsect2 id="server">
 
484
    <refsect2 id="SERVER">
634
485
      <title>SERVER</title>
635
486
      <para>
636
487
        Running this <command>&COMMANDNAME;</command> server program
637
488
        should not in itself present any security risk to the host
638
 
        computer running it.  The program switches to a non-root user
639
 
        soon after startup.
 
489
        computer running it.  The program does not need any special
 
490
        privileges to run, and is designed to run as a non-root user.
640
491
      </para>
641
492
    </refsect2>
642
 
    <refsect2 id="clients">
 
493
    <refsect2 id="CLIENTS">
643
494
      <title>CLIENTS</title>
644
495
      <para>
645
496
        The server only gives out its stored data to clients which
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
 
497
        does have the OpenPGP key of the stored fingerprint.  This is
 
498
        guaranteed by the fact that the client sends its OpenPGP
 
499
        public key in the TLS handshake; this ensures it to be
 
500
        genuine.  The server computes the fingerprint of the key
 
501
        itself and looks up the fingerprint in its list of
 
502
        clients. The <filename>clients.conf</filename> file (see
652
503
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
653
504
        <manvolnum>5</manvolnum></citerefentry>)
654
505
        <emphasis>must</emphasis> be made non-readable by anyone
655
 
        except the user starting the server (usually root).
 
506
        except the user running the server.
656
507
      </para>
657
508
      <para>
658
509
        As detailed in <xref linkend="checking"/>, the status of all
660
511
        compromised if they are gone for too long.
661
512
      </para>
662
513
      <para>
 
514
        If a client is compromised, its downtime should be duly noted
 
515
        by the server which would therefore declare the client
 
516
        invalid.  But if the server was ever restarted, it would
 
517
        re-read its client list from its configuration file and again
 
518
        regard all clients therein as valid, and hence eligible to
 
519
        receive their passwords.  Therefore, be careful when
 
520
        restarting servers if it is suspected that a client has, in
 
521
        fact, been compromised by parties who may now be running a
 
522
        fake Mandos client with the keys from the non-encrypted
 
523
        initial RAM image of the client host.  What should be done in
 
524
        that case (if restarting the server program really is
 
525
        necessary) is to stop the server program, edit the
 
526
        configuration file to omit any suspect clients, and restart
 
527
        the server program.
 
528
      </para>
 
529
      <para>
663
530
        For more details on client-side security, see
664
 
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
531
        <citerefentry><refentrytitle>password-request</refentrytitle>
665
532
        <manvolnum>8mandos</manvolnum></citerefentry>.
666
533
      </para>
667
534
    </refsect2>
668
535
  </refsect1>
669
 
  
 
536
 
670
537
  <refsect1 id="see_also">
671
538
    <title>SEE ALSO</title>
672
539
    <para>
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>
 
540
      <citerefentry>
 
541
        <refentrytitle>mandos.conf</refentrytitle>
 
542
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
 
543
        <refentrytitle>mandos-clients.conf</refentrytitle>
 
544
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
 
545
        <refentrytitle>password-request</refentrytitle>
 
546
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
 
547
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
 
548
      </citerefentry>
683
549
    </para>
684
550
    <variablelist>
685
551
      <varlistentry>
695
561
      </varlistentry>
696
562
      <varlistentry>
697
563
        <term>
698
 
          <ulink url="https://www.avahi.org/">Avahi</ulink>
 
564
          <ulink url="http://www.avahi.org/">Avahi</ulink>
699
565
        </term>
700
566
      <listitem>
701
567
        <para>
706
572
      </varlistentry>
707
573
      <varlistentry>
708
574
        <term>
709
 
          <ulink url="https://gnutls.org/">GnuTLS</ulink>
 
575
          <ulink
 
576
              url="http://www.gnu.org/software/gnutls/">GnuTLS</ulink>
710
577
        </term>
711
578
      <listitem>
712
579
        <para>
713
580
          GnuTLS is the library this server uses to implement TLS for
714
581
          communicating securely with the client, and at the same time
715
 
          confidently get the client’s public key.
 
582
          confidently get the client’s public OpenPGP key.
716
583
        </para>
717
584
      </listitem>
718
585
      </varlistentry>
719
586
      <varlistentry>
720
587
        <term>
721
 
          RFC 4291: <citetitle>IP Version 6 Addressing
722
 
          Architecture</citetitle>
 
588
          <citation>RFC 4291: <citetitle>IP Version 6 Addressing
 
589
          Architecture</citetitle>, section 2.5.6, Link-Local IPv6
 
590
          Unicast Addresses</citation>
723
591
        </term>
724
592
        <listitem>
725
 
          <variablelist>
726
 
            <varlistentry>
727
 
              <term>Section 2.2: <citetitle>Text Representation of
728
 
              Addresses</citetitle></term>
729
 
              <listitem><para/></listitem>
730
 
            </varlistentry>
731
 
            <varlistentry>
732
 
              <term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
733
 
              Address</citetitle></term>
734
 
              <listitem><para/></listitem>
735
 
            </varlistentry>
736
 
            <varlistentry>
737
 
            <term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
738
 
            Addresses</citetitle></term>
739
 
            <listitem>
740
 
              <para>
741
 
                The clients use IPv6 link-local addresses, which are
742
 
                immediately usable since a link-local addresses is
743
 
                automatically assigned to a network interfaces when it
744
 
                is brought up.
745
 
              </para>
746
 
            </listitem>
747
 
            </varlistentry>
748
 
          </variablelist>
 
593
          <para>
 
594
            The clients use IPv6 link-local addresses, which are
 
595
            immediately usable since a link-local addresses is
 
596
            automatically assigned to a network interfaces when it is
 
597
            brought up.
 
598
          </para>
749
599
        </listitem>
750
600
      </varlistentry>
751
601
      <varlistentry>
752
602
        <term>
753
 
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
754
 
          Protocol Version 1.2</citetitle>
 
603
          <citation>RFC 4346: <citetitle>The Transport Layer Security
 
604
          (TLS) Protocol Version 1.1</citetitle></citation>
755
605
        </term>
756
606
      <listitem>
757
607
        <para>
758
 
          TLS 1.2 is the protocol implemented by GnuTLS.
 
608
          TLS 1.1 is the protocol implemented by GnuTLS.
759
609
        </para>
760
610
      </listitem>
761
611
      </varlistentry>
762
612
      <varlistentry>
763
613
        <term>
764
 
          RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
 
614
          <citation>RFC 4880: <citetitle>OpenPGP Message
 
615
          Format</citetitle></citation>
765
616
        </term>
766
617
      <listitem>
767
618
        <para>
771
622
      </varlistentry>
772
623
      <varlistentry>
773
624
        <term>
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.
 
625
          <citation>RFC 5081: <citetitle>Using OpenPGP Keys for
 
626
          Transport Layer Security</citetitle></citation>
 
627
        </term>
 
628
      <listitem>
 
629
        <para>
 
630
          This is implemented by GnuTLS and used by this server so
 
631
          that OpenPGP keys can be used.
796
632
        </para>
797
633
      </listitem>
798
634
      </varlistentry>
799
635
    </variablelist>
800
636
  </refsect1>
801
637
</refentry>
802
 
<!-- Local Variables: -->
803
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
804
 
<!-- time-stamp-end: "[\"']>" -->
805
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
806
 
<!-- End: -->