/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: 2016-03-17 21:18:37 UTC
  • Revision ID: teddy@recompile.se-20160317211837-f2tz0c9284rsv3k8
Client: Document default directories more clearly

Document default plugin directory and default plugin helper directory
also in the FILES section of the manual.

* plugin-runner.xml (FILES): Add "/lib/mandos/plugins.d" and
                             "/lib/mandos/plugin-helpers".

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 "2016-03-05">
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
43
      <holder>Teddy Hogeborn</holder>
46
44
      <holder>Björn Påhlsson</holder>
47
45
    </copyright>
95
93
        <replaceable>FILE</replaceable></option></arg>
96
94
      </group>
97
95
      <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
96
      <arg>
113
97
        <option>--priority <replaceable>STRING</replaceable></option>
114
98
      </arg>
168
152
      brings up network interfaces, uses the interfaces’ IPv6
169
153
      link-local addresses to get network connectivity, uses Zeroconf
170
154
      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
 
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
175
159
      servers are periodically retried.  If no servers are found it
176
160
      will wait indefinitely for new servers to appear.
177
161
    </para>
321
305
      </varlistentry>
322
306
      
323
307
      <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
308
        <term><option>--priority=<replaceable
353
309
        >STRING</replaceable></option></term>
354
310
        <listitem>
364
320
          <para>
365
321
            Sets the number of bits to use for the prime number in the
366
322
            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.
 
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.
371
326
          </para>
372
327
        </listitem>
373
328
      </varlistentry>
725
680
        </listitem>
726
681
      </varlistentry>
727
682
      <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
683
        <term><filename
743
684
        class="directory">/lib/mandos/network-hooks.d</filename></term>
744
685
        <listitem>
786
727
    </informalexample>
787
728
    <informalexample>
788
729
      <para>
789
 
        Run in debug mode, and use custom keys:
 
730
        Run in debug mode, and use a custom key:
790
731
      </para>
791
732
      <para>
792
733
 
793
734
<!-- 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>
 
735
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt</userinput>
795
736
 
796
737
      </para>
797
738
    </informalexample>
798
739
    <informalexample>
799
740
      <para>
800
 
        Run in debug mode, with custom keys, and do not use Zeroconf
 
741
        Run in debug mode, with a custom key, and do not use Zeroconf
801
742
        to locate a server; connect directly to the IPv6 link-local
802
743
        address <quote><systemitem class="ipaddress"
803
744
        >fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
806
747
      <para>
807
748
 
808
749
<!-- 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>
 
750
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect fe80::aede:48ff:fe71:f6f2:4711 --interface eth2</userinput>
810
751
 
811
752
      </para>
812
753
    </informalexample>
836
777
    <para>
837
778
      The only remaining weak point is that someone with physical
838
779
      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
 
780
      computer, read the OpenPGP keys directly from the hard drive,
 
781
      and communicate with the server.  To safeguard against this, the
 
782
      server is supposed to notice the client disappearing and stop
 
783
      giving out the encrypted data.  Therefore, it is important to
 
784
      set the timeout and checker interval values tightly on the
 
785
      server.  See <citerefentry><refentrytitle
845
786
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
846
787
    </para>
847
788
    <para>
901
842
      </varlistentry>
902
843
      <varlistentry>
903
844
        <term>
904
 
          <ulink url="https://www.gnutls.org/">GnuTLS</ulink>
 
845
          <ulink url="http://www.gnu.org/software/gnutls/"
 
846
          >GnuTLS</ulink>
905
847
        </term>
906
848
      <listitem>
907
849
        <para>
908
850
          GnuTLS is the library this client uses to implement TLS for
909
851
          communicating securely with the server, and at the same time
910
 
          send the public key to the server.
 
852
          send the public OpenPGP key to the server.
911
853
        </para>
912
854
      </listitem>
913
855
      </varlistentry>
914
856
      <varlistentry>
915
857
        <term>
916
 
          <ulink url="https://www.gnupg.org/related_software/gpgme/"
 
858
          <ulink url="http://www.gnupg.org/related_software/gpgme/"
917
859
                 >GPGME</ulink>
918
860
        </term>
919
861
        <listitem>
957
899
      </varlistentry>
958
900
      <varlistentry>
959
901
        <term>
960
 
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
961
 
          Protocol Version 1.2</citetitle>
 
902
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
903
          Protocol Version 1.1</citetitle>
962
904
        </term>
963
905
      <listitem>
964
906
        <para>
965
 
          TLS 1.2 is the protocol implemented by GnuTLS.
 
907
          TLS 1.1 is the protocol implemented by GnuTLS.
966
908
        </para>
967
909
      </listitem>
968
910
      </varlistentry>
979
921
      </varlistentry>
980
922
      <varlistentry>
981
923
        <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
 
924
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
997
925
          Security</citetitle>
998
926
        </term>
999
927
      <listitem>
1000
928
        <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.
 
929
          This is implemented by GnuTLS and used by this program so
 
930
          that OpenPGP keys can be used.
1004
931
        </para>
1005
932
      </listitem>
1006
933
      </varlistentry>