/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: 2015-07-27 09:23:56 UTC
  • Revision ID: teddy@recompile.se-20150727092356-65ul6jsiozlkjw4e
Debian bug fix for mandos-client: Remove dhparams.pem on purge.

* debian/mandos-client.postrm (purge): Bug fix: Remove dhparams.pem.

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 "2015-07-20">
 
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>
 
39
      <year>2013</year>
 
40
      <year>2014</year>
 
41
      <year>2015</year>
34
42
      <holder>Teddy Hogeborn</holder>
35
43
      <holder>Björn Påhlsson</holder>
36
44
    </copyright>
37
45
    <xi:include href="legalnotice.xml"/>
38
46
  </refentryinfo>
39
 
 
 
47
  
40
48
  <refmeta>
41
49
    <refentrytitle>&COMMANDNAME;</refentrytitle>
42
50
    <manvolnum>8</manvolnum>
48
56
      Gives encrypted passwords to authenticated Mandos clients
49
57
    </refpurpose>
50
58
  </refnamediv>
51
 
 
 
59
  
52
60
  <refsynopsisdiv>
53
61
    <cmdsynopsis>
54
62
      <command>&COMMANDNAME;</command>
83
91
      <replaceable>DIRECTORY</replaceable></option></arg>
84
92
      <sbr/>
85
93
      <arg><option>--debug</option></arg>
 
94
      <sbr/>
 
95
      <arg><option>--debuglevel
 
96
      <replaceable>LEVEL</replaceable></option></arg>
 
97
      <sbr/>
 
98
      <arg><option>--no-dbus</option></arg>
 
99
      <sbr/>
 
100
      <arg><option>--no-ipv6</option></arg>
 
101
      <sbr/>
 
102
      <arg><option>--no-restore</option></arg>
 
103
      <sbr/>
 
104
      <arg><option>--statedir
 
105
      <replaceable>DIRECTORY</replaceable></option></arg>
 
106
      <sbr/>
 
107
      <arg><option>--socket
 
108
      <replaceable>FD</replaceable></option></arg>
 
109
      <sbr/>
 
110
      <arg><option>--foreground</option></arg>
 
111
      <sbr/>
 
112
      <arg><option>--no-zeroconf</option></arg>
86
113
    </cmdsynopsis>
87
114
    <cmdsynopsis>
88
115
      <command>&COMMANDNAME;</command>
100
127
      <arg choice="plain"><option>--check</option></arg>
101
128
    </cmdsynopsis>
102
129
  </refsynopsisdiv>
103
 
 
 
130
  
104
131
  <refsect1 id="description">
105
132
    <title>DESCRIPTION</title>
106
133
    <para>
107
134
      <command>&COMMANDNAME;</command> is a server daemon which
108
135
      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.
 
136
      client host computers. For an introduction, see
 
137
      <citerefentry><refentrytitle>intro</refentrytitle>
 
138
      <manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
 
139
      uses Zeroconf to announce itself on the local network, and uses
 
140
      TLS to communicate securely with and to authenticate the
 
141
      clients.  The Mandos server uses IPv6 to allow Mandos clients to
 
142
      use IPv6 link-local addresses, since the clients will probably
 
143
      not have any other addresses configured (see <xref
 
144
      linkend="overview"/>).  Any authenticated client is then given
 
145
      the stored pre-encrypted password for that specific client.
117
146
    </para>
118
 
 
119
147
  </refsect1>
120
148
  
121
149
  <refsect1 id="purpose">
122
150
    <title>PURPOSE</title>
123
 
 
124
151
    <para>
125
152
      The purpose of this is to enable <emphasis>remote and unattended
126
153
      rebooting</emphasis> of client host computer with an
127
154
      <emphasis>encrypted root file system</emphasis>.  See <xref
128
155
      linkend="overview"/> for details.
129
156
    </para>
130
 
    
131
157
  </refsect1>
132
158
  
133
159
  <refsect1 id="options">
134
160
    <title>OPTIONS</title>
135
 
    
136
161
    <variablelist>
137
162
      <varlistentry>
138
163
        <term><option>--help</option></term>
190
215
          <xi:include href="mandos-options.xml" xpointer="debug"/>
191
216
        </listitem>
192
217
      </varlistentry>
193
 
 
 
218
      
 
219
      <varlistentry>
 
220
        <term><option>--debuglevel
 
