/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-25 21:42:40 UTC
  • Revision ID: teddy@recompile.se-20190725214240-31i9qehf60xb8yu4
Use hexadecimal unicode character references, not decimal

* mandos-options.xml (priority): Use "​" instead of "​"
  to make it slightly more clear that ZERO WIDTH SPACE is intended.

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 "2012-06-13">
 
5
<!ENTITY TIMESTAMP "2019-07-24">
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>
36
38
      <year>2012</year>
 
39
      <year>2013</year>
 
40
      <year>2014</year>
 
41
      <year>2015</year>
 
42
      <year>2016</year>
 
43
      <year>2017</year>
 
44
      <year>2018</year>
 
45
      <year>2019</year>
37
46
      <holder>Teddy Hogeborn</holder>
38
47
      <holder>Björn Påhlsson</holder>
39
48
    </copyright>
87
96
        <replaceable>FILE</replaceable></option></arg>
88
97
      </group>
89
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/>
90
113
      <arg>
91
114
        <option>--priority <replaceable>STRING</replaceable></option>
92
115
      </arg>
96
119
      </arg>
97
120
      <sbr/>
98
121
      <arg>
 
122
        <option>--dh-params <replaceable>FILE</replaceable></option>
 
123
      </arg>
 
124
      <sbr/>
 
125
      <arg>
99
126
        <option>--delay <replaceable>SECONDS</replaceable></option>
100
127
      </arg>
101
128
      <sbr/>
142
169
      brings up network interfaces, uses the interfaces’ IPv6
143
170
      link-local addresses to get network connectivity, uses Zeroconf
144
171
      to find servers on the local network, and communicates with
145
 
      servers using TLS with an OpenPGP key to ensure authenticity and
146
 
      confidentiality.  This client program keeps running, trying all
147
 
      servers on the network, until it receives a satisfactory reply
148
 
      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
149
176
      servers are periodically retried.  If no servers are found it
150
177
      will wait indefinitely for new servers to appear.
151
178
    </para>
218
245
            assumed to separate the address from the port number.
219
246
          </para>
220
247
          <para>
221
 
            This option is normally only useful for testing and
222
 
            debugging.
 
248
            Normally, Zeroconf would be used to locate Mandos servers,
 
249
            in which case this option would only be used when testing
 
250
            and debugging.
223
251
          </para>
224
252
        </listitem>
225
253
      </varlistentry>
226
254
      
227
255
      <varlistentry>
228
256
        <term><option>--interface=<replaceable
229
 
        >NAME</replaceable></option></term>
 
257
        >NAME</replaceable><arg rep='repeat'>,<replaceable
 
258
        >NAME</replaceable></arg></option></term>
230
259
        <term><option>-i
231
 
        <replaceable>NAME</replaceable></option></term>
 
260
        <replaceable>NAME</replaceable><arg rep='repeat'>,<replaceable
 
261
        >NAME</replaceable></arg></option></term>
232
262
        <listitem>
233
263
          <para>
234
264
            Comma separated list of network interfaces that will be
237
267
            use all appropriate interfaces.
238
268
          </para>
239
269
          <para>
240
 
            If the <option>--connect</option> option is used, this
241
 
            specifies the interface to use to connect to the address
242
 
            given.
 
270
            If the <option>--connect</option> option is used, and
 
271
            exactly one interface name is specified (except
 
272
            <quote><literal>none</literal></quote>), this specifies
 
273
            the interface to use to connect to the address given.
243
274
          </para>
244
275
          <para>
245
276
            Note that since this program will normally run in the
254
285
          </para>
255
286
          <para>
256
287
            <replaceable>NAME</replaceable> can be the string
257
 
            <quote><literal>none</literal></quote>; this will not use
258
 
            any specific interface, and will not bring up an interface
259
 
            on startup.  This is not recommended, and only meant for
260
 
            advanced users.
 
288
            <quote><literal>none</literal></quote>; this will make
 
289
            <command>&COMMANDNAME;</command> only bring up interfaces
 
290
            specified <emphasis>before</emphasis> this string.  This
 
291
            is not recommended, and only meant for advanced users.
261
292
          </para>
262
293
        </listitem>
