/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

* debian/mandos-client.README.Debian: Document network hook facility.
* debian/mandos-client.docs (network-hooks.d): Added.
* initramfs-tools-hook: Also pass VERBOSITY to network hook.
* plugins.d/mandos-client.xml (DESCRIPTION): Document network
                                             interface selection
                                             algorithm.
  (OPTIONS/--interface): Refer to NETWORK HOOKS section.
  (OVERVIEW): Refer to password-prompt(8mandos) explicitly.
  (NETWORK HOOKS): New section.
  (FILES): Add "/lib/mandos/network-hooks.d".

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 "2015-07-08">
 
5
<!ENTITY TIMESTAMP "2011-11-27">
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>2012</year>
37
 
      <year>2013</year>
38
 
      <year>2014</year>
39
 
      <year>2015</year>
 
36
      <year>2011</year>
40
37
      <holder>Teddy Hogeborn</holder>
41
38
      <holder>Björn Påhlsson</holder>
42
39
    </copyright>
67
64
        ><replaceable>PORT</replaceable></option></arg>
68
65
      </group>
69
66
      <sbr/>
70
 
      <group rep='repeat'>
 
67
      <group>
71
68
        <arg choice="plain"><option>--interface
72
 
        <replaceable>NAME</replaceable><arg rep='repeat'
73
 
        >,<replaceable>NAME</replaceable></arg></option></arg>
74
 
        <arg choice="plain"><option>-i <replaceable>NAME</replaceable
75
 
        ><arg rep='repeat'>,<replaceable>NAME</replaceable></arg
76
 
        ></option></arg>
 
69
        <replaceable>NAME</replaceable></option></arg>
 
70
        <arg choice="plain"><option>-i
 
71
        <replaceable>NAME</replaceable></option></arg>
77
72
      </group>
78
73
      <sbr/>
79
74
      <group>
99
94
      </arg>
100
95
      <sbr/>
101
96
      <arg>
102
 
        <option>--dh-params <replaceable>FILE</replaceable></option>
103
 
      </arg>
104
 
      <sbr/>
105
 
      <arg>
106
97
        <option>--delay <replaceable>SECONDS</replaceable></option>
107
98
      </arg>
108
99
      <sbr/>
146
137
      communicates with <citerefentry><refentrytitle
147
138
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>
148
139
      to get a password.  In slightly more detail, this client program
149
 
      brings up network interfaces, uses the interfaces’ IPv6
150
 
      link-local addresses to get network connectivity, uses Zeroconf
151
 
      to find servers on the local network, and communicates with
152
 
      servers using TLS with an OpenPGP key to ensure authenticity and
 
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
144
      confidentiality.  This client program keeps running, trying all
154
145
      servers on the network, until it receives a satisfactory reply
155
146
      or a TERM signal.  After all servers have been tried, all
157
148
      will wait indefinitely for new servers to appear.
158
149
    </para>
159
150
    <para>
160
 
      The network interfaces are selected like this: If any interfaces
161
 
      are specified using the <option>--interface</option> option,
162
 
      those interface are used.  Otherwise,
163
 
      <command>&COMMANDNAME;</command> will use all interfaces that
164
 
      are not loopback interfaces, are not point-to-point interfaces,
165
 
      are capable of broadcasting and do not have the NOARP flag (see
 
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
166
157
      <citerefentry><refentrytitle>netdevice</refentrytitle>
167
158
      <manvolnum>7</manvolnum></citerefentry>).  (If the
168
159
      <option>--connect</option> option is used, point-to-point
169
 
      interfaces and non-broadcast interfaces are accepted.)  If any
170
 
      used interfaces are not up and running, they are first taken up
171
 
      (and later taken down again on program exit).
 
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
165
    </para>
173
166
    <para>
174
 
      Before network interfaces are selected, all <quote>network
 
167
      Before a network interface is selected, all <quote>network
175
168
      hooks</quote> are run; see <xref linkend="network-hooks"/>.
176
169
    </para>
177
170
    <para>
225
218
            assumed to separate the address from the port number.
226
219
          </para>
227
220
          <para>
228
 
            Normally, Zeroconf would be used to locate Mandos servers,
229
 
            in which case this option would only be used when testing
230
 
            and debugging.
 
221
            This option is normally only useful for testing and
 
222
            debugging.
231
223
          </para>
232
224
        </listitem>
233
225
      </varlistentry>
234
226
      
235
227
      <varlistentry>
236
228
        <term><option>--interface=<replaceable
237
 
        >NAME</replaceable><arg rep='repeat'>,<replaceable
238
 
        >NAME</replaceable></arg></option></term>
 
229
        >NAME</replaceable></option></term>
239
230
        <term><option>-i
240
 
        <replaceable>NAME</replaceable><arg rep='repeat'>,<replaceable
241
 
        >NAME</replaceable></arg></option></term>
 
231
        <replaceable>NAME</replaceable></option></term>
242
232
        <listitem>
243
233
          <para>
244
 
            Comma separated list of network interfaces that will be
245
 
            brought up and scanned for Mandos servers to connect to.
246
 
            The default is the empty string, which will automatically
