/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

* plugins.d/mandos-client.c: Merge unified printing system.

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 "2011-10-03">
6
6
<!ENTITY % common SYSTEM "common.ent">
7
7
%common;
8
8
]>
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
 
119
      handles incoming request for passwords for a pre-defined list of
 
120
      client host computers. For an introduction, see
141
121
      <citerefentry><refentrytitle>intro</refentrytitle>
142
122
      <manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
143
123
      uses Zeroconf to announce itself on the local network, and uses
295
275
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
296
276
        </listitem>
297
277
      </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
278
    </variablelist>
341
279
  </refsect1>
342
280
  
362
300
      start a TLS protocol handshake with a slight quirk: the Mandos
363
301
      server program acts as a TLS <quote>client</quote> while the
364
302
      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.
 
303
      The Mandos client must supply an OpenPGP certificate, and the
 
304
      fingerprint of this certificate is used by the Mandos server to
 
305
      look up (in a list read from <filename>clients.conf</filename>
 
306
      at start time) which binary blob to give the client.  No other
 
307
      authentication or authorization is done by the server.
370
308
    </para>
371
309
    <table>
372
310
      <title>Mandos Protocol (Version 1)</title><tgroup cols="3"><thead>
392
330
        </emphasis></entry>
393
331
      </row>
394
332
      <row>
395
 
        <entry>Public key (part of TLS handshake)</entry>
 
333
        <entry>OpenPGP public key (part of TLS handshake)</entry>
396
334
        <entry>-><!-- &rarr; --></entry>
397
335
      </row>
398
336
      <row>
419
357
      extended timeout, checker program, and interval between checks
420
358
      can be configured both globally and per client; see
421
359
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
422
 
      <manvolnum>5</manvolnum></citerefentry>.
 
360
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
 
361
      receiving its password will also be treated as a successful
 
362
      checker run.
423
363
    </para>
424
364
  </refsect1>
425
365
  
447
387
    <title>LOGGING</title>
448
388
    <para>
449
389
      The server will send log message with various severity levels to
450
 
      <filename class="devicefile">/dev/log</filename>.  With the
 
390
      <filename>/dev/log</filename>.  With the
451
391
      <option>--debug</option> option, it will log even more messages,
452
392
      and also show them on the console.
453
393
    </para>
454
394
  </refsect1>
455
395
  
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
396
  <refsect1 id="dbus_interface">
469
397
    <title>D-BUS INTERFACE</title>
470
398
    <para>
532
460
        </listitem>
533
461
      </varlistentry>
534
462
      <varlistentry>
535
 
        <term><filename>/run/mandos.pid</filename></term>
 
463
        <term><filename>/var/run/mandos.pid</filename></term>
536
464
        <listitem>
537
465
          <para>
538
466
            The file containing the process id of the
539
467
            <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>
 
468
          </para>
 
469
        </listitem>
 
470
      </varlistentry>
 
471
      <varlistentry>
 
472
        <term><filename>/dev/log</filename></term>
560
473
        <listitem>
561
474
          <para>
562
475
            The Unix domain socket to where local syslog messages are
585
498
      backtrace.  This could be considered a feature.
586
499
    </para>
587
500
    <para>
 
501
      Currently, if a client is disabled due to having timed out, the
 
502
      server does not record this fact onto permanent storage.  This
 
503
      has some security implications, see <xref linkend="clients"/>.
 
504
    </para>
 
505
    <para>
588
506
      There is no fine-grained control over logging and debug output.
589
507
    </para>
590
 
    <xi:include href="bugs.xml"/>
 
508
    <para>
 
509
      Debug mode is conflated with running in the foreground.
 
510
    </para>
 
511
    <para>
 
512
      The console log messages do not show a time stamp.
 
513
    </para>
 
514
    <para>
 
515
      This server does not check the expire time of clients’ OpenPGP
 
516
      keys.
 
517
    </para>
591
518
  </refsect1>
592
519
  
593
520
  <refsect1 id="example">
603
530
    <informalexample>
604
531
      <para>
605
532
        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:
 
533
        the <filename>~/mandos</filename> directory, and use the
 
