/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: 2016-03-19 22:00:38 UTC
  • Revision ID: teddy@recompile.se-20160319220038-mexjdy1ct3wzld5t
Tags: version-1.7.7-1
* Makefile (version): Changed to "1.7.7".
* NEWS (Version 1.7.7): New entry.
* debian/changelog (1.7.7-1): - '' -

Show diffs side-by-side

added added

removed removed

Lines of Context:
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
4
<!ENTITY COMMANDNAME "mandos">
5
 
<!ENTITY TIMESTAMP "2008-12-28">
 
5
<!ENTITY TIMESTAMP "2016-03-05">
6
6
<!ENTITY % common SYSTEM "common.ent">
7
7
%common;
8
8
]>
19
19
        <firstname>Björn</firstname>
20
20
        <surname>Påhlsson</surname>
21
21
        <address>
22
 
          <email>belorn@fukt.bsnet.se</email>
 
22
          <email>belorn@recompile.se</email>
23
23
        </address>
24
24
      </author>
25
25
      <author>
26
26
        <firstname>Teddy</firstname>
27
27
        <surname>Hogeborn</surname>
28
28
        <address>
29
 
          <email>teddy@fukt.bsnet.se</email>
 
29
          <email>teddy@recompile.se</email>
30
30
        </address>
31
31
      </author>
32
32
    </authorgroup>
33
33
    <copyright>
34
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>
35
43
      <holder>Teddy Hogeborn</holder>
36
44
      <holder>Björn Påhlsson</holder>
37
45
    </copyright>
85
93
      <sbr/>
86
94
      <arg><option>--debug</option></arg>
87
95
      <sbr/>
 
96
      <arg><option>--debuglevel
 
97
      <replaceable>LEVEL</replaceable></option></arg>
 
98
      <sbr/>
88
99
      <arg><option>--no-dbus</option></arg>
 
100
      <sbr/>
 
101
      <arg><option>--no-ipv6</option></arg>
 
102
      <sbr/>
 
103
      <arg><option>--no-restore</option></arg>
 
104
      <sbr/>
 
105
      <arg><option>--statedir
 
106
      <replaceable>DIRECTORY</replaceable></option></arg>
 
107
      <sbr/>
 
108
      <arg><option>--socket
 
109
      <replaceable>FD</replaceable></option></arg>
 
110
      <sbr/>
 
111
      <arg><option>--foreground</option></arg>
 
112
      <sbr/>
 
113
      <arg><option>--no-zeroconf</option></arg>
89
114
    </cmdsynopsis>
90
115
    <cmdsynopsis>
91
116
      <command>&COMMANDNAME;</command>
109
134
    <para>
110
135
      <command>&COMMANDNAME;</command> is a server daemon which
111
136
      handles incoming request for passwords for a pre-defined list of
112
 
      client host computers.  The Mandos server uses Zeroconf to
113
 
      announce itself on the local network, and uses TLS to
114
 
      communicate securely with and to authenticate the clients.  The
115
 
      Mandos server uses IPv6 to allow Mandos clients to use IPv6
116
 
      link-local addresses, since the clients will probably not have
117
 
      any other addresses configured (see <xref linkend="overview"/>).
118
 
      Any authenticated client is then given the stored pre-encrypted
119
 
      password for that specific client.
 
137
      client host computers. For an introduction, see
 
138
      <citerefentry><refentrytitle>intro</refentrytitle>
 
139
      <manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
 
140
      uses Zeroconf to announce itself on the local network, and uses
 
141
      TLS to communicate securely with and to authenticate the
 
142
      clients.  The Mandos server uses IPv6 to allow Mandos clients to
 
143
      use IPv6 link-local addresses, since the clients will probably
 
144
      not have any other addresses configured (see <xref
 
145
      linkend="overview"/>).  Any authenticated client is then given
 
146
      the stored pre-encrypted password for that specific client.
120
147
    </para>
121
148
  </refsect1>
122
149
  
191
218
      </varlistentry>
192
219
      
193
220
      <varlistentry>
 
221
        <term><option>--debuglevel
 
222
        <replaceable>LEVEL</replaceable></option></term>
 
223
        <listitem>
 
224
          <para>
 
225
            Set the debugging log level.
 
