/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: 2018-02-12 14:54:58 UTC
  • Revision ID: teddy@recompile.se-20180212145458-mkcjkw4cd9s18izm
Client bug fix: Revert change to plugin-runner

* plugin-runner.c (free_plugin): Bug fix: Don't free() plugin name.

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-13">
 
5
<!ENTITY TIMESTAMP "2018-02-08">
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>
 
43
      <year>2017</year>
 
44
      <year>2018</year>
37
45
      <holder>Teddy Hogeborn</holder>
38
46
      <holder>Björn Påhlsson</holder>
39
47
    </copyright>
96
104
      </arg>
97
105
      <sbr/>
98
106
      <arg>
 
107
        <option>--dh-params <replaceable>FILE</replaceable></option>
 
108
      </arg>
 
109
      <sbr/>
 
110
      <arg>
99
111
        <option>--delay <replaceable>SECONDS</replaceable></option>
100
112
      </arg>
101
113
      <sbr/>
218
230
            assumed to separate the address from the port number.
219
231
          </para>
220
232
          <para>
221
 
            This option is normally only useful for testing and
222
 
            debugging.
 
233
            Normally, Zeroconf would be used to locate Mandos servers,
 
234
            in which case this option would only be used when testing
 
235
            and debugging.
223
236
          </para>
224
237
        </listitem>
225
238
      </varlistentry>
226
239
      
227
240
      <varlistentry>
228
241
        <term><option>--interface=<replaceable
229
 
        >NAME</replaceable></option></term>
 
242
        >NAME</replaceable><arg rep='repeat'>,<replaceable
 
243
        >NAME</replaceable></arg></option></term>
230
244
        <term><option>-i
231
 
        <replaceable>NAME</replaceable></option></term>
 
245
        <replaceable>NAME</replaceable><arg rep='repeat'>,<replaceable
 
246
        >NAME</replaceable></arg></option></term>
232
247
        <listitem>
233
248
          <para>
234
249
            Comma separated list of network interfaces that will be
237
252
            use all appropriate interfaces.
238
253
          </para>
239
254
          <para>
240
 
            If the <option>--connect</option> option is used, this
241
 
            specifies the interface to use to connect to the address
242
 
            given.
 
255
            If the <option>--connect</option> option is used, and
 
256
            exactly one interface name is specified (except
 
257
            <quote><literal>none</literal></quote>), this specifies
 
258
            the interface to use to connect to the address given.
243
259
          </para>
244
260
          <para>
245
261
            Note that since this program will normally run in the
254
270
          </para>
255
271
          <para>
256
272
            <replaceable>NAME</replaceable> can be the string
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.
 
273
            <quote><literal>none</literal></quote>; this will make
 
274
            <command>&COMMANDNAME;</command> only bring up interfaces
 
275
            specified <emphasis>before</emphasis> this string.  This
 
276
            is not recommended, and only meant for advanced users.
261
277
          </para>
262
278
        </listitem>
263
279
      </varlistentry>
305
321
        <listitem>
306
322
          <para>
307
323
            Sets the number of bits to use for the prime number in the
308
 
            TLS Diffie-Hellman key exchange.  Default is 1024.
 
324
            TLS Diffie-Hellman key exchange.  The default value is
 
325
            selected automatically based on the OpenPGP key.  Note
 
326
            that if the <option>--dh-params</option> option is used,
 
327
            the values from that file will be used instead.
 
328
          </para>
 
329
        </listitem>
 
330
      </varlistentry>
 
331
      
 
332
      <varlistentry>
 
333
        <term><option>--dh-params=<replaceable
 
334
        >FILE</replaceable></option></term>
 
335
        <listitem>
 
336
          <para>
 
337
            Specifies a PEM-encoded PKCS#3 file to read the parameters
 
338
            needed by the TLS Diffie-Hellman key exchange from.  If
 
339
            this option is not given, or if the file for some reason
 
340
            could not be used, the parameters will be generated on
 
341
            startup, which will take some time and processing power.
 
342
            Those using servers running under time, power or processor
 
343
            constraints may want to generate such a file in advance
 
344
            and use this option.
309
345
          </para>
310
346
        </listitem>
311
347
      </varlistentry>
438
474
  
439
475
  <refsect1 id="environment">
440
476
    <title>ENVIRONMENT</title>
 
477
    <variablelist>
 
478
      <varlistentry>
 
479
        <term><envar>MANDOSPLUGINHELPERDIR</envar></term>
 
480
        <listitem>
 
481
          <para>
 
