/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: 2015-10-24 17:48:13 UTC
  • Revision ID: teddy@recompile.se-20151024174813-56h6prp05qt30fx0
Tags: version-1.7.1-1
* Makefile (version): Changed to "1.7.1".
* NEWS (Version 1.7.1): New entry.
* debian/changelog (1.7.1-1): - '' -

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 "2015-07-20">
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>
46
42
      <holder>Teddy Hogeborn</holder>
47
43
      <holder>Björn Påhlsson</holder>
48
44
    </copyright>
362
358
      start a TLS protocol handshake with a slight quirk: the Mandos
363
359
      server program acts as a TLS <quote>client</quote> while the
364
360
      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.
 
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.
370
366
    </para>
371
367
    <table>
372
368
      <title>Mandos Protocol (Version 1)</title><tgroup cols="3"><thead>
392
388
        </emphasis></entry>
393
389
      </row>
394
390
      <row>
395
 
        <entry>Public key (part of TLS handshake)</entry>
 
391
        <entry>OpenPGP public key (part of TLS handshake)</entry>
396
392
        <entry>-><!-- &rarr; --></entry>
397
393
      </row>
398
394
      <row>
545
541
        </listitem>
546
542
      </varlistentry>
547
543
      <varlistentry>
 
544
        <term><filename class="devicefile">/dev/log</filename></term>
 
545
      </varlistentry>
 
546
      <varlistentry>
548
547
        <term><filename
549
548
        class="directory">/var/lib/mandos</filename></term>
550
549
        <listitem>
556
555
        </listitem>
557
556
      </varlistentry>
558
557
      <varlistentry>
559
 
        <term><filename class="devicefile">/dev/log</filename></term>
 
558
        <term><filename>/dev/log</filename></term>
560
559
        <listitem>
561
560
          <para>
562
561
            The Unix domain socket to where local syslog messages are
587
586
    <para>
588
587
      There is no fine-grained control over logging and debug output.
589
588
    </para>
590
 
    <xi:include href="bugs.xml"/>
 
589
    <para>
 
590
      This server does not check the expire time of clients’ OpenPGP
 
591
      keys.
 
592
    </para>
591
593
  </refsect1>
592
594
  
593
595
  <refsect1 id="example">
643
645
      <title>CLIENTS</title>
644
646
      <para>
645
647
        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
 
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
652
654
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
653
655
        <manvolnum>5</manvolnum></citerefentry>)
654
656
        <emphasis>must</emphasis> be made non-readable by anyone
706
708
      </varlistentry>
707
709
      <varlistentry>
708
710
        <term>
709
 
          <ulink url="https://gnutls.org/">GnuTLS</ulink>
 
711
          <ulink url="http://gnutls.org/">GnuTLS</ulink>
710
712
        </term>
711
713
      <listitem>
712
714
        <para>
713
715
          GnuTLS is the library this server uses to implement TLS for
714
716
          communicating securely with the client, and at the same time
715
 
          confidently get the client’s public key.
 
717
          confidently get the client’s public OpenPGP key.
716
718
        </para>
717
719
      </listitem>
718
720
      </varlistentry>
771
773
      </varlistentry>
772
774
      <varlistentry>
773
775
        <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
776
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
789
777
          Security (TLS) Authentication</citetitle>
790
778
        </term>
791
779
      <listitem>
792
780
        <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.
 
781
          This is implemented by GnuTLS and used by this server so
 
782
          that OpenPGP keys can be used.
796
783
        </para>
797
784
      </listitem>
798
785
      </varlistentry>