/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: 2014-03-01 09:43:10 UTC
  • mto: (237.7.272 trunk)
  • mto: This revision was merged to the branch mainline in revision 311.
  • Revision ID: teddy@recompile.se-20140301094310-c8j8ejchfc4a3bqi
* debian/control (Build-Depends, Build-Depends-Indep): Moved build
  dependencies of "mandos" package to "Build-Depends-Indep".

Show diffs side-by-side

added added

removed removed

Lines of Context:
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
4
<!ENTITY COMMANDNAME "mandos-client">
6
 
<!ENTITY TIMESTAMP "2008-09-12">
 
5
<!ENTITY TIMESTAMP "2014-03-01">
 
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>2012</year>
 
37
      <year>2013</year>
 
38
      <year>2014</year>
34
39
      <holder>Teddy Hogeborn</holder>
35
40
      <holder>Björn Påhlsson</holder>
36
41
    </copyright>
61
66
        ><replaceable>PORT</replaceable></option></arg>
62
67
      </group>
63
68
      <sbr/>
64
 
      <group>
 
69
      <group rep='repeat'>
65
70
        <arg choice="plain"><option>--interface
66
 
        <replaceable>NAME</replaceable></option></arg>
67
 
        <arg choice="plain"><option>-i
68
 
        <replaceable>NAME</replaceable></option></arg>
 
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>
69
76
      </group>
70
77
      <sbr/>
71
78
      <group>
91
98
      </arg>
92
99
      <sbr/>
93
100
      <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>
94
114
        <option>--debug</option>
95
115
      </arg>
96
116
    </cmdsynopsis>
120
140
      <command>&COMMANDNAME;</command> is a client program that
121
141
      communicates with <citerefentry><refentrytitle
122
142
      >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 received.
 
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"/>.
128
171
    </para>
129
172
    <para>
130
173
      This program is not meant to be run directly; it is really meant
177
220
            assumed to separate the address from the port number.
178
221
          </para>
179
222
          <para>
180
 
            This option is normally only useful for testing and
181
 
            debugging.
 
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.
182
226
          </para>
183
227
        </listitem>
184
228
      </varlistentry>
185
229
      
186
230
      <varlistentry>
187
 
        <term><option>--interface=
188
 
        <replaceable>NAME</replaceable></option></term>
 
231
        <term><option>--interface=<replaceable
 
232
        >NAME</replaceable><arg rep='repeat'>,<replaceable
 
233
        >NAME</replaceable></arg></option></term>
189
234
        <term><option>-i
190
 
        <replaceable>NAME</replaceable></option></term>
 
235
        <replaceable>NAME</replaceable><arg rep='repeat'>,<replaceable
 
236
        >NAME</replaceable></arg></option></term>
191
237
        <listitem>
192
238
          <para>
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.
 
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> not bring up
 
265
            <emphasis>any</emphasis> interfaces specified
 
266
            <emphasis>after</emphasis> this string.  This is not
 
267
            recommended, and only meant for advanced users.
201
268
          </para>
202
269
        </listitem>
203
270
      </varlistentry>
249
316
          </para>
250
317
        </listitem>
251
318
      </varlistentry>
 
319
 
 
320
      <varlistentry>
 
321
        <term><option>--delay=<replaceable
 
322
        >SECONDS</replaceable></option></term>
 
323
        <listitem>
 
324
          <para>
 
325
            After bringing a network interface up, the program waits
 
326
            for the interface to arrive in a <quote>running</quote>
 
327
            state before proceeding.  During this time, the kernel log
 
328
            level will be lowered to reduce clutter on the system
 
329
            console, alleviating any other plugins which might be
 
330
            using the system console.  This option sets the upper
 
331
            limit of seconds to wait.  The default is 2.5 seconds.
 
332
          </para>
 
333
        </listitem>
 
334
      </varlistentry>
 
335
 
 
336
      <varlistentry>
 
337
        <term><option>--retry=<replaceable
 
338
        >SECONDS</replaceable></option></term>
 
339
        <listitem>
 
340
          <para>
 
341
            All Mandos servers are tried repeatedly until a password
 
