/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

* 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 "2014-01-20">
 
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>
 
36
      <year>2011</year>
38
37
      <holder>Teddy Hogeborn</holder>
39
38
      <holder>Björn Påhlsson</holder>
40
39
    </copyright>
65
64
        ><replaceable>PORT</replaceable></option></arg>
66
65
      </group>
67
66
      <sbr/>
68
 
      <group rep='repeat'>
 
67
      <group>
69
68
        <arg choice="plain"><option>--interface
70
 
        <replaceable>NAME</replaceable><arg rep='repeat'
71
 
        >,<replaceable>NAME</replaceable></arg></option></arg>
72
 
        <arg choice="plain"><option>-i <replaceable>NAME</replaceable
73
 
        ><arg rep='repeat'>,<replaceable>NAME</replaceable></arg
74
 
        ></option></arg>
 
69
        <replaceable>NAME</replaceable></option></arg>
 
70
        <arg choice="plain"><option>-i
 
71
        <replaceable>NAME</replaceable></option></arg>
75
72
      </group>
76
73
      <sbr/>
77
74
      <group>
140
137
      communicates with <citerefentry><refentrytitle
141
138
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>
142
139
      to get a password.  In slightly more detail, this client program
143
 
      brings up network interfaces, uses the interfaces’ IPv6
144
 
      link-local addresses to get network connectivity, uses Zeroconf
145
 
      to find servers on the local network, and communicates with
146
 
      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
147
144
      confidentiality.  This client program keeps running, trying all
148
145
      servers on the network, until it receives a satisfactory reply
149
146
      or a TERM signal.  After all servers have been tried, all
151
148
      will wait indefinitely for new servers to appear.
152
149
    </para>
153
150
    <para>
154
 
      The network interfaces are selected like this: If any interfaces
155
 
      are specified using the <option>--interface</option> option,
156
 
      those interface are used.  Otherwise,
157
 
      <command>&COMMANDNAME;</command> will use all interfaces that
158
 
      are not loopback interfaces, are not point-to-point interfaces,
159
 
      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
160
157
      <citerefentry><refentrytitle>netdevice</refentrytitle>
161
158
      <manvolnum>7</manvolnum></citerefentry>).  (If the
162
159
      <option>--connect</option> option is used, point-to-point
163
 
      interfaces and non-broadcast interfaces are accepted.)  If any
164
 
      used interfaces are not up and running, they are first taken up
165
 
      (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).
166
165
    </para>
167
166
    <para>
168
 
      Before network interfaces are selected, all <quote>network
 
167
      Before a network interface is selected, all <quote>network
169
168
      hooks</quote> are run; see <xref linkend="network-hooks"/>.
170
169
    </para>
171
170
    <para>
219
218
            assumed to separate the address from the port number.
220
219
          </para>
221
220
          <para>
222
 
            Normally, Zeroconf would be used to locate Mandos servers,
223
 
            in which case this option would only be used when testing
224
 
            and debugging.
 
221
            This option is normally only useful for testing and
 
222
            debugging.
225
223
          </para>
226
224
        </listitem>
227
225
      </varlistentry>
228
226
      
229
227
      <varlistentry>
230
228
        <term><option>--interface=<replaceable
231
 
        >NAME</replaceable><arg rep='repeat'>,<replaceable
232
 
        >NAME</replaceable></arg></option></term>
 
229
        >NAME</replaceable></option></term>
233
230
        <term><option>-i
234
 
        <replaceable>NAME</replaceable><arg rep='repeat'>,<replaceable
235
 
        >NAME</replaceable></arg></option></term>
 
231
        <replaceable>NAME</replaceable></option></term>
236
232
        <listitem>
237
233
          <para>
238
 
            Comma separated list of network interfaces that will be
239
 
            brought up and scanned for Mandos servers to connect to.
240
 
            The default is the empty string, which will automatically
241
 
            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.
242
238
          </para>
243
239
          <para>
244
 
            If the <option>--connect</option> option is used, and
245
 
            exactly one interface name is specified (except
246
 
            <quote><literal>none</literal></quote>), this specifies
247
 
            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.
248
243
          </para>
249
244
          <para>
250
245
            Note that since this program will normally run in the
