/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

* plugins.d/mandos-client.c (runnable_hook): Add debug output.
 (run_network_hooks): Bug fix: Ignore quit_now.  Also add debug output.
 (main): Bug fix: Ignore return value from run_network_hooks when
         passing "stop".

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 "2014-06-22">
 
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>2012</year>
37
 
      <year>2013</year>
38
 
      <year>2014</year>
 
36
      <year>2011</year>
39
37
      <holder>Teddy Hogeborn</holder>
40
38
      <holder>Björn Påhlsson</holder>
41
39
    </copyright>
66
64
        ><replaceable>PORT</replaceable></option></arg>
67
65
      </group>
68
66
      <sbr/>
69
 
      <group rep='repeat'>
 
67
      <group>
70
68
        <arg choice="plain"><option>--interface
71
 
        <replaceable>NAME</replaceable><arg rep='repeat'
72
 
        >,<replaceable>NAME</replaceable></arg></option></arg>
73
 
        <arg choice="plain"><option>-i <replaceable>NAME</replaceable
74
 
        ><arg rep='repeat'>,<replaceable>NAME</replaceable></arg
75
 
        ></option></arg>
 
69
        <replaceable>NAME</replaceable></option></arg>
 
70
        <arg choice="plain"><option>-i
 
71
        <replaceable>NAME</replaceable></option></arg>
76
72
      </group>
77
73
      <sbr/>
78
74
      <group>
106
102
      </arg>
107
103
      <sbr/>
108
104
      <arg>
109
 
        <option>--network-hook-dir
110
 
        <replaceable>DIR</replaceable></option>
 
105
        <option>--network-hook-dir<replaceable>DIR</replaceable></option>
111
106
      </arg>
112
107
      <sbr/>
113
108
      <arg>
141
136
      communicates with <citerefentry><refentrytitle
142
137
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>
143
138
      to get a password.  In slightly more detail, this client program
144
 
      brings up network interfaces, uses the interfaces’ IPv6
145
 
      link-local addresses to get network connectivity, uses Zeroconf
146
 
      to find servers on the local network, and communicates with
147
 
      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
148
143
      confidentiality.  This client program keeps running, trying all
149
144
      servers on the network, until it receives a satisfactory reply
150
145
      or a TERM signal.  After all servers have been tried, all
152
147
      will wait indefinitely for new servers to appear.
153
148
    </para>
154
149
    <para>
155
 
      The network interfaces are selected like this: If any interfaces
156
 
      are specified using the <option>--interface</option> option,
157
 
      those interface are used.  Otherwise,
158
 
      <command>&COMMANDNAME;</command> will use all interfaces that
159
 
      are not loopback interfaces, are not point-to-point interfaces,
160
 
      are capable of broadcasting and do not have the NOARP flag (see
161
 
      <citerefentry><refentrytitle>netdevice</refentrytitle>
162
 
      <manvolnum>7</manvolnum></citerefentry>).  (If the
163
 
      <option>--connect</option> option is used, point-to-point
164
 
      interfaces and non-broadcast interfaces are accepted.)  If any
165
 
      used interfaces are not up and running, they are first taken up
166
 
      (and later taken down again on program exit).
167
 
    </para>
168
 
    <para>
169
 
      Before network interfaces are selected, all <quote>network
170
 
      hooks</quote> are run; see <xref linkend="network-hooks"/>.
171
 
    </para>
172
 
    <para>
173
150
      This program is not meant to be run directly; it is really meant
174
151
      to run as a plugin of the <application>Mandos</application>
175
152
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
220
197
            assumed to separate the address from the port number.
221
198
          </para>
222
199
          <para>
223
 
            Normally, Zeroconf would be used to locate Mandos servers,
224
 
            in which case this option would only be used when testing
225
 
            and debugging.
 
200
            This option is normally only useful for testing and
 
201
            debugging.
226
202
          </para>
227
203
        </listitem>
228
204
      </varlistentry>
229
205
      
230
206
      <varlistentry>
231
207
        <term><option>--interface=<replaceable
