/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: 2025-06-27 19:56:23 UTC
  • Revision ID: teddy@recompile.se-20250627195623-02t2vap0gixox3mo
Update Debian Policy version to 4.7.2; no other changes necessary.

* debian/control (Standards-Version): Change to "4.7.2".

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 "2011-10-22">
 
5
<!ENTITY TIMESTAMP "2025-06-27">
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
      <year>2020</year>
 
47
      <year>2021</year>
 
48
      <year>2022</year>
38
49
      <holder>Teddy Hogeborn</holder>
39
50
      <holder>Björn Påhlsson</holder>
40
51
    </copyright>
96
107
      <arg><option>--no-ipv6</option></arg>
97
108
      <sbr/>
98
109
      <arg><option>--no-restore</option></arg>
 
110
      <sbr/>
 
111
      <arg><option>--statedir
 
112
      <replaceable>DIRECTORY</replaceable></option></arg>
 
113
      <sbr/>
 
114
      <arg><option>--socket
 
115
      <replaceable>FD</replaceable></option></arg>
 
116
      <sbr/>
 
117
      <arg><option>--foreground</option></arg>
 
118
      <sbr/>
 
119
      <arg><option>--no-zeroconf</option></arg>
99
120
    </cmdsynopsis>
100
121
    <cmdsynopsis>
101
122
      <command>&COMMANDNAME;</command>
118
139
    <title>DESCRIPTION</title>
119
140
    <para>
120
141
      <command>&COMMANDNAME;</command> is a server daemon which
121
 
      handles incoming request for passwords for a pre-defined list of
122
 
      client host computers. For an introduction, see
 
142
      handles incoming requests for passwords for a pre-defined list
 
143
      of client host computers. For an introduction, see
123
144
      <citerefentry><refentrytitle>intro</refentrytitle>
124
145
      <manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
125
146
      uses Zeroconf to announce itself on the local network, and uses
282
303
        <term><option>--no-restore</option></term>
283
304
        <listitem>
284
305
          <xi:include href="mandos-options.xml" xpointer="restore"/>
285
 
        </listitem>
286
 
      </varlistentry>
 
306
          <para>
 
307
            See also <xref linkend="persistent_state"/>.
 
308
          </para>
 
309
        </listitem>
 
310
      </varlistentry>
 
311
      
 
312
      <varlistentry>
 
313
        <term><option>--statedir
 
314
        <replaceable>DIRECTORY</replaceable></option></term>
 
315
        <listitem>
 
316
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
 
317
        </listitem>
 
318
      </varlistentry>
 
319
      
 
320
      <varlistentry>
 
321
        <term><option>--socket
 
322
        <replaceable>FD</replaceable></option></term>
 
323
        <listitem>
 
324
          <xi:include href="mandos-options.xml" xpointer="socket"/>
 
325
        </listitem>
 
326
      </varlistentry>
 
327
      
 
328
      <varlistentry>
 
329
        <term><option>--foreground</option></term>
 
330
        <listitem>
 
331
          <xi:include href="mandos-options.xml"
 
332
                      xpointer="foreground"/>
 
333
        </listitem>
 
334
      </varlistentry>
 
335
      
 
336
      <varlistentry>
 
337
        <term><option>--no-zeroconf</option></term>
 
338
        <listitem>
 
339
          <xi:include href="mandos-options.xml" xpointer="zeroconf"/>
 
340
        </listitem>
 
341
      </varlistentry>
 
342
      
287
343
    </variablelist>
288
344
  </refsect1>
289
345
  
309
365
      start a TLS protocol handshake with a slight quirk: the Mandos
310
366
      server program acts as a TLS <quote>client</quote> while the
311
367
      connecting Mandos client acts as a TLS <quote>server</quote>.
312
 
      The Mandos client must supply an OpenPGP certificate, and the
313
 
      fingerprint of this certificate is used by the Mandos server to
314
 
      look up (in a list read from <filename>clients.conf</filename>
315
 
      at start time) which binary blob to give the client.  No other
316
 
      authentication or authorization is done by the server.
 
368
      The Mandos client must supply a TLS public key, and the key ID
 
369
      of this public key is used by the Mandos server to look up (in a
 
370
      list read from <filename>clients.conf</filename> at start time)
 
371
      which binary blob to give the client.  No other authentication
 
372
      or authorization is done by the server.
317
373
    </para>
318
374
    <table>
319
375
      <title>Mandos Protocol (Version 1)</title><tgroup cols="3"><thead>
339
395
        </emphasis></entry>
