/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: 2017-08-20 13:50:57 UTC
  • Revision ID: teddy@recompile.se-20170820135057-u069yh7hhk2ha1a2
Don't import doctest module in mandos-ctl unless running tests.

* mandos-ctl: Don't import doctest module unless running tests.

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-03-08">
 
5
<!ENTITY TIMESTAMP "2017-02-23">
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>
38
40
      <year>2014</year>
 
41
      <year>2015</year>
 
42
      <year>2016</year>
 
43
      <year>2017</year>
39
44
      <holder>Teddy Hogeborn</holder>
40
45
      <holder>Björn Påhlsson</holder>
41
46
    </copyright>
98
103
      </arg>
99
104
      <sbr/>
100
105
      <arg>
 
106
        <option>--dh-params <replaceable>FILE</replaceable></option>
 
107
      </arg>
 
108
      <sbr/>
 
109
      <arg>
101
110
        <option>--delay <replaceable>SECONDS</replaceable></option>
102
111
      </arg>
103
112
      <sbr/>
312
321
          <para>
313
322
            Sets the number of bits to use for the prime number in the
314
323
            TLS Diffie-Hellman key exchange.  The default value is
315
 
            selected automatically based on the OpenPGP key.
 
324
            selected automatically based on the OpenPGP key.  Note
 
325
            that if the <option>--dh-params</option> option is used,
 
326
            the values from that file will be used instead.
 
327
          </para>
 
328
        </listitem>
 
329
      </varlistentry>
 
330
      
 
331
      <varlistentry>
 
332
        <term><option>--dh-params=<replaceable
 
333
        >FILE</replaceable></option></term>
 
334
        <listitem>
 
335
          <para>
 
336
            Specifies a PEM-encoded PKCS#3 file to read the parameters
 
337
            needed by the TLS Diffie-Hellman key exchange from.  If
 
338
            this option is not given, or if the file for some reason
 
339
            could not be used, the parameters will be generated on
 
340
            startup, which will take some time and processing power.
 
341
            Those using servers running under time, power or processor
 
342
            constraints may want to generate such a file in advance
 
343
            and use this option.
316
344
          </para>
317
345
        </listitem>
318
346
      </varlistentry>
445
473
  
446
474
  <refsect1 id="environment">
447
475
    <title>ENVIRONMENT</title>
 
476
    <variablelist>
 
477
      <varlistentry>
 
478
        <term><envar>MANDOSPLUGINHELPERDIR</envar></term>
 
479
        <listitem>
 
480
          <para>
 
481
            This environment variable will be assumed to contain the
 
482
            directory containing any helper executables.  The use and
 
483
            nature of these helper executables, if any, is
 
484
            purposefully not documented.
 
485
        </para>
 
486
        </listitem>
 
487
      </varlistentry>
 
488
    </variablelist>
448
489
    <para>
449
 
      This program does not use any environment variables, not even
450
 
      the ones provided by <citerefentry><refentrytitle
 
490
      This program does not use any other environment variables, not
 
491
      even the ones provided by <citerefentry><refentrytitle
451
492
      >cryptsetup</refentrytitle><manvolnum>8</manvolnum>
452
493
    </citerefentry>.
453
494
    </para>
653
694
    </variablelist>
654
695
  </refsect1>
655
696
  
656
 
<!--   <refsect1 id="bugs"> -->
657
 
<!--     <title>BUGS</title> -->
658
 
<!--     <para> -->
659
 
<!--     </para> -->
660
 
<!--   </refsect1> -->
 
697
  <refsect1 id="bugs">
 
698
    <title>BUGS</title>
 
699
    <xi:include href="../bugs.xml"/>
 
700
  </refsect1>
661
701
  
662
702
  <refsect1 id="example">
663
703
    <title>EXAMPLE</title>
803
843
      </varlistentry>
804
844
      <varlistentry>
805
845
        <term>
806
 
          <ulink url="http://www.gnu.org/software/gnutls/"
807
 
          >GnuTLS</ulink>
 
846
          <ulink url="https://www.gnutls.org/">GnuTLS</ulink>
808
847
        </term>
809
848
      <listitem>
810
849
        <para>
816
855
      </varlistentry>
817
856
      <varlistentry>
818
857
        <term>
819
 
          <ulink url="http://www.gnupg.org/related_software/gpgme/"
 
858
          <ulink url="https://www.gnupg.org/related_software/gpgme/"
820
859
                 >GPGME</ulink>
821
860
        </term>
822
861
        <listitem>
860
899
      </varlistentry>
861
900
      <varlistentry>
862
901
        <term>
863
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
864
 
          Protocol Version 1.1</citetitle>
 
902
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
 
903
          Protocol Version 1.2</citetitle>
865
904
        </term>
866
905
      <listitem>
867
906
        <para>
868
 
          TLS 1.1 is the protocol implemented by GnuTLS.
 
907
          TLS 1.2 is the protocol implemented by GnuTLS.
869
908
        </para>
870
909
      </listitem>
871
910
      </varlistentry>
882
921
      </varlistentry>
883
922
      <varlistentry>
884
923
        <term>
885
 
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
 
924
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
886
925
          Security</citetitle>
887
926
        </term>
888
927
      <listitem>