/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: 2011-09-18 15:03:26 UTC
  • Revision ID: teddy@fukt.bsnet.se-20110918150326-tj4zz5qv0cv54we3
* debian/control: Fix language for lintian.

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 "2022-04-24">
 
5
<!ENTITY TIMESTAMP "2011-08-08">
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@recompile.se</email>
 
22
          <email>belorn@fukt.bsnet.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@recompile.se</email>
 
29
          <email>teddy@fukt.bsnet.se</email>
30
30
        </address>
31
31
      </author>
32
32
    </authorgroup>
35
35
      <year>2009</year>
36
36
      <year>2010</year>
37
37
      <year>2011</year>
38
 
      <year>2012</year>
39
 
      <year>2013</year>
40
 
      <year>2014</year>
41
 
      <year>2015</year>
42
 
      <year>2016</year>
43
 
      <year>2017</year>
44
 
      <year>2018</year>
45
 
      <year>2019</year>
46
38
      <holder>Teddy Hogeborn</holder>
47
39
      <holder>Björn Påhlsson</holder>
48
40
    </copyright>
102
94
      <arg><option>--no-dbus</option></arg>
103
95
      <sbr/>
104
96
      <arg><option>--no-ipv6</option></arg>
105
 
      <sbr/>
106
 
      <arg><option>--no-restore</option></arg>
107
 
      <sbr/>
108
 
      <arg><option>--statedir
109
 
      <replaceable>DIRECTORY</replaceable></option></arg>
110
 
      <sbr/>
111
 
      <arg><option>--socket
112
 
      <replaceable>FD</replaceable></option></arg>
113
 
      <sbr/>
114
 
      <arg><option>--foreground</option></arg>
115
 
      <sbr/>
116
 
      <arg><option>--no-zeroconf</option></arg>
117
97
    </cmdsynopsis>
118
98
    <cmdsynopsis>
119
99
      <command>&COMMANDNAME;</command>
136
116
    <title>DESCRIPTION</title>
137
117
    <para>
138
118
      <command>&COMMANDNAME;</command> is a server daemon which
139
 
      handles incoming requests for passwords for a pre-defined list
140
 
      of client host computers. For an introduction, see
141
 
      <citerefentry><refentrytitle>intro</refentrytitle>
142
 
      <manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
143
 
      uses Zeroconf to announce itself on the local network, and uses
144
 
      TLS to communicate securely with and to authenticate the
145
 
      clients.  The Mandos server uses IPv6 to allow Mandos clients to
146
 
      use IPv6 link-local addresses, since the clients will probably
147
 
      not have any other addresses configured (see <xref
148
 
      linkend="overview"/>).  Any authenticated client is then given
149
 
      the stored pre-encrypted password for that specific client.
 
119
      handles incoming request for passwords for a pre-defined list of
 
120
      client host computers.  The Mandos server uses Zeroconf to
 
121
      announce itself on the local network, and uses TLS to
 
122
      communicate securely with and to authenticate the clients.  The
 
123
      Mandos server uses IPv6 to allow Mandos clients to use IPv6
 
124
      link-local addresses, since the clients will probably not have
 
125
      any other addresses configured (see <xref linkend="overview"/>).
 
126
      Any authenticated client is then given the stored pre-encrypted
 
127
      password for that specific client.
150
128
    </para>
151
129
  </refsect1>
152
130
  
295
273
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
296
274
        </listitem>
297
275
      </varlistentry>
298
 
      
299
 
      <varlistentry>
300
 
        <term><option>--no-restore</option></term>
301
 
        <listitem>
302
 
          <xi:include href="mandos-options.xml" xpointer="restore"/>
303
 
          <para>
304
 
            See also <xref linkend="persistent_state"/>.
305
 
          </para>
306
 
        </listitem>
307
 
      </varlistentry>
308
 
      
309
 
      <varlistentry>
310
 
        <term><option>--statedir
311
 
        <replaceable>DIRECTORY</replaceable></option></term>
312
 
        <listitem>
313
 
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
314
 
        </listitem>
315
 
      </varlistentry>
