/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

  • Committer: Teddy Hogeborn
  • Date: 2013-10-20 15:25:09 UTC
  • mto: (237.7.272 trunk)
  • mto: This revision was merged to the branch mainline in revision 305.
  • Revision ID: teddy@recompile.se-20131020152509-zkhuy2yse76w10hg
* Makefile (CFLAGS, LDFLAGS): Keep default flags from environment.
  (purge-server): PID file changed to "/run/mandos.pid".
* debian/compat: Changed to "9".
* debian/control (Standards-Version): Updated to "3.9.4".
  (DM-Upload-Allowed): Removed.
  (mandos/Depends): Add "initscripts (>= 2.88dsf-13.3)" to be able to
                    use the "/run" directory (for mandos.pid).
* debian/copyright (Copyright): Update year.
* init.d-mandos (PIDFILE): Changed to "/run/mandos.pid".
* mandos: Update copyright year.
  (pidfilename): Changed to "/run/mandos.pid".
* mandos-clients.conf.xml (OPTIONS/approval_delay): Bug fix: default
                                                    is "PT0S" - using
                                                    the new RFC 3339
                                                    duration syntax.
* mandos-keygen: Update copyright year.
* mandos-monitor: - '' -
* mandos.conf.xml: - '' -
* mandos.xml: - '' -
  (FILES): PID file changed to "/run/mandos.pid".
* plugin-runner.c: Update copyright year.
* plugins.d/mandos-client.c: - '' -
* plugins.d/mandos-client.xml: - '' -
* plugins.d/password-prompt.c: - '' -
* plugins.d/plymouth.c: - '' -

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 "2009-01-04">
 
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>
93
97
      </arg>
94
98
      <sbr/>
95
99
      <arg>
 
100
        <option>--delay <replaceable>SECONDS</replaceable></option>
 
101
      </arg>
 
102
      <sbr/>
 
103
      <arg>
 
104
        <option>--retry <replaceable>SECONDS</replaceable></option>
 
105
      </arg>
 
106
      <sbr/>
 
107
      <arg>
 
108
        <option>--network-hook-dir
 
109
        <replaceable>DIR</replaceable></option>
 
110
      </arg>
 
111
      <sbr/>
 
112
      <arg>
96
113
        <option>--debug</option>
97
114
      </arg>
98
115
    </cmdsynopsis>
122
139
      <command>&COMMANDNAME;</command> is a client program that
123
140
      communicates with <citerefentry><refentrytitle
124
141
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>
125
 
      to get a password.  It uses IPv6 link-local addresses to get
126
 
      network connectivity, Zeroconf to find servers, and TLS with an
127
 
      OpenPGP key to ensure authenticity and confidentiality.  It
128
 
      keeps running, trying all servers on the network, until it
129
 
      receives a satisfactory reply or a TERM signal is received.
 
142
      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
 
147
      confidentiality.  This client program keeps running, trying all
 
148
      servers on the network, until it receives a satisfactory reply
 
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"/>.
130
170
    </para>
131
171
    <para>
132
172
      This program is not meant to be run directly; it is really meant
186
226
      </varlistentry>
187
227
      
188
228
      <varlistentry>
189
 
        <term><option>--interface=
190
 
        <replaceable>NAME</replaceable></option></term>
 
229
        <term><option>--interface=<replaceable
 
230
        >NAME</replaceable><arg rep='repeat'>,<replaceable
 
231
        >NAME</replaceable></arg></option></term>
191
232
        <term><option>-i
192
 
        <replaceable>NAME</replaceable></option></term>
 
233
        <replaceable>NAME</replaceable><arg rep='repeat'>,<replaceable
 
234
        >NAME</replaceable></arg></option></term>
193
235
        <listitem>
194
236
          <para>
195
 
            Network interface that will be brought up and scanned for
196
 
            Mandos servers to connect to.  The default it
197
 
            <quote><literal>eth0</literal></quote>.
198
 
          </para>
199
 
          <para>
200
 
            If the <option>--connect</option> option is used, this
201
 
            specifies the interface to use to connect to the address
202
 
            given.
 
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.
 
241
          </para>
 
242
          <para>
 
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.
 
247
          </para>
 
248
          <para>
 
249
            Note that since this program will normally run in the
 
250
            initial RAM disk environment, the interface must be an
 
251
            interface which exists at that stage.  Thus, the interface
 
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"/>.
 
258
          </para>
 
259
          <para>
 
260
            <replaceable>NAME</replaceable> can be the string
 
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.
203
266
          </para>
204
267
        </listitem>
205
268
      </varlistentry>
251
314
          </para>
252
315
        </listitem>
