/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-09 23:31:44 UTC
  • 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 "2013-06-21">
 
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>
 
39
      <year>2013</year>
 
40
      <year>2014</year>
 
41
      <year>2015</year>
 
42
      <year>2016</year>
 
43
      <year>2017</year>
 
44
      <year>2018</year>
37
45
      <holder>Teddy Hogeborn</holder>
38
46
      <holder>Björn Påhlsson</holder>
39
47
    </copyright>
87
95
        <replaceable>FILE</replaceable></option></arg>
88
96
      </group>
89
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/>
90
112
      <arg>
91
113
        <option>--priority <replaceable>STRING</replaceable></option>
92
114
      </arg>
96
118
      </arg>
97
119
      <sbr/>
98
120
      <arg>
 
121
        <option>--dh-params <replaceable>FILE</replaceable></option>
 
122
      </arg>
 
123
      <sbr/>
 
124
      <arg>
99
125
        <option>--delay <replaceable>SECONDS</replaceable></option>
100
126
      </arg>
101
127
      <sbr/>
142
168
      brings up network interfaces, uses the interfaces’ IPv6
143
169
      link-local addresses to get network connectivity, uses Zeroconf
144
170
      to find servers on the local network, and communicates with
145
 
      servers using TLS with an OpenPGP key to ensure authenticity and
146
 
      confidentiality.  This client program keeps running, trying all
147
 
      servers on the network, until it receives a satisfactory reply
148
 
      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
149
175
      servers are periodically retried.  If no servers are found it
150
176
      will wait indefinitely for new servers to appear.
151
177
    </para>
218
244
            assumed to separate the address from the port number.
219
245
          </para>
220
246
          <para>
221
 
            This option is normally only useful for testing and
222
 
            debugging.
 
247
            Normally, Zeroconf would be used to locate Mandos servers,
 
248
            in which case this option would only be used when testing
 
249
            and debugging.
223
250
          </para>
224
251
        </listitem>
225
252
      </varlistentry>
258
285
          <para>
259
286
            <replaceable>NAME</replaceable> can be the string
260
287
            <quote><literal>none</literal></quote>; this will make
261
 
            <command>&COMMANDNAME;</command> not bring up
262
 
            <emphasis>any</emphasis> interfaces specified
263
 
            <emphasis>after</emphasis> this string.  This is not
264
 
            recommended, and only meant for advanced users.
 
288
            <command>&COMMANDNAME;</command> only bring up interfaces
 
289
            specified <emphasis>before</emphasis> this string.  This
 
290
            is not recommended, and only meant for advanced users.
265
291
          </para>
266
292
        </listitem>
267
293
      </varlistentry>
295
321
      </varlistentry>
296
322
      
297
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>
298
352
        <term><option>--priority=<replaceable
299
353
        >STRING</replaceable></option></term>
300
354
        <listitem>
309
363
        <listitem>
310
364
          <para>
311
365
            Sets the number of bits to use for the prime number in the
312
 
            TLS Diffie-Hellman key exchange.  Default is 1024.
 
366
            TLS Diffie-Hellman key exchange.  The default value is
 
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.
313
388
          </para>
314
389
        </listitem>
315
390
      </varlistentry>
442
517
  
443
518
  <refsect1 id="environment">
444
519
    <title>ENVIRONMENT</title>
 
520
    <variablelist>
 
521
      <varlistentry>
 
522
        <term><envar>MANDOSPLUGINHELPERDIR</envar></term>
 
523
        <listitem>
 
524
          <para>
 
525
            This environment variable will be assumed to contain the
 
526
            directory containing any helper executables.  The use and
 
527
            nature of these helper executables, if any, is
 
528
            purposefully not documented.
 
529
        </para>
 
530
        </listitem>
 
531
      </varlistentry>
 
532
    </variablelist>
445
533
    <para>
446
 
      This program does not use any environment variables, not even
447
 
      the ones provided by <citerefentry><refentrytitle
 
534
      This program does not use any other environment variables, not
 
535
      even the ones provided by <citerefentry><refentrytitle
448
536
      >cryptsetup</refentrytitle><manvolnum>8</manvolnum>
449
537
    </citerefentry>.
450
538
    </para>
637
725
        </listitem>
638
726
      </varlistentry>
639
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>
640
742
        <term><filename
641
743
        class="directory">/lib/mandos/network-hooks.d</filename></term>