534
        Zeroconf service name <quote>Test</quote> to not collide with
 
535
        any other official Mandos server on this host:
609
536
      </para>
610
537
      <para>
611
538
 
643
570
      <title>CLIENTS</title>
644
571
      <para>
645
572
        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
 
573
        does have the OpenPGP key of the stored fingerprint.  This is
 
574
        guaranteed by the fact that the client sends its OpenPGP
 
575
        public key in the TLS handshake; this ensures it to be
 
576
        genuine.  The server computes the fingerprint of the key
 
577
        itself and looks up the fingerprint in its list of
 
578
        clients. The <filename>clients.conf</filename> file (see
652
579
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
653
580
        <manvolnum>5</manvolnum></citerefentry>)
654
581
        <emphasis>must</emphasis> be made non-readable by anyone
660
587
        compromised if they are gone for too long.
661
588
      </para>
662
589
      <para>
 
590
        If a client is compromised, its downtime should be duly noted
 
591
        by the server which would therefore disable the client.  But
 
592
        if the server was ever restarted, it would re-read its client
 
593
        list from its configuration file and again regard all clients
 
594
        therein as enabled, and hence eligible to receive their
 
595
        passwords.  Therefore, be careful when restarting servers if
 
596
        it is suspected that a client has, in fact, been compromised
 
597
        by parties who may now be running a fake Mandos client with
 
598
        the keys from the non-encrypted initial <acronym>RAM</acronym>
 
599
        image of the client host.  What should be done in that case
 
600
        (if restarting the server program really is necessary) is to
 
601
        stop the server program, edit the configuration file to omit
 
602
        any suspect clients, and restart the server program.
 
603
      </para>
 
604
      <para>
663
605
        For more details on client-side security, see
664
606
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
665
607
        <manvolnum>8mandos</manvolnum></citerefentry>.
695
637
      </varlistentry>
696
638
      <varlistentry>
697
639
        <term>
698
 
          <ulink url="https://www.avahi.org/">Avahi</ulink>
 
640
          <ulink url="http://www.avahi.org/">Avahi</ulink>
699
641
        </term>
700
642
      <listitem>
701
643
        <para>
706
648
      </varlistentry>
707
649
      <varlistentry>
708
650
        <term>
709
 
          <ulink url="https://gnutls.org/">GnuTLS</ulink>
 
651
          <ulink url="http://www.gnu.org/software/gnutls/"
 
652
          >GnuTLS</ulink>
710
653
        </term>
711
654
      <listitem>
712
655
        <para>
713
656
          GnuTLS is the library this server uses to implement TLS for
714
657
          communicating securely with the client, and at the same time
715
 
          confidently get the client’s public key.
 
658
          confidently get the client’s public OpenPGP key.
716
659
        </para>
717
660
      </listitem>
718
661
      </varlistentry>
739
682
            <listitem>
740
683
              <para>
741
684
                The clients use IPv6 link-local addresses, which are
742
 
                immediately usable since a link-local address is
 
685
                immediately usable since a link-local addresses is
743
686
                automatically assigned to a network interfaces when it
744
687
                is brought up.
745
688
              </para>
750
693
      </varlistentry>
751
694
      <varlistentry>
752
695
        <term>
753
 
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
754
 
          Protocol Version 1.2</citetitle>
 
696
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
697
          Protocol Version 1.1</citetitle>
755
698
        </term>
756
699
      <listitem>
757
700
        <para>
758
 
          TLS 1.2 is the protocol implemented by GnuTLS.
 
701
          TLS 1.1 is the protocol implemented by GnuTLS.
759
702
        </para>
760
703
      </listitem>
761
704
      </varlistentry>
771
714
      </varlistentry>
772
715
      <varlistentry>
773
716
        <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.
 
717
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
 
718
          Security</citetitle>
 
719
        </term>
 
720
      <listitem>
 
721
        <para>
 
722
          This is implemented by GnuTLS and used by this server so
 
723
          that OpenPGP keys can be used.
796
724
        </para>
797
725
      </listitem>
798
726
      </varlistentry>