/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: 2015-07-12 01:25:14 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 325.
  • Revision ID: teddy@recompile.se-20150712012514-x4wdgi1hz46h0apg
debian/mandos-client.README.Debian: Document the dhparams.pem file.

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 "2015-07-08">
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>
38
36
      <year>2012</year>
39
37
      <year>2013</year>
40
38
      <year>2014</year>
41
39
      <year>2015</year>
42
 
      <year>2016</year>
43
 
      <year>2017</year>
44
 
      <year>2018</year>
45
 
      <year>2019</year>
46
40
      <holder>Teddy Hogeborn</holder>
47
41
      <holder>Björn Påhlsson</holder>
48
42
    </copyright>
96
90
        <replaceable>FILE</replaceable></option></arg>
97
91
      </group>
98
92
      <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
93
      <arg>
114
94
        <option>--priority <replaceable>STRING</replaceable></option>
115
95
      </arg>
169
149
      brings up network interfaces, uses the interfaces’ IPv6
170
150
      link-local addresses to get network connectivity, uses Zeroconf
171
151
      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
 
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
176
156
      servers are periodically retried.  If no servers are found it
177
157
      will wait indefinitely for new servers to appear.
178
158
    </para>
322
302
      </varlistentry>
323
303
      
324
304
      <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
305
        <term><option>--priority=<replaceable
354
306
        >STRING</replaceable></option></term>
355
307
        <listitem>
365
317
          <para>
366
318
            Sets the number of bits to use for the prime number in the
367
319
            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.
 
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.
372
323
          </para>
373
324
        </listitem>
374
325
      </varlistentry>
525
476
          <para>
526
477
            This environment variable will be assumed to contain the
527
478
            directory containing any helper executables.  The use and
528
 
            nature of these helper executables, if any, is purposely
529
 
            not documented.
 
479
            nature of these helper executables, if any, is
 
480
            purposefully not documented.
530
481
        </para>
531
482
        </listitem>
532
483
      </varlistentry>
726
677
        </listitem>
727
678
      </varlistentry>
728
679
      <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
680
        <term><filename
744
681
        class="directory">/lib/mandos/network-hooks.d</filename></term>
745
682
        <listitem>
753
690
    </variablelist>
754
691
  </refsect1>
755
692
  
756
 
  <refsect1 id="bugs">
757
 
    <title>BUGS</title>
758
 
    <xi:include href="../bugs.xml"/>
759
 
  </refsect1>
 
693
<!--   <refsect1 id="bugs"> -->
 
694
<!--     <title>BUGS</title> -->
 
695
<!--     <para> -->
 
696
<!--     </para> -->
 
697
<!--   </refsect1> -->
760
698
  
761
699
  <refsect1 id="example">
762
700
    <title>EXAMPLE</title>
787
725
    </informalexample>
788
726
    <informalexample>
789
727
      <para>
790
 
        Run in debug mode, and use custom keys:
 
728
        Run in debug mode, and use a custom key:
791
729
      </para>
792
730
      <para>
793
731
 
794
732
<!-- 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>
 
733
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt</userinput>
796
734
 
797
735
      </para>
798
736
    </informalexample>
799
737
    <informalexample>
800
738
      <para>
801
 
        Run in debug mode, with custom keys, and do not use Zeroconf
 
739
        Run in debug mode, with a custom key, and do not use Zeroconf
802
740
        to locate a server; connect directly to the IPv6 link-local
803
741
        address <quote><systemitem class="ipaddress"
804
742
        >fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
807
745
      <para>
808
746
 
809
747
<!-- 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>
 
748
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect fe80::aede:48ff:fe71:f6f2:4711 --interface eth2</userinput>
811
749
 
812
750
      </para>
813
751
    </informalexample>
837
775
    <para>
838
776
      The only remaining weak point is that someone with physical
839
777
      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
 
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
846
784
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
847
785
    </para>
848
786
    <para>
902
840
      </varlistentry>
903
841
      <varlistentry>
904
842
        <term>
905
 
          <ulink url="https://www.gnutls.org/">GnuTLS</ulink>
 
843
          <ulink url="http://www.gnu.org/software/gnutls/"
 
844
          >GnuTLS</ulink>
906
845
        </term>
907
846
      <listitem>
908
847
        <para>
909
848
          GnuTLS is the library this client uses to implement TLS for
910
849
          communicating securely with the server, and at the same time
911
 
          send the public key to the server.
 
850
          send the public OpenPGP key to the server.
912
851
        </para>
913
852
      </listitem>
914
853
      </varlistentry>
915
854
      <varlistentry>
916
855
        <term>
917
 
          <ulink url="https://www.gnupg.org/related_software/gpgme/"
 
856
          <ulink url="http://www.gnupg.org/related_software/gpgme/"
918
857
                 >GPGME</ulink>
919
858
        </term>
920
859
        <listitem>
958
897
      </varlistentry>
959
898
      <varlistentry>
960
899
        <term>
961
 
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
962
 
          Protocol Version 1.2</citetitle>
 
900
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
901
          Protocol Version 1.1</citetitle>
963
902
        </term>
964
903
      <listitem>
965
904
        <para>
966
 
          TLS 1.2 is the protocol implemented by GnuTLS.
 
905
          TLS 1.1 is the protocol implemented by GnuTLS.
967
906
        </para>
968
907
      </listitem>
969
908
      </varlistentry>
980
919
      </varlistentry>
981
920
      <varlistentry>
982
921
        <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
 
922
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
998
923
          Security</citetitle>
999
924
        </term>
1000
925
      <listitem>
1001
926
        <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.
 
927
          This is implemented by GnuTLS and used by this program so
 
928
          that OpenPGP keys can be used.
1005
929
        </para>
1006
930
      </listitem>
1007
931
      </varlistentry>