263
294
      </varlistentry>
291
322
      </varlistentry>
292
323
      
293
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>
294
353
        <term><option>--priority=<replaceable
295
354
        >STRING</replaceable></option></term>
296
355
        <listitem>
305
364
        <listitem>
306
365
          <para>
307
366
            Sets the number of bits to use for the prime number in the
308
 
            TLS Diffie-Hellman key exchange.  Default is 1024.
 
367
            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.
 
372
          </para>
 
373
        </listitem>
 
374
      </varlistentry>
 
375
      
 
376
      <varlistentry>
 
377
        <term><option>--dh-params=<replaceable
 
378
        >FILE</replaceable></option></term>
 
379
        <listitem>
 
380
          <para>
 
381
            Specifies a PEM-encoded PKCS#3 file to read the parameters
 
382
            needed by the TLS Diffie-Hellman key exchange from.  If
 
383
            this option is not given, or if the file for some reason
 
384
            could not be used, the parameters will be generated on
 
385
            startup, which will take some time and processing power.
 
386
            Those using servers running under time, power or processor
 
387
            constraints may want to generate such a file in advance
 
388
            and use this option.
309
389
          </para>
310
390
        </listitem>
311
391
      </varlistentry>
438
518
  
439
519
  <refsect1 id="environment">
440
520
    <title>ENVIRONMENT</title>
 
521
    <variablelist>
 
522
      <varlistentry>
 
523
        <term><envar>MANDOSPLUGINHELPERDIR</envar></term>
 
524
        <listitem>
 
525
          <para>
 
526
            This environment variable will be assumed to contain the
 
527
            directory containing any helper executables.  The use and
 
528
            nature of these helper executables, if any, is purposely
 
529
            not documented.
 
530
        </para>
 
531
        </listitem>
 
532
      </varlistentry>
 
533
    </variablelist>
441
534
    <para>
442
 
      This program does not use any environment variables, not even
443
 
      the ones provided by <citerefentry><refentrytitle
 
535
      This program does not use any other environment variables, not
 
536
      even the ones provided by <citerefentry><refentrytitle
444
537
      >cryptsetup</refentrytitle><manvolnum>8</manvolnum>
445
538
    </citerefentry>.
446
539
    </para>
508
601
              It is not necessary to print any non-executable files
509
602
              already in the network hook directory, these will be
510
603
              copied implicitly if they otherwise satisfy the name
511
 
              requirement.
 
604
              requirements.
512
605
            </para>
513
606
          </listitem>
514
607
        </varlistentry>
633
726
        </listitem>
634
727
      </varlistentry>
635
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>
636
743
        <term><filename
637
744
        class="directory">/lib/mandos/network-hooks.d</filename></term>
638
745
        <listitem>
646
753
    </variablelist>
647
754
  </refsect1>
648
755
  
649
 
<!--   <refsect1 id="bugs"> -->
650
 
<!--     <title>BUGS</title> -->
651
 
<!--     <para> -->
652
 
<!--     </para> -->
653
 
<!--   </refsect1> -->
 
756
  <refsect1 id="bugs">
 
757
    <title>BUGS</title>
 
758
    <xi:include href="../bugs.xml"/>
 
759
  </refsect1>
654
760
  
655
761
  <refsect1 id="example">
656
762
    <title>EXAMPLE</title>
662
768
    </para>
663
769
    <informalexample>
664
770
      <para>
665
 
        Normal invocation needs no options, if the network interface
 
771
        Normal invocation needs no options, if the network interfaces
666
772
        can be automatically determined:
667
773
      </para>
668
774
      <para>
671
777
    </informalexample>
672
778
    <informalexample>
673
779
      <para>
674
 
        Search for Mandos servers (and connect to them) using another
675
 
        interface:
 
780
        Search for Mandos servers (and connect to them) using one
 
781
        specific interface:
676
782
      </para>
677
783
      <para>
678
784
        <!-- do not wrap this line -->
681
787
    </informalexample>
682
788
    <informalexample>
683
789
      <para>
684
 
        Run in debug mode, and use a custom key:
 
790
        Run in debug mode, and use custom keys:
685
791
      </para>
686
792
      <para>
