/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to plugins.d/mandos-client.xml

  • Committer: Teddy Hogeborn
  • Date: 2016-10-29 13:44:49 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 356.
  • Revision ID: teddy@recompile.se-20161029134449-imf8eidhzwfnax9w
mandos: Use "self" instead of class name "GnuTLS" in __init__.

* mandos (GnuTLS.__init__): Use "self" instead of class name "GnuTLS".

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 "2011-11-27">
 
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>
36
37
      <year>2011</year>
 
38
      <year>2012</year>
 
39
      <year>2013</year>
 
40
      <year>2014</year>
 
41
      <year>2015</year>
 
42
      <year>2016</year>
37
43
      <holder>Teddy Hogeborn</holder>
38
44
      <holder>Björn Påhlsson</holder>
39
45
    </copyright>
64
70
        ><replaceable>PORT</replaceable></option></arg>
65
71
      </group>
66
72
      <sbr/>
67
 
      <group>
 
73
      <group rep='repeat'>
68
74
        <arg choice="plain"><option>--interface
69
 
        <replaceable>NAME</replaceable></option></arg>
70
 
        <arg choice="plain"><option>-i
71
 
        <replaceable>NAME</replaceable></option></arg>
 
75
        <replaceable>NAME</replaceable><arg rep='repeat'
 
76
        >,<replaceable>NAME</replaceable></arg></option></arg>
 
77
        <arg choice="plain"><option>-i <replaceable>NAME</replaceable
 
78
        ><arg rep='repeat'>,<replaceable>NAME</replaceable></arg
 
79
        ></option></arg>
72
80
      </group>
73
81
      <sbr/>
74
82
      <group>
94
102
      </arg>
95
103
      <sbr/>
96
104
      <arg>
 
105
        <option>--dh-params <replaceable>FILE</replaceable></option>
 
106
      </arg>
 
107
      <sbr/>
 
108
      <arg>
97
109
        <option>--delay <replaceable>SECONDS</replaceable></option>
98
110
      </arg>
99
111
      <sbr/>
137
149
      communicates with <citerefentry><refentrytitle
138
150
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>
139
151
      to get a password.  In slightly more detail, this client program
140
 
      brings up a network interface, uses the interface’s IPv6
141
 
      link-local address to get network connectivity, uses Zeroconf to
142
 
      find servers on the local network, and communicates with servers
143
 
      using TLS with an OpenPGP key to ensure authenticity and
 
152
      brings up network interfaces, uses the interfaces’ IPv6
 
153
      link-local addresses to get network connectivity, uses Zeroconf
 
154
      to find servers on the local network, and communicates with
 
155
      servers using TLS with an OpenPGP key to ensure authenticity and
144
156
      confidentiality.  This client program keeps running, trying all
145
157
      servers on the network, until it receives a satisfactory reply
146
158
      or a TERM signal.  After all servers have been tried, all
148
160
      will wait indefinitely for new servers to appear.
149
161
    </para>
150
162
    <para>
151
 
      The network interface is selected like this: If an interface is
152
 
      specified using the <option>--interface</option> option, that
153
 
      interface is used.  Otherwise, <command>&COMMANDNAME;</command>
154
 
      will choose any interface that is up and running and is not a
155
 
      loopback interface, is not a point-to-point interface, is
156
 
      capable of broadcasting and does not have the NOARP flag (see
 
163
      The network interfaces are selected like this: If any interfaces
 
164
      are specified using the <option>--interface</option> option,
 
165
      those interface are used.  Otherwise,
 
166
      <command>&COMMANDNAME;</command> will use all interfaces that
 
167
      are not loopback interfaces, are not point-to-point interfaces,
 
168
      are capable of broadcasting and do not have the NOARP flag (see
157
169
      <citerefentry><refentrytitle>netdevice</refentrytitle>
158
170
      <manvolnum>7</manvolnum></citerefentry>).  (If the
159
171
      <option>--connect</option> option is used, point-to-point
160
 
      interfaces and non-broadcast interfaces are accepted.)  If no
161
 
      acceptable interfaces are found, re-run the check but without
162
 
      the <quote>up and running</quote> requirement, and manually take
163
 
      the selected interface up (and later take it down on program
164
 
      exit).
 
172
      interfaces and non-broadcast interfaces are accepted.)  If any
 