232
 
        >NAME</replaceable><arg rep='repeat'>,<replaceable
233
 
        >NAME</replaceable></arg></option></term>
 
208
        >NAME</replaceable></option></term>
234
209
        <term><option>-i
235
 
        <replaceable>NAME</replaceable><arg rep='repeat'>,<replaceable
236
 
        >NAME</replaceable></arg></option></term>
 
210
        <replaceable>NAME</replaceable></option></term>
237
211
        <listitem>
238
212
          <para>
239
 
            Comma separated list of network interfaces that will be
240
 
            brought up and scanned for Mandos servers to connect to.
241
 
            The default is the empty string, which will automatically
242
 
            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.
243
217
          </para>
244
218
          <para>
245
 
            If the <option>--connect</option> option is used, and
246
 
            exactly one interface name is specified (except
247
 
            <quote><literal>none</literal></quote>), this specifies
248
 
            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.
249
222
          </para>
250
223
          <para>
251
224
            Note that since this program will normally run in the
252
225
            initial RAM disk environment, the interface must be an
253
226
            interface which exists at that stage.  Thus, the interface
254
 
            can normally not be a pseudo-interface such as
255
 
            <quote>br0</quote> or <quote>tun0</quote>; such interfaces
256
 
            will not exist until much later in the boot process, and
257
 
            can not be used by this program, unless created by a
258
 
            <quote>network hook</quote> — see <xref
259
 
            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.
260
231
          </para>
261
232
          <para>
262
233
            <replaceable>NAME</replaceable> can be the string
263
 
            <quote><literal>none</literal></quote>; this will make
264
 
            <command>&COMMANDNAME;</command> only bring up interfaces
265
 
            specified <emphasis>before</emphasis> this string.  This
266
 
            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.
267
238
          </para>
268
239
        </listitem>
269
240
      </varlistentry>
321
292
        >SECONDS</replaceable></option></term>
322
293
        <listitem>
323
294
          <para>
324
 
            After bringing a network interface up, the program waits
 
295
            After bringing the network interface up, the program waits
325
296
            for the interface to arrive in a <quote>running</quote>
326
297
            state before proceeding.  During this time, the kernel log
327
298
            level will be lowered to reduce clutter on the system
422
393
      <refentrytitle>plugin-runner</refentrytitle>
423
394
      <manvolnum>8mandos</manvolnum></citerefentry>) is used to run
424
395
      both this program and others in in parallel,
425
 
      <emphasis>one</emphasis> of which (<citerefentry>
426
 
      <refentrytitle>password-prompt</refentrytitle>
427
 
      <manvolnum>8mandos</manvolnum></citerefentry>) will prompt for
428
 
      passwords on the system console.
 
396
      <emphasis>one</emphasis> of which will prompt for passwords on
 
397
      the system console.
429
398
    </para>
430
399
  </refsect1>
431
400
  
452
421
    </para>
453
422
  </refsect1>
454
423
  
455
 
  <refsect1 id="network-hooks">
456
 
    <title>NETWORK HOOKS</title>
457
 
    <para>
458
 
      If a network interface like a bridge or tunnel is required to
459
 
      find a Mandos server, this requires the interface to be up and
460
 
      running before <command>&COMMANDNAME;</command> starts looking
461
 
      for Mandos servers.  This can be accomplished by creating a
462
 
      <quote>network hook</quote> program, and placing it in a special
463
 
      directory.
464
 
    </para>
465
 
    <para>
466
 
      Before the network is used (and again before program exit), any
467
 
      runnable programs found in the network hook directory are run
468
 
      with the argument <quote><literal>start</literal></quote> or
469
 
      <quote><literal>stop</literal></quote>.  This should bring up or
470
 
      down, respectively, any network interface which
471
 
      <command>&COMMANDNAME;</command> should use.
472
 
    </para>
473
 
    <refsect2 id="hook-requirements">
474
 
      <title>REQUIREMENTS</title>
475
 
      <para>
476
 
        A network hook must be an executable file, and its name must
477
 
        consist entirely of upper and lower case letters, digits,
478
 
        underscores, periods, and hyphens.
