/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: 2018-08-19 01:35:11 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 368.
  • Revision ID: teddy@recompile.se-20180819013511-cku25q9yeub3dnr0
Adapt to changes in cryptsetup; use "cryptroot-unlock" program

* Makefile (install-client-nokey): Also install new script files
  "mandos-to-cryptroot-unlock" and "initramfs-tools-script-stop".
* debian/mandos-client.dirs: Add
  "usr/share/initramfs-tools/scripts/local-premount".
* initramfs-tools-hook: Also copy "mandos-to-cryptroot-unlock".
* initramfs-tools-script: Only modify keyscript setting in cryptroot
  file if the file exists, otherwise start
  "mandos-to-cryptroot-unlock" in background.
* initramfs-tools-script-stop: New script to make sure plugin-runner
  has stopped before continuing.
* mandos-to-cryptroot-unlock: New script to run plugin-runner and feed
  any password it gets into the "cryptroot-unlock" program.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos.xml
1
1
<?xml version="1.0" encoding="UTF-8"?>
2
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
3
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
 
<!ENTITY VERSION "1.0">
5
4
<!ENTITY COMMANDNAME "mandos">
 
5
<!ENTITY TIMESTAMP "2018-02-08">
 
6
<!ENTITY % common SYSTEM "common.ent">
 
7
%common;
6
8
]>
7
9
 
8
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
9
 
  <refentryinfo>
10
 
    <title>&COMMANDNAME;</title>
 
11
   <refentryinfo>
 
12
    <title>Mandos Manual</title>
11
13
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
12
 
    <productname>&COMMANDNAME;</productname>
13
 
    <productnumber>&VERSION;</productnumber>
 
14
    <productname>Mandos</productname>
 
15
    <productnumber>&version;</productnumber>
 
16
    <date>&TIMESTAMP;</date>
14
17
    <authorgroup>
15
18
      <author>
16
19
        <firstname>Björn</firstname>
17
20
        <surname>Påhlsson</surname>
18
21
        <address>
19
 
          <email>belorn@fukt.bsnet.se</email>
 
22
          <email>belorn@recompile.se</email>
20
23
        </address>
21
24
      </author>
22
25
      <author>
23
26
        <firstname>Teddy</firstname>
24
27
        <surname>Hogeborn</surname>
25
28
        <address>
26
 
          <email>teddy@fukt.bsnet.se</email>
 
29
          <email>teddy@recompile.se</email>
27
30
        </address>
28
31
      </author>
29
32
    </authorgroup>
30
33
    <copyright>
31
34
      <year>2008</year>
 
35
      <year>2009</year>
 
36
      <year>2010</year>
 
37
      <year>2011</year>
 
38
      <year>2012</year>
 
39
      <year>2013</year>
 
40
      <year>2014</year>
 
41
      <year>2015</year>
 
42
      <year>2016</year>
 
43
      <year>2017</year>
 
44
      <year>2018</year>
32
45
      <holder>Teddy Hogeborn</holder>
33
46
      <holder>Björn Påhlsson</holder>
34
47
    </copyright>
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>
 
48
    <xi:include href="legalnotice.xml"/>
58
49
  </refentryinfo>
59
 
 
 
50
  
60
51
  <refmeta>
61
52
    <refentrytitle>&COMMANDNAME;</refentrytitle>
62
53
    <manvolnum>8</manvolnum>
65
56
  <refnamediv>
66
57
    <refname><command>&COMMANDNAME;</command></refname>
67
58
    <refpurpose>
68
 
      Sends encrypted passwords to authenticated Mandos clients
 
59
      Gives encrypted passwords to authenticated Mandos clients
69
60
    </refpurpose>
70
61
  </refnamediv>
71
 
 
 
62
  
72
63
  <refsynopsisdiv>
73
64
    <cmdsynopsis>
74
65
      <command>&COMMANDNAME;</command>
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>
 
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>
92
116
    </cmdsynopsis>
93
117
    <cmdsynopsis>
94
118
      <command>&COMMANDNAME;</command>
95
119
      <group choice="req">
