/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 "2017-02-23">
 
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>2010</year>
37
36
      <year>2011</year>
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
37
      <holder>Teddy Hogeborn</holder>
45
38
      <holder>Björn Påhlsson</holder>
46
39
    </copyright>
71
64
        ><replaceable>PORT</replaceable></option></arg>
72
65
      </group>
73
66
      <sbr/>
74
 
      <group rep='repeat'>
 
67
      <group>
75
68
        <arg choice="plain"><option>--interface
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>
 
69
        <replaceable>NAME</replaceable></option></arg>
 
70
        <arg choice="plain"><option>-i
 
71
        <replaceable>NAME</replaceable></option></arg>
81
72
      </group>
82
73
      <sbr/>
83
74
      <group>
103
94
      </arg>
104
95
      <sbr/>
105
96
      <arg>
106
 
        <option>--dh-params <replaceable>FILE</replaceable></option>
107
 
      </arg>
108
 
      <sbr/>
109
 
      <arg>
110
97
        <option>--delay <replaceable>SECONDS</replaceable></option>
111
98
      </arg>
112
99
      <sbr/>
150
137
      communicates with <citerefentry><refentrytitle
151
138
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>
152
139
      to get a password.  In slightly more detail, this client program
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
 
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
157
144
      confidentiality.  This client program keeps running, trying all
158
145
      servers on the network, until it receives a satisfactory reply
159
146
      or a TERM signal.  After all servers have been tried, all
161
148
      will wait indefinitely for new servers to appear.
162
149
    </para>
163
150
    <para>
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
 
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
170
157
      <citerefentry><refentrytitle>netdevice</refentrytitle>
171
158
      <manvolnum>7</manvolnum></citerefentry>).  (If the
172
159
      <option>--connect</option> option is used, point-to-point
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).
 
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).
176
165
    </para>
177
166
    <para>
178
 
      Before network interfaces are selected, all <quote>network
 
167
      Before a network interface is selected, all <quote>network
179
168
      hooks</quote> are run; see <xref linkend="network-hooks"/>.
180
169
    </para>
181
170
    <para>
229
218
            assumed to separate the address from the port number.
230
219
          </para>
231
220
          <para>
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.
 
221
            This option is normally only useful for testing and
 
222
            debugging.
235
223
          </para>
236
224
        </listitem>
237
225
      </varlistentry>
238
226
      
239
227
      <varlistentry>
240
228
        <term><option>--interface=<replaceable
241
 
        >NAME</replaceable><arg rep='repeat'>,<replaceable
242
 
        >NAME</replaceable></arg></option></term>
 
229
        >NAME</replaceable></option></term>
243
230
        <term><option>-i
244
 
        <replaceable>NAME</replaceable><arg rep='repeat'>,<replaceable
245
 
        >NAME</replaceable></arg></option></term>
 
231
        <replaceable>NAME</replaceable></option></term>
246
232
        <listitem>
247
233
          <para>
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.
 
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.
252
238
          </para>
253
239
          <para>
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.
 
240
            If the <option>--connect</option> option is used, this
 
241
            specifies the interface to use to connect to the address
 
242
            given.
258
243
          </para>
259
244
          <para>
260
245
            Note that since this program will normally run in the
261
246
            initial RAM disk environment, the interface must be an
262
247
            interface which exists at that stage.  Thus, the interface
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"/>.
 
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"/>.
269
253
          </para>
270
254
          <para>
271
255
            <replaceable>NAME</replaceable> can be the string
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.
 
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.
276
260
          </para>
277
261
        </listitem>
278
262
      </varlistentry>
320
304
        <listitem>
321
305
          <para>
322
306
            Sets the number of bits to use for the prime number in the
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.
 
307
            TLS Diffie-Hellman key exchange.  Default is 1024.
344
308
          </para>
345
309
        </listitem>
346
310
      </varlistentry>
350
314
        >SECONDS</replaceable></option></term>
351
315
        <listitem>
352
316
          <para>