479
 
      </para>
480
 
      <para>
481
 
        A network hook will receive one argument, which can be one of
482
 
        the following:
483
 
      </para>
484
 
      <variablelist>
485
 
        <varlistentry>
486
 
          <term><literal>start</literal></term>
487
 
          <listitem>
488
 
            <para>
489
 
              This should make the network hook create (if necessary)
490
 
              and bring up a network interface.
491
 
            </para>
492
 
          </listitem>
493
 
        </varlistentry>
494
 
        <varlistentry>
495
 
          <term><literal>stop</literal></term>
496
 
          <listitem>
497
 
            <para>
498
 
              This should make the network hook take down a network
499
 
              interface, and delete it if it did not exist previously.
500
 
            </para>
501
 
          </listitem>
502
 
        </varlistentry>
503
 
        <varlistentry>
504
 
          <term><literal>files</literal></term>
505
 
          <listitem>
506
 
            <para>
507
 
              This should make the network hook print, <emphasis>one
508
 
              file per line</emphasis>, all the files needed for it to
509
 
              run.  (These files will be copied into the initial RAM
510
 
              filesystem.)  Typical use is for a network hook which is
511
 
              a shell script to print its needed binaries.
512
 
            </para>
513
 
            <para>
514
 
              It is not necessary to print any non-executable files
515
 
              already in the network hook directory, these will be
516
 
              copied implicitly if they otherwise satisfy the name
517
 
              requirements.
518
 
            </para>
519
 
          </listitem>
520
 
        </varlistentry>
521
 
        <varlistentry>
522
 
          <term><literal>modules</literal></term>
523
 
          <listitem>
524
 
            <para>
525
 
              This should make the network hook print, <emphasis>on
526
 
              separate lines</emphasis>, all the kernel modules needed
527
 
              for it to run.  (These modules will be copied into the
528
 
              initial RAM filesystem.)  For instance, a tunnel
529
 
              interface needs the
530
 
              <quote><literal>tun</literal></quote> module.
531
 
            </para>
532
 
          </listitem>
533
 
        </varlistentry>
534
 
      </variablelist>
535
 
      <para>
536
 
        The network hook will be provided with a number of environment
537
 
        variables:
538
 
      </para>
539
 
      <variablelist>
540
 
        <varlistentry>
541
 
          <term><envar>MANDOSNETHOOKDIR</envar></term>
542
 
          <listitem>
543
 
            <para>
544
 
              The network hook directory, specified to
545
 
              <command>&COMMANDNAME;</command> by the
546
 
              <option>--network-hook-dir</option> option.  Note: this
547
 
              should <emphasis>always</emphasis> be used by the
548
 
              network hook to refer to itself or any files in the hook
549
 
              directory it may require.
550
 
            </para>
551
 
          </listitem>
552
 
        </varlistentry>
553
 
        <varlistentry>
554
 
          <term><envar>DEVICE</envar></term>
555
 
          <listitem>
556
 
            <para>
557
 
              The network interfaces, as specified to
558
 
              <command>&COMMANDNAME;</command> by the
559
 
              <option>--interface</option> option, combined to one
560
 
              string and separated by commas.  If this is set, and
561
 
              does not contain the interface a hook will bring up,
562
 
              there is no reason for a hook to continue.
563
 
            </para>
564
 
          </listitem>
565
 
        </varlistentry>
566
 
        <varlistentry>
567
 
          <term><envar>MODE</envar></term>
568
 
          <listitem>
569
 
            <para>
570
 
              This will be the same as the first argument;
571
 
              i.e. <quote><literal>start</literal></quote>,
572
 
              <quote><literal>stop</literal></quote>,
573
 
              <quote><literal>files</literal></quote>, or
574
 
              <quote><literal>modules</literal></quote>.
575
 
            </para>
576
 
          </listitem>
577
 
        </varlistentry>
578
 
        <varlistentry>
579
 
          <term><envar>VERBOSITY</envar></term>
580
 
          <listitem>
581
 
            <para>
582
 
              This will be the <quote><literal>1</literal></quote> if
