/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: 2008-09-19 20:54:58 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080919205458-f90xsypwa6k7fby1
* debian/control (mandos-client): Depend on "cryptsetup".

* debian/mandos-client.README.Debian: Add the text from
                                      "etc-plugins.d-README".

* debian/mandos-client.postrm (purge): Hide failures.

* etc-plugins.d-README: Removed.

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">
4
5
<!ENTITY COMMANDNAME "mandos-client">
5
 
<!ENTITY TIMESTAMP "2013-06-21">
6
 
<!ENTITY % common SYSTEM "../common.ent">
7
 
%common;
 
6
<!ENTITY TIMESTAMP "2008-09-12">
8
7
]>
9
8
 
10
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
11
10
  <refentryinfo>
12
11
    <title>Mandos Manual</title>
13
 
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
 
12
    <!-- Nwalsh’s docbook scripts use this to generate the footer: -->
14
13
    <productname>Mandos</productname>
15
 
    <productnumber>&version;</productnumber>
 
14
    <productnumber>&VERSION;</productnumber>
16
15
    <date>&TIMESTAMP;</date>
17
16
    <authorgroup>
18
17
      <author>
19
18
        <firstname>Björn</firstname>
20
19
        <surname>Påhlsson</surname>
21
20
        <address>
22
 
          <email>belorn@recompile.se</email>
 
21
          <email>belorn@fukt.bsnet.se</email>
23
22
        </address>
24
23
      </author>
25
24
      <author>
26
25
        <firstname>Teddy</firstname>
27
26
        <surname>Hogeborn</surname>
28
27
        <address>
29
 
          <email>teddy@recompile.se</email>
 
28
          <email>teddy@fukt.bsnet.se</email>
30
29
        </address>
31
30
      </author>
32
31
    </authorgroup>
33
32
    <copyright>
34
33
      <year>2008</year>
35
 
      <year>2009</year>
36
 
      <year>2012</year>
37
34
      <holder>Teddy Hogeborn</holder>
38
35
      <holder>Björn Påhlsson</holder>
39
36
    </copyright>
64
61
        ><replaceable>PORT</replaceable></option></arg>
65
62
      </group>
66
63
      <sbr/>
67
 
      <group rep='repeat'>
 
64
      <group>
68
65
        <arg choice="plain"><option>--interface
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>
 
66
        <replaceable>NAME</replaceable></option></arg>
 
67
        <arg choice="plain"><option>-i
 
68
        <replaceable>NAME</replaceable></option></arg>
74
69
      </group>
75
70
      <sbr/>
76
71
      <group>
96
91
      </arg>
97
92
      <sbr/>
98
93
      <arg>
99
 
        <option>--delay <replaceable>SECONDS</replaceable></option>
100
 
      </arg>
101
 
      <sbr/>
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>
112
94
        <option>--debug</option>
113
95
      </arg>
114
96
    </cmdsynopsis>
138
120
      <command>&COMMANDNAME;</command> is a client program that
139
121
      communicates with <citerefentry><refentrytitle
140
122
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>
141
 
      to get a password.  In slightly more detail, this client program
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
146
 
      confidentiality.  This client program keeps running, trying all
147
 
      servers on the network, until it receives a satisfactory reply
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"/>.
 
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 received.
169
128
    </para>
170
129
    <para>
171
130
      This program is not meant to be run directly; it is really meant
225
184
      </varlistentry>
226
185
      
227
186
      <varlistentry>
228
 
        <term><option>--interface=<replaceable
229
 
        >NAME</replaceable><arg rep='repeat'>,<replaceable
230
 
        >NAME</replaceable></arg></option></term>
 
187
        <term><option>--interface=
 
188
        <replaceable>NAME</replaceable></option></term>
231
189
        <term><option>-i
232
 
        <replaceable>NAME</replaceable><arg rep='repeat'>,<replaceable
233
 
        >NAME</replaceable></arg></option></term>
 
190
        <replaceable>NAME</replaceable></option></term>
234
191
        <listitem>
235
192
          <para>
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.
240
 
          </para>
241
 
          <para>
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.
246
 
          </para>
247
 
          <para>
248
 
            Note that since this program will normally run in the
249
 
            initial RAM disk environment, the interface must be an
250
 
            interface which exists at that stage.  Thus, the interface
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"/>.
257
 
          </para>
258
 
          <para>
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
264
 
            recommended, and only meant for advanced users.
 
193
            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>.
 
196
          </para>
 
197
          <para>
 
198
            If the <option>--connect</option> option is used, this
 
199
            specifies the interface to use to connect to the address
 
200
            given.
265
201
          </para>
266
202
        </listitem>
267
203
      </varlistentry>
313
249
          </para>
314
250
        </listitem>
315
251
      </varlistentry>
316
 
 
317
 
      <varlistentry>
318
 
        <term><option>--delay=<replaceable
319
 
        >SECONDS</replaceable></option></term>