226
            <replaceable>LEVEL</replaceable> is a string, one of
 
227
            <quote><literal>CRITICAL</literal></quote>,
 
228
            <quote><literal>ERROR</literal></quote>,
 
229
            <quote><literal>WARNING</literal></quote>,
 
230
            <quote><literal>INFO</literal></quote>, or
 
231
            <quote><literal>DEBUG</literal></quote>, in order of
 
232
            increasing verbosity.  The default level is
 
233
            <quote><literal>WARNING</literal></quote>.
 
234
          </para>
 
235
        </listitem>
 
236
      </varlistentry>
 
237
      
 
238
      <varlistentry>
194
239
        <term><option>--priority <replaceable>
195
240
        PRIORITY</replaceable></option></term>
196
241
        <listitem>
236
281
        <listitem>
237
282
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
238
283
          <para>
239
 
            See also <xref linkend="dbus"/>.
240
 
        </listitem>
241
 
      </varlistentry>
 
284
            See also <xref linkend="dbus_interface"/>.
 
285
          </para>
 
286
        </listitem>
 
287
      </varlistentry>
 
288
      
 
289
      <varlistentry>
 
290
        <term><option>--no-ipv6</option></term>
 
291
        <listitem>
 
292
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
 
293
        </listitem>
 
294
      </varlistentry>
 
295
      
 
296
      <varlistentry>
 
297
        <term><option>--no-restore</option></term>
 
298
        <listitem>
 
299
          <xi:include href="mandos-options.xml" xpointer="restore"/>
 
300
          <para>
 
301
            See also <xref linkend="persistent_state"/>.
 
302
          </para>
 
303
        </listitem>
 
304
      </varlistentry>
 
305
      
 
306
      <varlistentry>
 
307
        <term><option>--statedir
 
308
        <replaceable>DIRECTORY</replaceable></option></term>
 
309
        <listitem>
 
310
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
 
311
        </listitem>
 
312
      </varlistentry>
 
313
      
 
314
      <varlistentry>
 
315
        <term><option>--socket
 
316
        <replaceable>FD</replaceable></option></term>
 
317
        <listitem>
 
318
          <xi:include href="mandos-options.xml" xpointer="socket"/>
 
319
        </listitem>
 
320
      </varlistentry>
 
321
      
 
322
      <varlistentry>
 
323
        <term><option>--foreground</option></term>
 
324
        <listitem>
 
325
          <xi:include href="mandos-options.xml"
 
326
                      xpointer="foreground"/>
 
327
        </listitem>
 
328
      </varlistentry>
 
329
      
 
330
      <varlistentry>
 
331
        <term><option>--no-zeroconf</option></term>
 
332
        <listitem>
 
333
          <xi:include href="mandos-options.xml" xpointer="zeroconf"/>
 
334
        </listitem>
 
335
      </varlistentry>
 
336
      
242
337
    </variablelist>
243
338
  </refsect1>
244
339
  
316
411
      The server will, by default, continually check that the clients
317
412
      are still up.  If a client has not been confirmed as being up
318
413
      for some time, the client is assumed to be compromised and is no
319
 
      longer eligible to receive the encrypted password.  The timeout,
320
 
      checker program, and interval between checks can be configured
321
 
      both globally and per client; see <citerefentry>
 
414
      longer eligible to receive the encrypted password.  (Manual
 
415
      intervention is required to re-enable a client.)  The timeout,
 
416
      extended timeout, checker program, and interval between checks
 
417
      can be configured both globally and per client; see
 
418
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
419
      <manvolnum>5</manvolnum></citerefentry>.
 
420
    </para>
 
421
  </refsect1>
 
422
  
 
423
  <refsect1 id="approval">
 
424
    <title>APPROVAL</title>
 
425
    <para>
 
426
      The server can be configured to require manual approval for a
 
427
      client before it is sent its secret.  The delay to wait for such
 
428
      approval and the default action (approve or deny) can be
 
429
      configured both globally and per client; see <citerefentry>
322
430
      <refentrytitle>mandos-clients.conf</refentrytitle>
323
 
      <manvolnum>5</manvolnum></citerefentry>.
324
 
    </para>
 
431
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
 
432
      will be approved immediately without delay.
 
433
    </para>
 
434
    <para>
 
