/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: 2015-07-12 02:08:25 UTC
  • Revision ID: teddy@recompile.se-20150712020825-ng26jprj9m8crbo8
Don't use absolute paths to commands in Debian configurations scripts.

* debian/mandos-client.postinst: Don't use absolute paths to commands.
* debian/mandos-client.postrm: - '' -

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-09">
 
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
40
      <holder>Teddy Hogeborn</holder>
46
41
      <holder>Björn Påhlsson</holder>
47
42
    </copyright>
95
90
        <replaceable>FILE</replaceable></option></arg>
96
91
      </group>
97
92
      <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/>
112
93
      <arg>
113
94
        <option>--priority <replaceable>STRING</replaceable></option>
114
95
      </arg>
168
149
      brings up network interfaces, uses the interfaces’ IPv6
169
150
      link-local addresses to get network connectivity, uses Zeroconf
170
151
      to find servers on the local network, and communicates with
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
 
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
175
156
      servers are periodically retried.  If no servers are found it
176
157
      will wait indefinitely for new servers to appear.
177
158
    </para>
321
302
      </varlistentry>
322
303
      
323
304
      <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>
352
305
        <term><option>--priority=<replaceable
353
306
        >STRING</replaceable></option></term>
354
307
        <listitem>
364
317
          <para>
365
318
            Sets the number of bits to use for the prime number in the
366
319
            TLS Diffie-Hellman key exchange.  The default value is
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.
 
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.
371
323
          </para>
372
324
        </listitem>
373
325
      </varlistentry>
725
677
        </listitem>
726
678
      </varlistentry>
727
679
      <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>
742
680
        <term><filename
743
681
        class="directory">/lib/mandos/network-hooks.d</filename></term>
744
682
        <listitem>
752
690
    </variablelist>
753
691
  </refsect1>
754
692
  
755
 
  <refsect1 id="bugs">
756
 
    <title>BUGS</title>
757
 
    <xi:include href="../bugs.xml"/>
758
 
  </refsect1>
 
693
<!--   <refsect1 id="bugs"> -->
 
694
<!--     <title>BUGS</title> -->
 
695
<!--     <para> -->
 
696
<!--     </para> -->
 
697
<!--   </refsect1> -->
759
698
  
760
699
  <refsect1 id="example">
761
700
    <title>EXAMPLE</title>
786
725
    </informalexample>
787
726
    <informalexample>
788
727
      <para>
789
 
        Run in debug mode, and use custom keys:
 
728
        Run in debug mode, and use a custom key:
790
729
      </para>
791
730
      <para>
792
731
 
793
732
<!-- do not wrap this line -->
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>
 
733
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt</userinput>
795
734
 
796
735
      </para>
797
736
    </informalexample>
798
737
    <informalexample>
799
738
      <para>
800
 
        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
801
740
        to locate a server; connect directly to the IPv6 link-local
802
741
        address <quote><systemitem class="ipaddress"
803
742
        >fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
806
745
      <para>
807
746
 
808
747
<!-- do not wrap this line -->
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>
 
748
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect fe80::aede:48ff:fe71:f6f2:4711 --interface eth2</userinput>
810
749
 
811
750
      </para>
812
751
    </informalexample>
836
775
    <para>
837
776
      The only remaining weak point is that someone with physical
838
777
      access to the client hard drive might turn off the client
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
 
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
845
784
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
846
785
    </para>
847
786
    <para>
901
840
      </varlistentry>
902
841
      <varlistentry>
903
842
        <term>
904
 
          <ulink url="https://www.gnutls.org/">GnuTLS</ulink>
 
843
          <ulink url="http://www.gnu.org/software/gnutls/"
 
844
          >GnuTLS</ulink>
905
845
        </term>
906
846
      <listitem>
907
847
        <para>
908
848
          GnuTLS is the library this client uses to implement TLS for
909
849
          communicating securely with the server, and at the same time
910
 
          send the public key to the server.
 
850
          send the public OpenPGP key to the server.
911
851
        </para>
912
852
      </listitem>
913
853
      </varlistentry>
914
854
      <varlistentry>
915
855
        <term>
916
 
          <ulink url="https://www.gnupg.org/related_software/gpgme/"
 
856
          <ulink url="http://www.gnupg.org/related_software/gpgme/"
917
857
                 >GPGME</ulink>
918
858
        </term>
919
859
        <listitem>
957
897
      </varlistentry>
958
898
      <varlistentry>
959
899
        <term>
960
 
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
961
 
          Protocol Version 1.2</citetitle>
 
900
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
901
          Protocol Version 1.1</citetitle>
962
902
        </term>
963
903
      <listitem>
964
904
        <para>
965
 
          TLS 1.2 is the protocol implemented by GnuTLS.
 
905
          TLS 1.1 is the protocol implemented by GnuTLS.
966
906
        </para>
967
907
      </listitem>
968
908
      </varlistentry>
979
919
      </varlistentry>
980
920
      <varlistentry>
981
921
        <term>
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
 
922
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
997
923
          Security</citetitle>
998
924
        </term>
999
925
      <listitem>
1000
926
        <para>
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.
 
927
          This is implemented by GnuTLS and used by this program so
 
928
          that OpenPGP keys can be used.
1004
929
        </para>
1005
930
      </listitem>
1006
931
      </varlistentry>