320
 
        <listitem>
321
 
          <para>
322
 
            After bringing a network interface up, the program waits
323
 
            for the interface to arrive in a <quote>running</quote>
324
 
            state before proceeding.  During this time, the kernel log
325
 
            level will be lowered to reduce clutter on the system
326
 
            console, alleviating any other plugins which might be
327
 
            using the system console.  This option sets the upper
328
 
            limit of seconds to wait.  The default is 2.5 seconds.
329
 
          </para>
330
 
        </listitem>
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>
357
252
      
358
253
      <varlistentry>
359
254
        <term><option>--debug</option></term>
420
315
      <refentrytitle>plugin-runner</refentrytitle>
421
316
      <manvolnum>8mandos</manvolnum></citerefentry>) is used to run
422
317
      both this program and others in in parallel,
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.
 
318
      <emphasis>one</emphasis> of which will prompt for passwords on
 
319
      the system console.
427
320
    </para>
428
321
  </refsect1>
429
322
  
434
327
      server could be found and the password received from it could be
435
328
      successfully decrypted and output on standard output.  The
436
329
      program will exit with a non-zero exit status only if a critical
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.
 
330
      error occurs.  Otherwise, it will forever connect to new
 
331
      <application>Mandos</application> servers as they appear, trying
 
332
      to get a decryptable password and print it.
440
333
    </para>
441
334
  </refsect1>
442
335
  
450
343
    </para>
451
344
  </refsect1>
452
345
  
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
 
              requirements.
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
 
  
622
 
  <refsect1 id="files">
 
346
  <refsect1 id="file">
623
347
    <title>FILES</title>
624
348
    <variablelist>
625
349
      <varlistentry>
636
360
          </para>
637
361
        </listitem>
638
362
      </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>
650
363
    </variablelist>
651
364
  </refsect1>
652
365
  
666
379
    </para>
667
380
    <informalexample>
668
381
      <para>
669
 
        Normal invocation needs no options, if the network interfaces
670
 
        can be automatically determined:
 
382
        Normal invocation needs no options, if the network interface
 
383
        is <quote>eth0</quote>:
671
384
      </para>
672
385
      <para>
673
386
        <userinput>&COMMANDNAME;</userinput>
675
388
    </informalexample>
676
389
    <informalexample>
677
390
      <para>
678
 
        Search for Mandos servers (and connect to them) using one
679
 
        specific interface:
 
391
        Search for Mandos servers (and connect to them) using another
 
392
        interface:
680
393
      </para>
681
394
      <para>
682
395
        <!-- do not wrap this line -->
697
410
    <informalexample>
698
411
      <para>
699
412
        Run in debug mode, with a custom key, and do not use Zeroconf
700
 
        to locate a server; connect directly to the IPv6 link-local
701
 
        address <quote><systemitem class="ipaddress"
702
 
        >fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
703
 
        using interface eth2:
 
413
        to locate a server; connect directly to the IPv6 address
 
414
        <quote><systemitem class="ipaddress"
 
415
        >2001:db8:f983:bd0b:30de:ae4a:71f2:f672</systemitem></quote>,
 
416
        port 4711, using interface eth2:
704
417
      </para>
705
418
      <para>
706
419
 
707
420
<!-- do not wrap this line -->
708
 
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect fe80::aede:48ff:fe71:f6f2:4711 --interface eth2</userinput>
 
421
<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
422
 
710
423
      </para>
711
424
    </informalexample>
736
449
      The only remaining weak point is that someone with physical
737
450
      access to the client hard drive might turn off the client
738
451
      computer, read the OpenPGP keys directly from the hard drive,
739
 
      and communicate with the server.  To safeguard against this, the
740
 
      server is supposed to notice the client disappearing and stop
741
 
      giving out the encrypted data.  Therefore, it is important to
742
 
      set the timeout and checker interval values tightly on the
743
 
      server.  See <citerefentry><refentrytitle
 
452
      and communicate with the server.  The defense against this is
 
453
      that the server is supposed to notice the client disappearing
 
454
      and will stop giving out the encrypted data.  Therefore, it is
 
455
      important to set the timeout and checker interval values tightly
 
456
      on the server.  See <citerefentry><refentrytitle
744
457
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
745
458
    </para>
746
459
    <para>
761
474
  <refsect1 id="see_also">
762
475
    <title>SEE ALSO</title>
763
476
    <para>
764
 
      <citerefentry><refentrytitle>intro</refentrytitle>
765
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
766
477
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
767
478
      <manvolnum>8</manvolnum></citerefentry>,
768
479
      <citerefentry><refentrytitle>crypttab</refentrytitle>
846
557
              <para>
847
558
                This client uses IPv6 link-local addresses, which are
848
559
                immediately usable since a link-local addresses is
849
 
                automatically assigned to a network interface when it
 
560
                automatically assigned to a network interfaces when it
850
561
                is brought up.
851
562
              </para>
852
563
            </listitem>