/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

* mandos (main): Catch SIGSEGV and raise RuntimeError.

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 "2011-11-27">
 
5
<!ENTITY TIMESTAMP "2009-01-24">
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
35
      <year>2009</year>
36
 
      <year>2011</year>
37
36
      <holder>Teddy Hogeborn</holder>
38
37
      <holder>Björn Påhlsson</holder>
39
38
    </copyright>
94
93
      </arg>
95
94
      <sbr/>
96
95
      <arg>
97
 
        <option>--delay <replaceable>SECONDS</replaceable></option>
98
 
      </arg>
99
 
      <sbr/>
100
 
      <arg>
101
 
        <option>--retry <replaceable>SECONDS</replaceable></option>
102
 
      </arg>
103
 
      <sbr/>
104
 
      <arg>
105
 
        <option>--network-hook-dir
106
 
        <replaceable>DIR</replaceable></option>
107
 
      </arg>
108
 
      <sbr/>
109
 
      <arg>
110
96
        <option>--debug</option>
111
97
      </arg>
112
98
    </cmdsynopsis>
143
129
      using TLS with an OpenPGP key to ensure authenticity and
144
130
      confidentiality.  This client program keeps running, trying all
145
131
      servers on the network, until it receives a satisfactory reply
146
 
      or a TERM signal.  After all servers have been tried, all
147
 
      servers are periodically retried.  If no servers are found it
148
 
      will wait indefinitely for new servers to appear.
149
 
    </para>
150
 
    <para>
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
157
 
      <citerefentry><refentrytitle>netdevice</refentrytitle>
158
 
      <manvolnum>7</manvolnum></citerefentry>).  (If the
159
 
      <option>--connect</option> option is used, point-to-point
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).
165
 
    </para>
166
 
    <para>
167
 
      Before a network interface is selected, all <quote>network
168
 
      hooks</quote> are run; see <xref linkend="network-hooks"/>.
 
132
      or a TERM signal is received.  If no servers are found, or after
 
133
      all servers have been tried, it waits indefinitely for new
 
134
      servers to appear.
169
135
    </para>
170
136
    <para>
171
137
      This program is not meant to be run directly; it is really meant
225
191
      </varlistentry>
226
192
      
227
193
      <varlistentry>
228
 
        <term><option>--interface=<replaceable
229
 
        >NAME</replaceable></option></term>
 
194
        <term><option>--interface=
 
195
        <replaceable>NAME</replaceable></option></term>
230
196
        <term><option>-i
231
197
        <replaceable>NAME</replaceable></option></term>
232
198
        <listitem>
233
199
          <para>
234
200
            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.
 
201
            Mandos servers to connect to.  The default it
 
202
            <quote><literal>eth0</literal></quote>.
238
203
          </para>
239
204
          <para>
240
205
            If the <option>--connect</option> option is used, this
248
213
            can not be a pseudo-interface such as <quote>br0</quote>
249
214
            or <quote>tun0</quote>; such interfaces will not exist
250
215
            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"/>.
253
 
          </para>
254
 
          <para>
255
 
            <replaceable>NAME</replaceable> can be the string
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.
 
216
            by this program.
260
217
          </para>
261
218
        </listitem>
262
219
      </varlistentry>
308
265
          </para>
309
266
        </listitem>
310
267
      </varlistentry>
311
 
 
312
 
      <varlistentry>
313
 
        <term><option>--delay=<replaceable
314
 
        >SECONDS</replaceable></option></term>
315
 
        <listitem>
316
 
          <para>
317
 
            After bringing the network interface up, the program waits
318
 
            for the interface to arrive in a <quote>running</quote>
319
 
            state before proceeding.  During this time, the kernel log
320
 
            level will be lowered to reduce clutter on the system
321
 
            console, alleviating any other plugins which might be
322
 
            using the system console.  This option sets the upper
323
 
            limit of seconds to wait.  The default is 2.5 seconds.
324
 
          </para>
325
 
        </listitem>
326
 
      </varlistentry>
327
 
 
328
 
      <varlistentry>
329
 
        <term><option>--retry=<replaceable
330
 
        >SECONDS</replaceable></option></term>
331
 
        <listitem>
332
 
          <para>
333
 
            All Mandos servers are tried repeatedly until a password
334
 
            is received.  This value specifies, in seconds, how long
335
 
            between each successive try <emphasis>for the same
336
 
            server</emphasis>.  The default is 10 seconds.
337
 
          </para>
338
 
        </listitem>
339
 
      </varlistentry>
340
 
 
341
 
      <varlistentry>
342
 
        <term><option>--network-hook-dir=<replaceable
343
 
        >DIR</replaceable></option></term>
344
 
        <listitem>
345
 
          <para>
346
 
            Network hook directory.  The default directory is
347
 
            <quote><filename class="directory"
348
 
            >/lib/mandos/network-hooks.d</filename></quote>.
