/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 "2016-03-05">
 
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
37
      <holder>Teddy Hogeborn</holder>
44
38
      <holder>Björn Påhlsson</holder>
45
39
    </copyright>
102
96
      </arg>
103
97
      <sbr/>
104
98
      <arg>
105
 
        <option>--dh-params <replaceable>FILE</replaceable></option>
106
 
      </arg>
107
 
      <sbr/>
108
 
      <arg>
109
99
        <option>--delay <replaceable>SECONDS</replaceable></option>
110
100
      </arg>
111
101
      <sbr/>
228
218
            assumed to separate the address from the port number.
229
219
          </para>
230
220
          <para>
231
 
            Normally, Zeroconf would be used to locate Mandos servers,
232
 
            in which case this option would only be used when testing
233
 
            and debugging.
 
221
            This option is normally only useful for testing and
 
222
            debugging.
234
223
          </para>
235
224
        </listitem>
236
225
      </varlistentry>
269
258
          <para>
270
259
            <replaceable>NAME</replaceable> can be the string
271
260
            <quote><literal>none</literal></quote>; this will make
272
 
            <command>&COMMANDNAME;</command> only bring up interfaces
273
 
            specified <emphasis>before</emphasis> this string.  This
274
 
            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.
275
265
          </para>
276
266
        </listitem>
277
267
      </varlistentry>
319
309
        <listitem>
320
310
          <para>
321
311
            Sets the number of bits to use for the prime number in the
322
 
            TLS Diffie-Hellman key exchange.  The default value is
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.
326
 
          </para>
327
 
        </listitem>
328
 
      </varlistentry>
329
 
      
330
 
      <varlistentry>
331
 
        <term><option>--dh-params=<replaceable
332
 
        >FILE</replaceable></option></term>
333
 
        <listitem>
334
 
          <para>
335
 
            Specifies a PEM-encoded PKCS#3 file to read the parameters
336
 
            needed by the TLS Diffie-Hellman key exchange from.  If
337
 
            this option is not given, or if the file for some reason
338
 
            could not be used, the parameters will be generated on
339
 
            startup, which will take some time and processing power.
340
 
            Those using servers running under time, power or processor
341
 
            constraints may want to generate such a file in advance
342
 
            and use this option.
 
312
            TLS Diffie-Hellman key exchange.  Default is 1024.
343
313
          </para>
344
314
        </listitem>
345
315
      </varlistentry>
472
442
  
473
443
  <refsect1 id="environment">
474
444
    <title>ENVIRONMENT</title>
475
 
    <variablelist>
476
 
      <varlistentry>
477
 
        <term><envar>MANDOSPLUGINHELPERDIR</envar></term>
478
 
        <listitem>
479
 
          <para>
480
 
            This environment variable will be assumed to contain the
481
 
            directory containing any helper executables.  The use and
482
 
            nature of these helper executables, if any, is
483
 
            purposefully not documented.
484
 
        </para>
485
 
        </listitem>
486
 
      </varlistentry>
487
 
    </variablelist>
488
445
    <para>
489
 
      This program does not use any other environment variables, not
490
 
      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
491
448
      >cryptsetup</refentrytitle><manvolnum>8</manvolnum>
492
449
    </citerefentry>.
493
450
    </para>
555
512
              It is not necessary to print any non-executable files
556
513
              already in the network hook directory, these will be
557
514
              copied implicitly if they otherwise satisfy the name
558
 
              requirements.
 
515
              requirement.
559
516
            </para>
560
517
          </listitem>
561
518
        </varlistentry>
693
650
    </variablelist>
694
651
  </refsect1>
695
652
  
696
 
  <refsect1 id="bugs">
697
 
    <title>BUGS</title>
698
 
    <xi:include href="../bugs.xml"/>
699
 
  </refsect1>
 
653
<!--   <refsect1 id="bugs"> -->
 
654
<!--     <title>BUGS</title> -->
 
655
<!--     <para> -->
 
656
<!--     </para> -->
 
657
<!--   </refsect1> -->
700
658
  
701
659
  <refsect1 id="example">
702
660
    <title>EXAMPLE</title>
708
666
    </para>
709
667
    <informalexample>
710
668
      <para>
711
 
        Normal invocation needs no options, if the network interfaces
 
669
        Normal invocation needs no options, if the network interface
712
670
        can be automatically determined:
713
671
      </para>
714
672
      <para>
717
675
    </informalexample>
718
676
    <informalexample>
719
677
      <para>
720
 
        Search for Mandos servers (and connect to them) using one
721
 
        specific interface:
 
678
        Search for Mandos servers (and connect to them) using another
 
679
        interface:
722
680
      </para>
723
681
      <para>
724
682
        <!-- do not wrap this line -->
788
746
    <para>
789
747
      It will also help if the checker program on the server is
790
748
      configured to request something from the client which can not be
791
 
      spoofed by someone else on the network, like SSH server key
792
 
      fingerprints, and unlike unencrypted <acronym>ICMP</acronym>
793
 
      echo (<quote>ping</quote>) replies.
 
749
      spoofed by someone else on the network, unlike unencrypted
 
750
      <acronym>ICMP</acronym> echo (<quote>ping</quote>) replies.
794
751
    </para>
795
752
    <para>
796
753
      <emphasis>Note</emphasis>: This makes it completely insecure to
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>