/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

* mandos (Client.runtime_expansions): Add "expires" and (bug fix)
                                      "last_approval_request".
  (main): Don't ignore SIGINT.
* mandos-clients.conf.xml (RUNTIME EXPANSION): Added "expires".

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos.xml
1
1
<?xml version="1.0" encoding="UTF-8"?>
2
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
3
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
 
<!ENTITY VERSION "1.0">
5
4
<!ENTITY COMMANDNAME "mandos">
6
 
<!ENTITY TIMESTAMP "2008-09-01">
 
5
<!ENTITY TIMESTAMP "2012-01-15">
 
6
<!ENTITY % common SYSTEM "common.ent">
 
7
%common;
7
8
]>
8
9
 
9
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
10
 
  <refentryinfo>
 
11
   <refentryinfo>
11
12
    <title>Mandos Manual</title>
12
13
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
13
14
    <productname>Mandos</productname>
14
 
    <productnumber>&VERSION;</productnumber>
 
15
    <productnumber>&version;</productnumber>
15
16
    <date>&TIMESTAMP;</date>
16
17
    <authorgroup>
17
18
      <author>
18
19
        <firstname>Björn</firstname>
19
20
        <surname>Påhlsson</surname>
20
21
        <address>
21
 
          <email>belorn@fukt.bsnet.se</email>
 
22
          <email>belorn@recompile.se</email>
22
23
        </address>
23
24
      </author>
24
25
      <author>
25
26
        <firstname>Teddy</firstname>
26
27
        <surname>Hogeborn</surname>
27
28
        <address>
28
 
          <email>teddy@fukt.bsnet.se</email>
 
29
          <email>teddy@recompile.se</email>
29
30
        </address>
30
31
      </author>
31
32
    </authorgroup>
32
33
    <copyright>
33
34
      <year>2008</year>
 
35
      <year>2009</year>
 
36
      <year>2010</year>
 
37
      <year>2011</year>
 
38
      <year>2012</year>
34
39
      <holder>Teddy Hogeborn</holder>
35
40
      <holder>Björn Påhlsson</holder>
36
41
    </copyright>
37
42
    <xi:include href="legalnotice.xml"/>
38
43
  </refentryinfo>
39
 
 
 
44
  
40
45
  <refmeta>
41
46
    <refentrytitle>&COMMANDNAME;</refentrytitle>
42
47
    <manvolnum>8</manvolnum>
48
53
      Gives encrypted passwords to authenticated Mandos clients
49
54
    </refpurpose>
50
55
  </refnamediv>
51
 
 
 
56
  
52
57
  <refsynopsisdiv>
53
58
    <cmdsynopsis>
54
59
      <command>&COMMANDNAME;</command>
83
88
      <replaceable>DIRECTORY</replaceable></option></arg>
84
89
      <sbr/>
85
90
      <arg><option>--debug</option></arg>
 
91
      <sbr/>
 
92
      <arg><option>--debuglevel
 
93
      <replaceable>LEVEL</replaceable></option></arg>
 
94
      <sbr/>
 
95
      <arg><option>--no-dbus</option></arg>
 
96
      <sbr/>
 
97
      <arg><option>--no-ipv6</option></arg>
 
98
      <sbr/>
 
99
      <arg><option>--no-restore</option></arg>
 
100
      <sbr/>
 
101
      <arg><option>--statedir
 
102
      <replaceable>DIRECTORY</replaceable></option></arg>
86
103
    </cmdsynopsis>
87
104
    <cmdsynopsis>
88
105
      <command>&COMMANDNAME;</command>
100
117
      <arg choice="plain"><option>--check</option></arg>
101
118
    </cmdsynopsis>
102
119
  </refsynopsisdiv>
103
 
 
 
120
  
104
121
  <refsect1 id="description">
105
122
    <title>DESCRIPTION</title>
106
123
    <para>
107
124
      <command>&COMMANDNAME;</command> is a server daemon which
