/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to plugins.d/mandos-client.xml

  • Committer: Teddy Hogeborn
  • Date: 2012-06-17 12:23:31 UTC
  • mto: (301.1.1 release) (237.7.272 trunk)
  • mto: This revision was merged to the branch mainline in revision 302.
  • Revision ID: teddy@recompile.se-20120617122331-2drpu9t1jnmxzdhs
* plugins.d/mandos-client.c: Comment changes

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 "2015-07-08">
 
5
<!ENTITY TIMESTAMP "2012-06-17">
6
6
<!ENTITY % common SYSTEM "../common.ent">
7
7
%common;
8
8
]>
34
34
      <year>2008</year>
35
35
      <year>2009</year>
36
36
      <year>2012</year>
37
 
      <year>2013</year>
38
 
      <year>2014</year>
39
 
      <year>2015</year>
40
37
      <holder>Teddy Hogeborn</holder>
41
38
      <holder>Björn Påhlsson</holder>
42
39
    </copyright>
99
96
      </arg>
100
97
      <sbr/>
101
98
      <arg>
102
 
        <option>--dh-params <replaceable>FILE</replaceable></option>
103
 
      </arg>
104
 
      <sbr/>
105
 
      <arg>
106
99
        <option>--delay <replaceable>SECONDS</replaceable></option>
107
100
      </arg>
108
101
      <sbr/>
225
218
            assumed to separate the address from the port number.
226
219
          </para>
227
220
          <para>
228
 
            Normally, Zeroconf would be used to locate Mandos servers,
229
 
            in which case this option would only be used when testing
230
 
            and debugging.
 
221
            This option is normally only useful for testing and
 
222
            debugging.
231
223
          </para>
232
224
        </listitem>
233
225
      </varlistentry>
266
258
          <para>
267
259
            <replaceable>NAME</replaceable> can be the string
268
260
            <quote><literal>none</literal></quote>; this will make
269
 
            <command>&COMMANDNAME;</command> only bring up interfaces
270
 
            specified <emphasis>before</emphasis> this string.  This
271
 
            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.
272
265
          </para>
273
266
        </listitem>
274
267
      </varlistentry>
316
309
        <listitem>
317
310
          <para>
318
311
            Sets the number of bits to use for the prime number in the
319
 
            TLS Diffie-Hellman key exchange.  The default value is
320
 
            selected automatically based on the OpenPGP key.  Note
321
 
            that if the <option>--dh-params</option> option is used,
322
 
            the values from that file will be used instead.
323
 
          </para>
324
 
        </listitem>
325
 
      </varlistentry>
326
 
      
327
 
      <varlistentry>
328
 
        <term><option>--dh-params=<replaceable
329
 
        >FILE</replaceable></option></term>
330
 
        <listitem>
331
 
          <para>
332
 
            Specifies a PEM-encoded PKCS#3 file to read the parameters
333
 
            needed by the TLS Diffie-Hellman key exchange from.  If
334
 
            this option is not given, or if the file for some reason
335
 
            could not be used, the parameters will be generated on
336
 
            startup, which will take some time and processing power.
337
 
            Those using servers running under time, power or processor
338
 
            constraints may want to generate such a file in advance
339
 
            and use this option.
 
312
            TLS Diffie-Hellman key exchange.  Default is 1024.
340
313
          </para>
341
314
        </listitem>
342
315
      </varlistentry>
469
442
  
470
443
  <refsect1 id="environment">
471
444
    <title>ENVIRONMENT</title>
472
 
    <variablelist>
473
 
      <varlistentry>
474
 
        <term><envar>MANDOSPLUGINHELPERDIR</envar></term>
475
 
        <listitem>
476
 
          <para>
477
 
            This environment variable will be assumed to contain the
478
 
            directory containing any helper executables.  The use and
479
 
            nature of these helper executables, if any, is
480
 
            purposefully not documented.
481
 
        </para>
482
 
        </listitem>
483
 
      </varlistentry>
484
 
    </variablelist>
485
445
    <para>
486
 
      This program does not use any other environment variables, not
487
 
      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
488
448
      >cryptsetup</refentrytitle><manvolnum>8</manvolnum>
489
449
    </citerefentry>.
490
450
    </para>
552
512
              It is not necessary to print any non-executable files
553
513
              already in the network hook directory, these will be
554
514
              copied implicitly if they otherwise satisfy the name
555
 
              requirements.
 
515
              requirement.
556
516
            </para>
557
517
          </listitem>
558
518
        </varlistentry>
706
666
    </para>
707
667
    <informalexample>
708
668
      <para>
709
 
        Normal invocation needs no options, if the network interfaces
 
669
        Normal invocation needs no options, if the network interface
710
670
        can be automatically determined:
711
671
      </para>
712
672
      <para>
715
675
    </informalexample>
716
676
    <informalexample>
717
677
      <para>
718
 
        Search for Mandos servers (and connect to them) using one
719
 
        specific interface:
 
678
        Search for Mandos servers (and connect to them) using another
 
679
        interface:
720
680
      </para>
721
681
      <para>
722
682
        <!-- do not wrap this line -->
786
746
    <para>
787
747
      It will also help if the checker program on the server is
788
748
      configured to request something from the client which can not be
789
 
      spoofed by someone else on the network, like SSH server key
790
 
      fingerprints, and unlike unencrypted <acronym>ICMP</acronym>
791
 
      echo (<quote>ping</quote>) replies.
 
749
      spoofed by someone else on the network, unlike unencrypted
 
750
      <acronym>ICMP</acronym> echo (<quote>ping</quote>) replies.
792
751
    </para>
793
752
    <para>
794
753
      <emphasis>Note</emphasis>: This makes it completely insecure to
887
846
              <para>
888
847
                This client uses IPv6 link-local addresses, which are
889
848
                immediately usable since a link-local addresses is
890
 
                automatically assigned to a network interface when it
 
849
                automatically assigned to a network interfaces when it
891
850
                is brought up.
892
851
              </para>
893
852
            </listitem>