/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 plugins.d/mandos-client.xml

  • Committer: Teddy Hogeborn
  • Date: 2019-02-09 23:31:44 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 370.
  • Revision ID: teddy@recompile.se-20190209233144-5ewmrgezdqridssj
* TODO (Use raw public keys): Remove.

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-06">
 
5
<!ENTITY TIMESTAMP "2019-02-09">
6
6
<!ENTITY % common SYSTEM "../common.ent">
7
7
%common;
8
8
]>
33
33
    <copyright>
34
34
      <year>2008</year>
35
35
      <year>2009</year>
 
36
      <year>2010</year>
 
37
      <year>2011</year>
36
38
      <year>2012</year>
37
39
      <year>2013</year>
38
40
      <year>2014</year>
39
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>
90
95
        <replaceable>FILE</replaceable></option></arg>
91
96
      </group>
92
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/>
93
112
      <arg>
94
113
        <option>--priority <replaceable>STRING</replaceable></option>
95
114
      </arg>
99
118
      </arg>
100
119
      <sbr/>
101
120
      <arg>
 
121
        <option>--dh-params <replaceable>FILE</replaceable></option>
 
122
      </arg>
 
123
      <sbr/>
 
124
      <arg>
102
125
        <option>--delay <replaceable>SECONDS</replaceable></option>
103
126
      </arg>
104
127
      <sbr/>
145
168
      brings up network interfaces, uses the interfaces’ IPv6
146
169
      link-local addresses to get network connectivity, uses Zeroconf
147
170
      to find servers on the local network, and communicates with
148
 
      servers using TLS with an OpenPGP key to ensure authenticity and
149
 
      confidentiality.  This client program keeps running, trying all
150
 
      servers on the network, until it receives a satisfactory reply
151
 
      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
152
175
      servers are periodically retried.  If no servers are found it
153
176
      will wait indefinitely for new servers to appear.
154
177
    </para>
298
321
      </varlistentry>
299
322
      
300
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>
301
352
        <term><option>--priority=<replaceable
302
353
        >STRING</replaceable></option></term>
303
354
        <listitem>
313
364
          <para>
314
365
            Sets the number of bits to use for the prime number in the
315
366
            TLS Diffie-Hellman key exchange.  The default value is
316
 
            selected automatically based on the OpenPGP key.
 
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.
 
371
          </para>
 
372
        </listitem>
 
373
      </varlistentry>
 
374
      
 
375
      <varlistentry>
 
376
        <term><option>--dh-params=<replaceable
 
377
        >FILE</replaceable></option></term>
 
378
        <listitem>
 
379
          <para>
 
380
            Specifies a PEM-encoded PKCS#3 file to read the parameters
 
381
            needed by the TLS Diffie-Hellman key exchange from.  If
 
382
            this option is not given, or if the file for some reason
 
383
            could not be used, the parameters will be generated on
 
384
            startup, which will take some time and processing power.
 
385
            Those using servers running under time, power or processor
 
386
            constraints may want to generate such a file in advance
 
387
            and use this option.
317
388
          </para>
318
389
        </listitem>
319
390
      </varlistentry>
654
725
        </listitem>
655
726
      </varlistentry>
656
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>
657
742
        <term><filename
658
743
        class="directory">/lib/mandos/network-hooks.d</filename></term>
659
744
        <listitem>
667
752
    </variablelist>
668
753
  </refsect1>
669
754
  
670
 
<!--   <refsect1 id="bugs"> -->
671
 
<!--     <title>BUGS</title> -->
672
 
<!--     <para> -->
673
 
<!--     </para> -->
674
 
<!--   </refsect1> -->
 
755
  <refsect1 id="bugs">
 
756
    <title>BUGS</title>
 
757
    <xi:include href="../bugs.xml"/>
 
758
  </refsect1>
675
759
  
676
760
  <refsect1 id="example">
677
761
    <title>EXAMPLE</title>
702
786
    </informalexample>
703
787
    <informalexample>
704
788
      <para>
705
 
        Run in debug mode, and use a custom key:
 
789
        Run in debug mode, and use custom keys:
706
790
      </para>
707
791
      <para>
708
792
 
709
793
<!-- do not wrap this line -->
710
 
<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>
711
795
 
712
796
      </para>
713
797
    </informalexample>
714
798
    <informalexample>
715
799
      <para>
716
 
        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
717
801
        to locate a server; connect directly to the IPv6 link-local
718
802
        address <quote><systemitem class="ipaddress"
719
803
        >fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
722
806
      <para>
723
807
 
724
808
<!-- do not wrap this line -->
725
 
<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>
726
810
 
727
811
      </para>
728
812
    </informalexample>
752
836
    <para>
753
837
      The only remaining weak point is that someone with physical
754
838
      access to the client hard drive might turn off the client
755
 
      computer, read the OpenPGP keys directly from the hard drive,
756
 
      and communicate with the server.  To safeguard against this, the
757
 
      server is supposed to notice the client disappearing and stop
758
 
      giving out the encrypted data.  Therefore, it is important to
759
 
      set the timeout and checker interval values tightly on the
760
 
      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
761
845
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
762
846
    </para>
763
847
    <para>
817
901
      </varlistentry>
818
902
      <varlistentry>
819
903
        <term>
820
 
          <ulink url="http://www.gnu.org/software/gnutls/"
821
 
          >GnuTLS</ulink>
 
904
          <ulink url="https://www.gnutls.org/">GnuTLS</ulink>
822
905
        </term>
823
906
      <listitem>
824
907
        <para>
825
908
          GnuTLS is the library this client uses to implement TLS for
826
909
          communicating securely with the server, and at the same time
827
 
          send the public OpenPGP key to the server.
 
910
          send the public key to the server.
828
911
        </para>
829
912
      </listitem>
830
913
      </varlistentry>
831
914
      <varlistentry>
832
915
        <term>
833
 
          <ulink url="http://www.gnupg.org/related_software/gpgme/"
 
916
          <ulink url="https://www.gnupg.org/related_software/gpgme/"
834
917
                 >GPGME</ulink>
835
918
        </term>
836
919
        <listitem>
874
957
      </varlistentry>
875
958
      <varlistentry>
876
959
        <term>
877
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
878
 
          Protocol Version 1.1</citetitle>
 
960
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
 
961
          Protocol Version 1.2</citetitle>
879
962
        </term>
880
963
      <listitem>
881
964
        <para>
882
 
          TLS 1.1 is the protocol implemented by GnuTLS.
 
965
          TLS 1.2 is the protocol implemented by GnuTLS.
883
966
        </para>
884
967
      </listitem>
885
968
      </varlistentry>
896
979
      </varlistentry>
897
980
      <varlistentry>
898
981
        <term>
899
 
          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
900
997
          Security</citetitle>
901
998
        </term>
902
999
      <listitem>
903
1000
        <para>
904
 
          This is implemented by GnuTLS and used by this program so
905
 
          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.
906
1004
        </para>
907
1005
      </listitem>
908
1006
      </varlistentry>