/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: 2013-10-13 01:49:18 UTC
  • Revision ID: teddy@recompile.se-20131013014918-08ybiy64qxy4ceza
http://bugs.debian.org/721903
* initramfs-tools-hook: Bug fix: Make sure the right version of GnuPG
                        is copied into the initramfs image.  Always
                        assume that GPGME is used to avoid searching
                        for it since the path might not be /usr/lib.
                        Thanks to Félix Sipma <felix+debian@gueux.org>
                        for the initial bug report, and also thanks to
                        Dick Middleton <dick@lingbrae.com> for some
                        more debugging.
* initramfs-unpack: New script to help with development and debugging.
                    It is only part of the source tree, it is not
                    installed.

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 "2019-02-10">
 
5
<!ENTITY TIMESTAMP "2013-06-21">
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>
38
36
      <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>
45
 
      <year>2019</year>
46
37
      <holder>Teddy Hogeborn</holder>
47
38
      <holder>Björn Påhlsson</holder>
48
39
    </copyright>
96
87
        <replaceable>FILE</replaceable></option></arg>
97
88
      </group>
98
89
      <sbr/>
99
 
      <group>
100
 
        <arg choice="plain"><option>--tls-privkey
101
 
        <replaceable>FILE</replaceable></option></arg>
102
 
        <arg choice="plain"><option>-t
103
 
        <replaceable>FILE</replaceable></option></arg>
104
 
      </group>
105
 
      <sbr/>
106
 
      <group>
107
 
        <arg choice="plain"><option>--tls-pubkey
108
 
        <replaceable>FILE</replaceable></option></arg>
109
 
        <arg choice="plain"><option>-T
110
 
        <replaceable>FILE</replaceable></option></arg>
111
 
      </group>
112
 
      <sbr/>
113
90
      <arg>
114
91
        <option>--priority <replaceable>STRING</replaceable></option>
115
92
      </arg>
119
96
      </arg>
120
97
      <sbr/>
121
98
      <arg>
122
 
        <option>--dh-params <replaceable>FILE</replaceable></option>
123
 
      </arg>
124
 
      <sbr/>
125
 
      <arg>
126
99
        <option>--delay <replaceable>SECONDS</replaceable></option>
127
100
      </arg>
128
101
      <sbr/>
169
142
      brings up network interfaces, uses the interfaces’ IPv6
170
143
      link-local addresses to get network connectivity, uses Zeroconf
171
144
      to find servers on the local network, and communicates with
172
 
      servers using TLS with a raw public key to ensure authenticity
173
 
      and confidentiality.  This client program keeps running, trying
174
 
      all servers on the network, until it receives a satisfactory
175
 
      reply or a TERM signal.  After all servers have been tried, all
 
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
176
149
      servers are periodically retried.  If no servers are found it
177
150
      will wait indefinitely for new servers to appear.
178
151
    </para>
245
218
            assumed to separate the address from the port number.
246
219
          </para>
247
220
          <para>
248
 
            Normally, Zeroconf would be used to locate Mandos servers,
249
 
            in which case this option would only be used when testing
250
 
            and debugging.
 
221
            This option is normally only useful for testing and
 
222
            debugging.
251
223
          </para>
252
224
        </listitem>
253
225
      </varlistentry>
286
258
          <para>
287
259
            <replaceable>NAME</replaceable> can be the string
288
260
            <quote><literal>none</literal></quote>; this will make
289
 
            <command>&COMMANDNAME;</command> only bring up interfaces
290
 
            specified <emphasis>before</emphasis> this string.  This
291
 
            is not recommended, and only meant for advanced users.
 
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.
292
265
          </para>
293
266
        </listitem>
294
267
      </varlistentry>
322
295
      </varlistentry>
323
296
      
324
297
      <varlistentry>
325
 
        <term><option>--tls-pubkey=<replaceable
326
 
        >FILE</replaceable></option></term>
327
 
        <term><option>-T
328
 
        <replaceable>FILE</replaceable></option></term>
329
 
        <listitem>
330
 
          <para>
331
 
            TLS raw public key file name.  The default name is
332
 
            <quote><filename>/conf/conf.d/mandos/tls-pubkey.pem</filename
333
 
            ></quote>.
334
 
          </para>
335
 
        </listitem>
336
 
      </varlistentry>
337
 
 
338
 
      <varlistentry>
339
 
        <term><option>--tls-privkey=<replaceable
340
 
        >FILE</replaceable></option></term>
341
 
        <term><option>-t
342
 
        <replaceable>FILE</replaceable></option></term>
343
 
        <listitem>