108
125
      handles incoming request for passwords for a pre-defined list of
109
 
      client host computers.  The Mandos server uses Zeroconf to
110
 
      announce itself on the local network, and uses TLS to
111
 
      communicate securely with and to authenticate the clients.  The
112
 
      Mandos server uses IPv6 to allow Mandos clients to use IPv6
113
 
      link-local addresses, since the clients will probably not have
114
 
      any other addresses configured (see <xref linkend="overview"/>).
115
 
      Any authenticated client is then given the stored pre-encrypted
116
 
      password for that specific client.
 
126
      client host computers. For an introduction, see
 
127
      <citerefentry><refentrytitle>intro</refentrytitle>
 
128
      <manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
 
129
      uses Zeroconf to announce itself on the local network, and uses
 
130
      TLS to communicate securely with and to authenticate the
 
131
      clients.  The Mandos server uses IPv6 to allow Mandos clients to
 
132
      use IPv6 link-local addresses, since the clients will probably
 
133
      not have any other addresses configured (see <xref
 
134
      linkend="overview"/>).  Any authenticated client is then given
 
135
      the stored pre-encrypted password for that specific client.
117
136
    </para>
118
 
 
119
137
  </refsect1>
120
138
  
121
139
  <refsect1 id="purpose">
122
140
    <title>PURPOSE</title>
123
 
 
124
141
    <para>
125
142
      The purpose of this is to enable <emphasis>remote and unattended
126
143
      rebooting</emphasis> of client host computer with an
127
144
      <emphasis>encrypted root file system</emphasis>.  See <xref
128
145
      linkend="overview"/> for details.
129
146
    </para>
130
 
    
131
147
  </refsect1>
132
148
  
133
149
  <refsect1 id="options">
134
150
    <title>OPTIONS</title>
135
 
    
136
151
    <variablelist>
137
152
      <varlistentry>
138
153
        <term><option>--help</option></term>
190
205
          <xi:include href="mandos-options.xml" xpointer="debug"/>
191
206
        </listitem>
192
207
      </varlistentry>
193
 
 
 
208
      
 
209
      <varlistentry>
 
210
        <term><option>--debuglevel
 
211
        <replaceable>LEVEL</replaceable></option></term>
 
212
        <listitem>
 
213
          <para>
 
214
            Set the debugging log level.
 
215
            <replaceable>LEVEL</replaceable> is a string, one of
 
216
            <quote><literal>CRITICAL</literal></quote>,
 
217
            <quote><literal>ERROR</literal></quote>,
 
218
            <quote><literal>WARNING</literal></quote>,
 
219
            <quote><literal>INFO</literal></quote>, or
 
220
            <quote><literal>DEBUG</literal></quote>, in order of
 
221
            increasing verbosity.  The default level is
 
222
            <quote><literal>WARNING</literal></quote>.
 
223
          </para>
 
224
        </listitem>
 
225
      </varlistentry>
 
226
      
194
227
      <varlistentry>
195
228
        <term><option>--priority <replaceable>
196
229
        PRIORITY</replaceable></option></term>
198
231
          <xi:include href="mandos-options.xml" xpointer="priority"/>
199
232
        </listitem>
200
233
      </varlistentry>
201
 
 
 
234
      
202
235
      <varlistentry>
203
236
        <term><option>--servicename
204
237
        <replaceable>NAME</replaceable></option></term>
207
240
                      xpointer="servicename"/>
208
241
        </listitem>
209
242
      </varlistentry>
210
 
 
 
243
      
211
244
      <varlistentry>
212
245
        <term><option>--configdir
213
246
        <replaceable>DIRECTORY</replaceable></option></term>
222
255
          </para>
223
256
        </listitem>
224
257
      </varlistentry>
225
 
 
 
258
      
226
259
      <varlistentry>
227
260
        <term><option>--version</option></term>
228
261
        <listitem>
231
264
          </para>
232
265
        </listitem>
233
266
      </varlistentry>
 
