/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

* plugins.d/mandos-client.c (run_network_hooks): Do _exit() on failure
                                                 in child process.

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugins.d/mandos-client.xml
1
1
<?xml version="1.0" encoding="UTF-8"?>
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
 
<!ENTITY VERSION "1.0">
5
 
<!ENTITY COMMANDNAME "password-request">
6
 
<!ENTITY TIMESTAMP "2008-09-03">
 
4
<!ENTITY COMMANDNAME "mandos-client">
 
5
<!ENTITY TIMESTAMP "2011-11-27">
 
6
<!ENTITY % common SYSTEM "../common.ent">
 
7
%common;
7
8
]>
8
9
 
9
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
10
11
  <refentryinfo>
11
12
    <title>Mandos Manual</title>
12
 
    <!-- Nwalsh’s docbook scripts use this to generate the footer: -->
 
13
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
13
14
    <productname>Mandos</productname>
14
 
    <productnumber>&VERSION;</productnumber>
 
15
    <productnumber>&version;</productnumber>
15
16
    <date>&TIMESTAMP;</date>
16
17
    <authorgroup>
17
18
      <author>
18
19
        <firstname>Björn</firstname>
19
20
        <surname>Påhlsson</surname>
20
21
        <address>
21
 
          <email>belorn@fukt.bsnet.se</email>
 
22
          <email>belorn@recompile.se</email>
22
23
        </address>
23
24
      </author>
24
25
      <author>
25
26
        <firstname>Teddy</firstname>
26
27
        <surname>Hogeborn</surname>
27
28
        <address>
28
 
          <email>teddy@fukt.bsnet.se</email>
 
29
          <email>teddy@recompile.se</email>
29
30
        </address>
30
31
      </author>
31
32
    </authorgroup>
32
33
    <copyright>
33
34
      <year>2008</year>
 
35
      <year>2009</year>
 
36
      <year>2011</year>
34
37
      <holder>Teddy Hogeborn</holder>
35
38
      <holder>Björn Påhlsson</holder>
36
39
    </copyright>
37
40
    <xi:include href="../legalnotice.xml"/>
38
41
  </refentryinfo>
39
 
 
 
42
  
40
43
  <refmeta>
41
44
    <refentrytitle>&COMMANDNAME;</refentrytitle>
42
45
    <manvolnum>8mandos</manvolnum>
45
48
  <refnamediv>
46
49
    <refname><command>&COMMANDNAME;</command></refname>
47
50
    <refpurpose>
48
 
      Client for mandos
 
51
      Client for <application>Mandos</application>
49
52
    </refpurpose>
50
53
  </refnamediv>
51
 
 
 
54
  
52
55
  <refsynopsisdiv>
53
56
    <cmdsynopsis>
54
57
      <command>&COMMANDNAME;</command>
55
58
      <group>
56
59
        <arg choice="plain"><option>--connect
57
 
        <replaceable>IPADDR</replaceable><literal>:</literal
 
60
        <replaceable>ADDRESS</replaceable><literal>:</literal
58
61
        ><replaceable>PORT</replaceable></option></arg>
59
62
        <arg choice="plain"><option>-c
60
 
        <replaceable>IPADDR</replaceable><literal>:</literal
 
63
        <replaceable>ADDRESS</replaceable><literal>:</literal
61
64
        ><replaceable>PORT</replaceable></option></arg>
62
65
      </group>
63
66
      <sbr/>
91
94
      </arg>
92
95
      <sbr/>
93
96
      <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>
94
110
        <option>--debug</option>
95
111
      </arg>
96
112
    </cmdsynopsis>
113
129
      </group>
114
130
    </cmdsynopsis>
115
131
  </refsynopsisdiv>
116
 
 
 
132
  
117
133
  <refsect1 id="description">
118
134
    <title>DESCRIPTION</title>
119
135
    <para>
120
136
      <command>&COMMANDNAME;</command> is a client program that
121
137
      communicates with <citerefentry><refentrytitle
122
138
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>
123
 
      to get a password.  It uses IPv6 link-local addresses to get
124
 
      network connectivity, Zeroconf to find servers, and TLS with an