221
        <replaceable>LEVEL</replaceable></option></term>
 
222
        <listitem>
 
223
          <para>
 
224
            Set the debugging log level.
 
225
            <replaceable>LEVEL</replaceable> is a string, one of
 
226
            <quote><literal>CRITICAL</literal></quote>,
 
227
            <quote><literal>ERROR</literal></quote>,
 
228
            <quote><literal>WARNING</literal></quote>,
 
229
            <quote><literal>INFO</literal></quote>, or
 
230
            <quote><literal>DEBUG</literal></quote>, in order of
 
231
            increasing verbosity.  The default level is
 
232
            <quote><literal>WARNING</literal></quote>.
 
233
          </para>
 
234
        </listitem>
 
235
      </varlistentry>
 
236
      
194
237
      <varlistentry>
195
238
        <term><option>--priority <replaceable>
196
239
        PRIORITY</replaceable></option></term>
198
241
          <xi:include href="mandos-options.xml" xpointer="priority"/>
199
242
        </listitem>
200
243
      </varlistentry>
201
 
 
 
244
      
202
245
      <varlistentry>
203
246
        <term><option>--servicename
204
247
        <replaceable>NAME</replaceable></option></term>
207
250
                      xpointer="servicename"/>
208
251
        </listitem>
209
252
      </varlistentry>
210
 
 
 
253
      
211
254
      <varlistentry>
212
255
        <term><option>--configdir
213
256
        <replaceable>DIRECTORY</replaceable></option></term>
222
265
          </para>
223
266
        </listitem>
224
267
      </varlistentry>
225
 
 
 
268
      
226
269
      <varlistentry>
227
270
        <term><option>--version</option></term>
228
271
        <listitem>
231
274
          </para>
232
275
        </listitem>
233
276
      </varlistentry>
 
277
      
 
278
      <varlistentry>
 
279
        <term><option>--no-dbus</option></term>
 
280
        <listitem>
 
281
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
 
282
          <para>
 
283
            See also <xref linkend="dbus_interface"/>.
 
284
          </para>
 
285
        </listitem>
 
286
      </varlistentry>
 
287
      
 
288
      <varlistentry>
 
289
        <term><option>--no-ipv6</option></term>
 
290
        <listitem>
 
291
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
 
292
        </listitem>
 
293
      </varlistentry>
 
294
      
 
295
      <varlistentry>
 
296
        <term><option>--no-restore</option></term>
 
297
        <listitem>
 
298
          <xi:include href="mandos-options.xml" xpointer="restore"/>
 
299
          <para>
 
300
            See also <xref linkend="persistent_state"/>.
 
301
          </para>
 
302
        </listitem>
 
303
      </varlistentry>
 
304
      
 
305
      <varlistentry>
 
306
        <term><option>--statedir
 
307
        <replaceable>DIRECTORY</replaceable></option></term>
 
308
        <listitem>
 
309
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
 
310
        </listitem>
 
311
      </varlistentry>
 
312
      
 
313
      <varlistentry>
 
314
        <term><option>--socket
 
315
        <replaceable>FD</replaceable></option></term>
 
316
        <listitem>
 
317
          <xi:include href="mandos-options.xml" xpointer="socket"/>
 
318
        </listitem>
 
319
      </varlistentry>
 
320
      
 
321
      <varlistentry>
 
322
        <term><option>--foreground</option></term>
 
323
        <listitem>
 
324
          <xi:include href="mandos-options.xml"
 
325
                      xpointer="foreground"/>
 
326
        </listitem>
 
327
      </varlistentry>
 
328
      
 
329
      <varlistentry>
 
330
        <term><option>--no-zeroconf</option></term>
 
331
        <listitem>
 
332
          <xi:include href="mandos-options.xml" xpointer="zeroconf"/>
 
333
        </listitem>
 
334
      </varlistentry>
 
335
      
234
336
    </variablelist>
235
337
  </refsect1>
236
 
 
 
338
  
237
339
  <refsect1 id="overview">
238
340
    <title>OVERVIEW</title>
239
341
    <xi:include href="overview.xml"/>
243
345
      <acronym>RAM</acronym> disk environment.
244
346
    </para>
245
347
  </refsect1>
246
 
 
 
348
  
247
349
  <refsect1 id="protocol">
248
350
    <title>NETWORK PROTOCOL</title>
249
351
    <para>
301
403
      </row>