253
316
      </varlistentry>
 
317
 
 
318
      <varlistentry>
 
319
        <term><option>--delay=<replaceable
 
320
        >SECONDS</replaceable></option></term>
 
321
        <listitem>
 
322
          <para>
 
323
            After bringing a network interface up, the program waits
 
324
            for the interface to arrive in a <quote>running</quote>
 
325
            state before proceeding.  During this time, the kernel log
 
326
            level will be lowered to reduce clutter on the system
 
327
            console, alleviating any other plugins which might be
 
328
            using the system console.  This option sets the upper
 
329
            limit of seconds to wait.  The default is 2.5 seconds.
 
330
          </para>
 
331
        </listitem>
 
332
      </varlistentry>
 
333
 
 
334
      <varlistentry>
 
335
        <term><option>--retry=<replaceable
 
336
        >SECONDS</replaceable></option></term>
 
337
        <listitem>
 
338
          <para>
 
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>.
 
355
          </para>
 
356
        </listitem>
 
357
      </varlistentry>
254
358
      
255
359
      <varlistentry>
256
360
        <term><option>--debug</option></term>
317
421
      <refentrytitle>plugin-runner</refentrytitle>
318
422
      <manvolnum>8mandos</manvolnum></citerefentry>) is used to run
319
423
      both this program and others in in parallel,
320
 
      <emphasis>one</emphasis> of which will prompt for passwords on
321
 
      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.
322
428
    </para>
323
429
  </refsect1>
324
430
  
329
435
      server could be found and the password received from it could be
330
436
      successfully decrypted and output on standard output.  The
331
437
      program will exit with a non-zero exit status only if a critical
332
 
      error occurs.  Otherwise, it will forever connect to new
333
 
      <application>Mandos</application> servers as they appear, trying
334
 
      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.
335
441
    </para>
336
442
  </refsect1>
337
443
  
345
451
    </para>
346
452
  </refsect1>
347
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
  
348
623
  <refsect1 id="files">
349
624
    <title>FILES</title>
350
625
    <variablelist>
362
637
          </para>
363
638
        </listitem>
364
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>
365
651
    </variablelist>
366
652
  </refsect1>
367
653
  
381
667
    </para>
382
668
    <informalexample>
383
669
      <para>
384
 
        Normal invocation needs no options, if the network interface
385
 
        is <quote>eth0</quote>:
 
670
        Normal invocation needs no options, if the network interfaces
 
671
        can be automatically determined:
386
672
      </para>
387
673
      <para>
388
674
        <userinput>&COMMANDNAME;</userinput>
390
676
    </informalexample>
391
677
    <informalexample>
392
678
      <para>
393
 
        Search for Mandos servers (and connect to them) using another
394
 
        interface:
 
679
        Search for Mandos servers (and connect to them) using one
 
680
        specific interface:
395
681
      </para>
396
682
      <para>
397
683
        <!-- do not wrap this line -->
412
698
    <informalexample>
413
699
      <para>
414
700
        Run in debug mode, with a custom key, and do not use Zeroconf
415
 
        to locate a server; connect directly to the IPv6 address
416
 
        <quote><systemitem class="ipaddress"
417
 
        >2001:db8:f983:bd0b:30de:ae4a:71f2:f672</systemitem></quote>,
418
 
        port 4711, using interface eth2:
 
701
        to locate a server; connect directly to the IPv6 link-local
 
702
        address <quote><systemitem class="ipaddress"
 
703
        >fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
 
704
        using interface eth2:
419
705
      </para>
420
706
      <para>
421
707
 
422
708
<!-- do not wrap this line -->
423
 
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect 2001:db8:f983:bd0b:30de:ae4a:71f2:f672:4711 --interface eth2</userinput>
 
709
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect fe80::aede:48ff:fe71:f6f2:4711 --interface eth2</userinput>
424
710
 
425
711
      </para>
426
712
    </informalexample>
476
762
  <refsect1 id="see_also">
477
763
    <title>SEE ALSO</title>
478
764
    <para>
 
765
      <citerefentry><refentrytitle>intro</refentrytitle>
 
766
      <manvolnum>8mandos</manvolnum></citerefentry>,
479
767
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
480
768
      <manvolnum>8</manvolnum></citerefentry>,
481
769
      <citerefentry><refentrytitle>crypttab</refentrytitle>
559
847
              <para>
560
848
                This client uses IPv6 link-local addresses, which are
561
849
                immediately usable since a link-local addresses is
562
 
                automatically assigned to a network interfaces when it
 
850
                automatically assigned to a network interface when it
563
851
                is brought up.
564
852
              </para>
565
853
            </listitem>