/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 22:29:04 UTC
  • mfrom: (237.4.146 release)
  • Revision ID: teddy@recompile.se-20250627222904-lag5g9re6d6jag23
Merge from release branch

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 "2014-06-15">
 
5
<!ENTITY TIMESTAMP "2025-06-27">
6
6
<!ENTITY % common SYSTEM "common.ent">
7
7
%common;
8
8
]>
37
37
      <year>2011</year>
38
38
      <year>2012</year>
39
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>
40
49
      <holder>Teddy Hogeborn</holder>
41
50
      <holder>Björn Påhlsson</holder>
42
51
    </copyright>
130
139
    <title>DESCRIPTION</title>
131
140
    <para>
132
141
      <command>&COMMANDNAME;</command> is a server daemon which
133
 
      handles incoming request for passwords for a pre-defined list of
134
 
      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
135
144
      <citerefentry><refentrytitle>intro</refentrytitle>
136
145
      <manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
137
146
      uses Zeroconf to announce itself on the local network, and uses
236
245
        <term><option>--priority <replaceable>
237
246
        PRIORITY</replaceable></option></term>
238
247
        <listitem>
239
 
          <xi:include href="mandos-options.xml"
240
 
                      xpointer="priority_compat"/>
 
248
          <xi:include href="mandos-options.xml" xpointer="priority"/>
241
249
        </listitem>
242
250
      </varlistentry>
243
251
      
357
365
      start a TLS protocol handshake with a slight quirk: the Mandos
358
366
      server program acts as a TLS <quote>client</quote> while the
359
367
      connecting Mandos client acts as a TLS <quote>server</quote>.
360
 
      The Mandos client must supply an OpenPGP certificate, and the
361
 
      fingerprint of this certificate is used by the Mandos server to
362
 
      look up (in a list read from <filename>clients.conf</filename>
363
 
      at start time) which binary blob to give the client.  No other
364
 
      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.
365
373
    </para>
366
374
    <table>
367
375
      <title>Mandos Protocol (Version 1)</title><tgroup cols="3"><thead>
387
395
        </emphasis></entry>
388
396
      </row>
389
397
      <row>
390
 
        <entry>OpenPGP public key (part of TLS handshake)</entry>
 
398
        <entry>Public key (part of TLS handshake)</entry>
391
399
        <entry>-><!-- &rarr; --></entry>
392
400
      </row>
393
401
      <row>
540
548
        </listitem>
541
549
      </varlistentry>
542
550
      <varlistentry>
543
 
        <term><filename class="devicefile">/dev/log</filename></term>
544
 
      </varlistentry>
545
 
      <varlistentry>
546
551
        <term><filename
547
552
        class="directory">/var/lib/mandos</filename></term>
548
553
        <listitem>
554
559
        </listitem>
555
560
      </varlistentry>
556
561
      <varlistentry>
557
 
        <term><filename>/dev/log</filename></term>
 
562
        <term><filename class="devicefile">/dev/log</filename></term>
558
563
        <listitem>
559
564
          <para>
560
565
            The Unix domain socket to where local syslog messages are
585
590
    <para>
586
591
      There is no fine-grained control over logging and debug output.
587
592
    </para>
588
 
    <para>
589
 
      This server does not check the expire time of clients’ OpenPGP
590
 
      keys.
591
 
    </para>
 
593
    <xi:include href="bugs.xml"/>
592
594
  </refsect1>
593
595
  
594
596
  <refsect1 id="example">
644
646
      <title>CLIENTS</title>
645
647
      <para>
646
648
        The server only gives out its stored data to clients which
647
 
        does have the OpenPGP key of the stored fingerprint.  This is
648
 
        guaranteed by the fact that the client sends its OpenPGP
649
 
        public key in the TLS handshake; this ensures it to be
650
 
        genuine.  The server computes the fingerprint of the key
651
 
        itself and looks up the fingerprint in its list of
652
 
        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
653
655
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
654
656
        <manvolnum>5</manvolnum></citerefentry>)
655
657
        <emphasis>must</emphasis> be made non-readable by anyone
696
698
      </varlistentry>
697
699
      <varlistentry>
698
700
        <term>
699
 
          <ulink url="http://www.avahi.org/">Avahi</ulink>
 
701
          <ulink url="https://www.avahi.org/">Avahi</ulink>
700
702
        </term>
701
703
      <listitem>
702
704
        <para>
707
709
      </varlistentry>
708
710
      <varlistentry>
709
711
        <term>
710
 
          <ulink url="http://www.gnu.org/software/gnutls/"
711
 
          >GnuTLS</ulink>
 
712
          <ulink url="https://gnutls.org/">GnuTLS</ulink>
712
713
        </term>
713
714
      <listitem>
714
715
        <para>
715
716
          GnuTLS is the library this server uses to implement TLS for
716
717
          communicating securely with the client, and at the same time
717
 
          confidently get the client’s public OpenPGP key.
 
718
          confidently get the client’s public key.
718
719
        </para>
719
720
      </listitem>
720
721
      </varlistentry>
741
742
            <listitem>
742
743
              <para>
743
744
                The clients use IPv6 link-local addresses, which are
744
 
                immediately usable since a link-local addresses is
 
745
                immediately usable since a link-local address is
745
746
                automatically assigned to a network interfaces when it
746
747
                is brought up.
747
748
              </para>
752
753
      </varlistentry>
753
754
      <varlistentry>
754
755
        <term>
755
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
756
 
          Protocol Version 1.1</citetitle>
 
756
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
 
757
          Protocol Version 1.2</citetitle>
757
758
        </term>
758
759
      <listitem>
759
760
        <para>
760
 
          TLS 1.1 is the protocol implemented by GnuTLS.
 
761
          TLS 1.2 is the protocol implemented by GnuTLS.
761
762
        </para>
762
763
      </listitem>
763
764
      </varlistentry>
773
774
      </varlistentry>
774
775
      <varlistentry>
775
776
        <term>
776
 
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
777
 
          Security</citetitle>
778
 
        </term>
779
 
      <listitem>
780
 
        <para>
781
 
          This is implemented by GnuTLS and used by this server so
782
 
          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.
783
799
        </para>
784
800
      </listitem>
785
801
      </varlistentry>