/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

  • Committer: Teddy Hogeborn
  • Date: 2014-01-06 15:56:54 UTC
  • Revision ID: teddy@recompile.se-20140106155654-urx23ytuvy0nxzwp
Update init script to modern standards.

* init.d-mandos (status): Moved to standard location.  Re-added use of
                          -p switch compared to skeleton file.
  (*): Update message to include "status".

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 "2010-09-26">
 
5
<!ENTITY TIMESTAMP "2013-10-20">
6
6
<!ENTITY % common SYSTEM "../common.ent">
7
7
%common;
8
8
]>
19
19
        <firstname>Björn</firstname>
20
20
        <surname>Påhlsson</surname>
21
21
        <address>
22
 
          <email>belorn@fukt.bsnet.se</email>
 
22
          <email>belorn@recompile.se</email>
23
23
        </address>
24
24
      </author>
25
25
      <author>
26
26
        <firstname>Teddy</firstname>
27
27
        <surname>Hogeborn</surname>
28
28
        <address>
29
 
          <email>teddy@fukt.bsnet.se</email>
 
29
          <email>teddy@recompile.se</email>
30
30
        </address>
31
31
      </author>
32
32
    </authorgroup>
33
33
    <copyright>
34
34
      <year>2008</year>
35
35
      <year>2009</year>
 
36
      <year>2012</year>
 
37
      <year>2013</year>
36
38
      <holder>Teddy Hogeborn</holder>
37
39
      <holder>Björn Påhlsson</holder>
38
40
    </copyright>
63
65
        ><replaceable>PORT</replaceable></option></arg>
64
66
      </group>
65
67
      <sbr/>
66
 
      <group>
 
68
      <group rep='repeat'>
67
69
        <arg choice="plain"><option>--interface
68
 
        <replaceable>NAME</replaceable></option></arg>
69
 
        <arg choice="plain"><option>-i
70
 
        <replaceable>NAME</replaceable></option></arg>
 
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>
71
75
      </group>
72
76
      <sbr/>
73
77
      <group>
101
105
      </arg>
102
106
      <sbr/>
103
107
      <arg>
 
108
        <option>--network-hook-dir
 
109
        <replaceable>DIR</replaceable></option>
 
110
      </arg>
 
111
      <sbr/>
 
112
      <arg>
104
113
        <option>--debug</option>
105
114
      </arg>
106
115
    </cmdsynopsis>
131
140
      communicates with <citerefentry><refentrytitle
132
141
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>
133
142
      to get a password.  In slightly more detail, this client program
134
 
      brings up a network interface, uses the interface’s IPv6
135
 
      link-local address to get network connectivity, uses Zeroconf to
136
 
      find servers on the local network, and communicates with servers
137
 
      using TLS with an OpenPGP key to ensure authenticity and
 
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
138
147
      confidentiality.  This client program keeps running, trying all
139
148
      servers on the network, until it receives a satisfactory reply
140
 
      or a TERM signal is received.  If no servers are found, or after
141
 
      all servers have been tried, it waits indefinitely for new
142
 
      servers to appear.
 
149
      or a TERM signal.  After all servers have been tried, all
 
150
      servers are periodically retried.  If no servers are found it
 
151
      will wait indefinitely for new servers to appear.
 
152
    </para>
 
153
    <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
 
160
      <citerefentry><refentrytitle>netdevice</refentrytitle>
 
161
      <manvolnum>7</manvolnum></citerefentry>).  (If the
 
162
      <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).
 
166
    </para>
 
167
    <para>
 
168
      Before network interfaces are selected, all <quote>network
 
169
      hooks</quote> are run; see <xref linkend="network-hooks"/>.
143
170
    </para>
144
171
    <para>
145
172
      This program is not meant to be run directly; it is really meant
200
227
      
201
228
      <varlistentry>
202
229
        <term><option>--interface=<replaceable
203
 
        >NAME</replaceable></option></term>
 
230
        >NAME</replaceable><arg rep='repeat'>,<replaceable
 
231
        >NAME</replaceable></arg></option></term>
204
232
        <term><option>-i
205
 
        <replaceable>NAME</replaceable></option></term>
 
233
        <replaceable>NAME</replaceable><arg rep='repeat'>,<replaceable
 
234
        >NAME</replaceable></arg></option></term>
206
235
        <listitem>
207
236
          <para>
208
 
            Network interface that will be brought up and scanned for
209
 
            Mandos servers to connect to.  The default is the empty
210
 
            string, which will automatically choose an appropriate
211
 
            interface.
 
237
            Comma separated list of network interfaces that will be
 
238
            brought up and scanned for Mandos servers to connect to.
 
