/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:57:14 UTC
  • mfrom: (932 trunk)
  • mto: This revision was merged to the branch mainline in revision 933.
  • Revision ID: teddy@recompile.se-20180212145714-esg3hktbm7ma14sw
Merge from trunk

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 "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>
37
39
      <year>2013</year>
38
40
      <year>2014</year>
 
41
      <year>2015</year>
 
42
      <year>2016</year>
 
43
      <year>2017</year>
 
44
      <year>2018</year>
39
45
      <holder>Teddy Hogeborn</holder>
40
46
      <holder>Björn Påhlsson</holder>
41
47
    </copyright>
98
104
      </arg>
99
105
      <sbr/>
100
106
      <arg>
 
107
        <option>--dh-params <replaceable>FILE</replaceable></option>
 
108
      </arg>
 
109
      <sbr/>
 
110
      <arg>
101
111
        <option>--delay <replaceable>SECONDS</replaceable></option>
102
112
      </arg>
103
113
      <sbr/>
312
322
          <para>
313
323
            Sets the number of bits to use for the prime number in the
314
324
            TLS Diffie-Hellman key exchange.  The default value is
315
 
            selected automatically based on the OpenPGP key.
 
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.
316
345
          </para>
317
346
        </listitem>
318
347
      </varlistentry>
445
474
  
446
475
  <refsect1 id="environment">
447
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>
448
490
    <para>
449
 
      This program does not use any environment variables, not even
450
 
      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
451
493
      >cryptsetup</refentrytitle><manvolnum>8</manvolnum>
452
494
    </citerefentry>.
453
495
    </para>
653
695
    </variablelist>
654
696
  </refsect1>
655
697
  
656
 
<!--   <refsect1 id="bugs"> -->
657
 
<!--     <title>BUGS</title> -->
658
 
<!--     <para> -->
659
 
<!--     </para> -->
660
 
<!--   </refsect1> -->
 
698
  <refsect1 id="bugs">
 
699
    <title>BUGS</title>
 
700
    <xi:include href="../bugs.xml"/>
 
701
  </refsect1>
661
702
  
662
703
  <refsect1 id="example">
663
704
    <title>EXAMPLE</title>
803
844
      </varlistentry>
804
845
      <varlistentry>
805
846
        <term>
806
 
          <ulink url="http://www.gnu.org/software/gnutls/"
807
 
          >GnuTLS</ulink>
 
847
          <ulink url="https://www.gnutls.org/">GnuTLS</ulink>
808
848
        </term>
809
849
      <listitem>
810
850
        <para>
816
856
      </varlistentry>
817
857
      <varlistentry>
818
858
        <term>
819
 
          <ulink url="http://www.gnupg.org/related_software/gpgme/"
 
859
          <ulink url="https://www.gnupg.org/related_software/gpgme/"
820
860
                 >GPGME</ulink>
821
861
        </term>
822
862
        <listitem>
860
900
      </varlistentry>
861
901
      <varlistentry>
862
902
        <term>
863
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
864
 
          Protocol Version 1.1</citetitle>
 
903
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
 
904
          Protocol Version 1.2</citetitle>
865
905
        </term>
866
906
      <listitem>
867
907
        <para>
868
 
          TLS 1.1 is the protocol implemented by GnuTLS.
 
908
          TLS 1.2 is the protocol implemented by GnuTLS.
869
909
        </para>
870
910
      </listitem>
871
911
      </varlistentry>
882
922
      </varlistentry>
883
923
      <varlistentry>
884
924
        <term>
885
 
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
 
925
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
886
926
          Security</citetitle>
887
927
        </term>
888
928
      <listitem>