316
 
      
317
 
      <varlistentry>
318
 
        <term><option>--socket
319
 
        <replaceable>FD</replaceable></option></term>
320
 
        <listitem>
321
 
          <xi:include href="mandos-options.xml" xpointer="socket"/>
322
 
        </listitem>
323
 
      </varlistentry>
324
 
      
325
 
      <varlistentry>
326
 
        <term><option>--foreground</option></term>
327
 
        <listitem>
328
 
          <xi:include href="mandos-options.xml"
329
 
                      xpointer="foreground"/>
330
 
        </listitem>
331
 
      </varlistentry>
332
 
      
333
 
      <varlistentry>
334
 
        <term><option>--no-zeroconf</option></term>
335
 
        <listitem>
336
 
          <xi:include href="mandos-options.xml" xpointer="zeroconf"/>
337
 
        </listitem>
338
 
      </varlistentry>
339
 
      
340
276
    </variablelist>
341
277
  </refsect1>
342
278
  
362
298
      start a TLS protocol handshake with a slight quirk: the Mandos
363
299
      server program acts as a TLS <quote>client</quote> while the
364
300
      connecting Mandos client acts as a TLS <quote>server</quote>.
365
 
      The Mandos client must supply a TLS public key, and the key ID
366
 
      of this public key is used by the Mandos server to look up (in a
367
 
      list read from <filename>clients.conf</filename> at start time)
368
 
      which binary blob to give the client.  No other authentication
369
 
      or authorization is done by the server.
 
301
      The Mandos client must supply an OpenPGP certificate, and the
 
302
      fingerprint of this certificate is used by the Mandos server to
 
303
      look up (in a list read from <filename>clients.conf</filename>
 
304
      at start time) which binary blob to give the client.  No other
 
305
      authentication or authorization is done by the server.
370
306
    </para>
371
307
    <table>
372
308
      <title>Mandos Protocol (Version 1)</title><tgroup cols="3"><thead>
392
328
        </emphasis></entry>
393
329
      </row>
394
330
      <row>
395
 
        <entry>Public key (part of TLS handshake)</entry>
 
331
        <entry>OpenPGP public key (part of TLS handshake)</entry>
396
332
        <entry>-><!-- &rarr; --></entry>
397
333
      </row>
398
334
      <row>
416
352
      for some time, the client is assumed to be compromised and is no
417
353
      longer eligible to receive the encrypted password.  (Manual
418
354
      intervention is required to re-enable a client.)  The timeout,
419
 
      extended timeout, checker program, and interval between checks
420
 
      can be configured both globally and per client; see
421
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
422
 
      <manvolnum>5</manvolnum></citerefentry>.
 
355
      checker program, and interval between checks can be configured
 
356
      both globally and per client; see <citerefentry>
 
357
      <refentrytitle>mandos-clients.conf</refentrytitle>
 
358
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
 
359
      receiving its password will also be treated as a successful
 
360
      checker run.
423
361
    </para>
424
362
  </refsect1>
425
363
  
447
385
    <title>LOGGING</title>
448
386
    <para>
449
387
      The server will send log message with various severity levels to
450
 
      <filename class="devicefile">/dev/log</filename>.  With the
 
388
      <filename>/dev/log</filename>.  With the
451
389
      <option>--debug</option> option, it will log even more messages,
452
390
      and also show them on the console.
453
391
    </para>
454
392
  </refsect1>
455
393
  
456
 
  <refsect1 id="persistent_state">
457
 
    <title>PERSISTENT STATE</title>
458
 
    <para>
459
 
      Client settings, initially read from
460
 
      <filename>clients.conf</filename>, are persistent across
461
 
      restarts, and run-time changes will override settings in
462
 
      <filename>clients.conf</filename>.  However, if a setting is
463
 
      <emphasis>changed</emphasis> (or a client added, or removed) in
464
 
      <filename>clients.conf</filename>, this will take precedence.
465
 
    </para>
466
 
  </refsect1>
467
 
  
468
394
  <refsect1 id="dbus_interface">