247
 
            use all appropriate interfaces.
 
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
238
          </para>
249
239
          <para>
250
 
            If the <option>--connect</option> option is used, and
251
 
            exactly one interface name is specified (except
252
 
            <quote><literal>none</literal></quote>), this specifies
253
 
            the interface to use to connect to the address given.
 
240
            If the <option>--connect</option> option is used, this
 
241
            specifies the interface to use to connect to the address
 
242
            given.
254
243
          </para>
255
244
          <para>
256
245
            Note that since this program will normally run in the
257
246
            initial RAM disk environment, the interface must be an
258
247
            interface which exists at that stage.  Thus, the interface
259
 
            can normally not be a pseudo-interface such as
260
 
            <quote>br0</quote> or <quote>tun0</quote>; such interfaces
261
 
            will not exist until much later in the boot process, and
262
 
            can not be used by this program, unless created by a
263
 
            <quote>network hook</quote> — see <xref
264
 
            linkend="network-hooks"/>.
 
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"/>.
265
253
          </para>
266
254
          <para>
267
255
            <replaceable>NAME</replaceable> can be the string
268
 
            <quote><literal>none</literal></quote>; this will make
269
 
            <command>&COMMANDNAME;</command> only bring up interfaces
270
 
            specified <emphasis>before</emphasis> this string.  This
271
 
            is not recommended, and only meant for advanced users.
 
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
260
          </para>
273
261
        </listitem>
274
262
      </varlistentry>
316
304
        <listitem>
317
305
          <para>
318
306
            Sets the number of bits to use for the prime number in the
319
 
            TLS Diffie-Hellman key exchange.  The default value is
320
 
            selected automatically based on the OpenPGP key.  Note
321
 
            that if the <option>--dh-params</option> option is used,
322
 
            the values from that file will be used instead.
323
 
          </para>
324
 
        </listitem>
325
 
      </varlistentry>
326
 
      
327
 
      <varlistentry>
328
 
        <term><option>--dh-params=<replaceable
329
 
        >FILE</replaceable></option></term>
330
 
        <listitem>
331
 
          <para>
332
 
            Specifies a PEM-encoded PKCS#3 file to read the parameters
333
 
            needed by the TLS Diffie-Hellman key exchange from.  If
334
 
            this option is not given, or if the file for some reason
335
 
            could not be used, the parameters will be generated on
336
 
            startup, which will take some time and processing power.
337
 
            Those using servers running under time, power or processor
338
 
            constraints may want to generate such a file in advance
339
 
            and use this option.
 
307
            TLS Diffie-Hellman key exchange.  Default is 1024.
340
308
          </para>
341
309
        </listitem>
342
310
      </varlistentry>
346
314
        >SECONDS</replaceable></option></term>
347
315
        <listitem>
348
316
          <para>
349
 
            After bringing a network interface up, the program waits
 
317
            After bringing the network interface up, the program waits
350
318
            for the interface to arrive in a <quote>running</quote>
351
319
            state before proceeding.  During this time, the kernel log
352
320
            level will be lowered to reduce clutter on the system
469
437
  
470
438
  <refsect1 id="environment">
471
439
    <title>ENVIRONMENT</title>
472
 
    <variablelist>
473
 
      <varlistentry>
474
 
        <term><envar>MANDOSPLUGINHELPERDIR</envar></term>
475
 
        <listitem>
476
 
          <para>
477
 
            This environment variable will be assumed to contain the
478
 
            directory containing any helper executables.  The use and
479
 
            nature of these helper executables, if any, is
480
 
            purposefully not documented.
481
 
        </para>
482
 
        </listitem>
483
 
      </varlistentry>
484
 
    </variablelist>
485
440
    <para>
486
 
      This program does not use any other environment variables, not
487
 
      even the ones provided by <citerefentry><refentrytitle
 
441
      This program does not use any environment variables, not even
 
442
      the ones provided by <citerefentry><refentrytitle
488
443
      >cryptsetup</refentrytitle><manvolnum>8</manvolnum>
489
444
    </citerefentry>.
490
445
    </para>
513
468
      <para>
514
469
        A network hook must be an executable file, and its name must
515
470
        consist entirely of upper and lower case letters, digits,
516
 
        underscores, periods, and hyphens.
 
471
        underscores, and hyphens.
517
472
      </para>
518
473
      <para>
519
474
        A network hook will receive one argument, which can be one of
542
497
          <term><literal>files</literal></term>
543
498
          <listitem>
544
499
            <para>
545
 
              This should make the network hook print, <emphasis>one
546
 
              file per line</emphasis>, all the files needed for it to
547
 
              run.  (These files will be copied into the initial RAM
548
 
              filesystem.)  Typical use is for a network hook which is
549
 
              a shell script to print its needed binaries.
 
500
              This should make the network hook print, <emphasis>on
 
501
              separate lines</emphasis>, all the files needed for it
 
502
              to run.  (These files will be copied into the initial
 
503
              RAM filesystem.)  Intended use is for a network hook
 
504
              which is a shell script to print its needed binaries.
550
505
            </para>
551
506
            <para>
552
507
              It is not necessary to print any non-executable files
