/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: 2023-02-07 19:29:28 UTC
  • Revision ID: teddy@recompile.se-20230207192928-ueasjbsufb92o6ud
Clarify documentation and a comment about GnuTLS versions

* clients.conf ([foo]/secret): In the comment for the example client's
  "secret" setting, clarify GnuTLS version conditions.
* mandos-clients.conf.xml (OPTIONS/fingerprint, OPTIONS/key_id):
  Clarify required/optional status under different GnuTLS versions.

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 "2016-02-28">
 
5
<!ENTITY TIMESTAMP "2019-07-24">
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>
43
46
      <holder>Teddy Hogeborn</holder>
44
47
      <holder>Björn Påhlsson</holder>
45
48
    </copyright>
93
96
        <replaceable>FILE</replaceable></option></arg>
94
97
      </group>
95
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/>
96
113
      <arg>
97
114
        <option>--priority <replaceable>STRING</replaceable></option>
98
115
      </arg>
152
169
      brings up network interfaces, uses the interfaces’ IPv6
153
170
      link-local addresses to get network connectivity, uses Zeroconf
154
171
      to find servers on the local network, and communicates with
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
 
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
159
176
      servers are periodically retried.  If no servers are found it
160
177
      will wait indefinitely for new servers to appear.
161
178
    </para>
305
322
      </varlistentry>
306
323
      
307
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>
308
353
        <term><option>--priority=<replaceable
309
354
        >STRING</replaceable></option></term>
310
355
        <listitem>
320
365
          <para>
321
366
            Sets the number of bits to use for the prime number in the
322
367
            TLS Diffie-Hellman key exchange.  The default value is
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.
 
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.
326
372
          </para>
327
373
        </listitem>
328
374
      </varlistentry>
479
525
          <para>
480
526
            This environment variable will be assumed to contain the
481
527
            directory containing any helper executables.  The use and
482
 
            nature of these helper executables, if any, is
483
 
            purposefully not documented.
 
528
            nature of these helper executables, if any, is purposely
 
529
            not documented.
484
530
        </para>
485
531
        </listitem>
486
532
      </varlistentry>
680
726
        </listitem>
681
727
      </varlistentry>
682
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>
683
743
        <term><filename
684
744
        class="directory">/lib/mandos/network-hooks.d</filename></term>
685
745
        <listitem>
693
753
    </variablelist>
694
754
  </refsect1>
695
755
  
696
 
<!--   <refsect1 id="bugs"> -->
697
 
<!--     <title>BUGS</title> -->
698
 
<!--     <para> -->
699
 
<!--     </para> -->
700
 
<!--   </refsect1> -->
 
756
  <refsect1 id="bugs">
 
757
    <title>BUGS</title>
 
758
    <xi:include href="../bugs.xml"/>
 
759
  </refsect1>
701
760
  
702
761
  <refsect1 id="example">
703
762
    <title>EXAMPLE</title>
728
787
    </informalexample>
729
788
    <informalexample>
730
789
      <para>
731
 
        Run in debug mode, and use a custom key:
 
790
        Run in debug mode, and use custom keys:
732
791
      </para>
733
792
      <para>
734
793
 
735
794
<!-- do not wrap this line -->
736
 
<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>
737
796
 
738
797
      </para>
739
798
    </informalexample>
740
799
    <informalexample>
741
800
      <para>
742
 
        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
743
802
        to locate a server; connect directly to the IPv6 link-local
744
803
        address <quote><systemitem class="ipaddress"
745
804
        >fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
748
807
      <para>
749
808
 
750
809
<!-- do not wrap this line -->
751
 
<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>
752
811
 
753
812
      </para>
754
813
    </informalexample>
757
816
  <refsect1 id="security">
758
817
    <title>SECURITY</title>
759
818
    <para>
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.
 
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.
763
822
    </para>
764
823
    <para>
765
824
      To use this program for its intended purpose (see <xref
778
837
    <para>
779
838
      The only remaining weak point is that someone with physical
780
839
      access to the client hard drive might turn off the client
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
 
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
787
846
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
788
847
    </para>
789
848
    <para>
832
891
      </varlistentry>
833
892
      <varlistentry>
834
893
        <term>
835
 
          <ulink url="http://www.avahi.org/">Avahi</ulink>
 
894
          <ulink url="https://www.avahi.org/">Avahi</ulink>
836
895
        </term>
837
896
      <listitem>
838
897
        <para>
843
902
      </varlistentry>
844
903
      <varlistentry>
845
904
        <term>
846
 
          <ulink url="http://www.gnu.org/software/gnutls/"
847
 
          >GnuTLS</ulink>
 
905
          <ulink url="https://www.gnutls.org/">GnuTLS</ulink>
848
906
        </term>
849
907
      <listitem>
850
908
        <para>
851
909
          GnuTLS is the library this client uses to implement TLS for
852
910
          communicating securely with the server, and at the same time
853
 
          send the public OpenPGP key to the server.
 
911
          send the public key to the server.
854
912
        </para>
855
913
      </listitem>
856
914
      </varlistentry>
857
915
      <varlistentry>
858
916
        <term>
859
 
          <ulink url="http://www.gnupg.org/related_software/gpgme/"
 
917
          <ulink url="https://www.gnupg.org/related_software/gpgme/"
860
918
                 >GPGME</ulink>
861
919
        </term>
862
920
        <listitem>
900
958
      </varlistentry>
901
959
      <varlistentry>
902
960
        <term>
903
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
904
 
          Protocol Version 1.1</citetitle>
 
961
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
 
962
          Protocol Version 1.2</citetitle>
905
963
        </term>
906
964
      <listitem>
907
965
        <para>
908
 
          TLS 1.1 is the protocol implemented by GnuTLS.
 
966
          TLS 1.2 is the protocol implemented by GnuTLS.
909
967
        </para>
910
968
      </listitem>
911
969
      </varlistentry>
922
980
      </varlistentry>
923
981
      <varlistentry>
924
982
        <term>
925
 
          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
926
998
          Security</citetitle>
927
999
        </term>
928
1000
      <listitem>
929
1001
        <para>
930
 
          This is implemented by GnuTLS and used by this program so
931
 
          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.
932
1005
        </para>
933
1006
      </listitem>
934
1007
      </varlistentry>