/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: 2023-02-07 19:29:28 UTC
  • Revision ID: teddy@recompile.se-20230207192928-ueasjbsufb92o6ud
Clarify documentation and a comment about GnuTLS versions

* clients.conf ([foo]/secret): In the comment for the example client's
  "secret" setting, clarify GnuTLS version conditions.
* mandos-clients.conf.xml (OPTIONS/fingerprint, OPTIONS/key_id):
  Clarify required/optional status under different GnuTLS versions.

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 "2012-01-01">
 
5
<!ENTITY TIMESTAMP "2022-04-24">
6
6
<!ENTITY % common SYSTEM "common.ent">
7
7
%common;
8
8
]>
36
36
      <year>2010</year>
37
37
      <year>2011</year>
38
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>
39
46
      <holder>Teddy Hogeborn</holder>
40
47
      <holder>Björn Påhlsson</holder>
41
48
    </copyright>
100
107
      <sbr/>
101
108
      <arg><option>--statedir
102
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>
103
117
    </cmdsynopsis>
104
118
    <cmdsynopsis>
105
119
      <command>&COMMANDNAME;</command>
122
136
    <title>DESCRIPTION</title>
123
137
    <para>
124
138
      <command>&COMMANDNAME;</command> is a server daemon which
125
 
      handles incoming request for passwords for a pre-defined list of
126
 
      client host computers. For an introduction, see
 
139
      handles incoming requests for passwords for a pre-defined list
 
140
      of client host computers. For an introduction, see
127
141
      <citerefentry><refentrytitle>intro</refentrytitle>
128
142
      <manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
129
143
      uses Zeroconf to announce itself on the local network, and uses
286
300
        <term><option>--no-restore</option></term>
287
301
        <listitem>
288
302
          <xi:include href="mandos-options.xml" xpointer="restore"/>
 
303
          <para>
 
304
            See also <xref linkend="persistent_state"/>.
 
305
          </para>
289
306
        </listitem>
290
307
      </varlistentry>
291
308
      
296
313
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
297
314
        </listitem>
298
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
      
299
340
    </variablelist>
300
341
  </refsect1>
301
342
  
321
362
      start a TLS protocol handshake with a slight quirk: the Mandos
322
363
      server program acts as a TLS <quote>client</quote> while the
323
364
      connecting Mandos client acts as a TLS <quote>server</quote>.
324
 
      The Mandos client must supply an OpenPGP certificate, and the
325
 
      fingerprint of this certificate is used by the Mandos server to
326
 
      look up (in a list read from <filename>clients.conf</filename>
327
 
      at start time) which binary blob to give the client.  No other
328
 
      authentication or authorization is done by the server.
 
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.
329
370
    </para>
330
371
    <table>
331
372
      <title>Mandos Protocol (Version 1)</title><tgroup cols="3"><thead>
351
392
        </emphasis></entry>
352
393
      </row>
353
394
      <row>
354
 
        <entry>OpenPGP public key (part of TLS handshake)</entry>
 
395
        <entry>Public key (part of TLS handshake)</entry>
355
396
        <entry>-><!-- &rarr; --></entry>
356
397
      </row>
357
398
      <row>
378
419
      extended timeout, checker program, and interval between checks
379
420
      can be configured both globally and per client; see
380
421
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
381
 
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
382
 
      receiving its password will also be treated as a successful
383
 
      checker run.
 
422
      <manvolnum>5</manvolnum></citerefentry>.
384
423
    </para>
385
424
  </refsect1>
386
425
  
414
453
    </para>
415
454
  </refsect1>
416
455
  
 
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
  
417
468
  <refsect1 id="dbus_interface">
418
469
    <title>D-BUS INTERFACE</title>
419
470
    <para>
481
532
        </listitem>
482
533
      </varlistentry>
483
534
      <varlistentry>
484
 
        <term><filename>/var/run/mandos.pid</filename></term>
 
535
        <term><filename>/run/mandos.pid</filename></term>
485
536
        <listitem>
486
537
          <para>
487
538
            The file containing the process id of the
488
539
            <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.
489
544
          </para>
