/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: 2022-04-24 16:17:18 UTC
  • Revision ID: teddy@recompile.se-20220424161718-co15ev303rqgkv4p
Update Debian Policy version to 4.6.0; no other changes necessary.

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

Show diffs side-by-side

added added

removed removed

Lines of Context:
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 "2015-07-20">
 
5
<!ENTITY TIMESTAMP "2022-04-24">
6
6
<!ENTITY % common SYSTEM "common.ent">
7
7
%common;
8
8
]>
39
39
      <year>2013</year>
40
40
      <year>2014</year>
41
41
      <year>2015</year>
 
42
      <year>2016</year>
 
43
      <year>2017</year>
 
44
      <year>2018</year>
 
45
      <year>2019</year>
42
46
      <holder>Teddy Hogeborn</holder>
43
47
      <holder>Björn Påhlsson</holder>
44
48
    </copyright>
132
136
    <title>DESCRIPTION</title>
133
137
    <para>
134
138
      <command>&COMMANDNAME;</command> is a server daemon which
135
 
      handles incoming request for passwords for a pre-defined list of
136
 
      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
137
141
      <citerefentry><refentrytitle>intro</refentrytitle>
138
142
      <manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
139
143
      uses Zeroconf to announce itself on the local network, and uses
358
362
      start a TLS protocol handshake with a slight quirk: the Mandos
359
363
      server program acts as a TLS <quote>client</quote> while the
360
364
      connecting Mandos client acts as a TLS <quote>server</quote>.
361
 
      The Mandos client must supply an OpenPGP certificate, and the
362
 
      fingerprint of this certificate is used by the Mandos server to
363
 
      look up (in a list read from <filename>clients.conf</filename>
364
 
      at start time) which binary blob to give the client.  No other
365
 
      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.
366
370
    </para>
367
371
    <table>
368
372
      <title>Mandos Protocol (Version 1)</title><tgroup cols="3"><thead>
388
392
        </emphasis></entry>
389
393
      </row>
390
394
      <row>
391
 
        <entry>OpenPGP public key (part of TLS handshake)</entry>
 
395
        <entry>Public key (part of TLS handshake)</entry>
392
396
        <entry>-><!-- &rarr; --></entry>
393
397
      </row>
394
398
      <row>
541
545
        </listitem>
542
546
      </varlistentry>
543
547
      <varlistentry>
544
 
        <term><filename class="devicefile">/dev/log</filename></term>
545
 
      </varlistentry>
546
 
      <varlistentry>
547
548
        <term><filename
548
549
        class="directory">/var/lib/mandos</filename></term>
549
550
        <listitem>
555
556
        </listitem>
556
557
      </varlistentry>
557
558
      <varlistentry>
558
 
        <term><filename>/dev/log</filename></term>
 
559
        <term><filename class="devicefile">/dev/log</filename></term>
559
560
        <listitem>
560
561
          <para>
561
562
            The Unix domain socket to where local syslog messages are
586
587
    <para>
587
588
      There is no fine-grained control over logging and debug output.
588
589
    </para>
589
 
    <para>
590
 
      This server does not check the expire time of clients’ OpenPGP
591
 
      keys.
592
 
    </para>
 
590
    <xi:include href="bugs.xml"/>
593
591
  </refsect1>
594
592
  
595
593
  <refsect1 id="example">
645
643
      <title>CLIENTS</title>
646
644
      <para>
647
645
        The server only gives out its stored data to clients which
648
 
        does have the OpenPGP key of the stored fingerprint.  This is
649
 
        guaranteed by the fact that the client sends its OpenPGP
650
 
        public key in the TLS handshake; this ensures it to be
651
 
        genuine.  The server computes the fingerprint of the key
652
 
        itself and looks up the fingerprint in its list of
653
 
        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
654
652
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
655
653
        <manvolnum>5</manvolnum></citerefentry>)
656
654
        <emphasis>must</emphasis> be made non-readable by anyone
697
695
      </varlistentry>
698
696
      <varlistentry>
699
697
        <term>
700
 
          <ulink url="http://www.avahi.org/">Avahi</ulink>
 
698
          <ulink url="https://www.avahi.org/">Avahi</ulink>
701
699
        </term>
702
700
      <listitem>
703
701
        <para>
708
706
      </varlistentry>
709
707
      <varlistentry>
710
708
        <term>
711
 
          <ulink url="http://gnutls.org/">GnuTLS</ulink>
 
709
          <ulink url="https://gnutls.org/">GnuTLS</ulink>
712
710
        </term>
713
711
      <listitem>
714
712
        <para>
715
713
          GnuTLS is the library this server uses to implement TLS for
716
714
          communicating securely with the client, and at the same time
717
 
          confidently get the client’s public OpenPGP key.
 
715
          confidently get the client’s public key.
718
716
        </para>
719
717
      </listitem>
720
718
      </varlistentry>
741
739
            <listitem>
742
740
              <para>
743
741
                The clients use IPv6 link-local addresses, which are
744
 
                immediately usable since a link-local addresses is
 
742
                immediately usable since a link-local address is
745
743
                automatically assigned to a network interfaces when it
746
744
                is brought up.
747
745
              </para>
773
771
      </varlistentry>
774
772
      <varlistentry>
775
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>
776
788
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
777
789
          Security (TLS) Authentication</citetitle>
778
790
        </term>
779
791
      <listitem>
780
792
        <para>
781
 
          This is implemented by GnuTLS and used by this server so
782
 
          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.
783
796
        </para>
784
797
      </listitem>
785
798
      </varlistentry>