/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: 2008-08-29 06:38:27 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080829063827-hbjl6t92tyjl5305
* mandos-clients.conf.xml (ENTITY TIMESTAMP): New.  Automatically
                                              updated by Emacs
                                              time-stamp by using
                                              Emacs local variables.
  (/refentry/refentryinfo/date): New; set to "&TIMESTAMP;".
* mandos-keygen.xml: - '' -
* mandos.conf.xml: - '' -
* mandos.xml: - '' -
* plugin-runner.xml: - '' -
* plugins.d/password-request.xml: - '' -

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