239
            The default is the empty string, which will automatically
 
240
            use all appropriate interfaces.
212
241
          </para>
213
242
          <para>
214
 
            If the <option>--connect</option> option is used, this
215
 
            specifies the interface to use to connect to the address
216
 
            given.
 
243
            If the <option>--connect</option> option is used, and
 
244
            exactly one interface name is specified (except
 
245
            <quote><literal>none</literal></quote>), this specifies
 
246
            the interface to use to connect to the address given.
217
247
          </para>
218
248
          <para>
219
249
            Note that since this program will normally run in the
220
250
            initial RAM disk environment, the interface must be an
221
251
            interface which exists at that stage.  Thus, the interface
222
 
            can not be a pseudo-interface such as <quote>br0</quote>
223
 
            or <quote>tun0</quote>; such interfaces will not exist
224
 
            until much later in the boot process, and can not be used
225
 
            by this program.
 
252
            can normally not be a pseudo-interface such as
 
253
            <quote>br0</quote> or <quote>tun0</quote>; such interfaces
 
254
            will not exist until much later in the boot process, and
 
255
            can not be used by this program, unless created by a
 
256
            <quote>network hook</quote> — see <xref
 
257
            linkend="network-hooks"/>.
226
258
          </para>
227
259
          <para>
228
260
            <replaceable>NAME</replaceable> can be the string
229
 
            <quote><literal>none</literal></quote>; this will not use
230
 
            any specific interface, and will not bring up an interface
231
 
            on startup.  This is not recommended, and only meant for
232
 
            advanced users.
 
261
            <quote><literal>none</literal></quote>; this will make
 
262
            <command>&COMMANDNAME;</command> not bring up
 
263
            <emphasis>any</emphasis> interfaces specified
 
264
            <emphasis>after</emphasis> this string.  This is not
 
265
            recommended, and only meant for advanced users.
233
266
          </para>
234
267
        </listitem>
235
268
      </varlistentry>
287
320
        >SECONDS</replaceable></option></term>
288
321
        <listitem>
289
322
          <para>
290
 
            After bringing the network interface up, the program waits
 
323
            After bringing a network interface up, the program waits
291
324
            for the interface to arrive in a <quote>running</quote>
292
325
            state before proceeding.  During this time, the kernel log
293
326
            level will be lowered to reduce clutter on the system
303
336
        >SECONDS</replaceable></option></term>
304
337
        <listitem>
305
338
          <para>
306
 
            All Mandos servers servers are tried repeatedly until a
307
 
            password is received.  This value specifies, in seconds,
308
 
            how long between each successive try <emphasis>for the
309
 
            same server</emphasis>.  The default is 10 seconds.
 
339
            All Mandos servers are tried repeatedly until a password
 
340
            is received.  This value specifies, in seconds, how long
 
341
            between each successive try <emphasis>for the same
 
342
            server</emphasis>.  The default is 10 seconds.
 
343
          </para>
 
344
        </listitem>
 
345
      </varlistentry>
 
346
 
 
347
      <varlistentry>
 
348
        <term><option>--network-hook-dir=<replaceable
 
349
        >DIR</replaceable></option></term>
 
350
        <listitem>
 
351
          <para>
 
352
            Network hook directory.  The default directory is
 
353
            <quote><filename class="directory"
 
354
            >/lib/mandos/network-hooks.d</filename></quote>.
310
355
          </para>
311
356
        </listitem>
312
357
      </varlistentry>
376
421
      <refentrytitle>plugin-runner</refentrytitle>
377
422
      <manvolnum>8mandos</manvolnum></citerefentry>) is used to run
378
423
      both this program and others in in parallel,
379
 
      <emphasis>one</emphasis> of which will prompt for passwords on
380
 
      the system console.
 
424
      <emphasis>one</emphasis> of which (<citerefentry>
 
425
      <refentrytitle>password-prompt</refentrytitle>
 
426
      <manvolnum>8mandos</manvolnum></citerefentry>) will prompt for
 
427
      passwords on the system console.
381
428
    </para>
382
429
  </refsect1>
383
430
  
388
435
      server could be found and the password received from it could be
389
436
      successfully decrypted and output on standard output.  The
390
437
      program will exit with a non-zero exit status only if a critical
391
 
      error occurs.  Otherwise, it will forever connect to new
392
 
      <application>Mandos</application> servers as they appear, trying
393
 
      to get a decryptable password and print it.
 
438
      error occurs.  Otherwise, it will forever connect to any
 
439
      discovered <application>Mandos</application> servers, trying to
 
440
      get a decryptable password and print it.
394
441
    </para>
