/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

* Makefile: Bug fix for Debian bug #509398; make sure "-z relro" is
            passed to linker, not C compiler.

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-03-05">
 
5
<!ENTITY TIMESTAMP "2008-10-03">
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@recompile.se</email>
 
22
          <email>belorn@fukt.bsnet.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@recompile.se</email>
 
29
          <email>teddy@fukt.bsnet.se</email>
30
30
        </address>
31
31
      </author>
32
32
    </authorgroup>
33
33
    <copyright>
34
34
      <year>2008</year>
35
 
      <year>2009</year>
36
 
      <year>2012</year>
37
 
      <year>2013</year>
38
 
      <year>2014</year>
39
35
      <holder>Teddy Hogeborn</holder>
40
36
      <holder>Björn Påhlsson</holder>
41
37
    </copyright>
66
62
        ><replaceable>PORT</replaceable></option></arg>
67
63
      </group>
68
64
      <sbr/>
69
 
      <group rep='repeat'>
 
65
      <group>
70
66
        <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>
 
67
        <replaceable>NAME</replaceable></option></arg>
 
68
        <arg choice="plain"><option>-i
 
69
        <replaceable>NAME</replaceable></option></arg>
76
70
      </group>
77
71
      <sbr/>
78
72
      <group>
98
92
      </arg>
99
93
      <sbr/>
100
94
      <arg>
101
 
        <option>--delay <replaceable>SECONDS</replaceable></option>
102
 
      </arg>
103
 
      <sbr/>
104
 
      <arg>
105
 
        <option>--retry <replaceable>SECONDS</replaceable></option>
106
 
      </arg>
107
 
      <sbr/>
108
 
      <arg>
109
 
        <option>--network-hook-dir
110
 
        <replaceable>DIR</replaceable></option>
111
 
      </arg>
112
 
      <sbr/>
113
 
      <arg>
114
95
        <option>--debug</option>
115
96
      </arg>
116
97
    </cmdsynopsis>
140
121
      <command>&COMMANDNAME;</command> is a client program that
141
122
      communicates with <citerefentry><refentrytitle
142
123
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>
143
 
      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
148
 
      confidentiality.  This client program keeps running, trying all
149
 
      servers on the network, until it receives a satisfactory reply
150
 
      or a TERM signal.  After all servers have been tried, all
151
 
      servers are periodically retried.  If no servers are found it
152
 
      will wait indefinitely for new servers to appear.
153
 
    </para>
154
 
    <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"/>.
 
124
      to get a password.  It uses IPv6 link-local addresses to get
 
125
      network connectivity, Zeroconf to find servers, and TLS with an
 
126
      OpenPGP key to ensure authenticity and confidentiality.  It
 
127
      keeps running, trying all servers on the network, until it
 
128
      receives a satisfactory reply or a TERM signal is received.
171
129
    </para>
172
130
    <para>
173
131
      This program is not meant to be run directly; it is really meant
220
178
            assumed to separate the address from the port number.
221
179
          </para>
222
180
          <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.
 
181
            This option is normally only useful for testing and
 
182
            debugging.
226
183
          </para>
227
184
        </listitem>
228
185
      </varlistentry>
229
186
      
230
187
      <varlistentry>
231
 
        <term><option>--interface=<replaceable
232
 
        >NAME</replaceable><arg rep='repeat'>,<replaceable
233
 
        >NAME</replaceable></arg></option></term>
 
188
        <term><option>--interface=
 
189
        <replaceable>NAME</replaceable></option></term>
234
190
        <term><option>-i
235
 
        <replaceable>NAME</replaceable><arg rep='repeat'>,<replaceable
236
 
        >NAME</replaceable></arg></option></term>
 
191
        <replaceable>NAME</replaceable></option></term>
237
192
        <listitem>
238
193
          <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.
243
 
          </para>
244
 
          <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.
249
 
          </para>
250
 
          <para>
251
 
            Note that since this program will normally run in the
252
 
            initial RAM disk environment, the interface must be an
253
 
            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"/>.
260
 
          </para>
261
 
          <para>
262
 
            <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.
 
194
            Network interface that will be brought up and scanned for
 
195
            Mandos servers to connect to.  The default it
 
196
            <quote><literal>eth0</literal></quote>.
 
197
          </para>
 
198
          <para>
 
199
            If the <option>--connect</option> option is used, this
 
200
            specifies the interface to use to connect to the address
 
201
            given.
267
202
          </para>
268
203
        </listitem>
269
204
      </varlistentry>
315
250
          </para>
316
251
        </listitem>
317
252
      </varlistentry>
318
 
 
319
 
      <varlistentry>
320
 
        <term><option>--delay=<replaceable
321
 
        >SECONDS</replaceable></option></term>
322
 
        <listitem>
323
 
          <para>
324
 
            After bringing a network interface up, the program waits
325
 
            for the interface to arrive in a <quote>running</quote>
326
 
            state before proceeding.  During this time, the kernel log
327
 
            level will be lowered to reduce clutter on the system
