/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

* initramfs-tools-hook: Install network hooks (and any required files)
                        in the initramfs image.
* plugins.d/mandos-client.c (main): Also set MANDOSNETHOOKDIR for
                                    network hooks.
* plugins.d/mandos-client.xml (OPTIONS): Use <filename
                                         class="directory">, not
                                         <directory>.

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 "2018-02-08">
 
5
<!ENTITY TIMESTAMP "2011-10-03">
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
 
      <year>2018</year>
45
37
      <holder>Teddy Hogeborn</holder>
46
38
      <holder>Björn Påhlsson</holder>
47
39
    </copyright>
72
64
        ><replaceable>PORT</replaceable></option></arg>
73
65
      </group>
74
66
      <sbr/>
75
 
      <group rep='repeat'>
 
67
      <group>
76
68
        <arg choice="plain"><option>--interface
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>
 
69
        <replaceable>NAME</replaceable></option></arg>
 
70
        <arg choice="plain"><option>-i
 
71
        <replaceable>NAME</replaceable></option></arg>
82
72
      </group>
83
73
      <sbr/>
84
74
      <group>
104
94
      </arg>
105
95
      <sbr/>
106
96
      <arg>
107
 
        <option>--dh-params <replaceable>FILE</replaceable></option>
108
 
      </arg>
109
 
      <sbr/>
110
 
      <arg>
111
97
        <option>--delay <replaceable>SECONDS</replaceable></option>
112
98
      </arg>
113
99
      <sbr/>
116
102
      </arg>
117
103
      <sbr/>
118
104
      <arg>
119
 
        <option>--network-hook-dir
120
 
        <replaceable>DIR</replaceable></option>
 
105
        <option>--network-hook-dir<replaceable>DIR</replaceable></option>
121
106
      </arg>
122
107
      <sbr/>
123
108
      <arg>
151
136
      communicates with <citerefentry><refentrytitle
152
137
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>
153
138
      to get a password.  In slightly more detail, this client program
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
 
139
      brings up a network interface, uses the interface’s IPv6
 
140
      link-local address to get network connectivity, uses Zeroconf to
 
141
      find servers on the local network, and communicates with servers
 
142
      using TLS with an OpenPGP key to ensure authenticity and
158
143
      confidentiality.  This client program keeps running, trying all
159
144
      servers on the network, until it receives a satisfactory reply
160
145
      or a TERM signal.  After all servers have been tried, all
162
147
      will wait indefinitely for new servers to appear.
163
148
    </para>
164
149
    <para>
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
171
 
      <citerefentry><refentrytitle>netdevice</refentrytitle>
172
 
      <manvolnum>7</manvolnum></citerefentry>).  (If the
173
 
      <option>--connect</option> option is used, point-to-point
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).
177
 
    </para>
178
 
    <para>
179
 
      Before network interfaces are selected, all <quote>network
180
 
      hooks</quote> are run; see <xref linkend="network-hooks"/>.
181
 
    </para>
182
 
    <para>
183
150
      This program is not meant to be run directly; it is really meant
184
151
      to run as a plugin of the <application>Mandos</application>
185
152
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
230
197
            assumed to separate the address from the port number.
231
198
          </para>
232
199
          <para>
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.
 
200
            This option is normally only useful for testing and
 
201
            debugging.
236
202
          </para>
237
203
        </listitem>
238
204
      </varlistentry>
239
205
      
240
206
      <varlistentry>
241
207
        <term><option>--interface=<replaceable
242
 
        >NAME</replaceable><arg rep='repeat'>,<replaceable
243
 
        >NAME</replaceable></arg></option></term>
 
208
        >NAME</replaceable></option></term>
244
209
        <term><option>-i
245
 
        <replaceable>NAME</replaceable><arg rep='repeat'>,<replaceable
246
 
        >NAME</replaceable></arg></option></term>
 
210
        <replaceable>NAME</replaceable></option></term>
247
211
        <listitem>
248
212
          <para>
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.
 
213
            Network interface that will be brought up and scanned for
 
214
            Mandos servers to connect to.  The default is the empty
 
215
            string, which will automatically choose an appropriate
 
216
            interface.
253
217
          </para>
254
218
          <para>
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.
 
219
            If the <option>--connect</option> option is used, this
 
220
            specifies the interface to use to connect to the address
 
221
            given.
259
222
          </para>
260
223
          <para>
261
224
            Note that since this program will normally run in the
262
225
            initial RAM disk environment, the interface must be an