96
 
        <arg choice="plain">-h</arg>
97
 
        <arg choice="plain">--help</arg>
 
120
        <arg choice="plain"><option>--help</option></arg>
 
121
        <arg choice="plain"><option>-h</option></arg>
98
122
      </group>
99
123
    </cmdsynopsis>
100
124
    <cmdsynopsis>
101
125
      <command>&COMMANDNAME;</command>
102
 
      <arg choice="plain">--version</arg>
 
126
      <arg choice="plain"><option>--version</option></arg>
103
127
    </cmdsynopsis>
104
128
    <cmdsynopsis>
105
129
      <command>&COMMANDNAME;</command>
106
 
      <arg choice="plain">--check</arg>
 
130
      <arg choice="plain"><option>--check</option></arg>
107
131
    </cmdsynopsis>
108
132
  </refsynopsisdiv>
109
 
 
 
133
  
110
134
  <refsect1 id="description">
111
135
    <title>DESCRIPTION</title>
112
136
    <para>
113
137
      <command>&COMMANDNAME;</command> is a server daemon which
114
138
      handles incoming request for passwords for a pre-defined list of
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.
 
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.
123
149
    </para>
124
 
 
125
150
  </refsect1>
126
151
  
127
152
  <refsect1 id="purpose">
128
153
    <title>PURPOSE</title>
129
 
 
130
154
    <para>
131
155
      The purpose of this is to enable <emphasis>remote and unattended
132
156
      rebooting</emphasis> of client host computer with an
133
157
      <emphasis>encrypted root file system</emphasis>.  See <xref
134
158
      linkend="overview"/> for details.
135
159
    </para>
136
 
 
137
160
  </refsect1>
138
161
  
139
162
  <refsect1 id="options">
140
163
    <title>OPTIONS</title>
141
 
 
142
164
    <variablelist>
143
165
      <varlistentry>
144
 
        <term><literal>-h</literal>, <literal>--help</literal></term>
 
166
        <term><option>--help</option></term>
 
167
        <term><option>-h</option></term>
145
168
        <listitem>
146
169
          <para>
147
170
            Show a help message and exit
148
171
          </para>
149
172
        </listitem>
150
173
      </varlistentry>
151
 
 
 
174
      
152
175
      <varlistentry>
153
 
        <term><literal>-i</literal>, <literal>--interface <replaceable>
154
 
        IF</replaceable></literal></term>
 
176
        <term><option>--interface</option>
 
177
        <replaceable>NAME</replaceable></term>
 
178
        <term><option>-i</option>
 
179
        <replaceable>NAME</replaceable></term>
155
180
        <listitem>
156
181
          <xi:include href="mandos-options.xml" xpointer="interface"/>
157
182
        </listitem>
158
183
      </varlistentry>
159
 
 
 
184
      
160
185
      <varlistentry>
161
 
        <term><literal>-a</literal>, <literal>--address <replaceable>
162
 
        ADDRESS</replaceable></literal></term>
 
186
        <term><option>--address
 
187
        <replaceable>ADDRESS</replaceable></option></term>
 
188
        <term><option>-a
 
189
        <replaceable>ADDRESS</replaceable></option></term>
163
190
        <listitem>
164
191
          <xi:include href="mandos-options.xml" xpointer="address"/>
165
192
        </listitem>
166
193
      </varlistentry>
167
 
 
 
194
      
168
195
      <varlistentry>
169
 
        <term><literal>-p</literal>, <literal>--port <replaceable>
170
 
        PORT</replaceable></literal></term>
 
196
        <term><option>--port
 
197
        <replaceable>PORT</replaceable></option></term>
 
198
        <term><option>-p
 
199
        <replaceable>PORT</replaceable></option></term>
171
200
        <listitem>
172
201
          <xi:include href="mandos-options.xml" xpointer="port"/>
173
202
        </listitem>
174
203
      </varlistentry>
175
 
 
 
204
      
176
205
      <varlistentry>
177
 
        <term><literal>--check</literal></term>
 
206
        <term><option>--check</option></term>
178
207
        <listitem>
