/mandos/trunk

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/trunk

« back to all changes in this revision

Viewing changes to plugins.d/mandos-client.xml

  • Committer: Teddy Hogeborn
  • Date: 2019-02-10 03:50:20 UTC
  • 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:
plugins.d/mandos-client.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-client">
5
 
<!ENTITY TIMESTAMP "2015-07-20">
 
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>
92
95
        <replaceable>FILE</replaceable></option></arg>
93
96
      </group>
94
97
      <sbr/>
 
98
      <group>
 
99
        <arg choice="plain"><option>--tls-privkey
 
100
        <replaceable>FILE</replaceable></option></arg>
 
101
        <arg choice="plain"><option>-t
 
102
        <replaceable>FILE</replaceable></option></arg>
 
103
      </group>
 
104
      <sbr/>
 
105
      <group>
 
106
        <arg choice="plain"><option>--tls-pubkey
 
107
        <replaceable>FILE</replaceable></option></arg>
 
108
        <arg choice="plain"><option>-T
 
109
        <replaceable>FILE</replaceable></option></arg>
 
110
      </group>
 
111
      <sbr/>
95
112
      <arg>
96
113
        <option>--priority <replaceable>STRING</replaceable></option>
97
114
      </arg>
151
168
      brings up network interfaces, uses the interfaces’ IPv6
152
169
      link-local addresses to get network connectivity, uses Zeroconf
153
170
      to find servers on the local network, and communicates with
154
 
      servers using TLS with an OpenPGP key to ensure authenticity and
155
 
      confidentiality.  This client program keeps running, trying all
156
 
      servers on the network, until it receives a satisfactory reply
157
 
      or a TERM signal.  After all servers have been tried, all
 
171
      servers using TLS with a raw public key to ensure authenticity
 
172
      and confidentiality.  This client program keeps running, trying
 
173
      all servers on the network, until it receives a satisfactory
 
174
      reply or a TERM signal.  After all servers have been tried, all
158
175
      servers are periodically retried.  If no servers are found it
159
176
      will wait indefinitely for new servers to appear.
160
177
    </para>
304
321
      </varlistentry>
305
322
      
306
323
      <varlistentry>
 
324
        <term><option>--tls-pubkey=<replaceable
 
325
        >FILE</replaceable></option></term>
 
326
        <term><option>-T
 
327
        <replaceable>FILE</replaceable></option></term>
 
328
        <listitem>
 
329
          <para>
 
330
            TLS raw public key file name.  The default name is
 
331
            <quote><filename>/conf/conf.d/mandos/tls-pubkey.pem</filename
 
332
            ></quote>.
 
333
          </para>
 
334
        </listitem>
 
335
      </varlistentry>
 
336
 
 
337
      <varlistentry>
 
338
        <term><option>--tls-privkey=<replaceable
 
339
        >FILE</replaceable></option></term>
 
340
        <term><option>-t
 
341
        <replaceable>FILE</replaceable></option></term>
 
342
        <listitem>
 
343
          <para>
 
344
            TLS secret key file name.  The default name is
 
345
            <quote><filename>/conf/conf.d/mandos/tls-privkey.pem</filename
 
346
            ></quote>.
 
347
          </para>
 
348
        </listitem>
 
349
      </varlistentry>
 
350
 
 
351
      <varlistentry>
307
352
        <term><option>--priority=<replaceable
308
353
        >STRING</replaceable></option></term>
309
354
        <listitem>
319
364
          <para>
320
365
            Sets the number of bits to use for the prime number in the
321
366
            TLS Diffie-Hellman key exchange.  The default value is
322
 
            selected automatically based on the OpenPGP key.  Note
323
 
            that if the <option>--dh-params</option> option is used,
324
 
            the values from that file will be used instead.
 
367
            selected automatically based on the GnuTLS security
 
368
            profile set in its priority string.  Note that if the
 
369
            <option>--dh-params</option> option is used, the values
 
370
            from that file will be used instead.
325
371
          </para>
326
372
        </listitem>
327
373
      </varlistentry>
679
725
        </listitem>
680
726
      </varlistentry>
681
727
      <varlistentry>
 
728
        <term><filename>/conf/conf.d/mandos/tls-pubkey.pem</filename
 
729
        ></term>
 
730
        <term><filename>/conf/conf.d/mandos/tls-privkey.pem</filename
 
731
        ></term>
 
732
        <listitem>
 
733
          <para>
 
734
            Public and private raw key files, in <quote>PEM</quote>
 
735
            format.  These are the default file names, they can be
 
736
            changed with the <option>--tls-pubkey</option> and
 
737
            <option>--tls-privkey</option> options.
 
738
          </para>
 
739
        </listitem>
 
740
      </varlistentry>
 
741
      <varlistentry>
682
742
        <term><filename
683
743
        class="directory">/lib/mandos/network-hooks.d</filename></term>
684
744
        <listitem>
692
752
    </variablelist>
693
753
  </refsect1>
694
754
  
695
 
<!--   <refsect1 id="bugs"> -->
696
 
<!--     <title>BUGS</title> -->
697
 
<!--     <para> -->
698
 
<!--     </para> -->
699
 
<!--   </refsect1> -->
 
