/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

  • Committer: Teddy Hogeborn
  • Date: 2016-02-29 21:21:45 UTC
  • mfrom: (237.7.361 trunk)
  • Revision ID: teddy@recompile.se-20160229212145-plspagxx4kiyw1un
Merge from trunk.

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 "2016-02-28">
6
6
<!ENTITY % common SYSTEM "../common.ent">
7
7
%common;
8
8
]>
40
40
      <year>2014</year>
41
41
      <year>2015</year>
42
42
      <year>2016</year>
43
 
      <year>2017</year>
44
 
      <year>2018</year>
45
 
      <year>2019</year>
46
43
      <holder>Teddy Hogeborn</holder>
47
44
      <holder>Björn Påhlsson</holder>
48
45
    </copyright>
96
93
        <replaceable>FILE</replaceable></option></arg>
97
94
      </group>
98
95
      <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
96
      <arg>
114
97
        <option>--priority <replaceable>STRING</replaceable></option>
115
98
      </arg>
169
152
      brings up network interfaces, uses the interfaces’ IPv6
170
153
      link-local addresses to get network connectivity, uses Zeroconf
171
154
      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
 
155
      servers using TLS with an OpenPGP key to ensure authenticity and
 
156
      confidentiality.  This client program keeps running, trying all
 
157
      servers on the network, until it receives a satisfactory reply
 
158
      or a TERM signal.  After all servers have been tried, all
176
159
      servers are periodically retried.  If no servers are found it
177
160
      will wait indefinitely for new servers to appear.
178
161
    </para>
322
305
      </varlistentry>
323
306
      
324
307
      <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
308
        <term><option>--priority=<replaceable
354
309
        >STRING</replaceable></option></term>
355
310
        <listitem>
365
320
          <para>
366
321
            Sets the number of bits to use for the prime number in the
367
322
            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.
 
323
            selected automatically based on the OpenPGP key.  Note
 
324
            that if the <option>--dh-params</option> option is used,
 
325
            the values from that file will be used instead.
372
326
          </para>
373
327
        </listitem>
374
328
      </varlistentry>
525
479
          <para>
526
480
            This environment variable will be assumed to contain the
527
481
            directory containing any helper executables.  The use and
528
 
            nature of these helper executables, if any, is purposely
529
 
            not documented.
 
482
            nature of these helper executables, if any, is
 
483
            purposefully not documented.
530
484
        </para>
531
485
        </listitem>
532
486
      </varlistentry>
726
680
        </listitem>
727
681
      </varlistentry>
728
682
      <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
683
        <term><filename
744
684
        class="directory">/lib/mandos/network-hooks.d</filename></term>
745
685
        <listitem>
753
693
    </variablelist>
754
694
  </refsect1>
755
695
  
756
 
  <refsect1 id="bugs">
757
 
    <title>BUGS</title>
758
 
    <xi:include href="../bugs.xml"/>
759
 
  </refsect1>
 
696
<!--   <refsect1 id="bugs"> -->
 
697
<!--     <title>BUGS</title> -->
 
698
<!--     <para> -->
 
699
<!--     </para> -->
 
700
<!--   </refsect1> -->
760
701
  
761
702
  <refsect1 id="example">
762
703
    <title>EXAMPLE</title>
787
728
    </informalexample>
788
729
    <informalexample>
789
730
      <para>
790
 
        Run in debug mode, and use custom keys:
 
731
        Run in debug mode, and use a custom key:
791
732
      </para>
792
733
      <para>
793
734
 
794
735
<!-- 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>
 
736
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt</userinput>
796
737
 
797
738
      </para>
798
739
    </informalexample>
799
740
    <informalexample>
800
741
      <para>
801
 
        Run in debug mode, with custom keys, and do not use Zeroconf
 
742
        Run in debug mode, with a custom key, and do not use Zeroconf
802
743
        to locate a server; connect directly to the IPv6 link-local
803
744
        address <quote><systemitem class="ipaddress"
804
745
        >fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
807
748
      <para>
808
749
 
809
750
<!-- 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>
 
751
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect fe80::aede:48ff:fe71:f6f2:4711 --interface eth2</userinput>
811
752
 
812
753
      </para>
813
754
    </informalexample>
816
757
  <refsect1 id="security">
817
758
    <title>SECURITY</title>
818
759
    <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.
 
760
      This program is set-uid to root, but will switch back to the
 
761
      original (and presumably non-privileged) user and group after
 
762
      bringing up the network interface.
822
763
    </para>
823
764
    <para>
824
765
      To use this program for its intended purpose (see <xref
837
778
    <para>
838
779
      The only remaining weak point is that someone with physical
839
780
      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
 
781
      computer, read the OpenPGP keys directly from the hard drive,
 
782
      and communicate with the server.  To safeguard against this, the
 
783
      server is supposed to notice the client disappearing and stop
 
784
      giving out the encrypted data.  Therefore, it is important to
 
785
      set the timeout and checker interval values tightly on the
 
786
      server.  See <citerefentry><refentrytitle
846
787
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
847
788
    </para>
848
789
    <para>
891
832
      </varlistentry>
892
833
      <varlistentry>
893
834
        <term>
894
 
          <ulink url="https://www.avahi.org/">Avahi</ulink>
 
835
          <ulink url="http://www.avahi.org/">Avahi</ulink>
895
836
        </term>
896
837
      <listitem>
897
838
        <para>
902
843
      </varlistentry>
903
844
      <varlistentry>
904
845
        <term>
905
 
          <ulink url="https://www.gnutls.org/">GnuTLS</ulink>
 
846
          <ulink url="http://www.gnu.org/software/gnutls/"
 
847
          >GnuTLS</ulink>
906
848
        </term>
907
849
      <listitem>
908
850
        <para>
909
851
          GnuTLS is the library this client uses to implement TLS for
910
852
          communicating securely with the server, and at the same time
911
 
          send the public key to the server.
 
853
          send the public OpenPGP key to the server.
912
854
        </para>
913
855
      </listitem>
914
856
      </varlistentry>
915
857
      <varlistentry>
916
858
        <term>
917
 
          <ulink url="https://www.gnupg.org/related_software/gpgme/"
 
859
          <ulink url="http://www.gnupg.org/related_software/gpgme/"
918
860
                 >GPGME</ulink>
919
861
        </term>
920
862
        <listitem>
958
900
      </varlistentry>
959
901
      <varlistentry>
960
902
        <term>
961
 
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
962
 
          Protocol Version 1.2</citetitle>
 
903
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
904
          Protocol Version 1.1</citetitle>
963
905
        </term>
964
906
      <listitem>
965
907
        <para>
966
 
          TLS 1.2 is the protocol implemented by GnuTLS.
 
908
          TLS 1.1 is the protocol implemented by GnuTLS.
967
909
        </para>
968
910
      </listitem>
969
911
      </varlistentry>
980
922
      </varlistentry>
981
923
      <varlistentry>
982
924
        <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
 
925
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
998
926
          Security</citetitle>
999
927
        </term>
1000
928
      <listitem>
1001
929
        <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.
 
930
          This is implemented by GnuTLS and used by this program so
 
931
          that OpenPGP keys can be used.
1005
932
        </para>
1006
933
      </listitem>
1007
934
      </varlistentry>