/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: 2019-02-09 23:34:15 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 370.
  • 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:
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-02-09">
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>
43
45
      <holder>Teddy Hogeborn</holder>
44
46
      <holder>Björn Påhlsson</holder>
45
47
    </copyright>
93
95
        <replaceable>FILE</replaceable></option></arg>
94
96
      </group>
95
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/>
96
112
      <arg>
97
113
        <option>--priority <replaceable>STRING</replaceable></option>
98
114
      </arg>
152
168
      brings up network interfaces, uses the interfaces’ IPv6
153
169
      link-local addresses to get network connectivity, uses Zeroconf
154
170
      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
 
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
159
175
      servers are periodically retried.  If no servers are found it
160
176
      will wait indefinitely for new servers to appear.
161
177
    </para>
305
321
      </varlistentry>
306
322
      
307
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>
308
352
        <term><option>--priority=<replaceable
309
353
        >STRING</replaceable></option></term>
310
354
        <listitem>
320
364
          <para>
321
365
            Sets the number of bits to use for the prime number in the
322
366
            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.
 
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.
326
371
          </para>
327
372
        </listitem>
328
373
      </varlistentry>
680
725
        </listitem>
681
726
      </varlistentry>
682
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>
683
742
        <term><filename
684
743
        class="directory">/lib/mandos/network-hooks.d</filename></term>
685
744
        <listitem>
693
752
    </variablelist>
694
753
  </refsect1>
695
754
  
696
 
<!--   <refsect1 id="bugs"> -->
697
 
<!--     <title>BUGS</title> -->
698
 
<!--     <para> -->
699
 
<!--     </para> -->
700
 
<!--   </refsect1> -->
 
755
  <refsect1 id="bugs">
 
756
    <title>BUGS</title>
 
757
    <xi:include href="../bugs.xml"/>
 
758
  </refsect1>
701
759
  
702
760
  <refsect1 id="example">
703
761
    <title>EXAMPLE</title>
728
786
    </informalexample>
729
787
    <informalexample>
730
788
      <para>
731
 
        Run in debug mode, and use a custom key:
 
789
        Run in debug mode, and use custom keys:
732
790
      </para>
733
791
      <para>
734
792
 
735
793
<!-- do not wrap this line -->
736
 
<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>
737
795
 
738
796
      </para>
739
797
    </informalexample>
740
798
    <informalexample>
741
799
      <para>
742
 
        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
743
801
        to locate a server; connect directly to the IPv6 link-local
744
802
        address <quote><systemitem class="ipaddress"
745
803
        >fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
748
806
      <para>
749
807
 
750
808
<!-- 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>
 
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>
752
810
 
753
811
      </para>
754
812
    </informalexample>
778
836
    <para>
779
837
      The only remaining weak point is that someone with physical
780
838
      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
 
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
787
845
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
788
846
    </para>
789
847
    <para>
843
901
      </varlistentry>
844
902
      <varlistentry>
845
903
        <term>
846
 
          <ulink url="http://www.gnu.org/software/gnutls/"
847
 
          >GnuTLS</ulink>
 
904
          <ulink url="https://www.gnutls.org/">GnuTLS</ulink>
848
905
        </term>
849
906
      <listitem>
850
907
        <para>
851
908
          GnuTLS is the library this client uses to implement TLS for
852
909
          communicating securely with the server, and at the same time
853
 
          send the public OpenPGP key to the server.
 
910
          send the public key to the server.
854
911
        </para>
855
912
      </listitem>
856
913
      </varlistentry>
857
914
      <varlistentry>
858
915
        <term>
859
 
          <ulink url="http://www.gnupg.org/related_software/gpgme/"
 
916
          <ulink url="https://www.gnupg.org/related_software/gpgme/"
860
917
                 >GPGME</ulink>
861
918
        </term>
862
919
        <listitem>
900
957
      </varlistentry>
901
958
      <varlistentry>
902
959
        <term>
903
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
904
 
          Protocol Version 1.1</citetitle>
 
960
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
 
961
          Protocol Version 1.2</citetitle>
905
962
        </term>
906
963
      <listitem>
907
964
        <para>
908
 
          TLS 1.1 is the protocol implemented by GnuTLS.
 
965
          TLS 1.2 is the protocol implemented by GnuTLS.
909
966
        </para>
910
967
      </listitem>
911
968
      </varlistentry>
922
979
      </varlistentry>
923
980
      <varlistentry>
924
981
        <term>
925
 
          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
926
997
          Security</citetitle>
927
998
        </term>
928
999
      <listitem>
929
1000
        <para>
930
 
          This is implemented by GnuTLS and used by this program so
931
 
          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.
932
1004
        </para>
933
1005
      </listitem>
934
1006
      </varlistentry>