/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:36:11 UTC
  • Revision ID: teddy@recompile.se-20190209233611-qurtq0kpsoct9uwf
Doc fix: Minor clarification

* mandos-clients.conf.xml (OPTIONS/checker): Be more clear that it's
  specifically an SSH key fingerprint that is being compared, and no
  other kind of fingerprint.

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