/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: 2012-06-23 00:58:49 UTC
  • Revision ID: teddy@recompile.se-20120623005849-02wj82cng433rt2k
* clients.conf: Convert all time intervals to new RFC 3339 syntax.
* mandos: All client options for time intervals now take an RFC 3339
          duration.
  (rfc3339_duration_to_delta): New function.
  (string_to_delta): Try rfc3339_duration_to_delta first.
* mandos-clients.conf.xml (OPTIONS/timeout): Document new format.
  (EXAMPLE): Update to new interval format.
  (SEE ALSO): Reference RFC 3339.

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 "2017-02-23">
 
5
<!ENTITY TIMESTAMP "2012-06-17">
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
 
      <year>2013</year>
40
 
      <year>2014</year>
41
 
      <year>2015</year>
42
 
      <year>2016</year>
43
 
      <year>2017</year>
44
37
      <holder>Teddy Hogeborn</holder>
45
38
      <holder>Björn Påhlsson</holder>
46
39
    </copyright>
103
96
      </arg>
104
97
      <sbr/>
105
98
      <arg>
106
 
        <option>--dh-params <replaceable>FILE</replaceable></option>
107
 
      </arg>
108
 
      <sbr/>
109
 
      <arg>
110
99
        <option>--delay <replaceable>SECONDS</replaceable></option>
111
100
      </arg>
112
101
      <sbr/>
229
218
            assumed to separate the address from the port number.
230
219
          </para>
231
220
          <para>
232
 
            Normally, Zeroconf would be used to locate Mandos servers,
233
 
            in which case this option would only be used when testing
234
 
            and debugging.
 
221
            This option is normally only useful for testing and
 
222
            debugging.
235
223
          </para>
236
224
        </listitem>
237
225
      </varlistentry>
270
258
          <para>
271
259
            <replaceable>NAME</replaceable> can be the string
272
260
            <quote><literal>none</literal></quote>; this will make
273
 
            <command>&COMMANDNAME;</command> only bring up interfaces
274
 
            specified <emphasis>before</emphasis> this string.  This
275
 
            is not recommended, and only meant for advanced users.
 
261
            <command>&COMMANDNAME;</command> not bring up
 
262
            <emphasis>any</emphasis> interfaces specified
 
263
            <emphasis>after</emphasis> this string.  This is not
 
264
            recommended, and only meant for advanced users.
276
265
          </para>
277
266
        </listitem>
278
267
      </varlistentry>
320
309
        <listitem>
321
310
          <para>
322
311
            Sets the number of bits to use for the prime number in the
323
 
            TLS Diffie-Hellman key exchange.  The default value is
324
 
            selected automatically based on the OpenPGP key.  Note
325
 
            that if the <option>--dh-params</option> option is used,
326
 
            the values from that file will be used instead.
327
 
          </para>
328
 
        </listitem>
329
 
      </varlistentry>
330
 
      
331
 
      <varlistentry>
332
 
        <term><option>--dh-params=<replaceable
333
 
        >FILE</replaceable></option></term>
334
 
        <listitem>
335
 
          <para>
336
 
            Specifies a PEM-encoded PKCS#3 file to read the parameters
337
 
            needed by the TLS Diffie-Hellman key exchange from.  If
338
 
            this option is not given, or if the file for some reason
339
 
            could not be used, the parameters will be generated on
340
 
            startup, which will take some time and processing power.
341
 
            Those using servers running under time, power or processor
342
 
            constraints may want to generate such a file in advance
343
 
            and use this option.
 
312
            TLS Diffie-Hellman key exchange.  Default is 1024.
344
313
          </para>
345
314
        </listitem>
346
315
      </varlistentry>
473
442
  
474
443
  <refsect1 id="environment">
475
444
    <title>ENVIRONMENT</title>
476
 
    <variablelist>
477
 
      <varlistentry>
478
 
        <term><envar>MANDOSPLUGINHELPERDIR</envar></term>
479
 
        <listitem>
480
 
          <para>
481
 
            This environment variable will be assumed to contain the
482
 
            directory containing any helper executables.  The use and
483
 
            nature of these helper executables, if any, is
484
 
            purposefully not documented.
485
 
        </para>
486
 
        </listitem>
487
 
      </varlistentry>
488
 
    </variablelist>