349
 
          </para>
350
 
        </listitem>
351
 
      </varlistentry>
352
268
      
353
269
      <varlistentry>
354
270
        <term><option>--debug</option></term>
415
331
      <refentrytitle>plugin-runner</refentrytitle>
416
332
      <manvolnum>8mandos</manvolnum></citerefentry>) is used to run
417
333
      both this program and others in in parallel,
418
 
      <emphasis>one</emphasis> of which (<citerefentry>
419
 
      <refentrytitle>password-prompt</refentrytitle>
420
 
      <manvolnum>8mandos</manvolnum></citerefentry>) will prompt for
421
 
      passwords on the system console.
 
334
      <emphasis>one</emphasis> of which will prompt for passwords on
 
335
      the system console.
422
336
    </para>
423
337
  </refsect1>
424
338
  
429
343
      server could be found and the password received from it could be
430
344
      successfully decrypted and output on standard output.  The
431
345
      program will exit with a non-zero exit status only if a critical
432
 
      error occurs.  Otherwise, it will forever connect to any
433
 
      discovered <application>Mandos</application> servers, trying to
434
 
      get a decryptable password and print it.
 
346
      error occurs.  Otherwise, it will forever connect to new
 
347
      <application>Mandos</application> servers as they appear, trying
 
348
      to get a decryptable password and print it.
435
349
    </para>
436
350
  </refsect1>
437
351
  
445
359
    </para>
446
360
  </refsect1>
447
361
  
448
 
  <refsect1 id="network-hooks">
449
 
    <title>NETWORK HOOKS</title>
450
 
    <para>
451
 
      If a network interface like a bridge or tunnel is required to
452
 
      find a Mandos server, this requires the interface to be up and
453
 
      running before <command>&COMMANDNAME;</command> starts looking
454
 
      for Mandos servers.  This can be accomplished by creating a
455
 
      <quote>network hook</quote> program, and placing it in a special
456
 
      directory.
457
 
    </para>
458
 
    <para>
459
 
      Before the network is used (and again before program exit), any
460
 
      runnable programs found in the network hook directory are run
461
 
      with the argument <quote><literal>start</literal></quote> or
462
 
      <quote><literal>stop</literal></quote>.  This should bring up or
463
 
      down, respectively, any network interface which
464
 
      <command>&COMMANDNAME;</command> should use.
465
 
    </para>
466
 
    <refsect2 id="hook-requirements">
467
 
      <title>REQUIREMENTS</title>
468
 
      <para>
469
 
        A network hook must be an executable file, and its name must
470
 
        consist entirely of upper and lower case letters, digits,
471
 
        underscores, periods, and hyphens.
472
 
      </para>
473
 
      <para>
474
 
        A network hook will receive one argument, which can be one of
475
 
        the following:
476
 
      </para>
477
 
      <variablelist>
478
 
        <varlistentry>
479
 
          <term><literal>start</literal></term>
480
 
          <listitem>
481
 
            <para>
482
 
              This should make the network hook create (if necessary)
483
 
              and bring up a network interface.
484
 
            </para>
485
 
          </listitem>
486
 
        </varlistentry>
487
 
        <varlistentry>
488
 
          <term><literal>stop</literal></term>
489
 
          <listitem>
490
 
            <para>
491
 
              This should make the network hook take down a network
492
 
              interface, and delete it if it did not exist previously.
493
 
            </para>
494
 
          </listitem>
495
 
        </varlistentry>
496
 
        <varlistentry>
497
 
          <term><literal>files</literal></term>
498
 
          <listitem>
499
 
            <para>
500
 
              This should make the network hook print, <emphasis>one
501
 
              file per line</emphasis>, all the files needed for it to
502
 
              run.  (These files will be copied into the initial RAM
503
 
              filesystem.)  Typical use is for a network hook which is
504
 
              a shell script to print its needed binaries.
505
 
            </para>
506
 
            <para>
507
 
              It is not necessary to print any non-executable files
508
 
              already in the network hook directory, these will be
509
 
              copied implicitly if they otherwise satisfy the name
510
 
              requirement.
511
 
            </para>
512
 
          </listitem>
513
 
        </varlistentry>
514
 
        <varlistentry>
515
 
          <term><literal>modules</literal></term>
516
 
          <listitem>
517
 
            <para>
518
 
              This should make the network hook print, <emphasis>on
519
 
              separate lines</emphasis>, all the kernel modules needed
520
 
              for it to run.  (These modules will be copied into the
521
 
              initial RAM filesystem.)  For instance, a tunnel
522
 
              interface needs the
523
 
              <quote><literal>tun</literal></quote> module.
524
 
            </para>
525
 
          </listitem>
526
 
        </varlistentry>
527
 
      </variablelist>
528
 
      <para>
529
 
        The network hook will be provided with a number of environment