469
395
    <title>D-BUS INTERFACE</title>
470
396
    <para>
532
458
        </listitem>
533
459
      </varlistentry>
534
460
      <varlistentry>
535
 
        <term><filename>/run/mandos.pid</filename></term>
 
461
        <term><filename>/var/run/mandos.pid</filename></term>
536
462
        <listitem>
537
463
          <para>
538
464
            The file containing the process id of the
539
465
            <command>&COMMANDNAME;</command> process started last.
540
 
            <emphasis >Note:</emphasis> If the <filename
541
 
            class="directory">/run</filename> directory does not
542
 
            exist, <filename>/var/run/mandos.pid</filename> will be
543
 
            used instead.
544
 
          </para>
545
 
        </listitem>
546
 
      </varlistentry>
547
 
      <varlistentry>
548
 
        <term><filename
549
 
        class="directory">/var/lib/mandos</filename></term>
550
 
        <listitem>
551
 
          <para>
552
 
            Directory where persistent state will be saved.  Change
553
 
            this with the <option>--statedir</option> option.  See
554
 
            also the <option>--no-restore</option> option.
555
 
          </para>
556
 
        </listitem>
557
 
      </varlistentry>
558
 
      <varlistentry>
559
 
        <term><filename class="devicefile">/dev/log</filename></term>
 
466
          </para>
 
467
        </listitem>
 
468
      </varlistentry>
 
469
      <varlistentry>
 
470
        <term><filename>/dev/log</filename></term>
560
471
        <listitem>
561
472
          <para>
562
473
            The Unix domain socket to where local syslog messages are
585
496
      backtrace.  This could be considered a feature.
586
497
    </para>
587
498
    <para>
 
499
      Currently, if a client is disabled due to having timed out, the
 
500
      server does not record this fact onto permanent storage.  This
 
501
      has some security implications, see <xref linkend="clients"/>.
 
502
    </para>
 
503
    <para>
588
504
      There is no fine-grained control over logging and debug output.
589
505
    </para>
590
 
    <xi:include href="bugs.xml"/>
 
506
    <para>
 
507
      Debug mode is conflated with running in the foreground.
 
508
    </para>
 
509
    <para>
 
510
      The console log messages do not show a time stamp.
 
511
    </para>
 
512
    <para>
 
513
      This server does not check the expire time of clients’ OpenPGP
 
514
      keys.
 
515
    </para>
591
516
  </refsect1>
592
517
  
593
518
  <refsect1 id="example">
603
528
    <informalexample>
604
529
      <para>
605
530
        Run the server in debug mode, read configuration files from
606
 
        the <filename class="directory">~/mandos</filename> directory,
607
 
        and use the Zeroconf service name <quote>Test</quote> to not
608
 
        collide with any other official Mandos server on this host:
 
531
        the <filename>~/mandos</filename> directory, and use the
 
532
        Zeroconf service name <quote>Test</quote> to not collide with
 
533
        any other official Mandos server on this host:
609
534
      </para>
610
535
      <para>
611
536
 
643
568
      <title>CLIENTS</title>
644
569
      <para>
645
570
        The server only gives out its stored data to clients which
646
 
        does have the correct key ID of the stored key ID.  This is
647
 
        guaranteed by the fact that the client sends its public key in
648
 
        the TLS handshake; this ensures it to be genuine.  The server
649
 
        computes the key ID of the key itself and looks up the key ID
650
 
        in its list of clients. The <filename>clients.conf</filename>
