/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-30 11:31:37 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080830113137-v0inyj0limprzfwn
* mandos-options.xml (priority): Added <acronym> tags.

* mandos.xml (NAME): Improved wording.

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">
4
5
<!ENTITY COMMANDNAME "mandos">
5
 
<!ENTITY TIMESTAMP "2019-07-24">
6
 
<!ENTITY % common SYSTEM "common.ent">
7
 
%common;
 
6
<!ENTITY TIMESTAMP "2008-08-30">
8
7
]>
9
8
 
10
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
11
 
   <refentryinfo>
 
10
  <refentryinfo>
12
11
    <title>Mandos Manual</title>
13
12
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
14
13
    <productname>Mandos</productname>
15
 
    <productnumber>&version;</productnumber>
 
14
    <productnumber>&VERSION;</productnumber>
16
15
    <date>&TIMESTAMP;</date>
17
16
    <authorgroup>
18
17
      <author>
19
18
        <firstname>Björn</firstname>
20
19
        <surname>Påhlsson</surname>
21
20
        <address>
22
 
          <email>belorn@recompile.se</email>
 
21
          <email>belorn@fukt.bsnet.se</email>
23
22
        </address>
24
23
      </author>
25
24
      <author>
26
25
        <firstname>Teddy</firstname>
27
26
        <surname>Hogeborn</surname>
28
27
        <address>
29
 
          <email>teddy@recompile.se</email>
 
28
          <email>teddy@fukt.bsnet.se</email>
30
29
        </address>
31
30
      </author>
32
31
    </authorgroup>
33
32
    <copyright>
34
33
      <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
34
      <holder>Teddy Hogeborn</holder>
47
35
      <holder>Björn Påhlsson</holder>
48
36
    </copyright>
49
 
    <xi:include href="legalnotice.xml"/>
 
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>
50
60
  </refentryinfo>
51
 
  
 
61
 
52
62
  <refmeta>
53
63
    <refentrytitle>&COMMANDNAME;</refentrytitle>
54
64
    <manvolnum>8</manvolnum>
60
70
      Gives encrypted passwords to authenticated Mandos clients
61
71
    </refpurpose>
62
72
  </refnamediv>
63
 
  
 
73
 
64
74
  <refsynopsisdiv>
65
75
    <cmdsynopsis>
66
76
      <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>
 
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>
117
94
    </cmdsynopsis>
118
95
    <cmdsynopsis>
119
96
      <command>&COMMANDNAME;</command>
120
97
      <group choice="req">
121
 
        <arg choice="plain"><option>--help</option></arg>
122
 
        <arg choice="plain"><option>-h</option></arg>
 
98
        <arg choice="plain">-h</arg>
 
99
        <arg choice="plain">--help</arg>
123
100
      </group>
124
101
    </cmdsynopsis>
125
102
    <cmdsynopsis>
126
103
      <command>&COMMANDNAME;</command>
127
 
      <arg choice="plain"><option>--version</option></arg>
 
104
      <arg choice="plain">--version</arg>
128
105
    </cmdsynopsis>
129
106
    <cmdsynopsis>
130
107
      <command>&COMMANDNAME;</command>
131
 
      <arg choice="plain"><option>--check</option></arg>
 
108
      <arg choice="plain">--check</arg>
132
109
    </cmdsynopsis>
133
110
  </refsynopsisdiv>
134
 
  
 
111
 
135
112
  <refsect1 id="description">
136
113
    <title>DESCRIPTION</title>
137
114
    <para>
138
115
      <command>&COMMANDNAME;</command> is a server daemon which
139
116
      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.
 
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.
150
125
    </para>
 
126
 
151
127
  </refsect1>
152
128
  
153
129
  <refsect1 id="purpose">
154
130
    <title>PURPOSE</title>
 
131
 
155
132
    <para>
156
133
      The purpose of this is to enable <emphasis>remote and unattended
157
134
      rebooting</emphasis> of client host computer with an