125
 
      OpenPGP key to ensure authenticity and confidentiality.  It
126
 
      keeps running, trying all servers on the network, until it
127
 
      receives a satisfactory reply or a TERM signal is recieved.
 
139
      to get a password.  In slightly more detail, this client program
 
140
      brings up a network interface, uses the interface’s IPv6
 
141
      link-local address to get network connectivity, uses Zeroconf to
 
142
      find servers on the local network, and communicates with servers
 
143
      using TLS with an OpenPGP key to ensure authenticity and
 
144
      confidentiality.  This client program keeps running, trying all
 
145
      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"/>.
128
169
    </para>
129
170
    <para>
130
171
      This program is not meant to be run directly; it is really meant
184
225
      </varlistentry>
185
226
      
186
227
      <varlistentry>
187
 
        <term><option>--interface=
188
 
        <replaceable>NAME</replaceable></option></term>
 
228
        <term><option>--interface=<replaceable
 
229
        >NAME</replaceable></option></term>
189
230
        <term><option>-i
190
231
        <replaceable>NAME</replaceable></option></term>
191
232
        <listitem>
192
233
          <para>
193
234
            Network interface that will be brought up and scanned for
194
 
            Mandos servers to connect to.  The default it
195
 
            <quote><literal>eth0</literal></quote>.
 
235
            Mandos servers to connect to.  The default is the empty
 
236
            string, which will automatically choose an appropriate
 
237
            interface.
196
238
          </para>
197
239
          <para>
198
240
            If the <option>--connect</option> option is used, this
199
241
            specifies the interface to use to connect to the address
200
242
            given.
201
243
          </para>
 
244
          <para>
 
245
            Note that since this program will normally run in the
 
246
            initial RAM disk environment, the interface must be an
 
247
            interface which exists at that stage.  Thus, the interface
 
248
            can not be a pseudo-interface such as <quote>br0</quote>
 
249
            or <quote>tun0</quote>; such interfaces will not exist
 
250
            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.
 
260
          </para>
202
261
        </listitem>
203
262
      </varlistentry>
204
263
      
215
274
          </para>
216
275
        </listitem>
217
276
      </varlistentry>
218
 
 
 
277
      
219
278
      <varlistentry>
220
279
        <term><option>--seckey=<replaceable
221
280
        >FILE</replaceable></option></term>
238
297
                      xpointer="priority"/>
239
298
        </listitem>
240
299
      </varlistentry>
241
 
 
 
300
      
242
301
      <varlistentry>
243
302
        <term><option>--dh-bits=<replaceable
244
303
        >BITS</replaceable></option></term>
249
308
          </para>
250
309
        </listitem>
251
310
      </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>
252
352
      
253
353
      <varlistentry>
254
354
        <term><option>--debug</option></term>
284
384
          </para>
285
385
        </listitem>
286
386
      </varlistentry>
287
 
 
 
387
      
288
388
      <varlistentry>
289
389
        <term><option>--version</option></term>
290
390
        <term><option>-V</option></term>
296
396
      </varlistentry>
297
397
    </variablelist>
298
398
  </refsect1>
299
 
 
 
399
  
300
400
  <refsect1 id="overview">
301
401
    <title>OVERVIEW</title>
302
402
    <xi:include href="../overview.xml"/>
311
411
      <filename>/etc/crypttab</filename>, but it would then be
312
412
      impossible to enter a password for the encrypted root disk at
313
413
      the console, since this program does not read from the console
314
 
      at all.  This is why a separate plugin (<citerefentry>
 
414
      at all.  This is why a separate plugin runner (<citerefentry>
 
415
      <refentrytitle>plugin-runner</refentrytitle>
 
416
      <manvolnum>8mandos</manvolnum></citerefentry>) is used to run
 
417
      both this program and others in in parallel,
 
418
      <emphasis>one</emphasis> of which (<citerefentry>
315
419
      <refentrytitle>password-prompt</refentrytitle>
316
 
      <manvolnum>8mandos</manvolnum></citerefentry>) does that, which
317
 
      will be run in parallell to this one by the plugin runner.
 
420
      <manvolnum>8mandos</manvolnum></citerefentry>) will prompt for
 