179
208
          <para>
180
209
            Run the server’s self-tests.  This includes any unit
182
211
          </para>
183
212
        </listitem>
184
213
      </varlistentry>
185
 
 
 
214
      
186
215
      <varlistentry>
187
 
        <term><literal>--debug</literal></term>
 
216
        <term><option>--debug</option></term>
188
217
        <listitem>
189
218
          <xi:include href="mandos-options.xml" xpointer="debug"/>
190
219
        </listitem>
191
220
      </varlistentry>
192
 
 
193
 
      <varlistentry>
194
 
        <term><literal>--priority <replaceable>
195
 
        PRIORITY</replaceable></literal></term>
 
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>
196
243
        <listitem>
197
244
          <xi:include href="mandos-options.xml" xpointer="priority"/>
198
245
        </listitem>
199
246
      </varlistentry>
200
 
 
 
247
      
201
248
      <varlistentry>
202
 
        <term><literal>--servicename <replaceable>NAME</replaceable>
203
 
        </literal></term>
 
249
        <term><option>--servicename
 
250
        <replaceable>NAME</replaceable></option></term>
204
251
        <listitem>
205
252
          <xi:include href="mandos-options.xml"
206
253
                      xpointer="servicename"/>
207
254
        </listitem>
208
255
      </varlistentry>
209
 
 
 
256
      
210
257
      <varlistentry>
211
 
        <term><literal>--configdir <replaceable>DIR</replaceable>
212
 
        </literal></term>
 
258
        <term><option>--configdir
 
259
        <replaceable>DIRECTORY</replaceable></option></term>
213
260
        <listitem>
214
261
          <para>
215
262
            Directory to search for configuration files.  Default is
221
268
          </para>
222
269
        </listitem>
223
270
      </varlistentry>
224
 
 
 
271
      
225
272
      <varlistentry>
226
 
        <term><literal>--version</literal></term>
 
273
        <term><option>--version</option></term>
227
274
        <listitem>
228
275
          <para>
229
276
            Prints the program version and exit.
230
277
          </para>
231
278
        </listitem>
232
279
      </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
      
233
339
    </variablelist>
234
340
  </refsect1>
235
 
 
 
341
  
236
342
  <refsect1 id="overview">
237
343
    <title>OVERVIEW</title>
238
344
    <xi:include href="overview.xml"/>
239
345
    <para>
240
346
      This program is the server part.  It is a normal server program
241
347
      and will run in a normal system environment, not in an initial
242
 
      RAM disk environment.
 
348
      <acronym>RAM</acronym> disk environment.
243
349
    </para>
244
350
  </refsect1>
245
 
 
 
351
  
246
352
  <refsect1 id="protocol">
247
353
    <title>NETWORK PROTOCOL</title>
248
354
    <para>
300
406
      </row>
301
407
    </tbody></tgroup></table>
302
408
  </refsect1>
303
 
 
 
409
  
304
410
  <refsect1 id="checking">
305
411
    <title>CHECKING</title>
306
412
    <para>
307
413
      The server will, by default, continually check that the clients
308
414
      are still up.  If a client has not been confirmed as being up
309
415
      for some time, the client is assumed to be compromised and is no
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>
 
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>
 
421
      <manvolnum>5</manvolnum></citerefentry>.
 
422
    </para>
 
423
  </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>
313
432
      <refentrytitle>mandos-clients.conf</refentrytitle>
314
 
      <manvolnum>5</manvolnum></citerefentry>.
315
 
    </para>
 
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
    
316
443
  </refsect1>
317
 
 
 
444
  
318
445
  <refsect1 id="logging">
319
446
    <title>LOGGING</title>
320
447
    <para>
321
448
      The server will send log message with various severity levels to
322
 
      <filename>/dev/log</filename>.  With the
 
449
      <filename class="devicefile">/dev/log</filename>.  With the
323
450
      <option>--debug</option> option, it will log even more messages,
324
451
      and also show them on the console.
325
452
    </para>
326
453
  </refsect1>
327
 
 
 
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
  
328
477
  <refsect1 id="exit_status">
