/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-10 03:50:20 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 370.
  • Revision ID: teddy@recompile.se-20190210035020-nttr1tybgwwixueu
http://bugs.debian.org/879538
http://bugs.debian.org/916673
Show debconf note about new TLS key IDs

If mandos-client did not see TLS keys and had to create them, or if
mandos sees GnuTLS version 3.6.6 or later, show an important notice on
package installation about the importance of adding the new key_id
options to clients.conf on the Mandos server.

* debian/control (Package: mandos, Package: mandos-client): Depend on
                                                            debconf.
* debian/mandos-client.lintian-overrides: Override warnings.
* debian/mandos-client.postinst (create_keys): Show notice if new TLS
                                               key files were created.
* debian/mandos-client.templates: New.
* debian/mandos.lintian-overrides: Override warnings.
* debian/mandos.postinst (configure): If GnuTLS 3.6.6 or later is
                                      detected, show an important
                                      notice (once) about the new
                                      key_id option required in
                                      clients.conf.
* debian/mandos.templates: New.

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 "2014-06-15">
 
5
<!ENTITY TIMESTAMP "2019-02-09">
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>
40
45
      <holder>Teddy Hogeborn</holder>
41
46
      <holder>Björn Påhlsson</holder>
42
47
    </copyright>
236
241
        <term><option>--priority <replaceable>
237
242
        PRIORITY</replaceable></option></term>
238
243
        <listitem>
239
 
          <xi:include href="mandos-options.xml"
240
 
                      xpointer="priority_compat"/>
 
244
          <xi:include href="mandos-options.xml" xpointer="priority"/>
241
245
        </listitem>
242
246
      </varlistentry>
243
247
      
357
361
      start a TLS protocol handshake with a slight quirk: the Mandos
358
362
      server program acts as a TLS <quote>client</quote> while the
359
363
      connecting Mandos client acts as a TLS <quote>server</quote>.
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.
 
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.
365
369
    </para>
366
370
    <table>
367
371
      <title>Mandos Protocol (Version 1)</title><tgroup cols="3"><thead>
387
391
        </emphasis></entry>
388
392
      </row>
389
393
      <row>
390
 
        <entry>OpenPGP public key (part of TLS handshake)</entry>
 
394
        <entry>Public key (part of TLS handshake)</entry>
391
395
        <entry>-><!-- &rarr; --></entry>
392
396
      </row>
393
397
      <row>
540
544
        </listitem>
541
545
      </varlistentry>
542
546
      <varlistentry>
543
 
        <term><filename class="devicefile">/dev/log</filename></term>
544
 
      </varlistentry>
545
 
      <varlistentry>
546
547
        <term><filename
547
548
        class="directory">/var/lib/mandos</filename></term>
548
549
        <listitem>
554
555
        </listitem>
555
556
      </varlistentry>
556
557
      <varlistentry>
557
 
        <term><filename>/dev/log</filename></term>
 
558
        <term><filename class="devicefile">/dev/log</filename></term>
558
559
        <listitem>
559
560
          <para>
560
561
            The Unix domain socket to where local syslog messages are
585
586
    <para>
586
587
      There is no fine-grained control over logging and debug output.
587
588
    </para>
588
 
    <para>
589
 
      This server does not check the expire time of clients’ OpenPGP
590
 
      keys.
591
 
    </para>
 
589
    <xi:include href="bugs.xml"/>
592
590
  </refsect1>
593
591
  
594
592
  <refsect1 id="example">
644
642
      <title>CLIENTS</title>
645
643
      <para>
646
644
        The server only gives out its stored data to clients which
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
 
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
653
651
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
654
652
        <manvolnum>5</manvolnum></citerefentry>)
655
653
        <emphasis>must</emphasis> be made non-readable by anyone
707
705
      </varlistentry>
708
706
      <varlistentry>
709
707
        <term>
710
 
          <ulink url="http://www.gnu.org/software/gnutls/"
711
 
          >GnuTLS</ulink>
 
708
          <ulink url="https://gnutls.org/">GnuTLS</ulink>
712
709
        </term>
713
710
      <listitem>
714
711
        <para>
715
712
          GnuTLS is the library this server uses to implement TLS for
716
713
          communicating securely with the client, and at the same time
717
 
          confidently get the client’s public OpenPGP key.
 
714
          confidently get the client’s public key.
718
715
        </para>
719
716
      </listitem>
720
717
      </varlistentry>
752
749
      </varlistentry>
753
750
      <varlistentry>
754
751
        <term>
755
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
756
 
          Protocol Version 1.1</citetitle>
 
752
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
 
753
          Protocol Version 1.2</citetitle>
757
754
        </term>
758
755
      <listitem>
759
756
        <para>
760
 
          TLS 1.1 is the protocol implemented by GnuTLS.
 
757
          TLS 1.2 is the protocol implemented by GnuTLS.
761
758
        </para>
762
759
      </listitem>
763
760
      </varlistentry>
773
770
      </varlistentry>
774
771
      <varlistentry>
775
772
        <term>
776
 
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
777
 
          Security</citetitle>
778
 
        </term>
779
 
      <listitem>
780
 
        <para>
781
 
          This is implemented by GnuTLS and used by this server so
782
 
          that OpenPGP keys can be used.
 
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>
 
787
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
 
788
          Security (TLS) Authentication</citetitle>
 
789
        </term>
 
790
      <listitem>
 
791
        <para>
 
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.
783
795
        </para>
784
796
      </listitem>
785
797
      </varlistentry>