328
 
            console, alleviating any other plugins which might be
329
 
            using the system console.  This option sets the upper
330
 
            limit of seconds to wait.  The default is 2.5 seconds.
331
 
          </para>
332
 
        </listitem>
333
 
      </varlistentry>
334
 
 
335
 
      <varlistentry>
336
 
        <term><option>--retry=<replaceable
337
 
        >SECONDS</replaceable></option></term>
338
 
        <listitem>
339
 
          <para>
340
 
            All Mandos servers are tried repeatedly until a password
341
 
            is received.  This value specifies, in seconds, how long
342
 
            between each successive try <emphasis>for the same
343
 
            server</emphasis>.  The default is 10 seconds.
344
 
          </para>
345
 
        </listitem>
346
 
      </varlistentry>
347
 
 
348
 
      <varlistentry>
349
 
        <term><option>--network-hook-dir=<replaceable
350
 
        >DIR</replaceable></option></term>
351
 
        <listitem>
352
 
          <para>
353
 
            Network hook directory.  The default directory is
354
 
            <quote><filename class="directory"
355
 
            >/lib/mandos/network-hooks.d</filename></quote>.
356
 
          </para>
357
 
        </listitem>
358
 
      </varlistentry>
359
253
      
360
254
      <varlistentry>
361
255
        <term><option>--debug</option></term>
422
316
      <refentrytitle>plugin-runner</refentrytitle>
423
317
      <manvolnum>8mandos</manvolnum></citerefentry>) is used to run
424
318
      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.
 
319
      <emphasis>one</emphasis> of which will prompt for passwords on
 
320
      the system console.
429
321
    </para>
430
322
  </refsect1>
431
323
  
436
328
      server could be found and the password received from it could be
437
329
      successfully decrypted and output on standard output.  The
438
330
      program will exit with a non-zero exit status only if a critical
439
 
      error occurs.  Otherwise, it will forever connect to any
440
 
      discovered <application>Mandos</application> servers, trying to
441
 
      get a decryptable password and print it.
 
331
      error occurs.  Otherwise, it will forever connect to new
 
332
      <application>Mandos</application> servers as they appear, trying
 
333
      to get a decryptable password and print it.
442
334
    </para>
443
335
  </refsect1>
444
336
  
452
344
    </para>
453
345
  </refsect1>
454
346
  
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
347
  <refsect1 id="files">
625
348
    <title>FILES</title>
626
349
    <variablelist>
638
361
          </para>
639
362
        </listitem>
640
363
      </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
364
    </variablelist>
653
365
  </refsect1>
654
366
  
668
380
    </para>
669
381
    <informalexample>
670
382
      <para>
671
 
        Normal invocation needs no options, if the network interfaces
672
 
        can be automatically determined:
 
383
        Normal invocation needs no options, if the network interface
 
384
        is <quote>eth0</quote>:
673
385
      </para>
674
386
      <para>
675
387
        <userinput>&COMMANDNAME;</userinput>
677
389
    </informalexample>
678
390
    <informalexample>
679
391
      <para>
680
 
        Search for Mandos servers (and connect to them) using one
681
 
        specific interface:
 
392
        Search for Mandos servers (and connect to them) using another
 
393
        interface:
682
394
      </para>
683
395
      <para>
684
396
        <!-- do not wrap this line -->
699
411
    <informalexample>
700
412
      <para>
701
413
        Run in debug mode, with a custom key, and do not use Zeroconf
702
 
        to locate a server; connect directly to the IPv6 link-local
703
 
        address <quote><systemitem class="ipaddress"
704
 
        >fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
705
 
        using interface eth2:
 
414
        to locate a server; connect directly to the IPv6 address
 
415
        <quote><systemitem class="ipaddress"
 
416
        >2001:db8:f983:bd0b:30de:ae4a:71f2:f672</systemitem></quote>,
 
417
        port 4711, using interface eth2:
706
418
      </para>
707
419
      <para>
708
420
 
709
421
<!-- do not wrap this line -->
710
 
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect fe80::aede:48ff:fe71:f6f2:4711 --interface eth2</userinput>
 
422
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect 2001:db8:f983:bd0b:30de:ae4a:71f2:f672:4711 --interface eth2</userinput>
711
423
 
712
424
      </para>
713
425
    </informalexample>
763
475
  <refsect1 id="see_also">
764
476
    <title>SEE ALSO</title>
765
477
    <para>
766
 
      <citerefentry><refentrytitle>intro</refentrytitle>
767
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
768
478
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
769
479
      <manvolnum>8</manvolnum></citerefentry>,
770
480
      <citerefentry><refentrytitle>crypttab</refentrytitle>
848
558
              <para>
849
559
                This client uses IPv6 link-local addresses, which are
850
560
                immediately usable since a link-local addresses is
851
 
                automatically assigned to a network interface when it
 
561
                automatically assigned to a network interfaces when it
852
562
                is brought up.
853
563
              </para>
854
564
            </listitem>