/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-08-04 04:30:33 UTC
  • Revision ID: teddy@recompile.se-20190804043033-s0ztfrvi2383wznb
Client: Always build with LFS enabled

* Makefile (FEATURES): New; set to "-D_FILE_OFFSET_BITS=64".
  (CFLAGS): Add "$(FEATURES)".

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