/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-08-25 16:17:23 UTC
  • Revision ID: teddy@recompile.se-20160825161723-wsbn6sxyk29qgmsv
PEP8 compliance: mandos-ctl

* mandos-ctl: Add PEP8 compliance (as per the "pycodestyle" tool).

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 "2013-10-20">
 
5
<!ENTITY TIMESTAMP "2016-07-10">
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>
37
39
      <year>2013</year>
 
40
      <year>2014</year>
 
41
      <year>2015</year>
 
42
      <year>2016</year>
38
43
      <holder>Teddy Hogeborn</holder>
39
44
      <holder>Björn Påhlsson</holder>
40
45
    </copyright>
97
102
      </arg>
98
103
      <sbr/>
99
104
      <arg>
 
105
        <option>--dh-params <replaceable>FILE</replaceable></option>
 
106
      </arg>
 
107
      <sbr/>
 
108
      <arg>
100
109
        <option>--delay <replaceable>SECONDS</replaceable></option>
101
110
      </arg>
102
111
      <sbr/>
219
228
            assumed to separate the address from the port number.
220
229
          </para>
221
230
          <para>
222
 
            This option is normally only useful for testing and
223
 
            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.
224
234
          </para>
225
235
        </listitem>
226
236
      </varlistentry>
259
269
          <para>
260
270
            <replaceable>NAME</replaceable> can be the string
261
271
            <quote><literal>none</literal></quote>; this will make
262
 
            <command>&COMMANDNAME;</command> not bring up
263
 
            <emphasis>any</emphasis> interfaces specified
264
 
            <emphasis>after</emphasis> this string.  This is not
265
 
            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.
266
275
          </para>
267
276
        </listitem>
268
277
      </varlistentry>
310
319
        <listitem>
311
320
          <para>
312
321
            Sets the number of bits to use for the prime number in the
313
 
            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.
314
343
          </para>
315
344
        </listitem>
316
345
      </varlistentry>
443
472
  
444
473
  <refsect1 id="environment">
445
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>
446
488
    <para>
447
 
      This program does not use any environment variables, not even
448
 
      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
449
491
      >cryptsetup</refentrytitle><manvolnum>8</manvolnum>
450
492
    </citerefentry>.
451
493
    </para>
651
693
    </variablelist>
652
694
  </refsect1>
653
695
  
654
 
<!--   <refsect1 id="bugs"> -->
655
 
<!--     <title>BUGS</title> -->
656
 
<!--     <para> -->
657
 
<!--     </para> -->
658
 
<!--   </refsect1> -->
 
696
  <refsect1 id="bugs">
 
697
    <title>BUGS</title>
 
698
    <xi:include href="../bugs.xml"/>
 
699
  </refsect1>
659
700
  
660
701
  <refsect1 id="example">
661
702
    <title>EXAMPLE</title>
747
788
    <para>
748
789
      It will also help if the checker program on the server is
749
790
      configured to request something from the client which can not be
750
 
      spoofed by someone else on the network, unlike unencrypted
751
 
      <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.
752
794
    </para>
753
795
    <para>
754
796
      <emphasis>Note</emphasis>: This makes it completely insecure to
800
842
      </varlistentry>
801
843
      <varlistentry>
802
844
        <term>
803
 
          <ulink url="http://www.gnu.org/software/gnutls/"
804
 
          >GnuTLS</ulink>
 
845
          <ulink url="https://www.gnutls.org/">GnuTLS</ulink>
805
846
        </term>
806
847
      <listitem>
807
848
        <para>
813
854
      </varlistentry>
814
855
      <varlistentry>
815
856
        <term>
816
 
          <ulink url="http://www.gnupg.org/related_software/gpgme/"
 
857
          <ulink url="https://www.gnupg.org/related_software/gpgme/"
817
858
                 >GPGME</ulink>
818
859
        </term>
819
860
        <listitem>
857
898
      </varlistentry>
858
899
      <varlistentry>
859
900
        <term>
860
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
861
 
          Protocol Version 1.1</citetitle>
 
901
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
 
902
          Protocol Version 1.2</citetitle>
862
903
        </term>
863
904
      <listitem>
864
905
        <para>
865
 
          TLS 1.1 is the protocol implemented by GnuTLS.
 
906
          TLS 1.2 is the protocol implemented by GnuTLS.
866
907
        </para>
867
908
      </listitem>
868
909
      </varlistentry>
879
920
      </varlistentry>
880
921
      <varlistentry>
881
922
        <term>
882
 
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
 
923
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
883
924
          Security</citetitle>
884
925
        </term>
885
926
      <listitem>