251
246
            initial RAM disk environment, the interface must be an
252
247
            interface which exists at that stage.  Thus, the interface
253
 
            can normally not be a pseudo-interface such as
254
 
            <quote>br0</quote> or <quote>tun0</quote>; such interfaces
255
 
            will not exist until much later in the boot process, and
256
 
            can not be used by this program, unless created by a
257
 
            <quote>network hook</quote> — see <xref
258
 
            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"/>.
259
253
          </para>
260
254
          <para>
261
255
            <replaceable>NAME</replaceable> can be the string
262
 
            <quote><literal>none</literal></quote>; this will make
263
 
            <command>&COMMANDNAME;</command> not bring up
264
 
            <emphasis>any</emphasis> interfaces specified
265
 
            <emphasis>after</emphasis> this string.  This is not
266
 
            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.
267
260
          </para>
268
261
        </listitem>
269
262
      </varlistentry>
321
314
        >SECONDS</replaceable></option></term>
322
315
        <listitem>
323
316
          <para>
324
 
            After bringing a network interface up, the program waits
 
317
            After bringing the network interface up, the program waits
325
318
            for the interface to arrive in a <quote>running</quote>
326
319
            state before proceeding.  During this time, the kernel log
327
320
            level will be lowered to reduce clutter on the system
475
468
      <para>
476
469
        A network hook must be an executable file, and its name must
477
470
        consist entirely of upper and lower case letters, digits,
478
 
        underscores, periods, and hyphens.
 
471
        underscores, and hyphens.
479
472
      </para>
480
473
      <para>
481
474
        A network hook will receive one argument, which can be one of
504
497
          <term><literal>files</literal></term>
505
498
          <listitem>
506
499
            <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.
 
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.
512
505
            </para>
513
506
            <para>
514
507
              It is not necessary to print any non-executable files
515
508
              already in the network hook directory, these will be
516
509
              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.
 
510
              requirement.
531
511
            </para>
532
512
          </listitem>
533
513
        </varlistentry>
545
525
              <command>&COMMANDNAME;</command> by the
546
526
              <option>--network-hook-dir</option> option.  Note: this
547
527
              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.
 
528
              network hook to refer to itself or any files it may
 
529
              require.
550
530
            </para>
551
531
          </listitem>
552
532
        </varlistentry>
554
534
          <term><envar>DEVICE</envar></term>
555
535
          <listitem>
556
536
            <para>
557
 
              The network interfaces, as specified to
 
537
              The network interface, as specified to
558
538
              <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.
 
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.
563
542
            </para>
564
543
          </listitem>
565
544
        </varlistentry>
569
548
            <para>
570
549
              This will be the same as the first argument;
571
550
              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>.
 
551
              <quote><literal>stop</literal></quote>, or
 
552
              <quote><literal>files</literal></quote>.
575
553
            </para>
576
554
          </listitem>
577
555
        </varlistentry>
591
569
          <listitem>
592
570
            <para>
593
571
              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>.
 
572
              option passed to <command>&COMMANDNAME;</command>.
611
573
            </para>
612
574
          </listitem>
613
575
        </varlistentry>
668
630
    </para>
669
631
    <informalexample>
670
632
      <para>
671
 
        Normal invocation needs no options, if the network interfaces
672
 
        can be automatically determined:
 
633
        Normal invocation needs no options, if the network interface
 
634
        is <quote>eth0</quote>:
673
635
      </para>
674
636
      <para>
675
637
        <userinput>&COMMANDNAME;</userinput>
677
639
    </informalexample>
678
640
    <informalexample>
679
641
      <para>
680
 
        Search for Mandos servers (and connect to them) using one
681
 
        specific interface:
 
642
        Search for Mandos servers (and connect to them) using another
 
643
        interface:
682
644
      </para>
683
645
      <para>
684
646
        <!-- do not wrap this line -->
848
810
              <para>
849
811
                This client uses IPv6 link-local addresses, which are
850
812
                immediately usable since a link-local addresses is
851
 
                automatically assigned to a network interface when it
 
813
                automatically assigned to a network interfaces when it
852
814
                is brought up.
853
815
              </para>
854
816
            </listitem>