/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: 2016-02-28 14:34:45 UTC
  • mfrom: (237.7.356 trunk)
  • Revision ID: teddy@recompile.se-20160228143445-bbhvlujl07q5mrd1
Merge from trunk.

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