642
744
        <listitem>
650
752
    </variablelist>
651
753
  </refsect1>
652
754
  
653
 
<!--   <refsect1 id="bugs"> -->
654
 
<!--     <title>BUGS</title> -->
655
 
<!--     <para> -->
656
 
<!--     </para> -->
657
 
<!--   </refsect1> -->
 
755
  <refsect1 id="bugs">
 
756
    <title>BUGS</title>
 
757
    <xi:include href="../bugs.xml"/>
 
758
  </refsect1>
658
759
  
659
760
  <refsect1 id="example">
660
761
    <title>EXAMPLE</title>
685
786
    </informalexample>
686
787
    <informalexample>
687
788
      <para>
688
 
        Run in debug mode, and use a custom key:
 
789
        Run in debug mode, and use custom keys:
689
790
      </para>
690
791
      <para>
691
792
 
692
793
<!-- do not wrap this line -->
693
 
<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>
694
795
 
695
796
      </para>
696
797
    </informalexample>
697
798
    <informalexample>
698
799
      <para>
699
 
        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
700
801
        to locate a server; connect directly to the IPv6 link-local
701
802
        address <quote><systemitem class="ipaddress"
702
803
        >fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
705
806
      <para>
706
807
 
707
808
<!-- do not wrap this line -->
708
 
<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>
709
810
 
710
811
      </para>
711
812
    </informalexample>
735
836
    <para>
736
837
      The only remaining weak point is that someone with physical
737
838
      access to the client hard drive might turn off the client
738
 
      computer, read the OpenPGP keys directly from the hard drive,
739
 
      and communicate with the server.  To safeguard against this, the
740
 
      server is supposed to notice the client disappearing and stop
741
 
      giving out the encrypted data.  Therefore, it is important to
742
 
      set the timeout and checker interval values tightly on the
743
 
      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
744
845
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
745
846
    </para>
746
847
    <para>
747
848
      It will also help if the checker program on the server is
748
849
      configured to request something from the client which can not be
749
 
      spoofed by someone else on the network, unlike unencrypted
750
 
      <acronym>ICMP</acronym> echo (<quote>ping</quote>) replies.
 
850
      spoofed by someone else on the network, like SSH server key
 
851
      fingerprints, and unlike unencrypted <acronym>ICMP</acronym>
 
852
      echo (<quote>ping</quote>) replies.
751
853
    </para>
752
854
    <para>
753
855
      <emphasis>Note</emphasis>: This makes it completely insecure to
799
901
      </varlistentry>
800
902
      <varlistentry>
801
903
        <term>
802
 
          <ulink url="http://www.gnu.org/software/gnutls/"
803
 
          >GnuTLS</ulink>
 
904
          <ulink url="https://www.gnutls.org/">GnuTLS</ulink>
804
905
        </term>
805
906
      <listitem>
806
907
        <para>
807
908
          GnuTLS is the library this client uses to implement TLS for
808
909
          communicating securely with the server, and at the same time
809
 
          send the public OpenPGP key to the server.
 
910
          send the public key to the server.
810
911
        </para>
811
912
      </listitem>
812
913
      </varlistentry>
813
914
      <varlistentry>
814
915
        <term>
815
 
          <ulink url="http://www.gnupg.org/related_software/gpgme/"
 
916
          <ulink url="https://www.gnupg.org/related_software/gpgme/"
816
917
                 >GPGME</ulink>
817
918
        </term>
818
919
        <listitem>
856
957
      </varlistentry>
857
958
      <varlistentry>
858
959
        <term>
859
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
860
 
          Protocol Version 1.1</citetitle>
 
960
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
 
961
          Protocol Version 1.2</citetitle>
861
962
        </term>
862
963
      <listitem>
863
964
        <para>
864
 
          TLS 1.1 is the protocol implemented by GnuTLS.
 
965
          TLS 1.2 is the protocol implemented by GnuTLS.
865
966
        </para>
866
967
      </listitem>
867
968
      </varlistentry>
878
979
      </varlistentry>
879
980
      <varlistentry>
880
981
        <term>
881
 
          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
882
997
          Security</citetitle>
883
998
        </term>
884
999
      <listitem>
885
1000
        <para>
886
 
          This is implemented by GnuTLS and used by this program so
887
 
          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.
888
1004
        </para>
889
1005
      </listitem>
890
1006
      </varlistentry>