302
404
    </tbody></tgroup></table>
303
405
  </refsect1>
304
 
 
 
406
  
305
407
  <refsect1 id="checking">
306
408
    <title>CHECKING</title>
307
409
    <para>
308
410
      The server will, by default, continually check that the clients
309
411
      are still up.  If a client has not been confirmed as being up
310
412
      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>
 
413
      longer eligible to receive the encrypted password.  (Manual
 
414
      intervention is required to re-enable a client.)  The timeout,
 
415
      extended timeout, checker program, and interval between checks
 
416
      can be configured both globally and per client; see
 
417
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
418
      <manvolnum>5</manvolnum></citerefentry>.
 
419
    </para>
 
420
  </refsect1>
 
421
  
 
422
  <refsect1 id="approval">
 
423
    <title>APPROVAL</title>
 
424
    <para>
 
425
      The server can be configured to require manual approval for a
 
426
      client before it is sent its secret.  The delay to wait for such
 
427
      approval and the default action (approve or deny) can be
 
428
      configured both globally and per client; see <citerefentry>
314
429
      <refentrytitle>mandos-clients.conf</refentrytitle>
315
 
      <manvolnum>5</manvolnum></citerefentry>.
316
 
    </para>
 
430
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
 
431
      will be approved immediately without delay.
 
432
    </para>
 
433
    <para>
 
434
      This can be used to deny a client its secret if not manually
 
435
      approved within a specified time.  It can also be used to make
 
436
      the server delay before giving a client its secret, allowing
 
437
      optional manual denying of this specific client.
 
438
    </para>
 
439
    
317
440
  </refsect1>
318
 
 
 
441
  
319
442
  <refsect1 id="logging">
320
443
    <title>LOGGING</title>
321
444
    <para>
322
445
      The server will send log message with various severity levels to
323
 
      <filename>/dev/log</filename>.  With the
 
446
      <filename class="devicefile">/dev/log</filename>.  With the
324
447
      <option>--debug</option> option, it will log even more messages,
325
448
      and also show them on the console.
326
449
    </para>
327
450
  </refsect1>
328
 
 
 
451
  
 
452
  <refsect1 id="persistent_state">
 
453
    <title>PERSISTENT STATE</title>
 
454
    <para>
 
455
      Client settings, initially read from
 
456
      <filename>clients.conf</filename>, are persistent across
 
457
      restarts, and run-time changes will override settings in
 
458
      <filename>clients.conf</filename>.  However, if a setting is
 
459
      <emphasis>changed</emphasis> (or a client added, or removed) in
 
460
      <filename>clients.conf</filename>, this will take precedence.
 
461
    </para>
 
462
  </refsect1>
 
463
  
 
464
  <refsect1 id="dbus_interface">
 
465
    <title>D-BUS INTERFACE</title>
 
466
    <para>
 
467
      The server will by default provide a D-Bus system bus interface.
 
468
      This interface will only be accessible by the root user or a
 
469
      Mandos-specific user, if such a user exists.  For documentation
 
470
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
 
471
    </para>
 
472
  </refsect1>
 
473
  
329
474
  <refsect1 id="exit_status">
330
475
    <title>EXIT STATUS</title>
331
476
    <para>
333
478
      critical error is encountered.
334
479
    </para>
335
480
  </refsect1>
336
 
 
 
481
  
337
482
  <refsect1 id="environment">
338
483
    <title>ENVIRONMENT</title>
339
484
    <variablelist>
353
498
      </varlistentry>
354
499
    </variablelist>
355
500
  </refsect1>
356
 
 
357
 
  <refsect1 id="file">
 
501
  
 
502
  <refsect1 id="files">
358
503
    <title>FILES</title>
359
504
    <para>
360
505
      Use the <option>--configdir</option> option to change where
383
528
        </listitem>
384
529
      </varlistentry>
385
530
      <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>.
 
531
        <term><filename>/run/mandos.pid</filename></term>
 
532
        <listitem>
 
533
          <para>
 
534
            The file containing the process id of the
 
535
            <command>&COMMANDNAME;</command> process started last.
 
536
            <emphasis >Note:</emphasis> If the <filename
 
537
            class="directory">/run</filename> directory does not
 
538
            exist, <filename>/var/run/mandos.pid</filename> will be
 
539
            used instead.
 
540
          </para>
 
541
        </listitem>
 
542
      </varlistentry>
 