263
226
            interface which exists at that stage.  Thus, the interface
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"/>.
 
227
            can not be a pseudo-interface such as <quote>br0</quote>
 
228
            or <quote>tun0</quote>; such interfaces will not exist
 
229
            until much later in the boot process, and can not be used
 
230
            by this program.
270
231
          </para>
271
232
          <para>
272
233
            <replaceable>NAME</replaceable> can be the string
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.
 
234
            <quote><literal>none</literal></quote>; this will not use
 
235
            any specific interface, and will not bring up an interface
 
236
            on startup.  This is not recommended, and only meant for
 
237
            advanced users.
277
238
          </para>
278
239
        </listitem>
279
240
      </varlistentry>
321
282
        <listitem>
322
283
          <para>
323
284
            Sets the number of bits to use for the prime number in the
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.
 
285
            TLS Diffie-Hellman key exchange.  Default is 1024.
345
286
          </para>
346
287
        </listitem>
347
288
      </varlistentry>
351
292
        >SECONDS</replaceable></option></term>
352
293
        <listitem>
353
294
          <para>
354
 
            After bringing a network interface up, the program waits
 
295
            After bringing the network interface up, the program waits
355
296
            for the interface to arrive in a <quote>running</quote>
356
297
            state before proceeding.  During this time, the kernel log
357
298
            level will be lowered to reduce clutter on the system
452
393
      <refentrytitle>plugin-runner</refentrytitle>
453
394
      <manvolnum>8mandos</manvolnum></citerefentry>) is used to run
454
395
      both this program and others in in parallel,
455
 
      <emphasis>one</emphasis> of which (<citerefentry>
456
 
      <refentrytitle>password-prompt</refentrytitle>
457
 
      <manvolnum>8mandos</manvolnum></citerefentry>) will prompt for
458
 
      passwords on the system console.
 
396
      <emphasis>one</emphasis> of which will prompt for passwords on
 
397
      the system console.
459
398
    </para>
460
399
  </refsect1>
461
400
  
474
413
  
475
414
  <refsect1 id="environment">
476
415
    <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>
490
416
    <para>
491
 
      This program does not use any other environment variables, not
492
 
      even the ones provided by <citerefentry><refentrytitle
 
417
      This program does not use any environment variables, not even
 
418
      the ones provided by <citerefentry><refentrytitle
493
419
      >cryptsetup</refentrytitle><manvolnum>8</manvolnum>
494
420
    </citerefentry>.
495
421
    </para>
496
422
  </refsect1>
497
423
  
498
 
  <refsect1 id="network-hooks">
499
 
    <title>NETWORK HOOKS</title>
500
 
    <para>
501
 
      If a network interface like a bridge or tunnel is required to
502
 
      find a Mandos server, this requires the interface to be up and
503
 
      running before <command>&COMMANDNAME;</command> starts looking
504
 
      for Mandos servers.  This can be accomplished by creating a
505
 
      <quote>network hook</quote> program, and placing it in a special
506
 
      directory.
507
 
    </para>
508
 
    <para>
509
 
      Before the network is used (and again before program exit), any
510
 
      runnable programs found in the network hook directory are run
511
 
      with the argument <quote><literal>start</literal></quote> or
512
 
      <quote><literal>stop</literal></quote>.  This should bring up or
513
 
      down, respectively, any network interface which
514
 
      <command>&COMMANDNAME;</command> should use.
515
 
    </para>
516
 
    <refsect2 id="hook-requirements">
517
 
      <title>REQUIREMENTS</title>
518
 
      <para>
519
 
        A network hook must be an executable file, and its name must
520
 
        consist entirely of upper and lower case letters, digits,
521
 
        underscores, periods, and hyphens.
522
 
      </para>
523
 
      <para>
524
 
        A network hook will receive one argument, which can be one of
525
 
        the following:
526
 
      </para>
527
 
      <variablelist>
528
 
        <varlistentry>
529
 
          <term><literal>start</literal></term>
530
 
          <listitem>
531
 
            <para>
532
 
              This should make the network hook create (if necessary)
533
 
              and bring up a network interface.
534
 
            </para>
535
 
          </listitem>
536
 
        </varlistentry>
537
 
        <varlistentry>
538
 
          <term><literal>stop</literal></term>
539
 
          <listitem>
540
 
            <para>
541
 
              This should make the network hook take down a network
542
 
              interface, and delete it if it did not exist previously.
543
 
            </para>
544
 
          </listitem>