173
      used interfaces are not up and running, they are first taken up
 
174
      (and later taken down again on program exit).
165
175
    </para>
166
176
    <para>
167
 
      Before a network interface is selected, all <quote>network
 
177
      Before network interfaces are selected, all <quote>network
168
178
      hooks</quote> are run; see <xref linkend="network-hooks"/>.
169
179
    </para>
170
180
    <para>
218
228
            assumed to separate the address from the port number.
219
229
          </para>
220
230
          <para>
221
 
            This option is normally only useful for testing and
222
 
            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.
223
234
          </para>
224
235
        </listitem>
225
236
      </varlistentry>
226
237
      
227
238
      <varlistentry>
228
239
        <term><option>--interface=<replaceable
229
 
        >NAME</replaceable></option></term>
 
240
        >NAME</replaceable><arg rep='repeat'>,<replaceable
 
241
        >NAME</replaceable></arg></option></term>
230
242
        <term><option>-i
231
 
        <replaceable>NAME</replaceable></option></term>
 
243
        <replaceable>NAME</replaceable><arg rep='repeat'>,<replaceable
 
244
        >NAME</replaceable></arg></option></term>
232
245
        <listitem>
233
246
          <para>
234
 
            Network interface that will be brought up and scanned for
235
 
            Mandos servers to connect to.  The default is the empty
236
 
            string, which will automatically choose an appropriate
237
 
            interface.
 
247
            Comma separated list of network interfaces that will be
 
248
            brought up and scanned for Mandos servers to connect to.
 
249
            The default is the empty string, which will automatically
 
250
            use all appropriate interfaces.
238
251
          </para>
239
252
          <para>
240
 
            If the <option>--connect</option> option is used, this
241
 
            specifies the interface to use to connect to the address
242
 
            given.
 
253
            If the <option>--connect</option> option is used, and
 
254
            exactly one interface name is specified (except
 
255
            <quote><literal>none</literal></quote>), this specifies
 
256
            the interface to use to connect to the address given.
243
257
          </para>
244
258
          <para>
245
259
            Note that since this program will normally run in the
246
260
            initial RAM disk environment, the interface must be an
247
261
            interface which exists at that stage.  Thus, the interface
248
 
            can not be a pseudo-interface such as <quote>br0</quote>
249
 
            or <quote>tun0</quote>; such interfaces will not exist
250
 
            until much later in the boot process, and can not be used
251
 
            by this program, unless created by a <quote>network
252
 
            hook</quote> — see <xref linkend="network-hooks"/>.
 
262
            can normally not be a pseudo-interface such as
 
263
            <quote>br0</quote> or <quote>tun0</quote>; such interfaces
 
264
            will not exist until much later in the boot process, and
 
265
            can not be used by this program, unless created by a
 
266
            <quote>network hook</quote> — see <xref
 
267
            linkend="network-hooks"/>.
253
268
          </para>
254
269
          <para>
255
270
            <replaceable>NAME</replaceable> can be the string
256
 
            <quote><literal>none</literal></quote>; this will not use
257
 
            any specific interface, and will not bring up an interface
258
 
            on startup.  This is not recommended, and only meant for
259
 
            advanced users.
 
271
            <quote><literal>none</literal></quote>; this will make
 
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.
260
275
          </para>
261
276
        </listitem>
262
277
      </varlistentry>
304
319
        <listitem>
305
320
          <para>
306
321
            Sets the number of bits to use for the prime number in the
307
 
            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.
308
343
          </para>
309
344
        </listitem>
310
345
      </varlistentry>
314
349
        >SECONDS</replaceable></option></term>
315
350
        <listitem>
316
351
          <para>
317
 
            After bringing the network interface up, the program waits
 
352
            After bringing a network interface up, the program waits
318
353
            for the interface to arrive in a <quote>running</quote>
319
354
            state before proceeding.  During this time, the kernel log
320
355
            level will be lowered to reduce clutter on the system
437
472
  
438
473
  <refsect1 id="environment">
439
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>
440
488
    <para>
441
 
      This program does not use any environment variables, not even
442
 
      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
443
491
      >cryptsetup</refentrytitle><manvolnum>8</manvolnum>
444
492
    </citerefentry>.
445
493
    </para>
507
555
              It is not necessary to print any non-executable files
508
556
              already in the network hook directory, these will be