530
 
        variables:
531
 
      </para>
532
 
      <variablelist>
533
 
        <varlistentry>
534
 
          <term><envar>MANDOSNETHOOKDIR</envar></term>
535
 
          <listitem>
536
 
            <para>
537
 
              The network hook directory, specified to
538
 
              <command>&COMMANDNAME;</command> by the
539
 
              <option>--network-hook-dir</option> option.  Note: this
540
 
              should <emphasis>always</emphasis> be used by the
541
 
              network hook to refer to itself or any files in the hook
542
 
              directory it may require.
543
 
            </para>
544
 
          </listitem>
545
 
        </varlistentry>
546
 
        <varlistentry>
547
 
          <term><envar>DEVICE</envar></term>
548
 
          <listitem>
549
 
            <para>
550
 
              The network interface, as specified to
551
 
              <command>&COMMANDNAME;</command> by the
552
 
              <option>--interface</option> option.  If this is not the
553
 
              interface a hook will bring up, there is no reason for a
554
 
              hook to continue.
555
 
            </para>
556
 
          </listitem>
557
 
        </varlistentry>
558
 
        <varlistentry>
559
 
          <term><envar>MODE</envar></term>
560
 
          <listitem>
561
 
            <para>
562
 
              This will be the same as the first argument;
563
 
              i.e. <quote><literal>start</literal></quote>,
564
 
              <quote><literal>stop</literal></quote>,
565
 
              <quote><literal>files</literal></quote>, or
566
 
              <quote><literal>modules</literal></quote>.
567
 
            </para>
568
 
          </listitem>
569
 
        </varlistentry>
570
 
        <varlistentry>
571
 
          <term><envar>VERBOSITY</envar></term>
572
 
          <listitem>
573
 
            <para>
574
 
              This will be the <quote><literal>1</literal></quote> if
575
 
              the <option>--debug</option> option is passed to
576
 
              <command>&COMMANDNAME;</command>, otherwise
577
 
              <quote><literal>0</literal></quote>.
578
 
            </para>
579
 
          </listitem>
580
 
        </varlistentry>
581
 
        <varlistentry>
582
 
          <term><envar>DELAY</envar></term>
583
 
          <listitem>
584
 
            <para>
585
 
              This will be the same as the <option>--delay</option>
586
 
              option passed to <command>&COMMANDNAME;</command>.
587
 
            </para>
588
 
          </listitem>
589
 
        </varlistentry>
590
 
      </variablelist>
591
 
      <para>
592
 
        A hook may not read from standard input, and should be
593
 
        restrictive in printing to standard output or standard error
594
 
        unless <varname>VERBOSITY</varname> is
595
 
        <quote><literal>1</literal></quote>.
596
 
      </para>
597
 
    </refsect2>
598
 
  </refsect1>
599
 
  
600
362
  <refsect1 id="files">
601
363
    <title>FILES</title>
602
364
    <variablelist>
614
376
          </para>
615
377
        </listitem>
616
378
      </varlistentry>
617
 
      <varlistentry>
618
 
        <term><filename
619
 
        class="directory">/lib/mandos/network-hooks.d</filename></term>
620
 
        <listitem>
621
 
          <para>
622
 
            Directory where network hooks are located.  Change this
623
 
            with the <option>--network-hook-dir</option> option.  See
624
 
            <xref linkend="network-hooks"/>.
625
 
          </para>
626
 
        </listitem>
627
 
      </varlistentry>
628
379
    </variablelist>
629
380
  </refsect1>
630
381
  
675
426
    <informalexample>
676
427
      <para>
677
428
        Run in debug mode, with a custom key, and do not use Zeroconf
678
 
        to locate a server; connect directly to the IPv6 link-local
679
 
        address <quote><systemitem class="ipaddress"
680
 
        >fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
681
 
        using interface eth2:
 
429
        to locate a server; connect directly to the IPv6 address
 
430
        <quote><systemitem class="ipaddress"
 
431
        >2001:db8:f983:bd0b:30de:ae4a:71f2:f672</systemitem></quote>,
 
432
        port 4711, using interface eth2:
682
433
      </para>
683
434
      <para>
684
435
 
685
436
<!-- do not wrap this line -->
686
 
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect fe80::aede:48ff:fe71:f6f2:4711 --interface eth2</userinput>
 
437
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect 2001:db8:f983:bd0b:30de:ae4a:71f2:f672:4711 --interface eth2</userinput>
687
438
 
688
439
      </para>
689
440
    </informalexample>
739
490
  <refsect1 id="see_also">
740
491
    <title>SEE ALSO</title>
741
492
    <para>
742
 
      <citerefentry><refentrytitle>intro</refentrytitle>
743
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
744
493
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
745
494
      <manvolnum>8</manvolnum></citerefentry>,
746
495
      <citerefentry><refentrytitle>crypttab</refentrytitle>