342
            is received.  This value specifies, in seconds, how long
 
343
            between each successive try <emphasis>for the same
 
344
            server</emphasis>.  The default is 10 seconds.
 
345
          </para>
 
346
        </listitem>
 
347
      </varlistentry>
 
348
 
 
349
      <varlistentry>
 
350
        <term><option>--network-hook-dir=<replaceable
 
351
        >DIR</replaceable></option></term>
 
352
        <listitem>
 
353
          <para>
 
354
            Network hook directory.  The default directory is
 
355
            <quote><filename class="directory"
 
356
            >/lib/mandos/network-hooks.d</filename></quote>.
 
357
          </para>
 
358
        </listitem>
 
359
      </varlistentry>
252
360
      
253
361
      <varlistentry>
254
362
        <term><option>--debug</option></term>
315
423
      <refentrytitle>plugin-runner</refentrytitle>
316
424
      <manvolnum>8mandos</manvolnum></citerefentry>) is used to run
317
425
      both this program and others in in parallel,
318
 
      <emphasis>one</emphasis> of which will prompt for passwords on
319
 
      the system console.
 
426
      <emphasis>one</emphasis> of which (<citerefentry>
 
427
      <refentrytitle>password-prompt</refentrytitle>
 
428
      <manvolnum>8mandos</manvolnum></citerefentry>) will prompt for
 
429
      passwords on the system console.
320
430
    </para>
321
431
  </refsect1>
322
432
  
327
437
      server could be found and the password received from it could be
328
438
      successfully decrypted and output on standard output.  The
329
439
      program will exit with a non-zero exit status only if a critical
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
      error occurs.  Otherwise, it will forever connect to any
 
441
      discovered <application>Mandos</application> servers, trying to
 
442
      get a decryptable password and print it.
333
443
    </para>
334
444
  </refsect1>
335
445
  
343
453
    </para>
344
454
  </refsect1>
345
455
  
346
 
  <refsect1 id="file">
 
456
  <refsect1 id="network-hooks">
 
457
    <title>NETWORK HOOKS</title>
 
458
    <para>
 
459
      If a network interface like a bridge or tunnel is required to
 
460
      find a Mandos server, this requires the interface to be up and
 
461
      running before <command>&COMMANDNAME;</command> starts looking
 
462
      for Mandos servers.  This can be accomplished by creating a
 
463
      <quote>network hook</quote> program, and placing it in a special
 
464
      directory.
 
465
    </para>
 
466
    <para>
 
467
      Before the network is used (and again before program exit), any
 
468
      runnable programs found in the network hook directory are run
 
469
      with the argument <quote><literal>start</literal></quote> or
 
470
      <quote><literal>stop</literal></quote>.  This should bring up or
 
471
      down, respectively, any network interface which
 
472
      <command>&COMMANDNAME;</command> should use.
 
473
    </para>
 
474
    <refsect2 id="hook-requirements">
 
475
      <title>REQUIREMENTS</title>
 
476
      <para>
 
477
        A network hook must be an executable file, and its name must
 
478
        consist entirely of upper and lower case letters, digits,
 
479
        underscores, periods, and hyphens.
 
480
      </para>
 
481
      <para>
 
482
        A network hook will receive one argument, which can be one of
 
483
        the following:
 
484
      </para>
 
485
      <variablelist>
 
486
        <varlistentry>
 
487
          <term><literal>start</literal></term>
 
488
          <listitem>
 
489
            <para>
 
490
              This should make the network hook create (if necessary)
 
491
              and bring up a network interface.
 
492
            </para>
 
493
          </listitem>
 
494
        </varlistentry>
 
495
        <varlistentry>
 
496
          <term><literal>stop</literal></term>
 
497
          <listitem>
 
498
            <para>
 
499
              This should make the network hook take down a network
 
500
              interface, and delete it if it did not exist previously.
 
501
            </para>
 
502
          </listitem>
 
503
        </varlistentry>
 
504
        <varlistentry>
 
505
          <term><literal>files</literal></term>
 
506
          <listitem>
 
507
            <para>
 