344
 
          <para>
345
 
            TLS secret key file name.  The default name is
346
 
            <quote><filename>/conf/conf.d/mandos/tls-privkey.pem</filename
347
 
            ></quote>.
348
 
          </para>
349
 
        </listitem>
350
 
      </varlistentry>
351
 
 
352
 
      <varlistentry>
353
298
        <term><option>--priority=<replaceable
354
299
        >STRING</replaceable></option></term>
355
300
        <listitem>
364
309
        <listitem>
365
310
          <para>
366
311
            Sets the number of bits to use for the prime number in the
367
 
            TLS Diffie-Hellman key exchange.  The default value is
368
 
            selected automatically based on the GnuTLS security
369
 
            profile set in its priority string.  Note that if the
370
 
            <option>--dh-params</option> option is used, the values
371
 
            from that file will be used instead.
372
 
          </para>
373
 
        </listitem>
374
 
      </varlistentry>
375
 
      
376
 
      <varlistentry>
377
 
        <term><option>--dh-params=<replaceable
378
 
        >FILE</replaceable></option></term>
379
 
        <listitem>
380
 
          <para>
381
 
            Specifies a PEM-encoded PKCS#3 file to read the parameters
382
 
            needed by the TLS Diffie-Hellman key exchange from.  If
383
 
            this option is not given, or if the file for some reason
384
 
            could not be used, the parameters will be generated on
385
 
            startup, which will take some time and processing power.
386
 
            Those using servers running under time, power or processor
387
 
            constraints may want to generate such a file in advance
388
 
            and use this option.
 
312
            TLS Diffie-Hellman key exchange.  Default is 1024.
389
313
          </para>
390
314
        </listitem>
391
315
      </varlistentry>
518
442
  
519
443
  <refsect1 id="environment">
520
444
    <title>ENVIRONMENT</title>
521
 
    <variablelist>
522
 
      <varlistentry>
523
 
        <term><envar>MANDOSPLUGINHELPERDIR</envar></term>
524
 
        <listitem>
525
 
          <para>
526
 
            This environment variable will be assumed to contain the
527
 
            directory containing any helper executables.  The use and
528
 
            nature of these helper executables, if any, is purposely
529
 
            not documented.
530
 
        </para>
531
 
        </listitem>
532
 
      </varlistentry>
533
 
    </variablelist>
534
445
    <para>
535
 
      This program does not use any other environment variables, not
536
 
      even the ones provided by <citerefentry><refentrytitle
 
446
      This program does not use any environment variables, not even
 
447
      the ones provided by <citerefentry><refentrytitle
537
448
      >cryptsetup</refentrytitle><manvolnum>8</manvolnum>
538
449
    </citerefentry>.
539
450
    </para>
726
637
        </listitem>
727
638
      </varlistentry>
728
639
      <varlistentry>
729
 
        <term><filename>/conf/conf.d/mandos/tls-pubkey.pem</filename
730
 
        ></term>
731
 
        <term><filename>/conf/conf.d/mandos/tls-privkey.pem</filename
732
 
        ></term>
733
 
        <listitem>
734
 
          <para>
735
 
            Public and private raw key files, in <quote>PEM</quote>
736
 
            format.  These are the default file names, they can be
737
 
            changed with the <option>--tls-pubkey</option> and
738
 
            <option>--tls-privkey</option> options.
739
 
          </para>
740
 
        </listitem>
741
 
      </varlistentry>
742
 
      <varlistentry>
743
640
        <term><filename
744
641
        class="directory">/lib/mandos/network-hooks.d</filename></term>
745
642
        <listitem>
753
650
    </variablelist>
754
651
  </refsect1>
755
652
  
756
 
  <refsect1 id="bugs">
757
 
    <title>BUGS</title>
758
 
    <xi:include href="../bugs.xml"/>
759
 
  </refsect1>
 
653
<!--   <refsect1 id="bugs"> -->
 
654
<!--     <title>BUGS</title> -->
 
655
<!--     <para> -->
 
656
<!--     </para> -->
 
657
<!--   </refsect1> -->
760
658
  
761
659
  <refsect1 id="example">
762
660
    <title>EXAMPLE</title>
787
685
    </informalexample>
788
686
    <informalexample>
789
687
      <para>
790
 
        Run in debug mode, and use custom keys:
 
688
        Run in debug mode, and use a custom key:
791
689
      </para>
792
690
      <para>
793
691
 
794
692
<!-- do not wrap this line -->
795
 
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --tls-pubkey keydir/tls-pubkey.pem --tls-privkey keydir/tls-privkey.pem</userinput>
 
