/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-11-26 23:21:16 UTC
  • Revision ID: teddy@recompile.se-20161126232116-nhqk9x1qij09b7cx
Add comment in documentation source with clarifying text.

* intro.xml (INTRODUCTION): Add comment with clarification.

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