543
      <varlistentry>
 
544
        <term><filename class="devicefile">/dev/log</filename></term>
 
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.
391
554
          </para>
392
555
        </listitem>
393
556
      </varlistentry>
421
584
      backtrace.  This could be considered a feature.
422
585
    </para>
423
586
    <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
587
      There is no fine-grained control over logging and debug output.
436
588
    </para>
437
589
    <para>
438
 
      Debug mode is conflated with running in the foreground.
439
 
    </para>
440
 
    <para>
441
 
      The console log messages does not show a timestamp.
 
590
      This server does not check the expire time of clients’ OpenPGP
 
591
      keys.
442
592
    </para>
443
593
  </refsect1>
444
594
  
455
605
    <informalexample>
456
606
      <para>
457
607
        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:
 
608
        the <filename class="directory">~/mandos</filename> directory,
 
609
        and use the Zeroconf service name <quote>Test</quote> to not
 
610
        collide with any other official Mandos server on this host:
461
611
      </para>
462
612
      <para>
463
613
 
479
629
      </para>
480
630
    </informalexample>
481
631
  </refsect1>
482
 
 
 
632
  
483
633
  <refsect1 id="security">
484
634
    <title>SECURITY</title>
485
 
    <refsect2 id="SERVER">
 
635
    <refsect2 id="server">
486
636
      <title>SERVER</title>
487
637
      <para>
488
638
        Running this <command>&COMMANDNAME;</command> server program
489
639
        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.
 
640
        computer running it.  The program switches to a non-root user
 
641
        soon after startup.
492
642
      </para>
493
643
    </refsect2>
494
 
    <refsect2 id="CLIENTS">
 
644
    <refsect2 id="clients">
495
645
      <title>CLIENTS</title>
496
646
      <para>
497
647
        The server only gives out its stored data to clients which
504
654
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
505
655
        <manvolnum>5</manvolnum></citerefentry>)
506
656
        <emphasis>must</emphasis> be made non-readable by anyone
507
 
        except the user running the server.
 
657
        except the user starting the server (usually root).
508
658
      </para>
509
659
      <para>
510
660
        As detailed in <xref linkend="checking"/>, the status of all
512
662
        compromised if they are gone for too long.
513
663
      </para>
514
664
      <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
665
        For more details on client-side security, see
532
 
        <citerefentry><refentrytitle>password-request</refentrytitle>
 
666
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
533
667
        <manvolnum>8mandos</manvolnum></citerefentry>.
534
668
      </para>
535
669
    </refsect2>
536
670
  </refsect1>
537
 
 
 
671
  
538
672
  <refsect1 id="see_also">
539
673
    <title>SEE ALSO</title>
540
674
    <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>
 
675
      <citerefentry><refentrytitle>intro</refentrytitle>
 
676
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
677
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
678
      <manvolnum>5</manvolnum></citerefentry>,
 
679
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
 
680
      <manvolnum>5</manvolnum></citerefentry>,
 
681
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
682
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
683
      <citerefentry><refentrytitle>sh</refentrytitle>
 
684
      <manvolnum>1</manvolnum></citerefentry>
550
685
    </para>
551
686
    <variablelist>
552
687
      <varlistentry>
573
708
      </varlistentry>
574
709
      <varlistentry>
575
710
        <term>
576
 
          <ulink url="http://www.gnu.org/software/gnutls/"
577
 
          >GnuTLS</ulink>
 
711
          <ulink url="http://gnutls.org/">GnuTLS</ulink>
578
712
        </term>
579
713
      <listitem>
580
714
        <para>
618
752
      </varlistentry>
619
753
      <varlistentry>
620
754
        <term>
621
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
622
 
          Protocol Version 1.1</citetitle>
 
755
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
 
756
          Protocol Version 1.2</citetitle>
623
757
        </term>
624
758
      <listitem>
625
759
        <para>
626
 
          TLS 1.1 is the protocol implemented by GnuTLS.
 
760
          TLS 1.2 is the protocol implemented by GnuTLS.
627
761
        </para>
628
762
      </listitem>
629
763
      </varlistentry>
639
773
      </varlistentry>
640
774
      <varlistentry>
641
775
        <term>
642
 
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
643
 
          Security</citetitle>
 
776
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
 
777
          Security (TLS) Authentication</citetitle>
644
778
        </term>
645
779
      <listitem>
646
780
        <para>