267
      
 
268
      <varlistentry>
 
269
        <term><option>--no-dbus</option></term>
 
270
        <listitem>
 
271
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
 
272
          <para>
 
273
            See also <xref linkend="dbus_interface"/>.
 
274
          </para>
 
275
        </listitem>
 
276
      </varlistentry>
 
277
      
 
278
      <varlistentry>
 
279
        <term><option>--no-ipv6</option></term>
 
280
        <listitem>
 
281
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
 
282
        </listitem>
 
283
      </varlistentry>
 
284
      
 
285
      <varlistentry>
 
286
        <term><option>--no-restore</option></term>
 
287
        <listitem>
 
288
          <xi:include href="mandos-options.xml" xpointer="restore"/>
 
289
          <para>
 
290
            See also <xref linkend="persistent_state"/>.
 
291
          </para>
 
292
        </listitem>
 
293
      </varlistentry>
 
294
      
 
295
      <varlistentry>
 
296
        <term><option>--statedir
 
297
        <replaceable>DIRECTORY</replaceable></option></term>
 
298
        <listitem>
 
299
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
 
300
        </listitem>
 
301
      </varlistentry>
234
302
    </variablelist>
235
303
  </refsect1>
236
 
 
 
304
  
237
305
  <refsect1 id="overview">
238
306
    <title>OVERVIEW</title>
239
307
    <xi:include href="overview.xml"/>
243
311
      <acronym>RAM</acronym> disk environment.
244
312
    </para>
245
313
  </refsect1>
246
 
 
 
314
  
247
315
  <refsect1 id="protocol">
248
316
    <title>NETWORK PROTOCOL</title>
249
317
    <para>
301
369
      </row>
302
370
    </tbody></tgroup></table>
303
371
  </refsect1>
304
 
 
 
372
  
305
373
  <refsect1 id="checking">
306
374
    <title>CHECKING</title>
307
375
    <para>
308
376
      The server will, by default, continually check that the clients
309
377
      are still up.  If a client has not been confirmed as being up
310
378
      for some time, the client is assumed to be compromised and is no
311
 
      longer eligible to receive the encrypted password.  The timeout,
312
 
      checker program, and interval between checks can be configured
313
 
      both globally and per client; see <citerefentry>
 
379
      longer eligible to receive the encrypted password.  (Manual
 
380
      intervention is required to re-enable a client.)  The timeout,
 
381
      extended timeout, checker program, and interval between checks
 
382
      can be configured both globally and per client; see
 
383
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
384
      <manvolnum>5</manvolnum></citerefentry>.
 
385
    </para>
 
386
  </refsect1>
 
387
  
 
388
  <refsect1 id="approval">
 
389
    <title>APPROVAL</title>
 
390
    <para>
 
391
      The server can be configured to require manual approval for a
 
392
      client before it is sent its secret.  The delay to wait for such
 
393
      approval and the default action (approve or deny) can be
 
394
      configured both globally and per client; see <citerefentry>
314
395
      <refentrytitle>mandos-clients.conf</refentrytitle>
315
 
      <manvolnum>5</manvolnum></citerefentry>.
316
 
    </para>
 
396
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
 
397
      will be approved immediately without delay.
 
398
    </para>
 
399
    <para>
 
400
      This can be used to deny a client its secret if not manually
 
401
      approved within a specified time.  It can also be used to make
 
402
      the server delay before giving a client its secret, allowing
 
403
      optional manual denying of this specific client.
 
404
    </para>
 
405
    
317
406
  </refsect1>
318
 
 
 
407
  
319
408
  <refsect1 id="logging">
320
409
    <title>LOGGING</title>
321
410
    <para>
322
411
      The server will send log message with various severity levels to
323
 
      <filename>/dev/log</filename>.  With the
 
412
      <filename class="devicefile">/dev/log</filename>.  With the
324
413
      <option>--debug</option> option, it will log even more messages,
325
414
      and also show them on the console.
