/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-16 22:38:54 UTC
  • Revision ID: teddy@recompile.se-20120616223854-mfxkg6fgqr56sma5
* plugins.d/mandos-client (mandos_context): Removed "simple_poll"
                                            member.
  (simple_poll): New global variable.  All users changed.

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-20">
 
5
<!ENTITY TIMESTAMP "2012-06-13">
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
37
      <holder>Teddy Hogeborn</holder>
43
38
      <holder>Björn Påhlsson</holder>
44
39
    </copyright>
101
96
      </arg>
102
97
      <sbr/>
103
98
      <arg>
104
 
        <option>--dh-params <replaceable>FILE</replaceable></option>
105
 
      </arg>
106
 
      <sbr/>
107
 
      <arg>
108
99
        <option>--delay <replaceable>SECONDS</replaceable></option>
109
100
      </arg>
110
101
      <sbr/>
227
218
            assumed to separate the address from the port number.
228
219
          </para>
229
220
          <para>
230
 
            Normally, Zeroconf would be used to locate Mandos servers,
231
 
            in which case this option would only be used when testing
232
 
            and debugging.
 
221
            This option is normally only useful for testing and
 
222
            debugging.
233
223
          </para>
234
224
        </listitem>
235
225
      </varlistentry>
236
226
      
237
227
      <varlistentry>
238
228
        <term><option>--interface=<replaceable
239
 
        >NAME</replaceable><arg rep='repeat'>,<replaceable
240
 
        >NAME</replaceable></arg></option></term>
 
229
        >NAME</replaceable></option></term>
241
230
        <term><option>-i
242
 
        <replaceable>NAME</replaceable><arg rep='repeat'>,<replaceable
243
 
        >NAME</replaceable></arg></option></term>
 
231
        <replaceable>NAME</replaceable></option></term>
244
232
        <listitem>
245
233
          <para>
246
234
            Comma separated list of network interfaces that will be
249
237
            use all appropriate interfaces.
250
238
          </para>
251
239
          <para>
252
 
            If the <option>--connect</option> option is used, and
253
 
            exactly one interface name is specified (except
254
 
            <quote><literal>none</literal></quote>), this specifies
255
 
            the interface to use to connect to the address given.
 
240
            If the <option>--connect</option> option is used, this
 
241
            specifies the interface to use to connect to the address
 
242
            given.
256
243
          </para>
257
244
          <para>
258
245
            Note that since this program will normally run in the
267
254
          </para>
268
255
          <para>
269
256
            <replaceable>NAME</replaceable> can be the string
270
 
            <quote><literal>none</literal></quote>; this will make
271
 
            <command>&COMMANDNAME;</command> only bring up interfaces
272
 
            specified <emphasis>before</emphasis> this string.  This
273
 
            is not recommended, and only meant for advanced users.
 
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.
274
261
          </para>
275
262
        </listitem>
276
263
      </varlistentry>
318
305
        <listitem>
319
306
          <para>
320
307
            Sets the number of bits to use for the prime number in the
321
 
            TLS Diffie-Hellman key exchange.  The default value is
322
 
            selected automatically based on the OpenPGP key.  Note
323
 
            that if the <option>--dh-params</option> option is used,
324
 
            the values from that file will be used instead.
325
 
          </para>
326
 
        </listitem>
327
 
      </varlistentry>
328
 
      
329
 
      <varlistentry>
330
 
        <term><option>--dh-params=<replaceable
331
 
        >FILE</replaceable></option></term>
332
 
        <listitem>
333
 
          <para>
334
 
            Specifies a PEM-encoded PKCS#3 file to read the parameters
335
 
            needed by the TLS Diffie-Hellman key exchange from.  If
336
 
            this option is not given, or if the file for some reason
337
 
            could not be used, the parameters will be generated on
338
 
            startup, which will take some time and processing power.
339
 
            Those using servers running under time, power or processor
340
 
            constraints may want to generate such a file in advance
341
 
            and use this option.
 
308
            TLS Diffie-Hellman key exchange.  Default is 1024.
342
309
          </para>
343
310
        </listitem>
344
311
      </varlistentry>
471
438
  
472
439
  <refsect1 id="environment">
473
440
    <title>ENVIRONMENT</title>
474
 
    <variablelist>
475
 
      <varlistentry>
476
 
        <term><envar>MANDOSPLUGINHELPERDIR</envar></term>
477
 
        <listitem>
478
 
          <para>
479
 
            This environment variable will be assumed to contain the
480
 
            directory containing any helper executables.  The use and
481
 
            nature of these helper executables, if any, is
482
 
            purposefully not documented.
483
 
        </para>
484
 
        </listitem>
485
 
      </varlistentry>
486
 
    </variablelist>
487
441
    <para>
488
 
      This program does not use any other environment variables, not
489
 
      even the ones provided by <citerefentry><refentrytitle
 
442
      This program does not use any environment variables, not even
 
443
      the ones provided by <citerefentry><refentrytitle
490
444
      >cryptsetup</refentrytitle><manvolnum>8</manvolnum>
491
445
    </citerefentry>.
492
446
    </para>
554
508
              It is not necessary to print any non-executable files
555
509
              already in the network hook directory, these will be
556
510
              copied implicitly if they otherwise satisfy the name
557
 
              requirements.
 
511
              requirement.
558
512
            </para>
559
513
          </listitem>
560
514
        </varlistentry>
708
662
    </para>
709
663
    <informalexample>
710
664
      <para>
711
 
        Normal invocation needs no options, if the network interfaces
 
665
        Normal invocation needs no options, if the network interface
712
666
        can be automatically determined:
713
667
      </para>
714
668
      <para>
717
671
    </informalexample>
718
672
    <informalexample>
719
673
      <para>
720
 
        Search for Mandos servers (and connect to them) using one
721
 
        specific interface:
 
674
        Search for Mandos servers (and connect to them) using another
 
675
        interface:
722
676
      </para>
723
677
      <para>
724
678
        <!-- do not wrap this line -->
788
742
    <para>
789
743
      It will also help if the checker program on the server is
790
744
      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.
 
745
      spoofed by someone else on the network, unlike unencrypted
 
746
      <acronym>ICMP</acronym> echo (<quote>ping</quote>) replies.
794
747
    </para>
795
748
    <para>
796
749
      <emphasis>Note</emphasis>: This makes it completely insecure to
889
842
              <para>
890
843
                This client uses IPv6 link-local addresses, which are
891
844
                immediately usable since a link-local addresses is
892
 
                automatically assigned to a network interface when it
 
845
                automatically assigned to a network interfaces when it
893
846
                is brought up.
894
847
              </para>
895
848
            </listitem>