158
135
      <emphasis>encrypted root file system</emphasis>.  See <xref
159
136
      linkend="overview"/> for details.
160
137
    </para>
 
138
 
161
139
  </refsect1>
162
140
  
163
141
  <refsect1 id="options">
164
142
    <title>OPTIONS</title>
 
143
 
165
144
    <variablelist>
166
145
      <varlistentry>
 
146
        <term><option>-h</option></term>
167
147
        <term><option>--help</option></term>
168
 
        <term><option>-h</option></term>
169
148
        <listitem>
170
149
          <para>
171
150
            Show a help message and exit
172
151
          </para>
173
152
        </listitem>
174
153
      </varlistentry>
175
 
      
 
154
 
176
155
      <varlistentry>
 
156
        <term><option>-i</option>
 
157
        <replaceable>NAME</replaceable></term>
177
158
        <term><option>--interface</option>
178
159
        <replaceable>NAME</replaceable></term>
179
 
        <term><option>-i</option>
180
 
        <replaceable>NAME</replaceable></term>
181
160
        <listitem>
182
161
          <xi:include href="mandos-options.xml" xpointer="interface"/>
183
162
        </listitem>
184
163
      </varlistentry>
185
 
      
 
164
 
186
165
      <varlistentry>
187
 
        <term><option>--address
188
 
        <replaceable>ADDRESS</replaceable></option></term>
189
 
        <term><option>-a
190
 
        <replaceable>ADDRESS</replaceable></option></term>
 
166
        <term><literal>-a</literal>, <literal>--address <replaceable>
 
167
        ADDRESS</replaceable></literal></term>
191
168
        <listitem>
192
169
          <xi:include href="mandos-options.xml" xpointer="address"/>
193
170
        </listitem>
194
171
      </varlistentry>
195
 
      
 
172
 
196
173
      <varlistentry>
197
 
        <term><option>--port
198
 
        <replaceable>PORT</replaceable></option></term>
199
 
        <term><option>-p
200
 
        <replaceable>PORT</replaceable></option></term>
 
174
        <term><literal>-p</literal>, <literal>--port <replaceable>
 
175
        PORT</replaceable></literal></term>
201
176
        <listitem>
202
177
          <xi:include href="mandos-options.xml" xpointer="port"/>
203
178
        </listitem>
204
179
      </varlistentry>
205
 
      
 
180
 
206
181
      <varlistentry>
207
 
        <term><option>--check</option></term>
 
182
        <term><literal>--check</literal></term>
208
183
        <listitem>
209
184
          <para>
210
185
            Run the server’s self-tests.  This includes any unit
212
187
          </para>
213
188
        </listitem>
214
189
      </varlistentry>
215
 
      
 
190
 
216
191
      <varlistentry>
217
 
        <term><option>--debug</option></term>
 
192
        <term><literal>--debug</literal></term>
218
193
        <listitem>
219
194
          <xi:include href="mandos-options.xml" xpointer="debug"/>
220
195
        </listitem>
221
196
      </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>
 
197
 
 
198
      <varlistentry>
 
199
        <term><literal>--priority <replaceable>
 
200
        PRIORITY</replaceable></literal></term>
244
201
        <listitem>
245
202
          <xi:include href="mandos-options.xml" xpointer="priority"/>
246
203
        </listitem>
247
204
      </varlistentry>
248
 
      
 
205
 
249
206
      <varlistentry>
250
 
        <term><option>--servicename
251
 
        <replaceable>NAME</replaceable></option></term>
 
207
        <term><literal>--servicename <replaceable>NAME</replaceable>
 
208
        </literal></term>
252
209
        <listitem>
253
210
          <xi:include href="mandos-options.xml"
254
211
                      xpointer="servicename"/>
255
212
        </listitem>
256
213
      </varlistentry>
257
 
      
 
214
 
258
215
      <varlistentry>
259
 
        <term><option>--configdir
260
 
        <replaceable>DIRECTORY</replaceable></option></term>
 