508
              This should make the network hook print, <emphasis>one
 
509
              file per line</emphasis>, all the files needed for it to
 
510
              run.  (These files will be copied into the initial RAM
 
511
              filesystem.)  Typical use is for a network hook which is
 
512
              a shell script to print its needed binaries.
 
513
            </para>
 
514
            <para>
 
515
              It is not necessary to print any non-executable files
 
516
              already in the network hook directory, these will be
 
517
              copied implicitly if they otherwise satisfy the name
 
518
              requirements.
 
519
            </para>
 
520
          </listitem>
 
521
        </varlistentry>
 
522
        <varlistentry>
 
523
          <term><literal>modules</literal></term>
 
524
          <listitem>
 
525
            <para>
 
526
              This should make the network hook print, <emphasis>on
 
527
              separate lines</emphasis>, all the kernel modules needed
 
528
              for it to run.  (These modules will be copied into the
 
529
              initial RAM filesystem.)  For instance, a tunnel
 
530
              interface needs the
 
531
              <quote><literal>tun</literal></quote> module.
 
532
            </para>
 
533
          </listitem>
 
534
        </varlistentry>
 
535
      </variablelist>
 
536
      <para>
 
537
        The network hook will be provided with a number of environment
 
538
        variables:
 
539
      </para>
 
540
      <variablelist>
 
541
        <varlistentry>
 
542
          <term><envar>MANDOSNETHOOKDIR</envar></term>
 
543
          <listitem>
 
544
            <para>
 
545
              The network hook directory, specified to
 
546
              <command>&COMMANDNAME;</command> by the
 
547
              <option>--network-hook-dir</option> option.  Note: this
 
548
              should <emphasis>always</emphasis> be used by the
 
549
              network hook to refer to itself or any files in the hook
 
550
              directory it may require.
 
551
            </para>
 
552
          </listitem>
 
553
        </varlistentry>
 
554
        <varlistentry>
 
555
          <term><envar>DEVICE</envar></term>
 
556
          <listitem>
 
557
            <para>
 
558
              The network interfaces, as specified to
 
559
              <command>&COMMANDNAME;</command> by the
 
560
              <option>--interface</option> option, combined to one
 
561
              string and separated by commas.  If this is set, and
 
562
              does not contain the interface a hook will bring up,
 
563
              there is no reason for a hook to continue.
 
564
            </para>
 
565
          </listitem>
 
566
        </varlistentry>
 
567
        <varlistentry>
 
568
          <term><envar>MODE</envar></term>
 
569
          <listitem>
 
570
            <para>
 
571
              This will be the same as the first argument;
 
572
              i.e. <quote><literal>start</literal></quote>,
 
573
              <quote><literal>stop</literal></quote>,
 
574
              <quote><literal>files</literal></quote>, or
 
575
              <quote><literal>modules</literal></quote>.
 
576
            </para>
 
577
          </listitem>
 
578
        </varlistentry>
 
579
        <varlistentry>
 
580
          <term><envar>VERBOSITY</envar></term>
 
581
          <listitem>
 
582
            <para>
 
583
              This will be the <quote><literal>1</literal></quote> if
 
584
              the <option>--debug</option> option is passed to
 
585
              <command>&COMMANDNAME;</command>, otherwise
 
586
              <quote><literal>0</literal></quote>.
 
587
            </para>
 
588
          </listitem>
 
589
        </varlistentry>
 
590
        <varlistentry>
 
591
          <term><envar>DELAY</envar></term>
 
592
          <listitem>
 
593
            <para>
 
594
              This will be the same as the <option>--delay</option>
 
595
              option passed to <command>&COMMANDNAME;</command>.  Is
 
596
              only set if <envar>MODE</envar> is
 
597
              <quote><literal>start</literal></quote> or
 
598
              <quote><literal>stop</literal></quote>.
 
599
            </para>
 
600
          </listitem>
 
601
        </varlistentry>
 
602
        <varlistentry>
 
603
          <term><envar>CONNECT</envar></term>
 
604
          <listitem>
 
605
            <para>
 
606
              This will be the same as the <option>--connect</option>
 
