/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: 2019-09-01 07:07:15 UTC
  • Revision ID: teddy@recompile.se-20190901070715-wxmzxxlpx70vewto
Address Python 3 bytes/str warnings

* mandos-monitor (UserInterface.run): Ignore BytesWarning from urwid;
                                      work around Debian bug #939084.

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 "2018-02-08">
 
5
<!ENTITY TIMESTAMP "2019-07-24">
6
6
<!ENTITY % common SYSTEM "common.ent">
7
7
%common;
8
8
]>
42
42
      <year>2016</year>
43
43
      <year>2017</year>
44
44
      <year>2018</year>
 
45
      <year>2019</year>
45
46
      <holder>Teddy Hogeborn</holder>
46
47
      <holder>Björn Påhlsson</holder>
47
48
    </copyright>
361
362
      start a TLS protocol handshake with a slight quirk: the Mandos
362
363
      server program acts as a TLS <quote>client</quote> while the
363
364
      connecting Mandos client acts as a TLS <quote>server</quote>.
364
 
      The Mandos client must supply an OpenPGP certificate, and the
365
 
      fingerprint of this certificate is used by the Mandos server to
366
 
      look up (in a list read from <filename>clients.conf</filename>
367
 
      at start time) which binary blob to give the client.  No other
368
 
      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.
369
370
    </para>
370
371
    <table>
371
372
      <title>Mandos Protocol (Version 1)</title><tgroup cols="3"><thead>
391
392
        </emphasis></entry>
392
393
      </row>
393
394
      <row>
394
 
        <entry>OpenPGP public key (part of TLS handshake)</entry>
 
395
        <entry>Public key (part of TLS handshake)</entry>
395
396
        <entry>-><!-- &rarr; --></entry>
396
397
      </row>
397
398
      <row>
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>
593
590
    <xi:include href="bugs.xml"/>
594
591
  </refsect1>
595
592
  
646
643
      <title>CLIENTS</title>
647
644
      <para>
648
645
        The server only gives out its stored data to clients which
649
 
        does have the OpenPGP key of the stored fingerprint.  This is
650
 
        guaranteed by the fact that the client sends its OpenPGP
651
 
        public key in the TLS handshake; this ensures it to be
652
 
        genuine.  The server computes the fingerprint of the key
653
 
        itself and looks up the fingerprint in its list of
654
 
        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
655
652
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
656
653
        <manvolnum>5</manvolnum></citerefentry>)
657
654
        <emphasis>must</emphasis> be made non-readable by anyone
698
695
      </varlistentry>
699
696
      <varlistentry>
700
697
        <term>
701
 
          <ulink url="http://www.avahi.org/">Avahi</ulink>
 
698
          <ulink url="https://www.avahi.org/">Avahi</ulink>
702
699
        </term>
703
700
      <listitem>
704
701
        <para>
715
712
        <para>
716
713
          GnuTLS is the library this server uses to implement TLS for
717
714
          communicating securely with the client, and at the same time
718
 
          confidently get the client’s public OpenPGP key.
 
715
          confidently get the client’s public key.
719
716
        </para>
720
717
      </listitem>
721
718
      </varlistentry>
774
771
      </varlistentry>
775
772
      <varlistentry>
776
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>
777
788
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
778
789
          Security (TLS) Authentication</citetitle>
779
790
        </term>
780
791
      <listitem>
781
792
        <para>
782
 
          This is implemented by GnuTLS and used by this server so
783
 
          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.
784
796
        </para>
785
797
      </listitem>
786
798
      </varlistentry>