435
      This can be used to deny a client its secret if not manually
 
436
      approved within a specified time.  It can also be used to make
 
437
      the server delay before giving a client its secret, allowing
 
438
      optional manual denying of this specific client.
 
439
    </para>
 
440
    
325
441
  </refsect1>
326
442
  
327
443
  <refsect1 id="logging">
328
444
    <title>LOGGING</title>
329
445
    <para>
330
446
      The server will send log message with various severity levels to
331
 
      <filename>/dev/log</filename>.  With the
 
447
      <filename class="devicefile">/dev/log</filename>.  With the
332
448
      <option>--debug</option> option, it will log even more messages,
333
449
      and also show them on the console.
334
450
    </para>
335
451
  </refsect1>
336
452
  
337
 
  <refsect1 id="dbus">
 
453
  <refsect1 id="persistent_state">
 
454
    <title>PERSISTENT STATE</title>
 
455
    <para>
 
456
      Client settings, initially read from
 
457
      <filename>clients.conf</filename>, are persistent across
 
458
      restarts, and run-time changes will override settings in
 
459
      <filename>clients.conf</filename>.  However, if a setting is
 
460
      <emphasis>changed</emphasis> (or a client added, or removed) in
 
461
      <filename>clients.conf</filename>, this will take precedence.
 
462
    </para>
 
463
  </refsect1>
 
464
  
 
465
  <refsect1 id="dbus_interface">
338
466
    <title>D-BUS INTERFACE</title>
339
467
    <para>
340
468
      The server will by default provide a D-Bus system bus interface.
341
469
      This interface will only be accessible by the root user or a
342
 
      Mandos-specific user, if such a user exists.
343
 
      <!-- XXX -->
 
470
      Mandos-specific user, if such a user exists.  For documentation
 
471
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
344
472
    </para>
345
473
  </refsect1>
346
 
 
 
474
  
347
475
  <refsect1 id="exit_status">
348
476
    <title>EXIT STATUS</title>
349
477
    <para>
401
529
        </listitem>
402
530
      </varlistentry>
403
531
      <varlistentry>
404
 
        <term><filename>/var/run/mandos.pid</filename></term>
405
 
        <listitem>
406
 
          <para>
407
 
            The file containing the process id of
408
 
            <command>&COMMANDNAME;</command>.
409
 
          </para>
410
 
        </listitem>
411
 
      </varlistentry>
412
 
      <varlistentry>
413
 
        <term><filename>/dev/log</filename></term>
 
532
        <term><filename>/run/mandos.pid</filename></term>
 
533
        <listitem>
 
534
          <para>
 
535
            The file containing the process id of the
 
536
            <command>&COMMANDNAME;</command> process started last.
 
537
            <emphasis >Note:</emphasis> If the <filename
 
538
            class="directory">/run</filename> directory does not
 
539
            exist, <filename>/var/run/mandos.pid</filename> will be
 
540
            used instead.
 
541
          </para>
 
542
        </listitem>
 
543
      </varlistentry>
 
544
      <varlistentry>
 
545
        <term><filename
 
546
        class="directory">/var/lib/mandos</filename></term>
 
547
        <listitem>
 
548
          <para>
 
549
            Directory where persistent state will be saved.  Change
 
550
            this with the <option>--statedir</option> option.  See
 
551
            also the <option>--no-restore</option> option.
 
552
          </para>
 
553
        </listitem>
 
554
      </varlistentry>
 
555
      <varlistentry>
 
556
        <term><filename class="devicefile">/dev/log</filename></term>
414
557
        <listitem>
415
558
          <para>
416
559
            The Unix domain socket to where local syslog messages are
439
582
      backtrace.  This could be considered a feature.
440
583
    </para>
441
584
    <para>
442
 
      Currently, if a client is declared <quote>invalid</quote> due to
443
 
      having timed out, the server does not record this fact onto
444
 
      permanent storage.  This has some security implications, see
445
 
      <xref linkend="clients"/>.
446
 
    </para>
447
 
    <para>
448
 
      There is currently no way of querying the server of the current
449
 
      status of clients, other than analyzing its <systemitem
450
 
      class="service">syslog</systemitem> output.
451
 
    </para>
452
 
    <para>
453
585
      There is no fine-grained control over logging and debug output.