583
 
              the <option>--debug</option> option is passed to
584
 
              <command>&COMMANDNAME;</command>, otherwise
585
 
              <quote><literal>0</literal></quote>.
586
 
            </para>
587
 
          </listitem>
588
 
        </varlistentry>
589
 
        <varlistentry>
590
 
          <term><envar>DELAY</envar></term>
591
 
          <listitem>
592
 
            <para>
593
 
              This will be the same as the <option>--delay</option>
594
 
              option passed to <command>&COMMANDNAME;</command>.  Is
595
 
              only set if <envar>MODE</envar> is
596
 
              <quote><literal>start</literal></quote> or
597
 
              <quote><literal>stop</literal></quote>.
598
 
            </para>
599
 
          </listitem>
600
 
        </varlistentry>
601
 
        <varlistentry>
602
 
          <term><envar>CONNECT</envar></term>
603
 
          <listitem>
604
 
            <para>
605
 
              This will be the same as the <option>--connect</option>
606
 
              option passed to <command>&COMMANDNAME;</command>.  Is
607
 
              only set if <option>--connect</option> is passed and
608
 
              <envar>MODE</envar> is
609
 
              <quote><literal>start</literal></quote> or
610
 
              <quote><literal>stop</literal></quote>.
611
 
            </para>
612
 
          </listitem>
613
 
        </varlistentry>
614
 
      </variablelist>
615
 
      <para>
616
 
        A hook may not read from standard input, and should be
617
 
        restrictive in printing to standard output or standard error
618
 
        unless <varname>VERBOSITY</varname> is
619
 
        <quote><literal>1</literal></quote>.
620
 
      </para>
621
 
    </refsect2>
622
 
  </refsect1>
623
 
  
624
424
  <refsect1 id="files">
625
425
    <title>FILES</title>
626
426
    <variablelist>
638
438
          </para>
639
439
        </listitem>
640
440
      </varlistentry>
641
 
      <varlistentry>
642
 
        <term><filename
643
 
        class="directory">/lib/mandos/network-hooks.d</filename></term>
644
 
        <listitem>
645
 
          <para>
646
 
            Directory where network hooks are located.  Change this
647
 
            with the <option>--network-hook-dir</option> option.  See
648
 
            <xref linkend="network-hooks"/>.
649
 
          </para>
650
 
        </listitem>
651
 
      </varlistentry>
652
441
    </variablelist>
653
442
  </refsect1>
654
443
  
668
457
    </para>
669
458
    <informalexample>
670
459
      <para>
671
 
        Normal invocation needs no options, if the network interfaces
672
 
        can be automatically determined:
 
460
        Normal invocation needs no options, if the network interface
 
461
        is <quote>eth0</quote>:
673
462
      </para>
674
463
      <para>
675
464
        <userinput>&COMMANDNAME;</userinput>
677
466
    </informalexample>
678
467
    <informalexample>
679
468
      <para>
680
 
        Search for Mandos servers (and connect to them) using one
681
 
        specific interface:
 
469
        Search for Mandos servers (and connect to them) using another
 
470
        interface:
682
471
      </para>
683
472
      <para>
684
473
        <!-- do not wrap this line -->
748
537
    <para>
749
538
      It will also help if the checker program on the server is
750
539
      configured to request something from the client which can not be
751
 
      spoofed by someone else on the network, like SSH server key
752
 
      fingerprints, and unlike unencrypted <acronym>ICMP</acronym>
753
 
      echo (<quote>ping</quote>) replies.
 
540
      spoofed by someone else on the network, unlike unencrypted
 
541
      <acronym>ICMP</acronym> echo (<quote>ping</quote>) replies.
754
542
    </para>
755
543
    <para>
756
544
      <emphasis>Note</emphasis>: This makes it completely insecure to
849
637
              <para>
850
638
                This client uses IPv6 link-local addresses, which are
851
639
                immediately usable since a link-local addresses is
852
 
                automatically assigned to a network interface when it
 
640
                automatically assigned to a network interfaces when it
853
641
                is brought up.
854
642
              </para>
855
643
            </listitem>