353
 
            After bringing a network interface up, the program waits
 
317
            After bringing the network interface up, the program waits
354
318
            for the interface to arrive in a <quote>running</quote>
355
319
            state before proceeding.  During this time, the kernel log
356
320
            level will be lowered to reduce clutter on the system
473
437
  
474
438
  <refsect1 id="environment">
475
439
    <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>
489
440
    <para>
490
 
      This program does not use any other environment variables, not
491
 
      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
492
443
      >cryptsetup</refentrytitle><manvolnum>8</manvolnum>
493
444
    </citerefentry>.
494
445
    </para>
517
468
      <para>
518
469
        A network hook must be an executable file, and its name must
519
470
        consist entirely of upper and lower case letters, digits,
520
 
        underscores, periods, and hyphens.
 
471
        underscores, and hyphens.
521
472
      </para>
522
473
      <para>
523
474
        A network hook will receive one argument, which can be one of
546
497
          <term><literal>files</literal></term>
547
498
          <listitem>
548
499
            <para>
549
 
              This should make the network hook print, <emphasis>one
550
 
              file per line</emphasis>, all the files needed for it to
551
 
              run.  (These files will be copied into the initial RAM
552
 
              filesystem.)  Typical use is for a network hook which is
553
 
              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.
554
505
            </para>
555
506
            <para>
556
507
              It is not necessary to print any non-executable files
557
508
              already in the network hook directory, these will be
558
509
              copied implicitly if they otherwise satisfy the name
559
 
              requirements.
560
 
            </para>
561
 
          </listitem>
562
 
        </varlistentry>
563
 
        <varlistentry>
564
 
          <term><literal>modules</literal></term>
565
 
          <listitem>
566
 
            <para>
567
 
              This should make the network hook print, <emphasis>on
568
 
              separate lines</emphasis>, all the kernel modules needed
569
 
              for it to run.  (These modules will be copied into the
570
 
              initial RAM filesystem.)  For instance, a tunnel
571
 
              interface needs the
572
 
              <quote><literal>tun</literal></quote> module.
 
510
              requirement.
573
511
            </para>
574
512
          </listitem>
575
513
        </varlistentry>
587
525
              <command>&COMMANDNAME;</command> by the
588
526
              <option>--network-hook-dir</option> option.  Note: this
589
527
              should <emphasis>always</emphasis> be used by the
590
 
              network hook to refer to itself or any files in the hook
591
 
              directory it may require.
 
528
              network hook to refer to itself or any files it may
 
529
              require.
592
530
            </para>
593
531
          </listitem>
594
532
        </varlistentry>
596
534
          <term><envar>DEVICE</envar></term>
597
535
          <listitem>
598
536
            <para>
599
 
              The network interfaces, as specified to
 
537
              The network interface, as specified to
600
538
              <command>&COMMANDNAME;</command> by the
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.
 
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.
605
542
            </para>
606
543
          </listitem>
607
544
        </varlistentry>
611
548
            <para>
612
549
              This will be the same as the first argument;
613
550
              i.e. <quote><literal>start</literal></quote>,
614
 
              <quote><literal>stop</literal></quote>,
615
 
              <quote><literal>files</literal></quote>, or
616
 
              <quote><literal>modules</literal></quote>.
 
551
              <quote><literal>stop</literal></quote>, or
 
552
              <quote><literal>files</literal></quote>.
617
553
            </para>
618
554
          </listitem>
619
555
        </varlistentry>
633
569
          <listitem>
634
570
            <para>
635
571
              This will be the same as the <option>--delay</option>
636
 
              option passed to <command>&COMMANDNAME;</command>.  Is
637
 
              only set if <envar>MODE</envar> is
638
 
              <quote><literal>start</literal></quote> or
639
 
              <quote><literal>stop</literal></quote>.
640
 
            </para>
641
 
          </listitem>
642
 
        </varlistentry>
643
 
        <varlistentry>
644
 
          <term><envar>CONNECT</envar></term>
645
 
          <listitem>
646
 
            <para>