326
415
    </para>
327
416
  </refsect1>
328
 
 
 
417
  
 
418
  <refsect1 id="persistent_state">
 
419
    <title>PERSISTENT STATE</title>
 
420
    <para>
 
421
      Client settings, initially read from
 
422
      <filename>clients.conf</filename>, are persistent across
 
423
      restarts, and run-time changes will override settings in
 
424
      <filename>clients.conf</filename>.  However, if a setting is
 
425
      <emphasis>changed</emphasis> (or a client added, or removed) in
 
426
      <filename>clients.conf</filename>, this will take precedence.
 
427
    </para>
 
428
  </refsect1>
 
429
  
 
430
  <refsect1 id="dbus_interface">
 
431
    <title>D-BUS INTERFACE</title>
 
432
    <para>
 
433
      The server will by default provide a D-Bus system bus interface.
 
434
      This interface will only be accessible by the root user or a
 
435
      Mandos-specific user, if such a user exists.  For documentation
 
436
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
 
437
    </para>
 
438
  </refsect1>
 
439
  
329
440
  <refsect1 id="exit_status">
330
441
    <title>EXIT STATUS</title>
331
442
    <para>
333
444
      critical error is encountered.
334
445
    </para>
335
446
  </refsect1>
336
 
 
 
447
  
337
448
  <refsect1 id="environment">
338
449
    <title>ENVIRONMENT</title>
339
450
    <variablelist>
353
464
      </varlistentry>
354
465
    </variablelist>
355
466
  </refsect1>
356
 
 
357
 
  <refsect1 id="file">
 
467
  
 
468
  <refsect1 id="files">
358
469
    <title>FILES</title>
359
470
    <para>
360
471
      Use the <option>--configdir</option> option to change where
383
494
        </listitem>
384
495
      </varlistentry>
385
496
      <varlistentry>
386
 
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
387
 
        <listitem>
388
 
          <para>
389
 
            The file containing the process id of
390
 
            <command>&COMMANDNAME;</command>.
 
497
        <term><filename>/var/run/mandos.pid</filename></term>
 
498
        <listitem>
 
499
          <para>
 
500
            The file containing the process id of the
 
501
            <command>&COMMANDNAME;</command> process started last.
 
502
          </para>
 
503
        </listitem>
 
504
      </varlistentry>
 
505
      <varlistentry>
 
506
        <term><filename class="devicefile">/dev/log</filename></term>
 
507
      </varlistentry>
 
508
      <varlistentry>
 
509
        <term><filename
 
510
        class="directory">/var/lib/mandos</filename></term>
 
511
        <listitem>
 
512
          <para>
 
513
            Directory where persistent state will be saved.  Change
 
514
            this with the <option>--statedir</option> option.  See
 
515
            also the <option>--no-restore</option> option.
391
516
          </para>
392
517
        </listitem>
393
518
      </varlistentry>
421
546
      backtrace.  This could be considered a feature.
422
547
    </para>
423
548
    <para>
424
 
      Currently, if a client is declared <quote>invalid</quote> due to
425
 
      having timed out, the server does not record this fact onto
426
 
      permanent storage.  This has some security implications, see
427
 
      <xref linkend="CLIENTS"/>.
428
 
    </para>
429
 
    <para>
430
 
      There is currently no way of querying the server of the current
431
 
      status of clients, other than analyzing its <systemitem
432
 
      class="service">syslog</systemitem> output.
433
 
    </para>
434
 
    <para>
435
549
      There is no fine-grained control over logging and debug output.
436
550
    </para>
437
551
    <para>
438
552
      Debug mode is conflated with running in the foreground.
439
553
    </para>
440
554
    <para>
441
 
      The console log messages does not show a timestamp.
 
555
      This server does not check the expire time of clients’ OpenPGP
 
556
      keys.
442
557
    </para>
443
558
  </refsect1>
444
559
  
455
570
    <informalexample>
456
571
      <para>