395
442
  </refsect1>
396
443
  
404
451
    </para>
405
452
  </refsect1>
406
453
  
 
454
  <refsect1 id="network-hooks">
 
455
    <title>NETWORK HOOKS</title>
 
456
    <para>
 
457
      If a network interface like a bridge or tunnel is required to
 
458
      find a Mandos server, this requires the interface to be up and
 
459
      running before <command>&COMMANDNAME;</command> starts looking
 
460
      for Mandos servers.  This can be accomplished by creating a
 
461
      <quote>network hook</quote> program, and placing it in a special
 
462
      directory.
 
463
    </para>
 
464
    <para>
 
465
      Before the network is used (and again before program exit), any
 
466
      runnable programs found in the network hook directory are run
 
467
      with the argument <quote><literal>start</literal></quote> or
 
468
      <quote><literal>stop</literal></quote>.  This should bring up or
 
469
      down, respectively, any network interface which
 
470
      <command>&COMMANDNAME;</command> should use.
 
471
    </para>
 
472
    <refsect2 id="hook-requirements">
 
473
      <title>REQUIREMENTS</title>
 
474
      <para>
 
475
        A network hook must be an executable file, and its name must
 
476
        consist entirely of upper and lower case letters, digits,
 
477
        underscores, periods, and hyphens.
 
478
      </para>
 
479
      <para>
 
480
        A network hook will receive one argument, which can be one of
 
481
        the following:
 
482
      </para>
 
483
      <variablelist>
 
484
        <varlistentry>
 
485
          <term><literal>start</literal></term>
 
486
          <listitem>
 
487
            <para>
 
488
              This should make the network hook create (if necessary)
 
489
              and bring up a network interface.
 
490
            </para>
 
491
          </listitem>
 
492
        </varlistentry>
 
493
        <varlistentry>
 
494
          <term><literal>stop</literal></term>
 
495
          <listitem>
 
496
            <para>
 
497
              This should make the network hook take down a network
 
498
              interface, and delete it if it did not exist previously.
 
499
            </para>
 
500
          </listitem>
 
501
        </varlistentry>
 
502
        <varlistentry>
 
503
          <term><literal>files</literal></term>
 
504
          <listitem>
 
505
            <para>
 
506
              This should make the network hook print, <emphasis>one
 
507
              file per line</emphasis>, all the files needed for it to
 
508
              run.  (These files will be copied into the initial RAM
 
509
              filesystem.)  Typical use is for a network hook which is
 
510
              a shell script to print its needed binaries.
 
511
            </para>
 
512
            <para>
 
513
              It is not necessary to print any non-executable files
 
514
              already in the network hook directory, these will be
 
515
              copied implicitly if they otherwise satisfy the name
 
516
              requirements.
 
517
            </para>
 
518
          </listitem>
 
519
        </varlistentry>
 
520
        <varlistentry>
 
521
          <term><literal>modules</literal></term>
 
522
          <listitem>
 
523
            <para>
 
524
              This should make the network hook print, <emphasis>on
 
525
              separate lines</emphasis>, all the kernel modules needed
 
526
              for it to run.  (These modules will be copied into the
 
527
              initial RAM filesystem.)  For instance, a tunnel
 
528
              interface needs the
 
529
              <quote><literal>tun</literal></quote> module.
 
530
            </para>
 
531
          </listitem>
 
532
        </varlistentry>
 
533
      </variablelist>
 
534
      <para>
 
535
        The network hook will be provided with a number of environment
 
536
        variables:
 
537
      </para>
 
538
      <variablelist>
 
539
        <varlistentry>
 
540
          <term><envar>MANDOSNETHOOKDIR</envar></term>
 
541
          <listitem>
 
542
            <para>
 
543
              The network hook directory, specified to
 
544
              <command>&COMMANDNAME;</command> by the
 
545
              <option>--network-hook-dir</option> option.  Note: this
 
546
              should <emphasis>always</emphasis> be used by the
 
547
              network hook to refer to itself or any files in the hook
 
548
              directory it may require.
 
549
            </para>
 
550
          </listitem>
 
551
        </varlistentry>
 
552
        <varlistentry>
 
553
          <term><envar>DEVICE</envar></term>
 
554
          <listitem>
 
555
            <para>
 
556
              The network interfaces, as specified to
 
557
              <command>&COMMANDNAME;</command> by the
 
558
              <option>--interface</option> option, combined to one
 
559
              string and separated by commas.  If this is set, and
 
560
              does not contain the interface a hook will bring up,
 
561
              there is no reason for a hook to continue.
 
562
            </para>
 
563
          </listitem>
 
564
        </varlistentry>
 
