/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: 2012-06-23 00:58:49 UTC
  • Revision ID: teddy@recompile.se-20120623005849-02wj82cng433rt2k
* clients.conf: Convert all time intervals to new RFC 3339 syntax.
* mandos: All client options for time intervals now take an RFC 3339
          duration.
  (rfc3339_duration_to_delta): New function.
  (string_to_delta): Try rfc3339_duration_to_delta first.
* mandos-clients.conf.xml (OPTIONS/timeout): Document new format.
  (EXAMPLE): Update to new interval format.
  (SEE ALSO): Reference RFC 3339.

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