/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:34:15 UTC
  • Revision ID: teddy@recompile.se-20190209233415-m1ntebuepwna1xg1
Doc fix: Change some "/etc/mandos" to "/etc/keys/mandos"

* clients.conf: Change "/etc/mandos" to "/etc/keys/mandos" where
                appropriate
* mandos-keygen.xml: - '' -

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