329
478
    <title>EXIT STATUS</title>
330
479
    <para>
332
481
      critical error is encountered.
333
482
    </para>
334
483
  </refsect1>
335
 
 
 
484
  
336
485
  <refsect1 id="environment">
337
486
    <title>ENVIRONMENT</title>
338
487
    <variablelist>
339
488
      <varlistentry>
340
 
        <term><varname>PATH</varname></term>
 
489
        <term><envar>PATH</envar></term>
341
490
        <listitem>
342
491
          <para>
343
492
            To start the configured checker (see <xref
352
501
      </varlistentry>
353
502
    </variablelist>
354
503
  </refsect1>
355
 
 
356
 
  <refsect1 id="file">
 
504
  
 
505
  <refsect1 id="files">
357
506
    <title>FILES</title>
358
507
    <para>
359
508
      Use the <option>--configdir</option> option to change where
382
531
        </listitem>
383
532
      </varlistentry>
384
533
      <varlistentry>
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>
 
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>
395
559
        <listitem>
396
560
          <para>
397
561
            The Unix domain socket to where local syslog messages are
420
584
      backtrace.  This could be considered a feature.
421
585
    </para>
422
586
    <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>
434
587
      There is no fine-grained control over logging and debug output.
435
588
    </para>
436
589
    <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>
 
590
      This server does not check the expire time of clients’ OpenPGP
 
591
      keys.
 
592
    </para>
 
593
    <xi:include href="bugs.xml"/>
442
594
  </refsect1>
443
595
  
444
596
  <refsect1 id="example">
448
600
        Normal invocation needs no options:
449
601
      </para>
450
602
      <para>
451
 
        <userinput>mandos</userinput>
 
603
        <userinput>&COMMANDNAME;</userinput>
452
604
      </para>
453
605
    </informalexample>
454
606
    <informalexample>
455
607
      <para>
456
608
        Run the server in debug mode, read configuration files from
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
        the <filename class="directory">~/mandos</filename> directory,
 
610
        and use the Zeroconf service name <quote>Test</quote> to not
 
611
        collide with any other official Mandos server on this host:
460
612
      </para>
461
613
      <para>
462
614
 
463
615
<!-- do not wrap this line -->
464
 
<userinput>mandos --debug --configdir ~/mandos --servicename Test</userinput>
 
616
<userinput>&COMMANDNAME; --debug --configdir ~/mandos --servicename Test</userinput>
465
617
 
466
618
      </para>
467
619
    </informalexample>
473
625
      <para>
474
626
 
475
627
<!-- do not wrap this line -->
476
 
<userinput>mandos --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
 
628
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
477
629
 
478
630
      </para>
479
631
    </informalexample>
480
632
  </refsect1>
481
 
 
 
633
  
482
634
  <refsect1 id="security">
483
635
    <title>SECURITY</title>
484
 
    <refsect2 id="SERVER">
 
636
    <refsect2 id="server">
485
637
      <title>SERVER</title>
486
638
      <para>
487
639
        Running this <command>&COMMANDNAME;</command> server program
488
640
        should not in itself present any security risk to the host
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.
 
641
        computer running it.  The program switches to a non-root user
 
642
        soon after startup.
491
643
      </para>
492
644
    </refsect2>
493
 
    <refsect2 id="CLIENTS">
 
645
    <refsect2 id="clients">
494
646
      <title>CLIENTS</title>
495
647
      <para>
496
648
        The server only gives out its stored data to clients which
503
655
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
504
656
        <manvolnum>5</manvolnum></citerefentry>)
505
657
        <emphasis>must</emphasis> be made non-readable by anyone
506
 
        except the user running the server.
 
658
        except the user starting the server (usually root).
507
659
      </para>
508
660
      <para>
509
661
        As detailed in <xref linkend="checking"/>, the status of all
511
663
        compromised if they are gone for too long.
512
664
      </para>
513
665
      <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>
530
666
        For more details on client-side security, see
531
 
        <citerefentry><refentrytitle>password-request</refentrytitle>
 
