/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-14 21:42:44 UTC
  • Revision ID: teddy@recompile.se-20120614214244-meh2hr7pg0p0fek2
* plugins.d/mandos-client.c: Only print message about nonexisting
                             network hook directory in debug mode.

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-07-10">
 
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
 
      <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>
237
226
      
238
227
      <varlistentry>
239
228
        <term><option>--interface=<replaceable
240
 
        >NAME</replaceable><arg rep='repeat'>,<replaceable
241
 
        >NAME</replaceable></arg></option></term>
 
229
        >NAME</replaceable></option></term>
242
230
        <term><option>-i
243
 
        <replaceable>NAME</replaceable><arg rep='repeat'>,<replaceable
244
 
        >NAME</replaceable></arg></option></term>
 
231
        <replaceable>NAME</replaceable></option></term>
245
232
        <listitem>
246
233
          <para>
247
234
            Comma separated list of network interfaces that will be
250
237
            use all appropriate interfaces.
251
238
          </para>
252
239
          <para>
253
 
            If the <option>--connect</option> option is used, and
254
 
            exactly one interface name is specified (except
255
 
            <quote><literal>none</literal></quote>), this specifies
256
 
            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.
257
243
          </para>
258
244
          <para>
259
245
            Note that since this program will normally run in the
268
254
          </para>
269
255
          <para>
270
256
            <replaceable>NAME</replaceable> can be the string
271
 
            <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.
 
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.
275
261
          </para>
276
262
        </listitem>
277
263
      </varlistentry>
319
305
        <listitem>
320
306
          <para>
321
307
            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.
 
308
            TLS Diffie-Hellman key exchange.  Default is 1024.
343
309
          </para>
344
310
        </listitem>
345
311
      </varlistentry>
472
438
  
473
439
  <refsect1 id="environment">
474
440
    <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
441
    <para>
489
 
      This program does not use any other environment variables, not
490
 
      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
491
444
      >cryptsetup</refentrytitle><manvolnum>8</manvolnum>
492
445
    </citerefentry>.
493
446
    </para>
555
508
              It is not necessary to print any non-executable files
556
509
              already in the network hook directory, these will be
557
510
              copied implicitly if they otherwise satisfy the name
558
 
              requirements.
 
511
              requirement.
559
512
            </para>
560
513
          </listitem>
561
514
        </varlistentry>
693
646
    </variablelist>
694
647
  </refsect1>
695
648
  
696
 
  <refsect1 id="bugs">
697
 
    <title>BUGS</title>
698
 
    <xi:include href="../bugs.xml"/>
699
 
  </refsect1>
 
649
<!--   <refsect1 id="bugs"> -->
 
650
<!--     <title>BUGS</title> -->
 
651
<!--     <para> -->
 
652
<!--     </para> -->
 
653
<!--   </refsect1> -->
700
654
  
701
655
  <refsect1 id="example">
702
656
    <title>EXAMPLE</title>
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
842
795
      </varlistentry>
843
796
      <varlistentry>
844
797
        <term>
845
 
          <ulink url="https://www.gnutls.org/">GnuTLS</ulink>
 
798
          <ulink url="http://www.gnu.org/software/gnutls/"
 
799
          >GnuTLS</ulink>
846
800
        </term>
847
801
      <listitem>
848
802
        <para>
854
808
      </varlistentry>
855
809
      <varlistentry>
856
810
        <term>
857
 
          <ulink url="https://www.gnupg.org/related_software/gpgme/"
 
811
          <ulink url="http://www.gnupg.org/related_software/gpgme/"
858
812
                 >GPGME</ulink>
859
813
        </term>
860
814
        <listitem>
888
842
              <para>
889
843
                This client uses IPv6 link-local addresses, which are
890
844
                immediately usable since a link-local addresses is
891
 
                automatically assigned to a network interface when it
 
845
                automatically assigned to a network interfaces when it
892
846
                is brought up.
893
847
              </para>
894
848
            </listitem>
898
852
      </varlistentry>
899
853
      <varlistentry>
900
854
        <term>
901
 
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
902
 
          Protocol Version 1.2</citetitle>
 
855
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
856
          Protocol Version 1.1</citetitle>
903
857
        </term>
904
858
      <listitem>
905
859
        <para>
906
 
          TLS 1.2 is the protocol implemented by GnuTLS.
 
860
          TLS 1.1 is the protocol implemented by GnuTLS.
907
861
        </para>
908
862
      </listitem>
909
863
      </varlistentry>
920
874
      </varlistentry>
921
875
      <varlistentry>
922
876
        <term>
923
 
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
 
877
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
924
878
          Security</citetitle>
925
879
        </term>
926
880
      <listitem>