/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: 2019-07-24 06:16:09 UTC
  • Revision ID: teddy@recompile.se-20190724061609-itd0erooii5brhrn
Change URL for Avahi to use HTTPS

* INSTALL (Prerequisites/Libraries): Change URL for Avahi to
                                     "https://www.avahi.org/".
* mandos.xml (SEE ALSO): - '' -
* plugins.d/mandos-client.xml (SEE ALSO): - '' -

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 "2018-02-08">
 
5
<!ENTITY TIMESTAMP "2019-07-24">
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>
45
46
      <holder>Teddy Hogeborn</holder>
46
47
      <holder>Björn Påhlsson</holder>
47
48
    </copyright>
95
96
        <replaceable>FILE</replaceable></option></arg>
96
97
      </group>
97
98
      <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/>
98
113
      <arg>
99
114
        <option>--priority <replaceable>STRING</replaceable></option>
100
115
      </arg>
154
169
      brings up network interfaces, uses the interfaces’ IPv6
155
170
      link-local addresses to get network connectivity, uses Zeroconf
156
171
      to find servers on the local network, and communicates with
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
 
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
161
176
      servers are periodically retried.  If no servers are found it
162
177
      will wait indefinitely for new servers to appear.
163
178
    </para>
307
322
      </varlistentry>
308
323
      
309
324
      <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>
310
353
        <term><option>--priority=<replaceable
311
354
        >STRING</replaceable></option></term>
312
355
        <listitem>
322
365
          <para>
323
366
            Sets the number of bits to use for the prime number in the
324
367
            TLS Diffie-Hellman key exchange.  The default value is
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.
 
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.
328
372
          </para>
329
373
        </listitem>
330
374
      </varlistentry>
481
525
          <para>
482
526
            This environment variable will be assumed to contain the
483
527
            directory containing any helper executables.  The use and
484
 
            nature of these helper executables, if any, is
485
 
            purposefully not documented.
 
528
            nature of these helper executables, if any, is purposely
 
529
            not documented.
486
530
        </para>
487
531
        </listitem>
488
532
      </varlistentry>
682
726
        </listitem>
683
727
      </varlistentry>
684
728
      <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>
685
743
        <term><filename
686
744
        class="directory">/lib/mandos/network-hooks.d</filename></term>
687
745
        <listitem>
729
787
    </informalexample>
730
788
    <informalexample>
731
789
      <para>
732
 
        Run in debug mode, and use a custom key:
 
790
        Run in debug mode, and use custom keys:
733
791
      </para>
734
792
      <para>
735
793
 
736
794
<!-- do not wrap this line -->
737
 
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt</userinput>
 
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>
738
796
 
739
797
      </para>
740
798
    </informalexample>
741
799
    <informalexample>
742
800
      <para>
743
 
        Run in debug mode, with a custom key, and do not use Zeroconf
 
801
        Run in debug mode, with custom keys, and do not use Zeroconf
744
802
        to locate a server; connect directly to the IPv6 link-local
745
803
        address <quote><systemitem class="ipaddress"
746
804
        >fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
749
807
      <para>
750
808
 
751
809
<!-- do not wrap this line -->
752
 
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect fe80::aede:48ff:fe71:f6f2:4711 --interface eth2</userinput>
 
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>
753
811
 
754
812
      </para>
755
813
    </informalexample>
779
837
    <para>
780
838
      The only remaining weak point is that someone with physical
781
839
      access to the client hard drive might turn off the client
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
 
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
788
846
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
789
847
    </para>
790
848
    <para>
833
891
      </varlistentry>
834
892
      <varlistentry>
835
893
        <term>
836
 
          <ulink url="http://www.avahi.org/">Avahi</ulink>
 
894
          <ulink url="https://www.avahi.org/">Avahi</ulink>
837
895
        </term>
838
896
      <listitem>
839
897
        <para>
850
908
        <para>
851
909
          GnuTLS is the library this client uses to implement TLS for
852
910
          communicating securely with the server, and at the same time
853
 
          send the public OpenPGP key to the server.
 
911
          send the public key to the server.
854
912
        </para>
855
913
      </listitem>
856
914
      </varlistentry>
922
980
      </varlistentry>
923
981
      <varlistentry>
924
982
        <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>
925
997
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
926
998
          Security</citetitle>
927
999
        </term>
928
1000
      <listitem>
929
1001
        <para>
930
 
          This is implemented by GnuTLS and used by this program so
931
 
          that OpenPGP keys can be used.
 
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.
932
1005
        </para>
933
1006
      </listitem>
934
1007
      </varlistentry>