509
557
              copied implicitly if they otherwise satisfy the name
510
 
              requirement.
 
558
              requirements.
511
559
            </para>
512
560
          </listitem>
513
561
        </varlistentry>
547
595
          <term><envar>DEVICE</envar></term>
548
596
          <listitem>
549
597
            <para>
550
 
              The network interface, as specified to
 
598
              The network interfaces, as specified to
551
599
              <command>&COMMANDNAME;</command> by the
552
 
              <option>--interface</option> option.  If this is not the
553
 
              interface a hook will bring up, there is no reason for a
554
 
              hook to continue.
 
600
              <option>--interface</option> option, combined to one
 
601
              string and separated by commas.  If this is set, and
 
602
              does not contain the interface a hook will bring up,
 
603
              there is no reason for a hook to continue.
555
604
            </para>
556
605
          </listitem>
557
606
        </varlistentry>
644
693
    </variablelist>
645
694
  </refsect1>
646
695
  
647
 
<!--   <refsect1 id="bugs"> -->
648
 
<!--     <title>BUGS</title> -->
649
 
<!--     <para> -->
650
 
<!--     </para> -->
651
 
<!--   </refsect1> -->
 
696
  <refsect1 id="bugs">
 
697
    <title>BUGS</title>
 
698
    <xi:include href="../bugs.xml"/>
 
699
  </refsect1>
652
700
  
653
701
  <refsect1 id="example">
654
702
    <title>EXAMPLE</title>
660
708
    </para>
661
709
    <informalexample>
662
710
      <para>
663
 
        Normal invocation needs no options, if the network interface
664
 
        is <quote>eth0</quote>:
 
711
        Normal invocation needs no options, if the network interfaces
 
712
        can be automatically determined:
665
713
      </para>
666
714
      <para>
667
715
        <userinput>&COMMANDNAME;</userinput>
669
717
    </informalexample>
670
718
    <informalexample>
671
719
      <para>
672
 
        Search for Mandos servers (and connect to them) using another
673
 
        interface:
 
720
        Search for Mandos servers (and connect to them) using one
 
721
        specific interface:
674
722
      </para>
675
723
      <para>
676
724
        <!-- do not wrap this line -->
740
788
    <para>
741
789
      It will also help if the checker program on the server is
742
790
      configured to request something from the client which can not be
743
 
      spoofed by someone else on the network, unlike unencrypted
744
 
      <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.
745
794
    </para>
746
795
    <para>
747
796
      <emphasis>Note</emphasis>: This makes it completely insecure to
793
842
      </varlistentry>
794
843
      <varlistentry>
795
844
        <term>
796
 
          <ulink url="http://www.gnu.org/software/gnutls/"
797
 
          >GnuTLS</ulink>
 
845
          <ulink url="https://www.gnutls.org/">GnuTLS</ulink>
798
846
        </term>
799
847
      <listitem>
800
848
        <para>
806
854
      </varlistentry>
807
855
      <varlistentry>
808
856
        <term>
809
 
          <ulink url="http://www.gnupg.org/related_software/gpgme/"
 
857
          <ulink url="https://www.gnupg.org/related_software/gpgme/"
810
858
                 >GPGME</ulink>
811
859
        </term>
812
860
        <listitem>
840
888
              <para>
841
889
                This client uses IPv6 link-local addresses, which are
842
890
                immediately usable since a link-local addresses is
843
 
                automatically assigned to a network interfaces when it
 
891
                automatically assigned to a network interface when it
844
892
                is brought up.
845
893
              </para>
846
894
            </listitem>
850
898
      </varlistentry>
851
899
      <varlistentry>
852
900
        <term>
853
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
854
 
          Protocol Version 1.1</citetitle>
 
901
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
 
902
          Protocol Version 1.2</citetitle>
855
903
        </term>
856
904
      <listitem>
857
905
        <para>
858
 
          TLS 1.1 is the protocol implemented by GnuTLS.
 
906
          TLS 1.2 is the protocol implemented by GnuTLS.
859
907
        </para>
860
908
      </listitem>
861
909
      </varlistentry>
872
920
      </varlistentry>
873
921
      <varlistentry>
874
922
        <term>
875
 
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
 
923
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
876
924
          Security</citetitle>
877
925
        </term>
878
926
      <listitem>