647
 
              This will be the same as the <option>--connect</option>
648
 
              option passed to <command>&COMMANDNAME;</command>.  Is
649
 
              only set if <option>--connect</option> is passed and
650
 
              <envar>MODE</envar> is
651
 
              <quote><literal>start</literal></quote> or
652
 
              <quote><literal>stop</literal></quote>.
 
572
              option passed to <command>&COMMANDNAME;</command>.
653
573
            </para>
654
574
          </listitem>
655
575
        </varlistentry>
694
614
    </variablelist>
695
615
  </refsect1>
696
616
  
697
 
  <refsect1 id="bugs">
698
 
    <title>BUGS</title>
699
 
    <xi:include href="../bugs.xml"/>
700
 
  </refsect1>
 
617
<!--   <refsect1 id="bugs"> -->
 
618
<!--     <title>BUGS</title> -->
 
619
<!--     <para> -->
 
620
<!--     </para> -->
 
621
<!--   </refsect1> -->
701
622
  
702
623
  <refsect1 id="example">
703
624
    <title>EXAMPLE</title>
709
630
    </para>
710
631
    <informalexample>
711
632
      <para>
712
 
        Normal invocation needs no options, if the network interfaces
713
 
        can be automatically determined:
 
633
        Normal invocation needs no options, if the network interface
 
634
        is <quote>eth0</quote>:
714
635
      </para>
715
636
      <para>
716
637
        <userinput>&COMMANDNAME;</userinput>
718
639
    </informalexample>
719
640
    <informalexample>
720
641
      <para>
721
 
        Search for Mandos servers (and connect to them) using one
722
 
        specific interface:
 
642
        Search for Mandos servers (and connect to them) using another
 
643
        interface:
723
644
      </para>
724
645
      <para>
725
646
        <!-- do not wrap this line -->
789
710
    <para>
790
711
      It will also help if the checker program on the server is
791
712
      configured to request something from the client which can not be
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.
 
713
      spoofed by someone else on the network, unlike unencrypted
 
714
      <acronym>ICMP</acronym> echo (<quote>ping</quote>) replies.
795
715
    </para>
796
716
    <para>
797
717
      <emphasis>Note</emphasis>: This makes it completely insecure to
843
763
      </varlistentry>
844
764
      <varlistentry>
845
765
        <term>
846
 
          <ulink url="https://www.gnutls.org/">GnuTLS</ulink>
 
766
          <ulink url="http://www.gnu.org/software/gnutls/"
 
767
          >GnuTLS</ulink>
847
768
        </term>
848
769
      <listitem>
849
770
        <para>
855
776
      </varlistentry>
856
777
      <varlistentry>
857
778
        <term>
858
 
          <ulink url="https://www.gnupg.org/related_software/gpgme/"
 
779
          <ulink url="http://www.gnupg.org/related_software/gpgme/"
859
780
                 >GPGME</ulink>
860
781
        </term>
861
782
        <listitem>
889
810
              <para>
890
811
                This client uses IPv6 link-local addresses, which are
891
812
                immediately usable since a link-local addresses is
892
 
                automatically assigned to a network interface when it
 
813
                automatically assigned to a network interfaces when it
893
814
                is brought up.
894
815
              </para>
895
816
            </listitem>
899
820
      </varlistentry>
900
821
      <varlistentry>
901
822
        <term>
902
 
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
903
 
          Protocol Version 1.2</citetitle>
 
823
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
824
          Protocol Version 1.1</citetitle>
904
825
        </term>
905
826
      <listitem>
906
827
        <para>
907
 
          TLS 1.2 is the protocol implemented by GnuTLS.
 
828
          TLS 1.1 is the protocol implemented by GnuTLS.
908
829
        </para>
909
830
      </listitem>
910
831
      </varlistentry>
921
842
      </varlistentry>
922
843
      <varlistentry>
923
844
        <term>
924
 
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
 
845
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
925
846
          Security</citetitle>
926
847
        </term>
927
848
      <listitem>