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