340
396
      </row>
341
397
      <row>
342
 
        <entry>OpenPGP public key (part of TLS handshake)</entry>
 
398
        <entry>Public key (part of TLS handshake)</entry>
343
399
        <entry>-><!-- &rarr; --></entry>
344
400
      </row>
345
401
      <row>
366
422
      extended timeout, checker program, and interval between checks
367
423
      can be configured both globally and per client; see
368
424
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
369
 
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
370
 
      receiving its password will also be treated as a successful
371
 
      checker run.
 
425
      <manvolnum>5</manvolnum></citerefentry>.
372
426
    </para>
373
427
  </refsect1>
374
428
  
402
456
    </para>
403
457
  </refsect1>
404
458
  
 
459
  <refsect1 id="persistent_state">
 
460
    <title>PERSISTENT STATE</title>
 
461
    <para>
 
462
      Client settings, initially read from
 
463
      <filename>clients.conf</filename>, are persistent across
 
464
      restarts, and run-time changes will override settings in
 
465
      <filename>clients.conf</filename>.  However, if a setting is
 
466
      <emphasis>changed</emphasis> (or a client added, or removed) in
 
467
      <filename>clients.conf</filename>, this will take precedence.
 
468
    </para>
 
469
  </refsect1>
 
470
  
405
471
  <refsect1 id="dbus_interface">
406
472
    <title>D-BUS INTERFACE</title>
407
473
    <para>
469
535
        </listitem>
470
536
      </varlistentry>
471
537
      <varlistentry>
472
 
        <term><filename>/var/run/mandos.pid</filename></term>
 
538
        <term><filename>/run/mandos.pid</filename></term>
473
539
        <listitem>
474
540
          <para>
475
541
            The file containing the process id of the
476
542
            <command>&COMMANDNAME;</command> process started last.
 
543
            <emphasis >Note:</emphasis> If the <filename
 
544
            class="directory">/run</filename> directory does not
 
545
            exist, <filename>/var/run/mandos.pid</filename> will be
 
546
            used instead.
 
547
          </para>
 
548
        </listitem>
 
549
      </varlistentry>
 
550
      <varlistentry>
 
551
        <term><filename
 
552
        class="directory">/var/lib/mandos</filename></term>
 
553
        <listitem>
 
554
          <para>
 
555
            Directory where persistent state will be saved.  Change
 
556
            this with the <option>--statedir</option> option.  See
 
557
            also the <option>--no-restore</option> option.
477
558
          </para>
478
559
        </listitem>
479
560
      </varlistentry>
507
588
      backtrace.  This could be considered a feature.
508
589
    </para>
509
590
    <para>
510
 
      Currently, if a client is disabled due to having timed out, the
511
 
      server does not record this fact onto permanent storage.  This
512
 
      has some security implications, see <xref linkend="clients"/>.
513
 
    </para>
514
 
    <para>
515
591
      There is no fine-grained control over logging and debug output.
516
592
    </para>
517
 
    <para>
518
 
      Debug mode is conflated with running in the foreground.
519
 
    </para>
520
 
    <para>
521
 
      This server does not check the expire time of clients’ OpenPGP
522
 
      keys.
523
 
    </para>
 
593
    <xi:include href="bugs.xml"/>
524
594
  </refsect1>
525
595
  
526
596
  <refsect1 id="example">
536
606
    <informalexample>
537
607
      <para>
538
608
        Run the server in debug mode, read configuration files from
539
 
        the <filename>~/mandos</filename> directory, and use the
540
 
        Zeroconf service name <quote>Test</quote> to not collide with
541
 
        any other official Mandos server on this host:
 
609
        the <filename class="directory">~/mandos</filename> directory,
 
610
        and use the Zeroconf service name <quote>Test</quote> to not
 
611
        collide with any other official Mandos server on this host:
542
612
      </para>
543
613
      <para>
544
614
 
576
646
      <title>CLIENTS</title>
577
647
      <para>
578
648
        The server only gives out its stored data to clients which
579
 
        does have the OpenPGP key of the stored fingerprint.  This is
580
 
        guaranteed by the fact that the client sends its OpenPGP
581
 
        public key in the TLS handshake; this ensures it to be
582
 
        genuine.  The server computes the fingerprint of the key
583
 
        itself and looks up the fingerprint in its list of
