/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: 2018-02-22 18:34:39 UTC
  • mfrom: (942 trunk)
  • mto: This revision was merged to the branch mainline in revision 943.
  • Revision ID: teddy@recompile.se-20180222183439-ardlmmsvs6jbkp8x
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-02-10">
 
5
<!ENTITY TIMESTAMP "2018-02-08">
6
6
<!ENTITY % common SYSTEM "../common.ent">
7
7
%common;
8
8
]>
42
42
      <year>2016</year>
43
43
      <year>2017</year>
44
44
      <year>2018</year>
45
 
      <year>2019</year>
46
45
      <holder>Teddy Hogeborn</holder>
47
46
      <holder>Björn Påhlsson</holder>
48
47
    </copyright>
96
95
        <replaceable>FILE</replaceable></option></arg>
97
96
      </group>
98
97
      <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
98
      <arg>
114
99
        <option>--priority <replaceable>STRING</replaceable></option>
115
100
      </arg>
169
154
      brings up network interfaces, uses the interfaces’ IPv6
170
155
      link-local addresses to get network connectivity, uses Zeroconf
171
156
      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
 
157
      servers using TLS with an OpenPGP key to ensure authenticity and
 
158
      confidentiality.  This client program keeps running, trying all
 
159
      servers on the network, until it receives a satisfactory reply
 
160
      or a TERM signal.  After all servers have been tried, all
176
161
      servers are periodically retried.  If no servers are found it
177
162
      will wait indefinitely for new servers to appear.
178
163
    </para>
322
307
      </varlistentry>
323
308
      
324
309
      <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
310
        <term><option>--priority=<replaceable
354
311
        >STRING</replaceable></option></term>
355
312
        <listitem>
365
322
          <para>
366
323
            Sets the number of bits to use for the prime number in the
367
324
            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.
 
325
            selected automatically based on the OpenPGP key.  Note
 
326
            that if the <option>--dh-params</option> option is used,
 
327
            the values from that file will be used instead.
372
328
          </para>
373
329
        </listitem>
374
330
      </varlistentry>
726
682
        </listitem>
727
683
      </varlistentry>
728
684
      <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
685
        <term><filename
744
686
        class="directory">/lib/mandos/network-hooks.d</filename></term>
745
687
        <listitem>
787
729
    </informalexample>
788
730
    <informalexample>
789
731
      <para>
790
 
        Run in debug mode, and use custom keys:
 
732
        Run in debug mode, and use a custom key:
791
733
      </para>
792
734
      <para>
793
735
 
794
736
<!-- 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>
 
737
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt</userinput>
796
738
 
797
739
      </para>
798
740
    </informalexample>
799
741
    <informalexample>
800
742
      <para>
801
 
        Run in debug mode, with custom keys, and do not use Zeroconf
 
743
        Run in debug mode, with a custom key, and do not use Zeroconf
802
744
        to locate a server; connect directly to the IPv6 link-local
803
745
        address <quote><systemitem class="ipaddress"
804
746
        >fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
807
749
      <para>
808
750
 
809
751
<!-- 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>
 
752
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect fe80::aede:48ff:fe71:f6f2:4711 --interface eth2</userinput>
811
753
 
812
754
      </para>
813
755
    </informalexample>
837
779
    <para>
838
780
      The only remaining weak point is that someone with physical
839
781
      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
 
782
      computer, read the OpenPGP keys directly from the hard drive,
 
783
      and communicate with the server.  To safeguard against this, the
 
784
      server is supposed to notice the client disappearing and stop
 
785
      giving out the encrypted data.  Therefore, it is important to
 
786
      set the timeout and checker interval values tightly on the
 
787
      server.  See <citerefentry><refentrytitle
846
788
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
847
789
    </para>
848
790
    <para>
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>
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
925
          RFC 6091: <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>