454
586
    </para>
455
587
    <para>
456
 
      Debug mode is conflated with running in the foreground.
457
 
    </para>
458
 
    <para>
459
 
      The console log messages does not show a time stamp.
460
 
    </para>
461
 
    <para>
462
588
      This server does not check the expire time of clients’ OpenPGP
463
589
      keys.
464
590
    </para>
 
591
    <xi:include href="bugs.xml"/>
465
592
  </refsect1>
466
593
  
467
594
  <refsect1 id="example">
477
604
    <informalexample>
478
605
      <para>
479
606
        Run the server in debug mode, read configuration files from
480
 
        the <filename>~/mandos</filename> directory, and use the
481
 
        Zeroconf service name <quote>Test</quote> to not collide with
482
 
        any other official Mandos server on this host:
 
607
        the <filename class="directory">~/mandos</filename> directory,
 
608
        and use the Zeroconf service name <quote>Test</quote> to not
 
609
        collide with any other official Mandos server on this host:
483
610
      </para>
484
611
      <para>
485
612
 
534
661
        compromised if they are gone for too long.
535
662
      </para>
536
663
      <para>
537
 
        If a client is compromised, its downtime should be duly noted
538
 
        by the server which would therefore declare the client
539
 
        invalid.  But if the server was ever restarted, it would
540
 
        re-read its client list from its configuration file and again
541
 
        regard all clients therein as valid, and hence eligible to
542
 
        receive their passwords.  Therefore, be careful when
543
 
        restarting servers if it is suspected that a client has, in
544
 
        fact, been compromised by parties who may now be running a
545
 
        fake Mandos client with the keys from the non-encrypted
546
 
        initial <acronym>RAM</acronym> image of the client host.  What
547
 
        should be done in that case (if restarting the server program
548
 
        really is necessary) is to stop the server program, edit the
549
 
        configuration file to omit any suspect clients, and restart
550
 
        the server program.
551
 
      </para>
552
 
      <para>
553
664
        For more details on client-side security, see
554
665
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
555
666
        <manvolnum>8mandos</manvolnum></citerefentry>.
560
671
  <refsect1 id="see_also">
561
672
    <title>SEE ALSO</title>
562
673
    <para>
563
 
      <citerefentry>
564
 
        <refentrytitle>mandos-clients.conf</refentrytitle>
565
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
566
 
        <refentrytitle>mandos.conf</refentrytitle>
567
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
568
 
        <refentrytitle>mandos-client</refentrytitle>
569
 
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
570
 
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
571
 
      </citerefentry>
 
674
      <citerefentry><refentrytitle>intro</refentrytitle>
 
675
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
676
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
677
      <manvolnum>5</manvolnum></citerefentry>,
 
678
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
 
679
      <manvolnum>5</manvolnum></citerefentry>,
 
680
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
681
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
682
      <citerefentry><refentrytitle>sh</refentrytitle>
 
683
      <manvolnum>1</manvolnum></citerefentry>
572
684
    </para>
573
685
    <variablelist>
574
686
      <varlistentry>
595
707
      </varlistentry>
596
708
      <varlistentry>
597
709
        <term>
598
 
          <ulink url="http://www.gnu.org/software/gnutls/"
599
 
          >GnuTLS</ulink>
 
710
          <ulink url="http://gnutls.org/">GnuTLS</ulink>
600
711
        </term>
601
712
      <listitem>
602
713
        <para>
640
751
      </varlistentry>
641
752
      <varlistentry>
642
753
        <term>
643
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
644
 
          Protocol Version 1.1</citetitle>
 
754
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
 
755
          Protocol Version 1.2</citetitle>
645
756
        </term>
646
757
      <listitem>
647
758
        <para>
648
 
          TLS 1.1 is the protocol implemented by GnuTLS.
 
759
          TLS 1.2 is the protocol implemented by GnuTLS.
649
760
        </para>
650
761
      </listitem>
651
762
      </varlistentry>
661
772
      </varlistentry>
662
773
      <varlistentry>
663
774
        <term>
664
 
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
665
 
          Security</citetitle>
 
775
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
 
776
          Security (TLS) Authentication</citetitle>
666
777
        </term>
667
778
      <listitem>
668
779
        <para>