/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: 2015-10-04 13:44:03 UTC
  • Revision ID: teddy@recompile.se-20151004134403-jn72bwgbw3aocllk
* initramfs-tools-hook: Don't try to chmod symlinks.

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 "2015-07-20">
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>
37
42
      <holder>Teddy Hogeborn</holder>
38
43
      <holder>Björn Påhlsson</holder>
39
44
    </copyright>
64
69
        ><replaceable>PORT</replaceable></option></arg>
65
70
      </group>
66
71
      <sbr/>
67
 
      <group>
 
72
      <group rep='repeat'>
68
73
        <arg choice="plain"><option>--interface
69
 
        <replaceable>NAME</replaceable></option></arg>
70
 
        <arg choice="plain"><option>-i
71
 
        <replaceable>NAME</replaceable></option></arg>
 
74
        <replaceable>NAME</replaceable><arg rep='repeat'
 
75
        >,<replaceable>NAME</replaceable></arg></option></arg>
 
76
        <arg choice="plain"><option>-i <replaceable>NAME</replaceable
 
77
        ><arg rep='repeat'>,<replaceable>NAME</replaceable></arg
 
78
        ></option></arg>
72
79
      </group>
73
80
      <sbr/>
74
81
      <group>
94
101
      </arg>
95
102
      <sbr/>
96
103
      <arg>
 
104
        <option>--dh-params <replaceable>FILE</replaceable></option>
 
105
      </arg>
 
106
      <sbr/>
 
107
      <arg>
97
108
        <option>--delay <replaceable>SECONDS</replaceable></option>
98
109
      </arg>
99
110
      <sbr/>
137
148
      communicates with <citerefentry><refentrytitle
138
149
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>
139
150
      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
 
151
      brings up network interfaces, uses the interfaces’ IPv6
 
152
      link-local addresses to get network connectivity, uses Zeroconf
 
153
      to find servers on the local network, and communicates with
 
154
      servers using TLS with an OpenPGP key to ensure authenticity and
144
155
      confidentiality.  This client program keeps running, trying all
145
156
      servers on the network, until it receives a satisfactory reply
146
157
      or a TERM signal.  After all servers have been tried, all
148
159
      will wait indefinitely for new servers to appear.
149
160
    </para>
150
161
    <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
 
162
      The network interfaces are selected like this: If any interfaces
 
163
      are specified using the <option>--interface</option> option,
 
164
      those interface are used.  Otherwise,
 
165
      <command>&COMMANDNAME;</command> will use all interfaces that
 
166
      are not loopback interfaces, are not point-to-point interfaces,
 
167
      are capable of broadcasting and do not have the NOARP flag (see
157
168
      <citerefentry><refentrytitle>netdevice</refentrytitle>
158
169
      <manvolnum>7</manvolnum></citerefentry>).  (If the
159
170
      <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).
 
171
      interfaces and non-broadcast interfaces are accepted.)  If any
 
172
      used interfaces are not up and running, they are first taken up
 
173
      (and later taken down again on program exit).
165
174
    </para>
166
175
    <para>
167
 
      Before a network interface is selected, all <quote>network
 
176
      Before network interfaces are selected, all <quote>network
168
177
      hooks</quote> are run; see <xref linkend="network-hooks"/>.
169
178
    </para>
170
179
    <para>
218
227
            assumed to separate the address from the port number.
219
228
          </para>
220
229
          <para>
221
 
            This option is normally only useful for testing and
222
 
            debugging.
 
230
            Normally, Zeroconf would be used to locate Mandos servers,
 
231
            in which case this option would only be used when testing
 
232
            and debugging.
223
233
          </para>
224
234
        </listitem>
225
235
      </varlistentry>
226
236
      
227
237
      <varlistentry>
228
238
        <term><option>--interface=<replaceable
229
 
        >NAME</replaceable></option></term>
 
239
        >NAME</replaceable><arg rep='repeat'>,<replaceable
 
240
        >NAME</replaceable></arg></option></term>
230
241
        <term><option>-i
231
 
        <replaceable>NAME</replaceable></option></term>
 
242
        <replaceable>NAME</replaceable><arg rep='repeat'>,<replaceable
 
243
        >NAME</replaceable></arg></option></term>
232
244
        <listitem>
233
245
          <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.
 
246
            Comma separated list of network interfaces that will be
 
247
            brought up and scanned for Mandos servers to connect to.
 
248
            The default is the empty string, which will automatically
 
249
            use all appropriate interfaces.
238
250
          </para>
239
251
          <para>
240
 
            If the <option>--connect</option> option is used, this
241
 
            specifies the interface to use to connect to the address
242
 
            given.
 
252
            If the <option>--connect</option> option is used, and
 
