/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

Merge change to add local route when network is "unreachable".

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-07-24">
 
5
<!ENTITY TIMESTAMP "2015-07-06">
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
37
      <year>2013</year>
40
38
      <year>2014</year>
41
39
      <year>2015</year>
42
 
      <year>2016</year>
43
 
      <year>2017</year>
44
 
      <year>2018</year>
45
 
      <year>2019</year>
46
40
      <holder>Teddy Hogeborn</holder>
47
41
      <holder>Björn Påhlsson</holder>
48
42
    </copyright>
96
90
        <replaceable>FILE</replaceable></option></arg>
97
91
      </group>
98
92
      <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
93
      <arg>
114
94
        <option>--priority <replaceable>STRING</replaceable></option>
115
95
      </arg>
119
99
      </arg>
120
100
      <sbr/>
121
101
      <arg>
122
 
        <option>--dh-params <replaceable>FILE</replaceable></option>
123
 
      </arg>
124
 
      <sbr/>
125
 
      <arg>
126
102
        <option>--delay <replaceable>SECONDS</replaceable></option>
127
103
      </arg>
128
104
      <sbr/>
169
145
      brings up network interfaces, uses the interfaces’ IPv6
170
146
      link-local addresses to get network connectivity, uses Zeroconf
171
147
      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
 
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
176
152
      servers are periodically retried.  If no servers are found it
177
153
      will wait indefinitely for new servers to appear.
178
154
    </para>
322
298
      </varlistentry>
323
299
      
324
300
      <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
301
        <term><option>--priority=<replaceable
354
302
        >STRING</replaceable></option></term>
355
303
        <listitem>
365
313
          <para>
366
314
            Sets the number of bits to use for the prime number in the
367
315
            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.
 
316
            selected automatically based on the OpenPGP key.
389
317
          </para>
390
318
        </listitem>
391
319
      </varlistentry>
525
453
          <para>
526
454
            This environment variable will be assumed to contain the
527
455
            directory containing any helper executables.  The use and
528
 
            nature of these helper executables, if any, is purposely
529
 
            not documented.
 
456
            nature of these helper executables, if any, is
 
457
            purposefully not documented.
530
458
        </para>
531
459
        </listitem>
532
460
      </varlistentry>
726
654
        </listitem>
727
655
      </varlistentry>
728
656
      <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
657
        <term><filename
744
658
        class="directory">/lib/mandos/network-hooks.d</filename></term>
745
659
        <listitem>
753
667
    </variablelist>
754
668
  </refsect1>
755
669
  
756
 
  <refsect1 id="bugs">
757
 
    <title>BUGS</title>
758
 
    <xi:include href="../bugs.xml"/>
759
 
  </refsect1>
 
670
<!--   <refsect1 id="bugs"> -->
 
671
<!--     <title>BUGS</title> -->
 
672
<!--     <para> -->
 
673
<!--     </para> -->
 
674
<!--   </refsect1> -->
760
675
  
761
676
  <refsect1 id="example">
762
677
    <title>EXAMPLE</title>
787
702
    </informalexample>
788
703
    <informalexample>
789
704
      <para>
790
 
        Run in debug mode, and use custom keys:
 
705
        Run in debug mode, and use a custom key:
791
706
      </para>
792
707
      <para>
793
708
 
794
709
<!-- 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>
 
710
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt</userinput>
796
711
 
797
712
      </para>
798
713
    </informalexample>
799
714
    <informalexample>
800
715
      <para>
801
 
        Run in debug mode, with custom keys, and do not use Zeroconf
 
716
        Run in debug mode, with a custom key, and do not use Zeroconf
802
717
        to locate a server; connect directly to the IPv6 link-local
803
718
        address <quote><systemitem class="ipaddress"
804
719
        >fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
807
722
      <para>
808
723
 
809
724
<!-- 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>
 
725
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect fe80::aede:48ff:fe71:f6f2:4711 --interface eth2</userinput>
811
726
 
812
727
      </para>
813
728
    </informalexample>
816
731
  <refsect1 id="security">
817
732
    <title>SECURITY</title>
818
733
    <para>
819
 
      This program assumes that it is set-uid to root, and will switch
820
 
      back to the original (and presumably non-privileged) user and
821
 
      group after bringing up the network interface.
 
734
      This program is set-uid to root, but will switch back to the
 
735
      original (and presumably non-privileged) user and group after
 
736
      bringing up the network interface.
822
737
    </para>
823
738
    <para>
824
739
      To use this program for its intended purpose (see <xref
837
752
    <para>
838
753
      The only remaining weak point is that someone with physical
839
754
      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
 
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
846
761
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
847
762
    </para>
848
763
    <para>
891
806
      </varlistentry>
892
807
      <varlistentry>
893
808
        <term>
894
 
          <ulink url="https://www.avahi.org/">Avahi</ulink>
 
809
          <ulink url="http://www.avahi.org/">Avahi</ulink>
895
810
        </term>
896
811
      <listitem>
897
812
        <para>
902
817
      </varlistentry>
903
818
      <varlistentry>
904
819
        <term>
905
 
          <ulink url="https://www.gnutls.org/">GnuTLS</ulink>
 
820
          <ulink url="http://www.gnu.org/software/gnutls/"
 
821
          >GnuTLS</ulink>
906
822
        </term>
907
823
      <listitem>
908
824
        <para>
909
825
          GnuTLS is the library this client uses to implement TLS for
910
826
          communicating securely with the server, and at the same time
911
 
          send the public key to the server.
 
827
          send the public OpenPGP key to the server.
912
828
        </para>
913
829
      </listitem>
914
830
      </varlistentry>
915
831
      <varlistentry>
916
832
        <term>
917
 
          <ulink url="https://www.gnupg.org/related_software/gpgme/"
 
833
          <ulink url="http://www.gnupg.org/related_software/gpgme/"
918
834
                 >GPGME</ulink>
919
835
        </term>
920
836
        <listitem>
958
874
      </varlistentry>
959
875
      <varlistentry>
960
876
        <term>
961
 
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
962
 
          Protocol Version 1.2</citetitle>
 
877
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
878
          Protocol Version 1.1</citetitle>
963
879
        </term>
964
880
      <listitem>
965
881
        <para>
966
 
          TLS 1.2 is the protocol implemented by GnuTLS.
 
882
          TLS 1.1 is the protocol implemented by GnuTLS.
967
883
        </para>
968
884
      </listitem>
969
885
      </varlistentry>
980
896
      </varlistentry>
981
897
      <varlistentry>
982
898
        <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
 
899
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
998
900
          Security</citetitle>
999
901
        </term>
1000
902
      <listitem>
1001
903
        <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.
 
904
          This is implemented by GnuTLS and used by this program so
 
905
          that OpenPGP keys can be used.
1005
906
        </para>
1006
907
      </listitem>
1007
908
      </varlistentry>