216
        <term><literal>--configdir <replaceable>DIR</replaceable>
 
217
        </literal></term>
261
218
        <listitem>
262
219
          <para>
263
220
            Directory to search for configuration files.  Default is
269
226
          </para>
270
227
        </listitem>
271
228
      </varlistentry>
272
 
      
 
229
 
273
230
      <varlistentry>
274
 
        <term><option>--version</option></term>
 
231
        <term><literal>--version</literal></term>
275
232
        <listitem>
276
233
          <para>
277
234
            Prints the program version and exit.
278
235
          </para>
279
236
        </listitem>
280
237
      </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
238
    </variablelist>
341
239
  </refsect1>
342
 
  
 
240
 
343
241
  <refsect1 id="overview">
344
242
    <title>OVERVIEW</title>
345
243
    <xi:include href="overview.xml"/>
346
244
    <para>
347
245
      This program is the server part.  It is a normal server program
348
246
      and will run in a normal system environment, not in an initial
349
 
      <acronym>RAM</acronym> disk environment.
 
247
      RAM disk environment.
350
248
    </para>
351
249
  </refsect1>
352
 
  
 
250
 
353
251
  <refsect1 id="protocol">
354
252
    <title>NETWORK PROTOCOL</title>
355
253
    <para>
362
260
      start a TLS protocol handshake with a slight quirk: the Mandos
363
261
      server program acts as a TLS <quote>client</quote> while the
364
262
      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.
 
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.
370
268
    </para>
371
269
    <table>
372
270
      <title>Mandos Protocol (Version 1)</title><tgroup cols="3"><thead>
392
290
        </emphasis></entry>
393
291
      </row>
394
292
      <row>
395
 
        <entry>Public key (part of TLS handshake)</entry>
 
293
        <entry>OpenPGP public key (part of TLS handshake)</entry>
396
294
        <entry>-><!-- &rarr; --></entry>
397
295
      </row>
398
296
      <row>
407
305
      </row>
408
306
    </tbody></tgroup></table>
409
307
  </refsect1>
410
 
  
 
308
 
411
309
  <refsect1 id="checking">
412
310
    <title>CHECKING</title>
413
311
    <para>
414
312
      The server will, by default, continually check that the clients
415
313
      are still up.  If a client has not been confirmed as being up
416
314
      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>
 
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>
 
318
      <refentrytitle>mandos-clients.conf</refentrytitle>
422
319
      <manvolnum>5</manvolnum></citerefentry>.
423
320
    </para>
424
321
  </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
 
  
 
322
 
446
323
  <refsect1 id="logging">
447
324
    <title>LOGGING</title>
448
325
    <para>
449
326
      The server will send log message with various severity levels to
450
 
      <filename class="devicefile">/dev/log</filename>.  With the
 
327
      <filename>/dev/log</filename>.  With the
451
328
      <option>--debug</option> option, it will log even more messages,
452
329
      and also show them on the console.
453
330
    </para>
454
331
  </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
 
  
 
332
 
478
333
  <refsect1 id="exit_status">
479
334
    <title>EXIT STATUS</title>
480
335
    <para>
482
337
      critical error is encountered.
483
338
    </para>
484
339
  </refsect1>
485
 
  
 
340
 
486
341
  <refsect1 id="environment">
487
342
    <title>ENVIRONMENT</title>
488
343
    <variablelist>
489
344
      <varlistentry>
490
 
        <term><envar>PATH</envar></term>
 
345
        <term><varname>PATH</varname></term>
491
346
        <listitem>
492
347
          <para>