584
 
        clients. The <filename>clients.conf</filename> file (see
 
649
        does have the correct key ID of the stored key ID.  This is
 
650
        guaranteed by the fact that the client sends its public key in
 
651
        the TLS handshake; this ensures it to be genuine.  The server
 
652
        computes the key ID of the key itself and looks up the key ID
 
653
        in its list of clients. The <filename>clients.conf</filename>
 
654
        file (see
585
655
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
586
656
        <manvolnum>5</manvolnum></citerefentry>)
587
657
        <emphasis>must</emphasis> be made non-readable by anyone
593
663
        compromised if they are gone for too long.
594
664
      </para>
595
665
      <para>
596
 
        If a client is compromised, its downtime should be duly noted
597
 
        by the server which would therefore disable the client.  But
598
 
        if the server was ever restarted, it would re-read its client
599
 
        list from its configuration file and again regard all clients
600
 
        therein as enabled, and hence eligible to receive their
601
 
        passwords.  Therefore, be careful when restarting servers if
602
 
        it is suspected that a client has, in fact, been compromised
603
 
        by parties who may now be running a fake Mandos client with
604
 
        the keys from the non-encrypted initial <acronym>RAM</acronym>
605
 
        image of the client host.  What should be done in that case
606
 
        (if restarting the server program really is necessary) is to
607
 
        stop the server program, edit the configuration file to omit
608
 
        any suspect clients, and restart the server program.
609
 
      </para>
610
 
      <para>
611
666
        For more details on client-side security, see
612
667
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
613
668
        <manvolnum>8mandos</manvolnum></citerefentry>.
643
698
      </varlistentry>
644
699
      <varlistentry>
645
700
        <term>
646
 
          <ulink url="http://www.avahi.org/">Avahi</ulink>
 
701
          <ulink url="https://www.avahi.org/">Avahi</ulink>
647
702
        </term>
648
703
      <listitem>
649
704
        <para>
654
709
      </varlistentry>
655
710
      <varlistentry>
656
711
        <term>
657
 
          <ulink url="http://www.gnu.org/software/gnutls/"
658
 
          >GnuTLS</ulink>
 
712
          <ulink url="https://gnutls.org/">GnuTLS</ulink>
659
713
        </term>
660
714
      <listitem>
661
715
        <para>
662
716
          GnuTLS is the library this server uses to implement TLS for
663
717
          communicating securely with the client, and at the same time
664
 
          confidently get the client’s public OpenPGP key.
 
718
          confidently get the client’s public key.
665
719
        </para>
666
720
      </listitem>
667
721
      </varlistentry>
688
742
            <listitem>
689
743
              <para>
690
744
                The clients use IPv6 link-local addresses, which are
691
 
                immediately usable since a link-local addresses is
 
745
                immediately usable since a link-local address is
692
746
                automatically assigned to a network interfaces when it
693
747
                is brought up.
694
748
              </para>
699
753
      </varlistentry>
700
754
      <varlistentry>
701
755
        <term>
702
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
703
 
          Protocol Version 1.1</citetitle>
 
756
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
 
757
          Protocol Version 1.2</citetitle>
704
758
        </term>
705
759
      <listitem>
706
760
        <para>
707
 
          TLS 1.1 is the protocol implemented by GnuTLS.
 
761
          TLS 1.2 is the protocol implemented by GnuTLS.
708
762
        </para>
709
763
      </listitem>
710
764
      </varlistentry>
720
774
      </varlistentry>
721
775
      <varlistentry>
722
776
        <term>
723
 
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
724
 
          Security</citetitle>
725
 
        </term>
726
 
      <listitem>
727
 
        <para>
728
 
          This is implemented by GnuTLS and used by this server so
729
 
          that OpenPGP keys can be used.
 
777
          RFC 7250: <citetitle>Using Raw Public Keys in Transport
 
778
          Layer Security (TLS) and Datagram Transport Layer Security
 
779
          (DTLS)</citetitle>
 
780
        </term>
 
781
      <listitem>
 
782
        <para>
 
783
          This is implemented by GnuTLS version 3.6.6 and is, if
 
784
          present, used by this server so that raw public keys can be
 
785
          used.
 
786
        </para>
 
787
      </listitem>
 
788
      </varlistentry>
 
789
      <varlistentry>
 
790
        <term>
 
791
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
 
792
          Security (TLS) Authentication</citetitle>
 
793
        </term>
 
794
      <listitem>
 
795
        <para>
 
796
          This is implemented by GnuTLS before version 3.6.0 and is,
 
797
          if present, used by this server so that OpenPGP keys can be
 
798
          used.
730
799
        </para>
731
800
      </listitem>
732
801
      </varlistentry>