553
508
              already in the network hook directory, these will be
554
509
              copied implicitly if they otherwise satisfy the name
555
 
              requirements.
556
 
            </para>
557
 
          </listitem>
558
 
        </varlistentry>
559
 
        <varlistentry>
560
 
          <term><literal>modules</literal></term>
561
 
          <listitem>
562
 
            <para>
563
 
              This should make the network hook print, <emphasis>on
564
 
              separate lines</emphasis>, all the kernel modules needed
565
 
              for it to run.  (These modules will be copied into the
566
 
              initial RAM filesystem.)  For instance, a tunnel
567
 
              interface needs the
568
 
              <quote><literal>tun</literal></quote> module.
 
510
              requirement.
569
511
            </para>
570
512
          </listitem>
571
513
        </varlistentry>
583
525
              <command>&COMMANDNAME;</command> by the
584
526
              <option>--network-hook-dir</option> option.  Note: this
585
527
              should <emphasis>always</emphasis> be used by the
586
 
              network hook to refer to itself or any files in the hook
587
 
              directory it may require.
 
528
              network hook to refer to itself or any files it may
 
529
              require.
588
530
            </para>
589
531
          </listitem>
590
532
        </varlistentry>
592
534
          <term><envar>DEVICE</envar></term>
593
535
          <listitem>
594
536
            <para>
595
 
              The network interfaces, as specified to
 
537
              The network interface, as specified to
596
538
              <command>&COMMANDNAME;</command> by the
597
 
              <option>--interface</option> option, combined to one
598
 
              string and separated by commas.  If this is set, and
599
 
              does not contain the interface a hook will bring up,
600
 
              there is no reason for a hook to continue.
 
539
              <option>--interface</option> option.  If this is not the
 
540
              interface a hook will bring up, there is no reason for a
 
541
              hook to continue.
601
542
            </para>
602
543
          </listitem>
603
544
        </varlistentry>
607
548
            <para>
608
549
              This will be the same as the first argument;
609
550
              i.e. <quote><literal>start</literal></quote>,
610
 
              <quote><literal>stop</literal></quote>,
611
 
              <quote><literal>files</literal></quote>, or
612
 
              <quote><literal>modules</literal></quote>.
 
551
              <quote><literal>stop</literal></quote>, or
 
552
              <quote><literal>files</literal></quote>.
613
553
            </para>
614
554
          </listitem>
615
555
        </varlistentry>
629
569
          <listitem>
630
570
            <para>
631
571
              This will be the same as the <option>--delay</option>
632
 
              option passed to <command>&COMMANDNAME;</command>.  Is
633
 
              only set if <envar>MODE</envar> is
634
 
              <quote><literal>start</literal></quote> or
635
 
              <quote><literal>stop</literal></quote>.
636
 
            </para>
637
 
          </listitem>
638
 
        </varlistentry>
639
 
        <varlistentry>
640
 
          <term><envar>CONNECT</envar></term>
641
 
          <listitem>
642
 
            <para>
643
 
              This will be the same as the <option>--connect</option>
644
 
              option passed to <command>&COMMANDNAME;</command>.  Is
645
 
              only set if <option>--connect</option> is passed and
646
 
              <envar>MODE</envar> is
647
 
              <quote><literal>start</literal></quote> or
648
 
              <quote><literal>stop</literal></quote>.
 
572
              option passed to <command>&COMMANDNAME;</command>.
649
573
            </para>
650
574
          </listitem>
651
575
        </varlistentry>
706
630
    </para>
707
631
    <informalexample>
708
632
      <para>
709
 
        Normal invocation needs no options, if the network interfaces
710
 
        can be automatically determined:
 
633
        Normal invocation needs no options, if the network interface
 
634
        is <quote>eth0</quote>:
711
635
      </para>
712
636
      <para>
713
637
        <userinput>&COMMANDNAME;</userinput>
715
639
    </informalexample>
716
640
    <informalexample>
717
641
      <para>
718
 
        Search for Mandos servers (and connect to them) using one
719
 
        specific interface:
 
642
        Search for Mandos servers (and connect to them) using another
 
643
        interface:
720
644
      </para>
721
645
      <para>
722
646
        <!-- do not wrap this line -->
786
710
    <para>
787
711
      It will also help if the checker program on the server is
788
712
      configured to request something from the client which can not be
789
 
      spoofed by someone else on the network, like SSH server key
790
 
      fingerprints, and unlike unencrypted <acronym>ICMP</acronym>
791
 
      echo (<quote>ping</quote>) replies.
 
713
      spoofed by someone else on the network, unlike unencrypted
 
714
      <acronym>ICMP</acronym> echo (<quote>ping</quote>) replies.
792
715
    </para>
793
716
    <para>
794
717
      <emphasis>Note</emphasis>: This makes it completely insecure to
887
810
              <para>
888
811
                This client uses IPv6 link-local addresses, which are
889
812
                immediately usable since a link-local addresses is
890
 
                automatically assigned to a network interface when it
 
813
                automatically assigned to a network interfaces when it
891
814
                is brought up.
892
815
              </para>
893
816
            </listitem>