493
348
            To start the configured checker (see <xref
502
357
      </varlistentry>
503
358
    </variablelist>
504
359
  </refsect1>
505
 
  
506
 
  <refsect1 id="files">
 
360
 
 
361
  <refsect1 id="file">
507
362
    <title>FILES</title>
508
363
    <para>
509
364
      Use the <option>--configdir</option> option to change where
532
387
        </listitem>
533
388
      </varlistentry>
534
389
      <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>
 
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>
560
400
        <listitem>
561
401
          <para>
562
402
            The Unix domain socket to where local syslog messages are
585
425
      backtrace.  This could be considered a feature.
586
426
    </para>
587
427
    <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>
588
439
      There is no fine-grained control over logging and debug output.
589
440
    </para>
590
 
    <xi:include href="bugs.xml"/>
 
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>
591
447
  </refsect1>
592
448
  
593
449
  <refsect1 id="example">
603
459
    <informalexample>
604
460
      <para>
605
461
        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:
 
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:
609
465
      </para>
610
466
      <para>
611
467
 
627
483
      </para>
628
484
    </informalexample>
629
485
  </refsect1>
630
 
  
 
486
 
631
487
  <refsect1 id="security">
632
488
    <title>SECURITY</title>
633
 
    <refsect2 id="server">
 
489
    <refsect2 id="SERVER">
634
490
      <title>SERVER</title>
635
491
      <para>
636
492
        Running this <command>&COMMANDNAME;</command> server program
637
493
        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.
 
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.
640
496
      </para>
641
497
    </refsect2>
642
 
    <refsect2 id="clients">
 
498
    <refsect2 id="CLIENTS">
643
499
      <title>CLIENTS</title>
644
500
      <para>
645
501
        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
 
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
652
508
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
653
509
        <manvolnum>5</manvolnum></citerefentry>)
654
510
        <emphasis>must</emphasis> be made non-readable by anyone
655
 
        except the user starting the server (usually root).
 
511
        except the user running the server.
656
512
      </para>
657
513
      <para>
658
514
        As detailed in <xref linkend="checking"/>, the status of all
660
516
        compromised if they are gone for too long.
661
517
      </para>
662
518
      <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>
663
535
        For more details on client-side security, see
664
 
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
536
        <citerefentry><refentrytitle>password-request</refentrytitle>
665
537
        <manvolnum>8mandos</manvolnum></citerefentry>.
666
538
      </para>
667
539
    </refsect2>
668
540
  </refsect1>
669
 
  
 
541
 
670
542
  <refsect1 id="see_also">
671
543
    <title>SEE ALSO</title>
672
544
    <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>
 
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>
683
554
    </para>
684
555
    <variablelist>
685
556
      <varlistentry>
695
566
      </varlistentry>
696
567
      <varlistentry>
697
568
        <term>
698
 
          <ulink url="https://www.avahi.org/">Avahi</ulink>
 
569
          <ulink url="http://www.avahi.org/">Avahi</ulink>
699
570
        </term>
700
571
      <listitem>
701
572
        <para>
706
577
      </varlistentry>
707
578
      <varlistentry>
708
579
        <term>
709
 
          <ulink url="https://gnutls.org/">GnuTLS</ulink>
 
580
          <ulink url="http://www.gnu.org/software/gnutls/"
 
581
          >GnuTLS</ulink>
710
582
        </term>
711
583
      <listitem>
712
584
        <para>
713
585
          GnuTLS is the library this server uses to implement TLS for
714
586
          communicating securely with the client, and at the same time
715
 
          confidently get the client’s public key.
 
587
          confidently get the client’s public OpenPGP key.
716
588
        </para>
717
589
      </listitem>
718
590
      </varlistentry>
750
622
      </varlistentry>
751
623
      <varlistentry>
752
624
        <term>
753
 
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
754
 
          Protocol Version 1.2</citetitle>
 
625
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
626
          Protocol Version 1.1</citetitle>
755
627
        </term>
756
628
      <listitem>
757
629
        <para>
758
 
          TLS 1.2 is the protocol implemented by GnuTLS.
 
630
          TLS 1.1 is the protocol implemented by GnuTLS.
759
631
        </para>
760
632
      </listitem>
761
633
      </varlistentry>
771
643
      </varlistentry>
772
644
      <varlistentry>
773
645
        <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.
 
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.
796
653
        </para>
797
654
      </listitem>
798
655
      </varlistentry>