/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to mandos.xml

  • Committer: Teddy Hogeborn
  • Date: 2019-02-09 23:31:44 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 370.
  • Revision ID: teddy@recompile.se-20190209233144-5ewmrgezdqridssj
* TODO (Use raw public keys): Remove.

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-02-28">
 
5
<!ENTITY TIMESTAMP "2019-02-09">
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>
43
45
      <holder>Teddy Hogeborn</holder>
44
46
      <holder>Björn Påhlsson</holder>
45
47
    </copyright>
359
361
      start a TLS protocol handshake with a slight quirk: the Mandos
360
362
      server program acts as a TLS <quote>client</quote> while the
361
363
      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.
 
364
      The Mandos client must supply a TLS public key, and the key ID
 
365
      of this public key is used by the Mandos server to look up (in a
 
366
      list read from <filename>clients.conf</filename> at start time)
 
367
      which binary blob to give the client.  No other authentication
 
368
      or authorization is done by the server.
367
369
    </para>
368
370
    <table>
369
371
      <title>Mandos Protocol (Version 1)</title><tgroup cols="3"><thead>
389
391
        </emphasis></entry>
390
392
      </row>
391
393
      <row>
392
 
        <entry>OpenPGP public key (part of TLS handshake)</entry>
 
394
        <entry>Public key (part of TLS handshake)</entry>
393
395
        <entry>-><!-- &rarr; --></entry>
394
396
      </row>
395
397
      <row>
584
586
    <para>
585
587
      There is no fine-grained control over logging and debug output.
586
588
    </para>
587
 
    <para>
588
 
      This server does not check the expire time of clients’ OpenPGP
589
 
      keys.
590
 
    </para>
 
589
    <xi:include href="bugs.xml"/>
591
590
  </refsect1>
592
591
  
593
592
  <refsect1 id="example">
643
642
      <title>CLIENTS</title>
644
643
      <para>
645
644
        The server only gives out its stored data to clients which
646
 
        does have the OpenPGP key of the stored fingerprint.  This is
647
 
        guaranteed by the fact that the client sends its OpenPGP
648
 
        public key in the TLS handshake; this ensures it to be
649
 
        genuine.  The server computes the fingerprint of the key
650
 
        itself and looks up the fingerprint in its list of
651
 
        clients. The <filename>clients.conf</filename> file (see
 
645
        does have the correct key ID of the stored key ID.  This is
 
646
        guaranteed by the fact that the client sends its public key in
 
647
        the TLS handshake; this ensures it to be genuine.  The server
 
648
        computes the key ID of the key itself and looks up the key ID
 
649
        in its list of clients. The <filename>clients.conf</filename>
 
650
        file (see
652
651
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
653
652
        <manvolnum>5</manvolnum></citerefentry>)
654
653
        <emphasis>must</emphasis> be made non-readable by anyone
706
705
      </varlistentry>
707
706
      <varlistentry>
708
707
        <term>
709
 
          <ulink url="http://gnutls.org/">GnuTLS</ulink>
 
708
          <ulink url="https://gnutls.org/">GnuTLS</ulink>
710
709
        </term>
711
710
      <listitem>
712
711
        <para>
713
712
          GnuTLS is the library this server uses to implement TLS for
714
713
          communicating securely with the client, and at the same time
715
 
          confidently get the client’s public OpenPGP key.
 
714
          confidently get the client’s public key.
716
715
        </para>
717
716
      </listitem>
718
717
      </varlistentry>
771
770
      </varlistentry>
772
771
      <varlistentry>
773
772
        <term>
 
773
          RFC 7250: <citetitle>Using Raw Public Keys in Transport
 
774
          Layer Security (TLS) and Datagram Transport Layer Security
 
775
          (DTLS)</citetitle>
 
776
        </term>
 
777
      <listitem>
 
778
        <para>
 
779
          This is implemented by GnuTLS version 3.6.6 and is, if
 
780
          present, used by this server so that raw public keys can be
 
781
          used.
 
782
        </para>
 
783
      </listitem>
 
784
      </varlistentry>
 
785
      <varlistentry>
 
786
        <term>
774
787
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
775
788
          Security (TLS) Authentication</citetitle>
776
789
        </term>
777
790
      <listitem>
778
791
        <para>
779
 
          This is implemented by GnuTLS and used by this server so
780
 
          that OpenPGP keys can be used.
 
792
          This is implemented by GnuTLS before version 3.6.0 and is,
 
793
          if present, used by this server so that OpenPGP keys can be
 
794
          used.
781
795
        </para>
782
796
      </listitem>
783
797
      </varlistentry>