755
  <refsect1 id="bugs">
 
756
    <title>BUGS</title>
 
757
    <xi:include href="../bugs.xml"/>
 
758
  </refsect1>
700
759
  
701
760
  <refsect1 id="example">
702
761
    <title>EXAMPLE</title>
727
786
    </informalexample>
728
787
    <informalexample>
729
788
      <para>
730
 
        Run in debug mode, and use a custom key:
 
789
        Run in debug mode, and use custom keys:
731
790
      </para>
732
791
      <para>
733
792
 
734
793
<!-- do not wrap this line -->
735
 
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt</userinput>
 
794
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --tls-pubkey keydir/tls-pubkey.pem --tls-privkey keydir/tls-privkey.pem</userinput>
736
795
 
737
796
      </para>
738
797
    </informalexample>
739
798
    <informalexample>
740
799
      <para>
741
 
        Run in debug mode, with a custom key, and do not use Zeroconf
 
800
        Run in debug mode, with custom keys, and do not use Zeroconf
742
801
        to locate a server; connect directly to the IPv6 link-local
743
802
        address <quote><systemitem class="ipaddress"
744
803
        >fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
747
806
      <para>
748
807
 
749
808
<!-- do not wrap this line -->
750
 
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect fe80::aede:48ff:fe71:f6f2:4711 --interface eth2</userinput>
 
809
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --tls-pubkey keydir/tls-pubkey.pem --tls-privkey keydir/tls-privkey.pem --connect fe80::aede:48ff:fe71:f6f2:4711 --interface eth2</userinput>
751
810
 
752
811
      </para>
753
812
    </informalexample>
777
836
    <para>
778
837
      The only remaining weak point is that someone with physical
779
838
      access to the client hard drive might turn off the client
780
 
      computer, read the OpenPGP keys directly from the hard drive,
781
 
      and communicate with the server.  To safeguard against this, the
782
 
      server is supposed to notice the client disappearing and stop
783
 
      giving out the encrypted data.  Therefore, it is important to
784
 
      set the timeout and checker interval values tightly on the
785
 
      server.  See <citerefentry><refentrytitle
 
839
      computer, read the OpenPGP and TLS keys directly from the hard
 
840
      drive, and communicate with the server.  To safeguard against
 
841
      this, the server is supposed to notice the client disappearing
 
842
      and stop giving out the encrypted data.  Therefore, it is
 
843
      important to set the timeout and checker interval values tightly
 
844
      on the server.  See <citerefentry><refentrytitle
786
845
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
787
846
    </para>
788
847
    <para>
842
901
      </varlistentry>
843
902
      <varlistentry>
844
903
        <term>
845
 
          <ulink url="http://www.gnu.org/software/gnutls/"
846
 
          >GnuTLS</ulink>
 
904
          <ulink url="https://www.gnutls.org/">GnuTLS</ulink>
847
905
        </term>
848
906
      <listitem>
849
907
        <para>
850
908
          GnuTLS is the library this client uses to implement TLS for
851
909
          communicating securely with the server, and at the same time
852
 
          send the public OpenPGP key to the server.
 
910
          send the public key to the server.
853
911
        </para>
854
912
      </listitem>
855
913
      </varlistentry>
856
914
      <varlistentry>
857
915
        <term>
858
 
          <ulink url="http://www.gnupg.org/related_software/gpgme/"
 
916
          <ulink url="https://www.gnupg.org/related_software/gpgme/"
859
917
                 >GPGME</ulink>
860
918
        </term>
861
919
        <listitem>
899
957
      </varlistentry>
900
958
      <varlistentry>
901
959
        <term>
902
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
903
 
          Protocol Version 1.1</citetitle>
 
960
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
 
961
          Protocol Version 1.2</citetitle>
904
962
        </term>
905
963
      <listitem>
906
964
        <para>
907
 
          TLS 1.1 is the protocol implemented by GnuTLS.
 
965
          TLS 1.2 is the protocol implemented by GnuTLS.
908
966
        </para>
909
967
      </listitem>
910
968
      </varlistentry>
921
979
      </varlistentry>
922
980
      <varlistentry>
923
981
        <term>
924
 
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
 
982
          RFC 7250: <citetitle>Using Raw Public Keys in Transport
 
983
          Layer Security (TLS) and Datagram Transport Layer Security
 
984
          (DTLS)</citetitle>
 
985
        </term>
 
986
      <listitem>
 
987
        <para>
 
988
          This is implemented by GnuTLS in version 3.6.6 and is, if
 
989
          present, used by this program so that raw public keys can be
 
990
          used.
 
991
        </para>
 
992
      </listitem>
 
993
      </varlistentry>
 
994
      <varlistentry>
 
995
        <term>
 
996
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
925
997
          Security</citetitle>
926
998
        </term>
927
999
      <listitem>
928
1000
        <para>
929
 
          This is implemented by GnuTLS and used by this program so
930
 
          that OpenPGP keys can be used.
 
1001
          This is implemented by GnuTLS before version 3.6.0 and is,
 
1002
          if present, used by this program so that OpenPGP keys can be
 
1003
          used.
931
1004
        </para>
932
1005
      </listitem>
933
1006
      </varlistentry>