253
            exactly one interface name is specified (except
 
254
            <quote><literal>none</literal></quote>), this specifies
 
255
            the interface to use to connect to the address given.
243
256
          </para>
244
257
          <para>
245
258
            Note that since this program will normally run in the
246
259
            initial RAM disk environment, the interface must be an
247
260
            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"/>.
 
261
            can normally not be a pseudo-interface such as
 
262
            <quote>br0</quote> or <quote>tun0</quote>; such interfaces
 
263
            will not exist until much later in the boot process, and
 
264
            can not be used by this program, unless created by a
 
265
            <quote>network hook</quote> — see <xref
 
266
            linkend="network-hooks"/>.
253
267
          </para>
254
268
          <para>
255
269
            <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.
 
270
            <quote><literal>none</literal></quote>; this will make
 
271
            <command>&COMMANDNAME;</command> only bring up interfaces
 
272
            specified <emphasis>before</emphasis> this string.  This
 
273
            is not recommended, and only meant for advanced users.
260
274
          </para>
261
275
        </listitem>
262
276
      </varlistentry>
304
318
        <listitem>
305
319
          <para>
306
320
            Sets the number of bits to use for the prime number in the
307
 
            TLS Diffie-Hellman key exchange.  Default is 1024.
 
321
            TLS Diffie-Hellman key exchange.  The default value is
 
322
            selected automatically based on the OpenPGP key.  Note
 
323
            that if the <option>--dh-params</option> option is used,
 
324
            the values from that file will be used instead.
 
325
          </para>
 
326
        </listitem>
 
327
      </varlistentry>
 
328
      
 
329
      <varlistentry>
 
330
        <term><option>--dh-params=<replaceable
 
331
        >FILE</replaceable></option></term>
 
332
        <listitem>
 
333
          <para>
 
334
            Specifies a PEM-encoded PKCS#3 file to read the parameters
 
335
            needed by the TLS Diffie-Hellman key exchange from.  If
 
336
            this option is not given, or if the file for some reason
 
337
            could not be used, the parameters will be generated on
 
338
            startup, which will take some time and processing power.
 
339
            Those using servers running under time, power or processor
 
340
            constraints may want to generate such a file in advance
 
341
            and use this option.
308
342
          </para>
309
343
        </listitem>
310
344
      </varlistentry>
314
348
        >SECONDS</replaceable></option></term>
315
349
        <listitem>
316
350
          <para>
317
 
            After bringing the network interface up, the program waits
 
351
            After bringing a network interface up, the program waits
318
352
            for the interface to arrive in a <quote>running</quote>
319
353
            state before proceeding.  During this time, the kernel log
320
354
            level will be lowered to reduce clutter on the system
437
471
  
438
472
  <refsect1 id="environment">
439
473
    <title>ENVIRONMENT</title>
 
474
    <variablelist>
 
475
      <varlistentry>
 
476
        <term><envar>MANDOSPLUGINHELPERDIR</envar></term>
 
477
        <listitem>
 
478
          <para>
 
479
            This environment variable will be assumed to contain the
 
480
            directory containing any helper executables.  The use and
 
481
            nature of these helper executables, if any, is
 
482
            purposefully not documented.
 
483
        </para>
 
484
        </listitem>
 
485
      </varlistentry>
 
486
    </variablelist>
440
487
    <para>
441
 
      This program does not use any environment variables, not even
442
 
      the ones provided by <citerefentry><refentrytitle
 
488
      This program does not use any other environment variables, not
 
489
      even the ones provided by <citerefentry><refentrytitle
443
490
      >cryptsetup</refentrytitle><manvolnum>8</manvolnum>
444
491
    </citerefentry>.
445
492
    </para>
507
554
              It is not necessary to print any non-executable files
508
555
              already in the network hook directory, these will be
509
556
              copied implicitly if they otherwise satisfy the name
510
 
              requirement.
 
557
              requirements.
511
558
            </para>
512
559
          </listitem>
513
560
        </varlistentry>
547
594
          <term><envar>DEVICE</envar></term>
548
595
          <listitem>
549
596
            <para>
550
 
              The network interface, as specified to
 
597
              The network interfaces, as specified to
551
598
              <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.
 
599
              <option>--interface</option> option, combined to one
 
600
              string and separated by commas.  If this is set, and
 
601
              does not contain the interface a hook will bring up,
 
602
              there is no reason for a hook to continue.
555
603
            </para>
556
604
          </listitem>
557
605
        </varlistentry>
660
708
    </para>
661
709
    <informalexample>
662
710
      <para>
663
 
        Normal invocation needs no options, if the network interface
 
711
        Normal invocation needs no options, if the network interfaces
664
712
        can be automatically determined:
665
713
      </para>
666
714
      <para>
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
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>