607
              option passed to <command>&COMMANDNAME;</command>.  Is
 
608
              only set if <option>--connect</option> is passed and
 
609
              <envar>MODE</envar> is
 
610
              <quote><literal>start</literal></quote> or
 
611
              <quote><literal>stop</literal></quote>.
 
612
            </para>
 
613
          </listitem>
 
614
        </varlistentry>
 
615
      </variablelist>
 
616
      <para>
 
617
        A hook may not read from standard input, and should be
 
618
        restrictive in printing to standard output or standard error
 
619
        unless <varname>VERBOSITY</varname> is
 
620
        <quote><literal>1</literal></quote>.
 
621
      </para>
 
622
    </refsect2>
 
623
  </refsect1>
 
624
  
 
625
  <refsect1 id="files">
347
626
    <title>FILES</title>
348
627
    <variablelist>
349
628
      <varlistentry>
360
639
          </para>
361
640
        </listitem>
362
641
      </varlistentry>
 
642
      <varlistentry>
 
643
        <term><filename
 
644
        class="directory">/lib/mandos/network-hooks.d</filename></term>
 
645
        <listitem>
 
646
          <para>
 
647
            Directory where network hooks are located.  Change this
 
648
            with the <option>--network-hook-dir</option> option.  See
 
649
            <xref linkend="network-hooks"/>.
 
650
          </para>
 
651
        </listitem>
 
652
      </varlistentry>
363
653
    </variablelist>
364
654
  </refsect1>
365
655
  
379
669
    </para>
380
670
    <informalexample>
381
671
      <para>
382
 
        Normal invocation needs no options, if the network interface
383
 
        is <quote>eth0</quote>:
 
672
        Normal invocation needs no options, if the network interfaces
 
673
        can be automatically determined:
384
674
      </para>
385
675
      <para>
386
676
        <userinput>&COMMANDNAME;</userinput>
388
678
    </informalexample>
389
679
    <informalexample>
390
680
      <para>
391
 
        Search for Mandos servers (and connect to them) using another
392
 
        interface:
 
681
        Search for Mandos servers (and connect to them) using one
 
682
        specific interface:
393
683
      </para>
394
684
      <para>
395
685
        <!-- do not wrap this line -->
410
700
    <informalexample>
411
701
      <para>
412
702
        Run in debug mode, with a custom key, and do not use Zeroconf
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:
 
703
        to locate a server; connect directly to the IPv6 link-local
 
704
        address <quote><systemitem class="ipaddress"
 
705
        >fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
 
706
        using interface eth2:
417
707
      </para>
418
708
      <para>
419
709
 
420
710
<!-- do not wrap this line -->
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>
 
711
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect fe80::aede:48ff:fe71:f6f2:4711 --interface eth2</userinput>
422
712
 
423
713
      </para>
424
714
    </informalexample>
449
739
      The only remaining weak point is that someone with physical
450
740
      access to the client hard drive might turn off the client
451
741
      computer, read the OpenPGP keys directly from the hard drive,
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
 
742
      and communicate with the server.  To safeguard against this, the
 
743
      server is supposed to notice the client disappearing and stop
 
744
      giving out the encrypted data.  Therefore, it is important to
 
745
      set the timeout and checker interval values tightly on the
 
746
      server.  See <citerefentry><refentrytitle
457
747
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
458
748
    </para>
459
749
    <para>
474
764
  <refsect1 id="see_also">
475
765
    <title>SEE ALSO</title>
476
766
    <para>
 
767
      <citerefentry><refentrytitle>intro</refentrytitle>
 
768
      <manvolnum>8mandos</manvolnum></citerefentry>,
477
769
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
478
770
      <manvolnum>8</manvolnum></citerefentry>,
479
771
      <citerefentry><refentrytitle>crypttab</refentrytitle>
557
849
              <para>
558
850
                This client uses IPv6 link-local addresses, which are
559
851
                immediately usable since a link-local addresses is
560
 
                automatically assigned to a network interfaces when it
 
852
                automatically assigned to a network interface when it
561
853
                is brought up.
562
854
              </para>
563
855
            </listitem>