490
545
        </listitem>
491
546
      </varlistentry>
492
547
      <varlistentry>
493
 
        <term><filename class="devicefile">/dev/log</filename></term>
494
 
      </varlistentry>
495
 
      <varlistentry>
496
548
        <term><filename
497
549
        class="directory">/var/lib/mandos</filename></term>
498
550
        <listitem>
504
556
        </listitem>
505
557
      </varlistentry>
506
558
      <varlistentry>
507
 
        <term><filename>/dev/log</filename></term>
 
559
        <term><filename class="devicefile">/dev/log</filename></term>
508
560
        <listitem>
509
561
          <para>
510
562
            The Unix domain socket to where local syslog messages are
535
587
    <para>
536
588
      There is no fine-grained control over logging and debug output.
537
589
    </para>
538
 
    <para>
539
 
      Debug mode is conflated with running in the foreground.
540
 
    </para>
541
 
    <para>
542
 
      This server does not check the expire time of clients’ OpenPGP
543
 
      keys.
544
 
    </para>
 
590
    <xi:include href="bugs.xml"/>
545
591
  </refsect1>
546
592
  
547
593
  <refsect1 id="example">
597
643
      <title>CLIENTS</title>
598
644
      <para>
599
645
        The server only gives out its stored data to clients which
600
 
        does have the OpenPGP key of the stored fingerprint.  This is
601
 
        guaranteed by the fact that the client sends its OpenPGP
602
 
        public key in the TLS handshake; this ensures it to be
603
 
        genuine.  The server computes the fingerprint of the key
604
 
        itself and looks up the fingerprint in its list of
605
 
        clients. The <filename>clients.conf</filename> file (see
 
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
606
652
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
607
653
        <manvolnum>5</manvolnum></citerefentry>)
608
654
        <emphasis>must</emphasis> be made non-readable by anyone
649
695
      </varlistentry>
650
696
      <varlistentry>
651
697
        <term>
652
 
          <ulink url="http://www.avahi.org/">Avahi</ulink>
 
698
          <ulink url="https://www.avahi.org/">Avahi</ulink>
653
699
        </term>
654
700
      <listitem>
655
701
        <para>
660
706
      </varlistentry>
661
707
      <varlistentry>
662
708
        <term>
663
 
          <ulink url="http://www.gnu.org/software/gnutls/"
664
 
          >GnuTLS</ulink>
 
709
          <ulink url="https://gnutls.org/">GnuTLS</ulink>
665
710
        </term>
666
711
      <listitem>
667
712
        <para>
668
713
          GnuTLS is the library this server uses to implement TLS for
669
714
          communicating securely with the client, and at the same time
670
 
          confidently get the client’s public OpenPGP key.
 
715
          confidently get the client’s public key.
671
716
        </para>
672
717
      </listitem>
673
718
      </varlistentry>
694
739
            <listitem>
695
740
              <para>
696
741
                The clients use IPv6 link-local addresses, which are
697
 
                immediately usable since a link-local addresses is
 
742
                immediately usable since a link-local address is
698
743
                automatically assigned to a network interfaces when it
699
744
                is brought up.
700
745
              </para>
705
750
      </varlistentry>
706
751
      <varlistentry>
707
752
        <term>
708
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
709
 
          Protocol Version 1.1</citetitle>
 
753
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
 
754
          Protocol Version 1.2</citetitle>
710
755
        </term>
711
756
      <listitem>
712
757
        <para>
713
 
          TLS 1.1 is the protocol implemented by GnuTLS.
 
758
          TLS 1.2 is the protocol implemented by GnuTLS.
714
759
        </para>
715
760
      </listitem>
716
761
      </varlistentry>
726
771
      </varlistentry>
727
772
      <varlistentry>
728
773
        <term>
729
 
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
730
 
          Security</citetitle>
731
 
        </term>
732
 
      <listitem>
733
 
        <para>
734
 
          This is implemented by GnuTLS and used by this server so
735
 
          that OpenPGP keys can be used.
 
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.
736
796
        </para>
737
797
      </listitem>
738
798
      </varlistentry>