/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 (SYNOPSIS, OPTIONS): Document
                                                 "--network-hook-dir"
                                                 option.

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