545
 
        </varlistentry>
546
 
        <varlistentry>
547
 
          <term><literal>files</literal></term>
548
 
          <listitem>
549
 
            <para>
550
 
              This should make the network hook print, <emphasis>one
551
 
              file per line</emphasis>, all the files needed for it to
552
 
              run.  (These files will be copied into the initial RAM
553
 
              filesystem.)  Typical use is for a network hook which is
554
 
              a shell script to print its needed binaries.
555
 
            </para>
556
 
            <para>
557
 
              It is not necessary to print any non-executable files
558
 
              already in the network hook directory, these will be
559
 
              copied implicitly if they otherwise satisfy the name
560
 
              requirements.
561
 
            </para>
562
 
          </listitem>
563
 
        </varlistentry>
564
 
        <varlistentry>
565
 
          <term><literal>modules</literal></term>
566
 
          <listitem>
567
 
            <para>
568
 
              This should make the network hook print, <emphasis>on
569
 
              separate lines</emphasis>, all the kernel modules needed
570
 
              for it to run.  (These modules will be copied into the
571
 
              initial RAM filesystem.)  For instance, a tunnel
572
 
              interface needs the
573
 
              <quote><literal>tun</literal></quote> module.
574
 
            </para>
575
 
          </listitem>
576
 
        </varlistentry>
577
 
      </variablelist>
578
 
      <para>
579
 
        The network hook will be provided with a number of environment
580
 
        variables:
581
 
      </para>
582
 
      <variablelist>
583
 
        <varlistentry>
584
 
          <term><envar>MANDOSNETHOOKDIR</envar></term>
585
 
          <listitem>
586
 
            <para>
587
 
              The network hook directory, specified to
588
 
              <command>&COMMANDNAME;</command> by the
589
 
              <option>--network-hook-dir</option> option.  Note: this
590
 
              should <emphasis>always</emphasis> be used by the
591
 
              network hook to refer to itself or any files in the hook
592
 
              directory it may require.
593
 
            </para>
594
 
          </listitem>
595
 
        </varlistentry>
596
 
        <varlistentry>
597
 
          <term><envar>DEVICE</envar></term>
598
 
          <listitem>
599
 
            <para>
600
 
              The network interfaces, as specified to
601
 
              <command>&COMMANDNAME;</command> by the
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.
606
 
            </para>
607
 
          </listitem>
608
 
        </varlistentry>
609
 
        <varlistentry>
610
 
          <term><envar>MODE</envar></term>
611
 
          <listitem>
612
 
            <para>
613
 
              This will be the same as the first argument;
614
 
              i.e. <quote><literal>start</literal></quote>,
615
 
              <quote><literal>stop</literal></quote>,
616
 
              <quote><literal>files</literal></quote>, or
617
 
              <quote><literal>modules</literal></quote>.
618
 
            </para>
619
 
          </listitem>
620
 
        </varlistentry>
621
 
        <varlistentry>
622
 
          <term><envar>VERBOSITY</envar></term>
623
 
          <listitem>
624
 
            <para>
625
 
              This will be the <quote><literal>1</literal></quote> if
626
 
              the <option>--debug</option> option is passed to
627
 
              <command>&COMMANDNAME;</command>, otherwise
628
 
              <quote><literal>0</literal></quote>.
629
 
            </para>
630
 
          </listitem>
631
 
        </varlistentry>
632
 
        <varlistentry>
633
 
          <term><envar>DELAY</envar></term>
634
 
          <listitem>
635
 
            <para>
636
 
              This will be the same as the <option>--delay</option>
637
 
              option passed to <command>&COMMANDNAME;</command>.  Is
638
 
              only set if <envar>MODE</envar> is
639
 
              <quote><literal>start</literal></quote> or
640
 
              <quote><literal>stop</literal></quote>.
641
 
            </para>
642
 
          </listitem>
643
 
        </varlistentry>
644
 
        <varlistentry>
645
 
          <term><envar>CONNECT</envar></term>
646
 
          <listitem>
647
 
            <para>
648
 
              This will be the same as the <option>--connect</option>
649
 
              option passed to <command>&COMMANDNAME;</command>.  Is
650
 
              only set if <option>--connect</option> is passed and
651
 
              <envar>MODE</envar> is
652
 
              <quote><literal>start</literal></quote> or
653
 
              <quote><literal>stop</literal></quote>.
654
 
            </para>
655
 
          </listitem>
656
 
        </varlistentry>
657
 
      </variablelist>