565
        <varlistentry>
 
566
          <term><envar>MODE</envar></term>
 
567
          <listitem>
 
568
            <para>
 
569
              This will be the same as the first argument;
 
570
              i.e. <quote><literal>start</literal></quote>,
 
571
              <quote><literal>stop</literal></quote>,
 
572
              <quote><literal>files</literal></quote>, or
 
573
              <quote><literal>modules</literal></quote>.
 
574
            </para>
 
575
          </listitem>
 
576
        </varlistentry>
 
577
        <varlistentry>
 
578
          <term><envar>VERBOSITY</envar></term>
 
579
          <listitem>
 
580
            <para>
 
581
              This will be the <quote><literal>1</literal></quote> if
 
582
              the <option>--debug</option> option is passed to
 
583
              <command>&COMMANDNAME;</command>, otherwise
 
584
              <quote><literal>0</literal></quote>.
 
585
            </para>
 
586
          </listitem>
 
587
        </varlistentry>
 
588
        <varlistentry>
 
589
          <term><envar>DELAY</envar></term>
 
590
          <listitem>
 
591
            <para>
 
592
              This will be the same as the <option>--delay</option>
 
593
              option passed to <command>&COMMANDNAME;</command>.  Is
 
594
              only set if <envar>MODE</envar> is
 
595
              <quote><literal>start</literal></quote> or
 
596
              <quote><literal>stop</literal></quote>.
 
597
            </para>
 
598
          </listitem>
 
599
        </varlistentry>
 
600
        <varlistentry>
 
601
          <term><envar>CONNECT</envar></term>
 
602
          <listitem>
 
603
            <para>
 
604
              This will be the same as the <option>--connect</option>
 
605
              option passed to <command>&COMMANDNAME;</command>.  Is
 
606
              only set if <option>--connect</option> is passed and
 
607
              <envar>MODE</envar> is
 
608
              <quote><literal>start</literal></quote> or
 
609
              <quote><literal>stop</literal></quote>.
 
610
            </para>
 
611
          </listitem>
 
612
        </varlistentry>
 
613
      </variablelist>
 
614
      <para>
 
615
        A hook may not read from standard input, and should be
 
616
        restrictive in printing to standard output or standard error
 
617
        unless <varname>VERBOSITY</varname> is
 
618
        <quote><literal>1</literal></quote>.
 
619
      </para>
 
620
    </refsect2>
 
621
  </refsect1>
 
622
  
407
623
  <refsect1 id="files">
408
624
    <title>FILES</title>
409
625
    <variablelist>
421
637
          </para>
422
638
        </listitem>
423
639
      </varlistentry>
 
640
      <varlistentry>
 
641
        <term><filename
 
642
        class="directory">/lib/mandos/network-hooks.d</filename></term>
 
643
        <listitem>
 
644
          <para>
 
645
            Directory where network hooks are located.  Change this
 
646
            with the <option>--network-hook-dir</option> option.  See
 
647
            <xref linkend="network-hooks"/>.
 
648
          </para>
 
649
        </listitem>
 
650
      </varlistentry>
424
651
    </variablelist>
425
652
  </refsect1>
426
653
  
440
667
    </para>
441
668
    <informalexample>
442
669
      <para>
443
 
        Normal invocation needs no options, if the network interface
444
 
        is <quote>eth0</quote>:
 
670
        Normal invocation needs no options, if the network interfaces
 
671
        can be automatically determined:
445
672
      </para>
446
673
      <para>
447
674
        <userinput>&COMMANDNAME;</userinput>
449
676
    </informalexample>
450
677
    <informalexample>
451
678
      <para>
452
 
        Search for Mandos servers (and connect to them) using another
453
 
        interface:
 
679
        Search for Mandos servers (and connect to them) using one
 
680
        specific interface:
454
681
      </para>
455
682
      <para>
456
683
        <!-- do not wrap this line -->
535
762
  <refsect1 id="see_also">
536
763
    <title>SEE ALSO</title>
537
764
    <para>
 
765
      <citerefentry><refentrytitle>intro</refentrytitle>
 
766
      <manvolnum>8mandos</manvolnum></citerefentry>,
538
767
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
539
768
      <manvolnum>8</manvolnum></citerefentry>,
540
769
      <citerefentry><refentrytitle>crypttab</refentrytitle>
618
847
              <para>
619
848
                This client uses IPv6 link-local addresses, which are
620
849
                immediately usable since a link-local addresses is
621
 
                automatically assigned to a network interfaces when it
 
850
                automatically assigned to a network interface when it
622
851
                is brought up.
623
852
              </para>
624
853
            </listitem>