/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

* debian/mandos-client.README.Debian: Remove warning about --connect
                                      not looping, since it now does.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos.xml
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 "2010-09-26">
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>
34
34
      <year>2008</year>
35
35
      <year>2009</year>
36
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>
45
 
      <year>2019</year>
46
37
      <holder>Teddy Hogeborn</holder>
47
38
      <holder>Björn Påhlsson</holder>
48
39
    </copyright>
102
93
      <arg><option>--no-dbus</option></arg>
103
94
      <sbr/>
104
95
      <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
96
    </cmdsynopsis>
118
97
    <cmdsynopsis>
119
98
      <command>&COMMANDNAME;</command>
136
115
    <title>DESCRIPTION</title>
137
116
    <para>
138
117
      <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.
 
118
      handles incoming request for passwords for a pre-defined list of
 
119
      client host computers.  The Mandos server uses Zeroconf to
 
120
      announce itself on the local network, and uses TLS to
 
121
      communicate securely with and to authenticate the clients.  The
 
122
      Mandos server uses IPv6 to allow Mandos clients to use IPv6
 
123
      link-local addresses, since the clients will probably not have
 
124
      any other addresses configured (see <xref linkend="overview"/>).
 
125
      Any authenticated client is then given the stored pre-encrypted
 
126
      password for that specific client.
150
127
    </para>
151
128
  </refsect1>
152
129
  
295
272
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
296
273
        </listitem>
297
274
      </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
275
    </variablelist>
341
276
  </refsect1>
342
277
  
362
297
      start a TLS protocol handshake with a slight quirk: the Mandos
363
298
      server program acts as a TLS <quote>client</quote> while the
364
299
      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.
 
300
      The Mandos client must supply an OpenPGP certificate, and the
 
301
      fingerprint of this certificate is used by the Mandos server to
 
302
      look up (in a list read from <filename>clients.conf</filename>
 
303
      at start time) which binary blob to give the client.  No other
 
304
      authentication or authorization is done by the server.
370
305
    </para>
371
306
    <table>
372
307
      <title>Mandos Protocol (Version 1)</title><tgroup cols="3"><thead>
392
327
        </emphasis></entry>
393
328
      </row>
394
329
      <row>
395
 
        <entry>Public key (part of TLS handshake)</entry>
 
330
        <entry>OpenPGP public key (part of TLS handshake)</entry>
396
331
        <entry>-><!-- &rarr; --></entry>
397
332
      </row>
398
333
      <row>
416
351
      for some time, the client is assumed to be compromised and is no
