/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-08 01:38:30 UTC
  • mfrom: (237.4.140 release)
  • Revision ID: teddy@recompile.se-20230208013830-sehn0b55qbhcxaj6
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 "2016-07-03">
 
5
<!ENTITY TIMESTAMP "2022-04-24">
6
6
<!ENTITY % common SYSTEM "common.ent">
7
7
%common;
8
8
]>
40
40
      <year>2014</year>
41
41
      <year>2015</year>
42
42
      <year>2016</year>
 
43
      <year>2017</year>
 
44
      <year>2018</year>
 
45
      <year>2019</year>
43
46
      <holder>Teddy Hogeborn</holder>
44
47
      <holder>Björn Påhlsson</holder>
45
48
    </copyright>
133
136
    <title>DESCRIPTION</title>
134
137
    <para>
135
138
      <command>&COMMANDNAME;</command> is a server daemon which
136
 
      handles incoming request for passwords for a pre-defined list of
137
 
      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
138
141
      <citerefentry><refentrytitle>intro</refentrytitle>
139
142
      <manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
140
143
      uses Zeroconf to announce itself on the local network, and uses
359
362
      start a TLS protocol handshake with a slight quirk: the Mandos
360
363
      server program acts as a TLS <quote>client</quote> while the
361
364
      connecting Mandos client acts as a TLS <quote>server</quote>.
362
 
      The Mandos client must supply an OpenPGP certificate, and the
363
 
      fingerprint of this certificate is used by the Mandos server to
364
 
      look up (in a list read from <filename>clients.conf</filename>
365
 
      at start time) which binary blob to give the client.  No other
366
 
      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.
367
370
    </para>
368
371
    <table>
369
372
      <title>Mandos Protocol (Version 1)</title><tgroup cols="3"><thead>
389
392
        </emphasis></entry>
390
393
      </row>
391
394
      <row>
392
 
        <entry>OpenPGP public key (part of TLS handshake)</entry>
 
395
        <entry>Public key (part of TLS handshake)</entry>
393
396
        <entry>-><!-- &rarr; --></entry>
394
397
      </row>
395
398
      <row>
584
587
    <para>
585
588
      There is no fine-grained control over logging and debug output.
586
589
    </para>
587
 
    <para>
588
 
      This server does not check the expire time of clients’ OpenPGP
589
 
      keys.
590
 
    </para>
591
590
    <xi:include href="bugs.xml"/>
592
591
  </refsect1>
593
592
  
644
643
      <title>CLIENTS</title>
645
644
      <para>
646
645
        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
 
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
653
652
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
654
653
        <manvolnum>5</manvolnum></citerefentry>)
655
654
        <emphasis>must</emphasis> be made non-readable by anyone
696
695
      </varlistentry>
697
696
      <varlistentry>
698
697
        <term>
699
 
          <ulink url="http://www.avahi.org/">Avahi</ulink>
 
698
          <ulink url="https://www.avahi.org/">Avahi</ulink>
700
699
        </term>
701
700
      <listitem>
702
701
        <para>
713
712
        <para>
714
713
          GnuTLS is the library this server uses to implement TLS for
715
714
          communicating securely with the client, and at the same time
716
 
          confidently get the client’s public OpenPGP key.
 
715
          confidently get the client’s public key.
717
716
        </para>
718
717
      </listitem>
719
718
      </varlistentry>
740
739
            <listitem>
741
740
              <para>
742
741
                The clients use IPv6 link-local addresses, which are
743
 
                immediately usable since a link-local addresses is
 
742
                immediately usable since a link-local address is
744
743
                automatically assigned to a network interfaces when it
745
744
                is brought up.
746
745
              </para>
772
771
      </varlistentry>
773
772
      <varlistentry>
774
773
        <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>
775
788
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
776
789
          Security (TLS) Authentication</citetitle>
777
790
        </term>
778
791
      <listitem>
779
792
        <para>
780
 
          This is implemented by GnuTLS and used by this server so
781
 
          that OpenPGP keys can be used.
 
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.
782
796
        </para>
783
797
      </listitem>
784
798
      </varlistentry>