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