421
      passwords on the system console.
318
422
    </para>
319
423
  </refsect1>
320
424
  
325
429
      server could be found and the password received from it could be
326
430
      successfully decrypted and output on standard output.  The
327
431
      program will exit with a non-zero exit status only if a critical
328
 
      error occurs.  Otherwise, it will forever connect to new
329
 
      <application>Mandos</application> servers as they appear, trying
330
 
      to get a decryptable password.
 
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.
331
435
    </para>
332
436
  </refsect1>
333
437
  
341
445
    </para>
342
446
  </refsect1>
343
447
  
344
 
  <refsect1 id="file">
 
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
  <refsect1 id="files">
345
601
    <title>FILES</title>
346
602
    <variablelist>
347
603
      <varlistentry>
358
614
          </para>
359
615
        </listitem>
360
616
      </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>
361
628
    </variablelist>
362
629
  </refsect1>
363
630
  
366
633
<!--     <para> -->
367
634
<!--     </para> -->
368
635
<!--   </refsect1> -->
369
 
 
 
636
  
370
637
  <refsect1 id="example">
371
638
    <title>EXAMPLE</title>
372
639
    <para>
386
653
    </informalexample>
387
654
    <informalexample>
388
655
      <para>
389
 
        Search for Mandos servers on another interface:
 
656
        Search for Mandos servers (and connect to them) using another
 
657
        interface:
390
658
      </para>
391
659
      <para>
392
660
        <!-- do not wrap this line -->
407
675
    <informalexample>
408
676
      <para>
409
677
        Run in debug mode, with a custom key, and do not use Zeroconf
410
 
        to locate a server; connect directly to the IPv6 address
411
 
        <quote><systemitem class="ipaddress"
412
 
        >2001:db8:f983:bd0b:30de:ae4a:71f2:f672</systemitem></quote>,
413
 
        port 4711, using interface eth2:
 
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:
414
682
      </para>
415
683
      <para>
416
684
 
417
685
<!-- do not wrap this line -->
418
 
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect 2001:db8:f983:bd0b:30de:ae4a:71f2:f672:4711 --interface eth2</userinput>
 
686
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect fe80::aede:48ff:fe71:f6f2:4711 --interface eth2</userinput>
419
687
 
420
688
      </para>
421
689
    </informalexample>
422
690
  </refsect1>
423
 
 
 
691
  
424
692
  <refsect1 id="security">
425
693
    <title>SECURITY</title>
426
694
    <para>
446
714
      The only remaining weak point is that someone with physical
447
715
      access to the client hard drive might turn off the client
448
716
      computer, read the OpenPGP keys directly from the hard drive,
449
 
      and communicate with the server.  The defense against this is
450
 
      that the server is supposed to notice the client disappearing
451
 
      and will stop giving out the encrypted data.  Therefore, it is
452
 
      important to set the timeout and checker interval values tightly
453
 
      on the server.  See <citerefentry><refentrytitle
 
717
      and communicate with the server.  To safeguard against this, the
 
718
      server is supposed to notice the client disappearing and stop
 
719
      giving out the encrypted data.  Therefore, it is important to
 
720
      set the timeout and checker interval values tightly on the
 
721
      server.  See <citerefentry><refentrytitle
454
722
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
455
723
    </para>
456
724
    <para>
467
735
      confidential.
468
736
    </para>
469
737
  </refsect1>
470
 
 
 
738
  
471
739
  <refsect1 id="see_also">
472
740
    <title>SEE ALSO</title>
473
741
    <para>
 
742
      <citerefentry><refentrytitle>intro</refentrytitle>
 
743
      <manvolnum>8mandos</manvolnum></citerefentry>,
474
744
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
475
745
      <manvolnum>8</manvolnum></citerefentry>,
476
746
      <citerefentry><refentrytitle>crypttab</refentrytitle>
598
868
      </varlistentry>
599
869
    </variablelist>
600
870
  </refsect1>
601
 
 
602
871
</refentry>
 
872
 
603
873
<!-- Local Variables: -->
604
874
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
605
875
<!-- time-stamp-end: "[\"']>" -->