417
352
      longer eligible to receive the encrypted password.  (Manual
418
353
      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>.
 
354
      checker program, and interval between checks can be configured
 
355
      both globally and per client; see <citerefentry>
 
356
      <refentrytitle>mandos-clients.conf</refentrytitle>
 
357
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
 
358
      receiving its password will also be treated as a successful
 
359
      checker run.
423
360
    </para>
424
361
  </refsect1>
425
362
  
447
384
    <title>LOGGING</title>
448
385
    <para>
449
386
      The server will send log message with various severity levels to
450
 
      <filename class="devicefile">/dev/log</filename>.  With the
 
387
      <filename>/dev/log</filename>.  With the
451
388
      <option>--debug</option> option, it will log even more messages,
452
389
      and also show them on the console.
453
390
    </para>
454
391
  </refsect1>
455
392
  
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
393
  <refsect1 id="dbus_interface">
469
394
    <title>D-BUS INTERFACE</title>
470
395
    <para>
532
457
        </listitem>
533
458
      </varlistentry>
534
459
      <varlistentry>
535
 
        <term><filename>/run/mandos.pid</filename></term>
 
460
        <term><filename>/var/run/mandos.pid</filename></term>
536
461
        <listitem>
537
462
          <para>
538
463
            The file containing the process id of the
539
464
            <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>
 
465
          </para>
 
466
        </listitem>
 
467
      </varlistentry>
 
468
      <varlistentry>
 
469
        <term><filename>/dev/log</filename></term>
560
470
        <listitem>
561
471
          <para>
562
472
            The Unix domain socket to where local syslog messages are
585
495
      backtrace.  This could be considered a feature.
586
496
    </para>
587
497
    <para>
 
498
      Currently, if a client is disabled due to having timed out, the
 
499
      server does not record this fact onto permanent storage.  This
 
500
      has some security implications, see <xref linkend="clients"/>.
 
501
    </para>
 
502
    <para>
588
503
      There is no fine-grained control over logging and debug output.
589
504
    </para>
590
 
    <xi:include href="bugs.xml"/>
 
505
    <para>
 
506
      Debug mode is conflated with running in the foreground.
 
507
    </para>
 
508
    <para>
 
509
      The console log messages do not show a time stamp.
 
510
    </para>
 
511
    <para>
 
512
      This server does not check the expire time of clients’ OpenPGP
 
513
      keys.
 
514
    </para>
591
515
  </refsect1>
592
516
  
593
517
  <refsect1 id="example">
603
527
    <informalexample>
604
528
      <para>
605
529
        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:
 
530
        the <filename>~/mandos</filename> directory, and use the
 
531
        Zeroconf service name <quote>Test</quote> to not collide with
 
532
        any other official Mandos server on this host:
609
533
      </para>
610
534
      <para>
611
535
 
643
567
      <title>CLIENTS</title>
644
568
      <para>
645
569
        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
 
570
        does have the OpenPGP key of the stored fingerprint.  This is
 
571
        guaranteed by the fact that the client sends its OpenPGP
 
572
        public key in the TLS handshake; this ensures it to be
 
573
        genuine.  The server computes the fingerprint of the key
 
574
        itself and looks up the fingerprint in its list of
 
575
        clients. The <filename>clients.conf</filename> file (see
652
576
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
653
577
        <manvolnum>5</manvolnum></citerefentry>)
654
578
        <emphasis>must</emphasis> be made non-readable by anyone
660
584
        compromised if they are gone for too long.
661
585
      </para>
662
586
      <para>
 
587
        If a client is compromised, its downtime should be duly noted
 
588
        by the server which would therefore disable the client.  But
 
589
        if the server was ever restarted, it would re-read its client
 
590
        list from its configuration file and again regard all clients
 
591
        therein as enabled, and hence eligible to receive their
 
592
        passwords.  Therefore, be careful when restarting servers if
 
593
        it is suspected that a client has, in fact, been compromised
 
594
        by parties who may now be running a fake Mandos client with
 
595
        the keys from the non-encrypted initial <acronym>RAM</acronym>
 
596
        image of the client host.  What should be done in that case
 
597
        (if restarting the server program really is necessary) is to
 
598
        stop the server program, edit the configuration file to omit
 
599
        any suspect clients, and restart the server program.
 
600
      </para>
 
601
      <para>
663
602
        For more details on client-side security, see
664
603
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
665
604
        <manvolnum>8mandos</manvolnum></citerefentry>.
670
609
  <refsect1 id="see_also">
671
610
    <title>SEE ALSO</title>
672
611
    <para>
673
 
      <citerefentry><refentrytitle>intro</refentrytitle>
674
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
675
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
676
 
      <manvolnum>5</manvolnum></citerefentry>,
677
 
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
678
 
      <manvolnum>5</manvolnum></citerefentry>,
679
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
680
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
681
 
      <citerefentry><refentrytitle>sh</refentrytitle>
682
 
      <manvolnum>1</manvolnum></citerefentry>
 
612
      <citerefentry>
 
613
        <refentrytitle>mandos-clients.conf</refentrytitle>
 
614
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
 
615
        <refentrytitle>mandos.conf</refentrytitle>
 
616
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
 
617
        <refentrytitle>mandos-client</refentrytitle>
 
618
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
 
619
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
 
620
      </citerefentry>
683
621
    </para>
684
622
    <variablelist>
685
623
      <varlistentry>
695
633
      </varlistentry>
696
634
      <varlistentry>
697
635
        <term>
698
 
          <ulink url="https://www.avahi.org/">Avahi</ulink>
 
636
          <ulink url="http://www.avahi.org/">Avahi</ulink>
699
637
        </term>
700
638
      <listitem>
701
639
        <para>
706
644
      </varlistentry>
707
645
      <varlistentry>
708
646
        <term>
709
 
          <ulink url="https://gnutls.org/">GnuTLS</ulink>
 
647
          <ulink url="http://www.gnu.org/software/gnutls/"
 
648
          >GnuTLS</ulink>
710
649
        </term>
711
650
      <listitem>
712
651
        <para>
713
652
          GnuTLS is the library this server uses to implement TLS for
714
653
          communicating securely with the client, and at the same time
715
 
          confidently get the client’s public key.
 
654
          confidently get the client’s public OpenPGP key.
716
655
        </para>
717
656
      </listitem>
718
657
      </varlistentry>
739
678
            <listitem>
740
679
              <para>
741
680
                The clients use IPv6 link-local addresses, which are
742
 
                immediately usable since a link-local address is
 
681
                immediately usable since a link-local addresses is
743
682
                automatically assigned to a network interfaces when it
744
683
                is brought up.
745
684
              </para>
750
689
      </varlistentry>
751
690
      <varlistentry>
752
691
        <term>
753
 
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
754
 
          Protocol Version 1.2</citetitle>
 
692
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
693
          Protocol Version 1.1</citetitle>
755
694
        </term>
756
695
      <listitem>
757
696
        <para>
758
 
          TLS 1.2 is the protocol implemented by GnuTLS.
 
697
          TLS 1.1 is the protocol implemented by GnuTLS.
759
698
        </para>
760
699
      </listitem>
761
700
      </varlistentry>
771
710
      </varlistentry>
772
711
      <varlistentry>
773
712
        <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.
 
713
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
 
714
          Security</citetitle>
 
715
        </term>
 
716
      <listitem>
 
717
        <para>
 
718
          This is implemented by GnuTLS and used by this server so
 
719
          that OpenPGP keys can be used.
796
720
        </para>
797
721
      </listitem>
798
722
      </varlistentry>