687
793
 
688
794
<!-- do not wrap this line -->
689
 
<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>
690
796
 
691
797
      </para>
692
798
    </informalexample>
693
799
    <informalexample>
694
800
      <para>
695
 
        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
696
802
        to locate a server; connect directly to the IPv6 link-local
697
803
        address <quote><systemitem class="ipaddress"
698
804
        >fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
701
807
      <para>
702
808
 
703
809
<!-- do not wrap this line -->
704
 
<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>
705
811
 
706
812
      </para>
707
813
    </informalexample>
731
837
    <para>
732
838
      The only remaining weak point is that someone with physical
733
839
      access to the client hard drive might turn off the client
734
 
      computer, read the OpenPGP keys directly from the hard drive,
735
 
      and communicate with the server.  To safeguard against this, the
736
 
      server is supposed to notice the client disappearing and stop
737
 
      giving out the encrypted data.  Therefore, it is important to
738
 
      set the timeout and checker interval values tightly on the
739
 
      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
740
846
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
741
847
    </para>
742
848
    <para>
743
849
      It will also help if the checker program on the server is
744
850
      configured to request something from the client which can not be
745
 
      spoofed by someone else on the network, unlike unencrypted
746
 
      <acronym>ICMP</acronym> echo (<quote>ping</quote>) replies.
 
851
      spoofed by someone else on the network, like SSH server key
 
852
      fingerprints, and unlike unencrypted <acronym>ICMP</acronym>
 
853
      echo (<quote>ping</quote>) replies.
747
854
    </para>
748
855
    <para>
749
856
      <emphasis>Note</emphasis>: This makes it completely insecure to
784
891
      </varlistentry>
785
892
      <varlistentry>
786
893
        <term>
787
 
          <ulink url="http://www.avahi.org/">Avahi</ulink>
 
894
          <ulink url="https://www.avahi.org/">Avahi</ulink>
788
895
        </term>
789
896
      <listitem>
790
897
        <para>
795
902
      </varlistentry>
796
903
      <varlistentry>
797
904
        <term>
798
 
          <ulink url="http://www.gnu.org/software/gnutls/"
799
 
          >GnuTLS</ulink>
 
905
          <ulink url="https://www.gnutls.org/">GnuTLS</ulink>
800
906
        </term>
801
907
      <listitem>
802
908
        <para>
803
909
          GnuTLS is the library this client uses to implement TLS for
804
910
          communicating securely with the server, and at the same time
805
 
          send the public OpenPGP key to the server.
 
911
          send the public key to the server.
806
912
        </para>
807
913
      </listitem>
808
914
      </varlistentry>
809
915
      <varlistentry>
810
916
        <term>
811
 
          <ulink url="http://www.gnupg.org/related_software/gpgme/"
 
917
          <ulink url="https://www.gnupg.org/related_software/gpgme/"
812
918
                 >GPGME</ulink>
813
919
        </term>
814
920
        <listitem>
842
948
              <para>
843
949
                This client uses IPv6 link-local addresses, which are
844
950
                immediately usable since a link-local addresses is
845
 
                automatically assigned to a network interfaces when it
 
951
                automatically assigned to a network interface when it
846
952
                is brought up.
847
953
              </para>
848
954
            </listitem>
852
958
      </varlistentry>
853
959
      <varlistentry>
854
960
        <term>
855
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
856
 
          Protocol Version 1.1</citetitle>
 
961
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
 
962
          Protocol Version 1.2</citetitle>
857
963
        </term>
858
964
      <listitem>
859
965
        <para>
860
 
          TLS 1.1 is the protocol implemented by GnuTLS.
 
966
          TLS 1.2 is the protocol implemented by GnuTLS.
861
967
        </para>
862
968
      </listitem>
863
969
      </varlistentry>
874
980
      </varlistentry>
875
981
      <varlistentry>
876
982
        <term>
877
 
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
 
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
878
998
          Security</citetitle>
879
999
        </term>
880
1000
      <listitem>
881
1001
        <para>
882
 
          This is implemented by GnuTLS and used by this program so
883
 
          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.
884
1005
        </para>
885
1006
      </listitem>
886
1007
      </varlistentry>