489
445
    <para>
490
 
      This program does not use any other environment variables, not
491
 
      even the ones provided by <citerefentry><refentrytitle
 
446
      This program does not use any environment variables, not even
 
447
      the ones provided by <citerefentry><refentrytitle
492
448
      >cryptsetup</refentrytitle><manvolnum>8</manvolnum>
493
449
    </citerefentry>.
494
450
    </para>
556
512
              It is not necessary to print any non-executable files
557
513
              already in the network hook directory, these will be
558
514
              copied implicitly if they otherwise satisfy the name
559
 
              requirements.
 
515
              requirement.
560
516
            </para>
561
517
          </listitem>
562
518
        </varlistentry>
694
650
    </variablelist>
695
651
  </refsect1>
696
652
  
697
 
  <refsect1 id="bugs">
698
 
    <title>BUGS</title>
699
 
    <xi:include href="../bugs.xml"/>
700
 
  </refsect1>
 
653
<!--   <refsect1 id="bugs"> -->
 
654
<!--     <title>BUGS</title> -->
 
655
<!--     <para> -->
 
656
<!--     </para> -->
 
657
<!--   </refsect1> -->
701
658
  
702
659
  <refsect1 id="example">
703
660
    <title>EXAMPLE</title>
709
666
    </para>
710
667
    <informalexample>
711
668
      <para>
712
 
        Normal invocation needs no options, if the network interfaces
 
669
        Normal invocation needs no options, if the network interface
713
670
        can be automatically determined:
714
671
      </para>
715
672
      <para>
718
675
    </informalexample>
719
676
    <informalexample>
720
677
      <para>
721
 
        Search for Mandos servers (and connect to them) using one
722
 
        specific interface:
 
678
        Search for Mandos servers (and connect to them) using another
 
679
        interface:
723
680
      </para>
724
681
      <para>
725
682
        <!-- do not wrap this line -->
789
746
    <para>
790
747
      It will also help if the checker program on the server is
791
748
      configured to request something from the client which can not be
792
 
      spoofed by someone else on the network, like SSH server key
793
 
      fingerprints, and unlike unencrypted <acronym>ICMP</acronym>
794
 
      echo (<quote>ping</quote>) replies.
 
749
      spoofed by someone else on the network, unlike unencrypted
 
750
      <acronym>ICMP</acronym> echo (<quote>ping</quote>) replies.
795
751
    </para>
796
752
    <para>
797
753
      <emphasis>Note</emphasis>: This makes it completely insecure to
843
799
      </varlistentry>
844
800
      <varlistentry>
845
801
        <term>
846
 
          <ulink url="https://www.gnutls.org/">GnuTLS</ulink>
 
802
          <ulink url="http://www.gnu.org/software/gnutls/"
 
803
          >GnuTLS</ulink>
847
804
        </term>
848
805
      <listitem>
849
806
        <para>
855
812
      </varlistentry>
856
813
      <varlistentry>
857
814
        <term>
858
 
          <ulink url="https://www.gnupg.org/related_software/gpgme/"
 
815
          <ulink url="http://www.gnupg.org/related_software/gpgme/"
859
816
                 >GPGME</ulink>
860
817
        </term>
861
818
        <listitem>
889
846
              <para>
890
847
                This client uses IPv6 link-local addresses, which are
891
848
                immediately usable since a link-local addresses is
892
 
                automatically assigned to a network interface when it
 
849
                automatically assigned to a network interfaces when it
893
850
                is brought up.
894
851
              </para>
895
852
            </listitem>
899
856
      </varlistentry>
900
857
      <varlistentry>
901
858
        <term>
902
 
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
903
 
          Protocol Version 1.2</citetitle>
 
859
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
860
          Protocol Version 1.1</citetitle>
904
861
        </term>
905
862
      <listitem>
906
863
        <para>
907
 
          TLS 1.2 is the protocol implemented by GnuTLS.
 
864
          TLS 1.1 is the protocol implemented by GnuTLS.
908
865
        </para>
909
866
      </listitem>
910
867
      </varlistentry>
921
878
      </varlistentry>
922
879
      <varlistentry>
923
880
        <term>
924
 
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
 
881
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
925
882
          Security</citetitle>
926
883
        </term>
927
884
      <listitem>