658
 
      <para>
659
 
        A hook may not read from standard input, and should be
660
 
        restrictive in printing to standard output or standard error
661
 
        unless <varname>VERBOSITY</varname> is
662
 
        <quote><literal>1</literal></quote>.
663
 
      </para>
664
 
    </refsect2>
665
 
  </refsect1>
666
 
  
667
424
  <refsect1 id="files">
668
425
    <title>FILES</title>
669
426
    <variablelist>
681
438
          </para>
682
439
        </listitem>
683
440
      </varlistentry>
684
 
      <varlistentry>
685
 
        <term><filename
686
 
        class="directory">/lib/mandos/network-hooks.d</filename></term>
687
 
        <listitem>
688
 
          <para>
689
 
            Directory where network hooks are located.  Change this
690
 
            with the <option>--network-hook-dir</option> option.  See
691
 
            <xref linkend="network-hooks"/>.
692
 
          </para>
693
 
        </listitem>
694
 
      </varlistentry>
695
441
    </variablelist>
696
442
  </refsect1>
697
443
  
698
 
  <refsect1 id="bugs">
699
 
    <title>BUGS</title>
700
 
    <xi:include href="../bugs.xml"/>
701
 
  </refsect1>
 
444
<!--   <refsect1 id="bugs"> -->
 
445
<!--     <title>BUGS</title> -->
 
446
<!--     <para> -->
 
447
<!--     </para> -->
 
448
<!--   </refsect1> -->
702
449
  
703
450
  <refsect1 id="example">
704
451
    <title>EXAMPLE</title>
710
457
    </para>
711
458
    <informalexample>
712
459
      <para>
713
 
        Normal invocation needs no options, if the network interfaces
714
 
        can be automatically determined:
 
460
        Normal invocation needs no options, if the network interface
 
461
        is <quote>eth0</quote>:
715
462
      </para>
716
463
      <para>
717
464
        <userinput>&COMMANDNAME;</userinput>
719
466
    </informalexample>
720
467
    <informalexample>
721
468
      <para>
722
 
        Search for Mandos servers (and connect to them) using one
723
 
        specific interface:
 
469
        Search for Mandos servers (and connect to them) using another
 
470
        interface:
724
471
      </para>
725
472
      <para>
726
473
        <!-- do not wrap this line -->
790
537
    <para>
791
538
      It will also help if the checker program on the server is
792
539
      configured to request something from the client which can not be
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.
 
540
      spoofed by someone else on the network, unlike unencrypted
 
541
      <acronym>ICMP</acronym> echo (<quote>ping</quote>) replies.
796
542
    </para>
797
543
    <para>
798
544
      <emphasis>Note</emphasis>: This makes it completely insecure to
844
590
      </varlistentry>
845
591
      <varlistentry>
846
592
        <term>
847
 
          <ulink url="https://www.gnutls.org/">GnuTLS</ulink>
 
593
          <ulink url="http://www.gnu.org/software/gnutls/"
 
594
          >GnuTLS</ulink>
848
595
        </term>
849
596
      <listitem>
850
597
        <para>
856
603
      </varlistentry>
857
604
      <varlistentry>
858
605
        <term>
859
 
          <ulink url="https://www.gnupg.org/related_software/gpgme/"
 
606
          <ulink url="http://www.gnupg.org/related_software/gpgme/"
860
607
                 >GPGME</ulink>
861
608
        </term>
862
609
        <listitem>
890
637
              <para>
891
638
                This client uses IPv6 link-local addresses, which are
892
639
                immediately usable since a link-local addresses is
893
 
                automatically assigned to a network interface when it
 
640
                automatically assigned to a network interfaces when it
894
641
                is brought up.
895
642
              </para>
896
643
            </listitem>
900
647
      </varlistentry>
901
648
      <varlistentry>
902
649
        <term>
903
 
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
904
 
          Protocol Version 1.2</citetitle>
 
650
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
651
          Protocol Version 1.1</citetitle>
905
652
        </term>
906
653
      <listitem>
907
654
        <para>
908
 
          TLS 1.2 is the protocol implemented by GnuTLS.
 
655
          TLS 1.1 is the protocol implemented by GnuTLS.
909
656
        </para>
910
657
      </listitem>
911
658
      </varlistentry>
922
669
      </varlistentry>
923
670
      <varlistentry>
924
671
        <term>
925
 
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
 
672
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
926
673
          Security</citetitle>
927
674
        </term>
928
675
      <listitem>