693
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt</userinput>
796
694
 
797
695
      </para>
798
696
    </informalexample>
799
697
    <informalexample>
800
698
      <para>
801
 
        Run in debug mode, with custom keys, and do not use Zeroconf
 
699
        Run in debug mode, with a custom key, and do not use Zeroconf
802
700
        to locate a server; connect directly to the IPv6 link-local
803
701
        address <quote><systemitem class="ipaddress"
804
702
        >fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
807
705
      <para>
808
706
 
809
707
<!-- do not wrap this line -->
810
 
<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>
 
708
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect fe80::aede:48ff:fe71:f6f2:4711 --interface eth2</userinput>
811
709
 
812
710
      </para>
813
711
    </informalexample>
837
735
    <para>
838
736
      The only remaining weak point is that someone with physical
839
737
      access to the client hard drive might turn off the client
840
 
      computer, read the OpenPGP and TLS keys directly from the hard
841
 
      drive, and communicate with the server.  To safeguard against
842
 
      this, the server is supposed to notice the client disappearing
843
 
      and stop giving out the encrypted data.  Therefore, it is
844
 
      important to set the timeout and checker interval values tightly
845
 
      on the server.  See <citerefentry><refentrytitle
 
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
846
744
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
847
745
    </para>
848
746
    <para>
849
747
      It will also help if the checker program on the server is
850
748
      configured to request something from the client which can not be
851
 
      spoofed by someone else on the network, like SSH server key
852
 
      fingerprints, and unlike unencrypted <acronym>ICMP</acronym>
853
 
      echo (<quote>ping</quote>) replies.
 
749
      spoofed by someone else on the network, unlike unencrypted
 
750
      <acronym>ICMP</acronym> echo (<quote>ping</quote>) replies.
854
751
    </para>
855
752
    <para>
856
753
      <emphasis>Note</emphasis>: This makes it completely insecure to
902
799
      </varlistentry>
903
800
      <varlistentry>
904
801
        <term>
905
 
          <ulink url="https://www.gnutls.org/">GnuTLS</ulink>
 
802
          <ulink url="http://www.gnu.org/software/gnutls/"
 
803
          >GnuTLS</ulink>
906
804
        </term>
907
805
      <listitem>
908
806
        <para>
909
807
          GnuTLS is the library this client uses to implement TLS for
910
808
          communicating securely with the server, and at the same time
911
 
          send the public key to the server.
 
809
          send the public OpenPGP key to the server.
912
810
        </para>
913
811
      </listitem>
914
812
      </varlistentry>
915
813
      <varlistentry>
916
814
        <term>
917
 
          <ulink url="https://www.gnupg.org/related_software/gpgme/"
 
815
          <ulink url="http://www.gnupg.org/related_software/gpgme/"
918
816
                 >GPGME</ulink>
919
817
        </term>
920
818
        <listitem>
958
856
      </varlistentry>
959
857
      <varlistentry>
960
858
        <term>
961
 
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
962
 
          Protocol Version 1.2</citetitle>
 
859
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
860
          Protocol Version 1.1</citetitle>
963
861
        </term>
964
862
      <listitem>
965
863
        <para>
966
 
          TLS 1.2 is the protocol implemented by GnuTLS.
 
864
          TLS 1.1 is the protocol implemented by GnuTLS.
967
865
        </para>
968
866
      </listitem>
969
867
      </varlistentry>
980
878
      </varlistentry>
981
879
      <varlistentry>
982
880
        <term>
983
 
          RFC 7250: <citetitle>Using Raw Public Keys in Transport
984
 
          Layer Security (TLS) and Datagram Transport Layer Security
985
 
          (DTLS)</citetitle>
986
 
        </term>
987
 
      <listitem>
988
 
        <para>
989
 
          This is implemented by GnuTLS in version 3.6.6 and is, if
990
 
          present, used by this program so that raw public keys can be
991
 
          used.
992
 
        </para>
993
 
      </listitem>
994
 
      </varlistentry>
995
 
      <varlistentry>
996
 
        <term>
997
 
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
 
881
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
998
882
          Security</citetitle>
999
883
        </term>
1000
884
      <listitem>
1001
885
        <para>
1002
 
          This is implemented by GnuTLS before version 3.6.0 and is,
1003
 
          if present, used by this program so that OpenPGP keys can be
1004
 
          used.
 
886
          This is implemented by GnuTLS and used by this program so
 
887
          that OpenPGP keys can be used.
1005
888
        </para>
1006
889
      </listitem>
1007
890
      </varlistentry>