482
            This environment variable will be assumed to contain the
 
483
            directory containing any helper executables.  The use and
 
484
            nature of these helper executables, if any, is
 
485
            purposefully not documented.
 
486
        </para>
 
487
        </listitem>
 
488
      </varlistentry>
 
489
    </variablelist>
441
490
    <para>
442
 
      This program does not use any environment variables, not even
443
 
      the ones provided by <citerefentry><refentrytitle
 
491
      This program does not use any other environment variables, not
 
492
      even the ones provided by <citerefentry><refentrytitle
444
493
      >cryptsetup</refentrytitle><manvolnum>8</manvolnum>
445
494
    </citerefentry>.
446
495
    </para>
508
557
              It is not necessary to print any non-executable files
509
558
              already in the network hook directory, these will be
510
559
              copied implicitly if they otherwise satisfy the name
511
 
              requirement.
 
560
              requirements.
512
561
            </para>
513
562
          </listitem>
514
563
        </varlistentry>
646
695
    </variablelist>
647
696
  </refsect1>
648
697
  
649
 
<!--   <refsect1 id="bugs"> -->
650
 
<!--     <title>BUGS</title> -->
651
 
<!--     <para> -->
652
 
<!--     </para> -->
653
 
<!--   </refsect1> -->
 
698
  <refsect1 id="bugs">
 
699
    <title>BUGS</title>
 
700
    <xi:include href="../bugs.xml"/>
 
701
  </refsect1>
654
702
  
655
703
  <refsect1 id="example">
656
704
    <title>EXAMPLE</title>
662
710
    </para>
663
711
    <informalexample>
664
712
      <para>
665
 
        Normal invocation needs no options, if the network interface
 
713
        Normal invocation needs no options, if the network interfaces
666
714
        can be automatically determined:
667
715
      </para>
668
716
      <para>
671
719
    </informalexample>
672
720
    <informalexample>
673
721
      <para>
674
 
        Search for Mandos servers (and connect to them) using another
675
 
        interface:
 
722
        Search for Mandos servers (and connect to them) using one
 
723
        specific interface:
676
724
      </para>
677
725
      <para>
678
726
        <!-- do not wrap this line -->
742
790
    <para>
743
791
      It will also help if the checker program on the server is
744
792
      configured to request something from the client which can not be
745
 
      spoofed by someone else on the network, unlike unencrypted
746
 
      <acronym>ICMP</acronym> echo (<quote>ping</quote>) replies.
 
793
      spoofed by someone else on the network, like SSH server key
 
794
      fingerprints, and unlike unencrypted <acronym>ICMP</acronym>
 
795
      echo (<quote>ping</quote>) replies.
747
796
    </para>
748
797
    <para>
749
798
      <emphasis>Note</emphasis>: This makes it completely insecure to
795
844
      </varlistentry>
796
845
      <varlistentry>
797
846
        <term>
798
 
          <ulink url="http://www.gnu.org/software/gnutls/"
799
 
          >GnuTLS</ulink>
 
847
          <ulink url="https://www.gnutls.org/">GnuTLS</ulink>
800
848
        </term>
801
849
      <listitem>
802
850
        <para>
808
856
      </varlistentry>
809
857
      <varlistentry>
810
858
        <term>
811
 
          <ulink url="http://www.gnupg.org/related_software/gpgme/"
 
859
          <ulink url="https://www.gnupg.org/related_software/gpgme/"
812
860
                 >GPGME</ulink>
813
861
        </term>
814
862
        <listitem>
842
890
              <para>
843
891
                This client uses IPv6 link-local addresses, which are
844
892
                immediately usable since a link-local addresses is
845
 
                automatically assigned to a network interfaces when it
 
893
                automatically assigned to a network interface when it
846
894
                is brought up.
847
895
              </para>
848
896
            </listitem>
852
900
      </varlistentry>
853
901
      <varlistentry>
854
902
        <term>
855
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
856
 
          Protocol Version 1.1</citetitle>
 
903
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
 
904
          Protocol Version 1.2</citetitle>
857
905
        </term>
858
906
      <listitem>
859
907
        <para>
860
 
          TLS 1.1 is the protocol implemented by GnuTLS.
 
908
          TLS 1.2 is the protocol implemented by GnuTLS.
861
909
        </para>
862
910
      </listitem>
863
911
      </varlistentry>
874
922
      </varlistentry>
875
923
      <varlistentry>
876
924
        <term>
877
 
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
 
925
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
878
926
          Security</citetitle>
879
927
        </term>
880
928
      <listitem>