/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-07-06 21:02:27 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 325.
  • Revision ID: teddy@recompile.se-20150706210227-4wz9tazr6bte3js1
debian/control (Build-Depends): Bug fix: Added "libnl-route-3-dev".

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-07-24">
 
5
<!ENTITY TIMESTAMP "2015-01-25">
6
6
<!ENTITY % common SYSTEM "common.ent">
7
7
%common;
8
8
]>
37
37
      <year>2011</year>
38
38
      <year>2012</year>
39
39
      <year>2013</year>
40
 
      <year>2014</year>
41
 
      <year>2015</year>
42
 
      <year>2016</year>
43
 
      <year>2017</year>
44
 
      <year>2018</year>
45
 
      <year>2019</year>
46
40
      <holder>Teddy Hogeborn</holder>
47
41
      <holder>Björn Påhlsson</holder>
48
42
    </copyright>
242
236
        <term><option>--priority <replaceable>
243
237
        PRIORITY</replaceable></option></term>
244
238
        <listitem>
245
 
          <xi:include href="mandos-options.xml" xpointer="priority"/>
 
239
          <xi:include href="mandos-options.xml"
 
240
                      xpointer="priority_compat"/>
246
241
        </listitem>
247
242
      </varlistentry>
248
243
      
362
357
      start a TLS protocol handshake with a slight quirk: the Mandos
363
358
      server program acts as a TLS <quote>client</quote> while the
364
359
      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.
 
360
      The Mandos client must supply an OpenPGP certificate, and the
 
361
      fingerprint of this certificate is used by the Mandos server to
 
362
      look up (in a list read from <filename>clients.conf</filename>
 
363
      at start time) which binary blob to give the client.  No other
 
364
      authentication or authorization is done by the server.
370
365
    </para>
371
366
    <table>
372
367
      <title>Mandos Protocol (Version 1)</title><tgroup cols="3"><thead>
392
387
        </emphasis></entry>
393
388
      </row>
394
389
      <row>
395
 
        <entry>Public key (part of TLS handshake)</entry>
 
390
        <entry>OpenPGP public key (part of TLS handshake)</entry>
396
391
        <entry>-><!-- &rarr; --></entry>
397
392
      </row>
398
393
      <row>
545
540
        </listitem>
546
541
      </varlistentry>
547
542
      <varlistentry>
 
543
        <term><filename class="devicefile">/dev/log</filename></term>
 
544
      </varlistentry>
 
545
      <varlistentry>
548
546
        <term><filename
549
547
        class="directory">/var/lib/mandos</filename></term>
550
548
        <listitem>
556
554
        </listitem>
557
555
      </varlistentry>
558
556
      <varlistentry>
559
 
        <term><filename class="devicefile">/dev/log</filename></term>
 
557
        <term><filename>/dev/log</filename></term>
560
558
        <listitem>
561
559
          <para>
562
560
            The Unix domain socket to where local syslog messages are
587
585
    <para>
588
586
      There is no fine-grained control over logging and debug output.
589
587
    </para>
590
 
    <xi:include href="bugs.xml"/>
 
588
    <para>
 
589
      This server does not check the expire time of clients’ OpenPGP
 
590
      keys.
 
591
    </para>
591
592
  </refsect1>
592
593
  
593
594
  <refsect1 id="example">
643
644
      <title>CLIENTS</title>
644
645
      <para>
645
646
        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
 
647
        does have the OpenPGP key of the stored fingerprint.  This is
 
648
        guaranteed by the fact that the client sends its OpenPGP
 
649
        public key in the TLS handshake; this ensures it to be
 
650
        genuine.  The server computes the fingerprint of the key
 
651
        itself and looks up the fingerprint in its list of
 
652
        clients. The <filename>clients.conf</filename> file (see
652
653
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
653
654
        <manvolnum>5</manvolnum></citerefentry>)
654
655
        <emphasis>must</emphasis> be made non-readable by anyone
695
696
      </varlistentry>
696
697
      <varlistentry>
697
698
        <term>
698
 
          <ulink url="https://www.avahi.org/">Avahi</ulink>
 
699
          <ulink url="http://www.avahi.org/">Avahi</ulink>
699
700
        </term>
700
701
      <listitem>
701
702
        <para>
706
707
      </varlistentry>
707
708
      <varlistentry>
708
709
        <term>
709
 
          <ulink url="https://gnutls.org/">GnuTLS</ulink>
 
710
          <ulink url="http://gnutls.org/">GnuTLS</ulink>
710
711
        </term>
711
712
      <listitem>
712
713
        <para>
713
714
          GnuTLS is the library this server uses to implement TLS for
714
715
          communicating securely with the client, and at the same time
715
 
          confidently get the client’s public key.
 
716
          confidently get the client’s public OpenPGP key.
716
717
        </para>
717
718
      </listitem>
718
719
      </varlistentry>
771
772
      </varlistentry>
772
773
      <varlistentry>
773
774
        <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
775
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
789
776
          Security (TLS) Authentication</citetitle>
790
777
        </term>
791
778
      <listitem>
792
779
        <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.
 
780
          This is implemented by GnuTLS and used by this server so
 
781
          that OpenPGP keys can be used.
796
782
        </para>
797
783
      </listitem>
798
784
      </varlistentry>