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