457
572
        Run the server in debug mode, read configuration files from
458
 
        the <filename>~/mandos</filename> directory, and use the
459
 
        Zeroconf service name <quote>Test</quote> to not collide with
460
 
        any other official Mandos server on this host:
 
573
        the <filename class="directory">~/mandos</filename> directory,
 
574
        and use the Zeroconf service name <quote>Test</quote> to not
 
575
        collide with any other official Mandos server on this host:
461
576
      </para>
462
577
      <para>
463
578
 
479
594
      </para>
480
595
    </informalexample>
481
596
  </refsect1>
482
 
 
 
597
  
483
598
  <refsect1 id="security">
484
599
    <title>SECURITY</title>
485
 
    <refsect2 id="SERVER">
 
600
    <refsect2 id="server">
486
601
      <title>SERVER</title>
487
602
      <para>
488
603
        Running this <command>&COMMANDNAME;</command> server program
489
604
        should not in itself present any security risk to the host
490
 
        computer running it.  The program does not need any special
491
 
        privileges to run, and is designed to run as a non-root user.
 
605
        computer running it.  The program switches to a non-root user
 
606
        soon after startup.
492
607
      </para>
493
608
    </refsect2>
494
 
    <refsect2 id="CLIENTS">
 
609
    <refsect2 id="clients">
495
610
      <title>CLIENTS</title>
496
611
      <para>
497
612
        The server only gives out its stored data to clients which
504
619
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
505
620
        <manvolnum>5</manvolnum></citerefentry>)
506
621
        <emphasis>must</emphasis> be made non-readable by anyone
507
 
        except the user running the server.
 
622
        except the user starting the server (usually root).
508
623
      </para>
509
624
      <para>
510
625
        As detailed in <xref linkend="checking"/>, the status of all
512
627
        compromised if they are gone for too long.
513
628
      </para>
514
629
      <para>
515
 
        If a client is compromised, its downtime should be duly noted
516
 
        by the server which would therefore declare the client
517
 
        invalid.  But if the server was ever restarted, it would
518
 
        re-read its client list from its configuration file and again
519
 
        regard all clients therein as valid, and hence eligible to
520
 
        receive their passwords.  Therefore, be careful when
521
 
        restarting servers if it is suspected that a client has, in
522
 
        fact, been compromised by parties who may now be running a
523
 
        fake Mandos client with the keys from the non-encrypted
524
 
        initial <acronym>RAM</acronym> image of the client host.  What
525
 
        should be done in that case (if restarting the server program
526
 
        really is necessary) is to stop the server program, edit the
527
 
        configuration file to omit any suspect clients, and restart
528
 
        the server program.
529
 
      </para>
530
 
      <para>
531
630
        For more details on client-side security, see
532
 
        <citerefentry><refentrytitle>password-request</refentrytitle>
 
631
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
533
632
        <manvolnum>8mandos</manvolnum></citerefentry>.
534
633
      </para>
535
634
    </refsect2>
536
635
  </refsect1>
537
 
 
 
636
  
538
637
  <refsect1 id="see_also">
539
638
    <title>SEE ALSO</title>
540
639
    <para>
541
 
      <citerefentry>
542
 
        <refentrytitle>mandos-clients.conf</refentrytitle>
543
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
544
 
        <refentrytitle>mandos.conf</refentrytitle>
545
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
546
 
        <refentrytitle>password-request</refentrytitle>
547
 
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
548
 
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
549
 
      </citerefentry>
 
640
      <citerefentry><refentrytitle>intro</refentrytitle>
 
641
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
642
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
643
      <manvolnum>5</manvolnum></citerefentry>,
 
644
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
 
645
      <manvolnum>5</manvolnum></citerefentry>,
 
646
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
647
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
648
      <citerefentry><refentrytitle>sh</refentrytitle>
 
649
      <manvolnum>1</manvolnum></citerefentry>
550
650
    </para>
551
651
    <variablelist>
552
652
      <varlistentry>