651
 
        file (see
 
571
        does have the OpenPGP key of the stored fingerprint.  This is
 
572
        guaranteed by the fact that the client sends its OpenPGP
 
573
        public key in the TLS handshake; this ensures it to be
 
574
        genuine.  The server computes the fingerprint of the key
 
575
        itself and looks up the fingerprint in its list of
 
576
        clients. The <filename>clients.conf</filename> file (see
652
577
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
653
578
        <manvolnum>5</manvolnum></citerefentry>)
654
579
        <emphasis>must</emphasis> be made non-readable by anyone
660
585
        compromised if they are gone for too long.
661
586
      </para>
662
587
      <para>
 
588
        If a client is compromised, its downtime should be duly noted
 
589
        by the server which would therefore disable the client.  But
 
590
        if the server was ever restarted, it would re-read its client
 
591
        list from its configuration file and again regard all clients
 
592
        therein as enabled, and hence eligible to receive their
 
593
        passwords.  Therefore, be careful when restarting servers if
 
594
        it is suspected that a client has, in fact, been compromised
 
595
        by parties who may now be running a fake Mandos client with
 
596
        the keys from the non-encrypted initial <acronym>RAM</acronym>
 
597
        image of the client host.  What should be done in that case
 
598
        (if restarting the server program really is necessary) is to
 
599
        stop the server program, edit the configuration file to omit
 
600
        any suspect clients, and restart the server program.
 
601
      </para>
 
602
      <para>
663
603
        For more details on client-side security, see
664
604
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
665
605
        <manvolnum>8mandos</manvolnum></citerefentry>.
695
635
      </varlistentry>
696
636
      <varlistentry>
697
637
        <term>
698
 
          <ulink url="https://www.avahi.org/">Avahi</ulink>
 
638
          <ulink url="http://www.avahi.org/">Avahi</ulink>
699
639
        </term>
700
640
      <listitem>
701
641
        <para>
706
646
      </varlistentry>
707
647
      <varlistentry>
708
648
        <term>
709
 
          <ulink url="https://gnutls.org/">GnuTLS</ulink>
 
649
          <ulink url="http://www.gnu.org/software/gnutls/"
 
650
          >GnuTLS</ulink>
710
651
        </term>
711
652
      <listitem>
712
653
        <para>
713
654
          GnuTLS is the library this server uses to implement TLS for
714
655
          communicating securely with the client, and at the same time
715
 
          confidently get the client’s public key.
 
656
          confidently get the client’s public OpenPGP key.
716
657
        </para>
717
658
      </listitem>
718
659
      </varlistentry>
739
680
            <listitem>
740
681
              <para>
741
682
                The clients use IPv6 link-local addresses, which are
742
 
                immediately usable since a link-local address is
 
683
                immediately usable since a link-local addresses is
743
684
                automatically assigned to a network interfaces when it
744
685
                is brought up.
745
686
              </para>
750
691
      </varlistentry>
751
692
      <varlistentry>
752
693
        <term>
753
 
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
754
 
          Protocol Version 1.2</citetitle>
 
694
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
695
          Protocol Version 1.1</citetitle>
755
696
        </term>
756
697
      <listitem>
757
698
        <para>
758
 
          TLS 1.2 is the protocol implemented by GnuTLS.
 
699
          TLS 1.1 is the protocol implemented by GnuTLS.
759
700
        </para>
760
701
      </listitem>
761
702
      </varlistentry>
771
712
      </varlistentry>
772
713
      <varlistentry>
773
714
        <term>
774
 
          RFC 7250: <citetitle>Using Raw Public Keys in Transport
775
 
          Layer Security (TLS) and Datagram Transport Layer Security
776
 
          (DTLS)</citetitle>
777
 
        </term>
778
 
      <listitem>
779
 
        <para>
780
 
          This is implemented by GnuTLS version 3.6.6 and is, if
781
 
          present, used by this server so that raw public keys can be
782
 
          used.
783
 
        </para>
784
 
      </listitem>
785
 
      </varlistentry>
786
 
      <varlistentry>
787
 
        <term>
788
 
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
789
 
          Security (TLS) Authentication</citetitle>
790
 
        </term>
791
 
      <listitem>
792
 
        <para>
793
 
          This is implemented by GnuTLS before version 3.6.0 and is,
794
 
          if present, used by this server so that OpenPGP keys can be
795
 
          used.
 
715
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
 
716
          Security</citetitle>
 
717
        </term>
 
718
      <listitem>
 
719
        <para>
 
720
          This is implemented by GnuTLS and used by this server so
 
721
          that OpenPGP keys can be used.
796
722
        </para>
797
723
      </listitem>
798
724
      </varlistentry>