667
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
532
668
        <manvolnum>8mandos</manvolnum></citerefentry>.
533
669
      </para>
534
670
    </refsect2>
535
671
  </refsect1>
536
 
 
 
672
  
537
673
  <refsect1 id="see_also">
538
674
    <title>SEE ALSO</title>
539
675
    <para>
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>
 
676
      <citerefentry><refentrytitle>intro</refentrytitle>
 
677
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
678
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
679
      <manvolnum>5</manvolnum></citerefentry>,
 
680
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
 
681
      <manvolnum>5</manvolnum></citerefentry>,
 
682
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
683
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
684
      <citerefentry><refentrytitle>sh</refentrytitle>
 
685
      <manvolnum>1</manvolnum></citerefentry>
549
686
    </para>
550
687
    <variablelist>
551
688
      <varlistentry>
572
709
      </varlistentry>
573
710
      <varlistentry>
574
711
        <term>
575
 
          <ulink
576
 
              url="http://www.gnu.org/software/gnutls/">GnuTLS</ulink>
 
712
          <ulink url="https://gnutls.org/">GnuTLS</ulink>
577
713
        </term>
578
714
      <listitem>
579
715
        <para>
585
721
      </varlistentry>
586
722
      <varlistentry>
587
723
        <term>
588
 
          <citation>RFC 4291: <citetitle>IP Version 6 Addressing
589
 
          Architecture</citetitle>, section 2.5.6, Link-Local IPv6
590
 
          Unicast Addresses</citation>
 
724
          RFC 4291: <citetitle>IP Version 6 Addressing
 
725
          Architecture</citetitle>
591
726
        </term>
592
727
        <listitem>
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>
 
728
          <variablelist>
 
729
            <varlistentry>
 
730
              <term>Section 2.2: <citetitle>Text Representation of
 
731
              Addresses</citetitle></term>
 
732
              <listitem><para/></listitem>
 
733
            </varlistentry>
 
734
            <varlistentry>
 
735
              <term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
 
736
              Address</citetitle></term>
 
737
              <listitem><para/></listitem>
 
738
            </varlistentry>
 
739
            <varlistentry>
 
740
            <term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
 
741
            Addresses</citetitle></term>
 
742
            <listitem>
 
743
              <para>
 
744
                The clients use IPv6 link-local addresses, which are
 
745
                immediately usable since a link-local addresses is
 
746
                automatically assigned to a network interfaces when it
 
747
                is brought up.
 
748
              </para>
 
749
            </listitem>
 
750
            </varlistentry>
 
751
          </variablelist>
599
752
        </listitem>
600
753
      </varlistentry>
601
754
      <varlistentry>
602
755
        <term>
603
 
          <citation>RFC 4346: <citetitle>The Transport Layer Security
604
 
          (TLS) Protocol Version 1.1</citetitle></citation>
 
756
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
 
757
          Protocol Version 1.2</citetitle>
605
758
        </term>
606
759
      <listitem>
607
760
        <para>
608
 
          TLS 1.1 is the protocol implemented by GnuTLS.
 
761
          TLS 1.2 is the protocol implemented by GnuTLS.
609
762
        </para>
610
763
      </listitem>
611
764
      </varlistentry>
612
765
      <varlistentry>
613
766
        <term>
614
 
          <citation>RFC 4880: <citetitle>OpenPGP Message
615
 
          Format</citetitle></citation>
 
767
          RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
616
768
        </term>
617
769
      <listitem>
618
770
        <para>
622
774
      </varlistentry>
623
775
      <varlistentry>
624
776
        <term>
625
 
          <citation>RFC 5081: <citetitle>Using OpenPGP Keys for
626
 
          Transport Layer Security</citetitle></citation>
 
777
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
 
778
          Security (TLS) Authentication</citetitle>
627
779
        </term>
628
780
      <listitem>
629
781
        <para>
635
787
    </variablelist>
636
788
  </refsect1>
637
789
</refentry>
 
790
<!-- Local Variables: -->
 
791
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
792
<!-- time-stamp-end: "[\"']>" -->
 
793
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
794
<!-- End: -->