/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: 2016-03-13 22:46:30 UTC
  • mfrom: (237.4.71 release)
  • Revision ID: teddy@recompile.se-20160313224630-nz8ng3zl82elmk1h
Merge from release branch

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-17">
 
5
<!ENTITY TIMESTAMP "2016-03-05">
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>
37
43
      <holder>Teddy Hogeborn</holder>
38
44
      <holder>Björn Påhlsson</holder>
39
45
    </copyright>
96
102
      </arg>
97
103
      <sbr/>
98
104
      <arg>
 
105
        <option>--dh-params <replaceable>FILE</replaceable></option>
 
106
      </arg>
 
107
      <sbr/>
 
108
      <arg>
99
109
        <option>--delay <replaceable>SECONDS</replaceable></option>
100
110
      </arg>
101
111
      <sbr/>
218
228
            assumed to separate the address from the port number.
219
229
          </para>
220
230
          <para>
221
 
            This option is normally only useful for testing and
222
 
            debugging.
 
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.
223
234
          </para>
224
235
        </listitem>
225
236
      </varlistentry>
258
269
          <para>
259
270
            <replaceable>NAME</replaceable> can be the string
260
271
            <quote><literal>none</literal></quote>; this will make
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
            <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.
265
275
          </para>
266
276
        </listitem>
267
277
      </varlistentry>
309
319
        <listitem>
310
320
          <para>
311
321
            Sets the number of bits to use for the prime number in the
312
 
            TLS Diffie-Hellman key exchange.  Default is 1024.
 
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.
313
343
          </para>
314
344
        </listitem>
315
345
      </varlistentry>
442
472
  
443
473
  <refsect1 id="environment">
444
474
    <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>
445
488
    <para>
446
 
      This program does not use any environment variables, not even
447
 
      the ones provided by <citerefentry><refentrytitle
 
489
      This program does not use any other environment variables, not
 
490
      even the ones provided by <citerefentry><refentrytitle
448
491
      >cryptsetup</refentrytitle><manvolnum>8</manvolnum>
449
492
    </citerefentry>.
450
493
    </para>
512
555
              It is not necessary to print any non-executable files
513
556
              already in the network hook directory, these will be
514
557
              copied implicitly if they otherwise satisfy the name
515
 
              requirement.
 
558
              requirements.
516
559
            </para>
517
560
          </listitem>
518
561
        </varlistentry>
650
693
    </variablelist>
651
694
  </refsect1>
652
695
  
653
 
<!--   <refsect1 id="bugs"> -->
654
 
<!--     <title>BUGS</title> -->
655
 
<!--     <para> -->
656
 
<!--     </para> -->
657
 
<!--   </refsect1> -->
 
696
  <refsect1 id="bugs">
 
697
    <title>BUGS</title>
 
698
    <xi:include href="../bugs.xml"/>
 
699
  </refsect1>
658
700
  
659
701
  <refsect1 id="example">
660
702
    <title>EXAMPLE</title>
666
708
    </para>
667
709
    <informalexample>
668
710
      <para>
669
 
        Normal invocation needs no options, if the network interface
 
711
        Normal invocation needs no options, if the network interfaces
670
712
        can be automatically determined:
671
713
      </para>
672
714
      <para>
675
717
    </informalexample>
676
718
    <informalexample>
677
719
      <para>
678
 
        Search for Mandos servers (and connect to them) using another
679
 
        interface:
 
720
        Search for Mandos servers (and connect to them) using one
 
721
        specific interface:
680
722
      </para>
681
723
      <para>
682
724
        <!-- do not wrap this line -->
746
788
    <para>
747
789
      It will also help if the checker program on the server is
748
790
      configured to request something from the client which can not be
749
 
      spoofed by someone else on the network, unlike unencrypted
750
 
      <acronym>ICMP</acronym> echo (<quote>ping</quote>) replies.
 
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.
751
794
    </para>
752
795
    <para>
753
796
      <emphasis>Note</emphasis>: This makes it completely insecure to
846
889
              <para>
847
890
                This client uses IPv6 link-local addresses, which are
848
891
                immediately usable since a link-local addresses is
849
 
                automatically assigned to a network interfaces when it
 
892
                automatically assigned to a network interface when it
850
893
                is brought up.
851
894
              </para>
852
895
            </listitem>