/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: 2008-10-01 18:41:06 UTC
  • Revision ID: teddy@fukt.bsnet.se-20081001184106-r728au6iv0lq8orm
Tags: version-1.0-2
* debian/changelog: Add Debian revision number to old revision too.

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 "2015-07-08">
 
5
<!ENTITY TIMESTAMP "2008-09-30">
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
 
      <year>2009</year>
36
 
      <year>2012</year>
37
 
      <year>2013</year>
38
 
      <year>2014</year>
39
 
      <year>2015</year>
40
35
      <holder>Teddy Hogeborn</holder>
41
36
      <holder>Björn Påhlsson</holder>
42
37
    </copyright>
67
62
        ><replaceable>PORT</replaceable></option></arg>
68
63
      </group>
69
64
      <sbr/>
70
 
      <group rep='repeat'>
 
65
      <group>
71
66
        <arg choice="plain"><option>--interface
72
 
        <replaceable>NAME</replaceable><arg rep='repeat'
73
 
        >,<replaceable>NAME</replaceable></arg></option></arg>
74
 
        <arg choice="plain"><option>-i <replaceable>NAME</replaceable
75
 
        ><arg rep='repeat'>,<replaceable>NAME</replaceable></arg
76
 
        ></option></arg>
 
67
        <replaceable>NAME</replaceable></option></arg>
 
68
        <arg choice="plain"><option>-i
 
69
        <replaceable>NAME</replaceable></option></arg>
77
70
      </group>
78
71
      <sbr/>
79
72
      <group>
99
92
      </arg>
100
93
      <sbr/>
101
94
      <arg>
102
 
        <option>--dh-params <replaceable>FILE</replaceable></option>
103
 
      </arg>
104
 
      <sbr/>
105
 
      <arg>
106
 
        <option>--delay <replaceable>SECONDS</replaceable></option>
107
 
      </arg>
108
 
      <sbr/>
109
 
      <arg>
110
 
        <option>--retry <replaceable>SECONDS</replaceable></option>
111
 
      </arg>
112
 
      <sbr/>
113
 
      <arg>
114
 
        <option>--network-hook-dir
115
 
        <replaceable>DIR</replaceable></option>
116
 
      </arg>
117
 
      <sbr/>
118
 
      <arg>
119
95
        <option>--debug</option>
120
96
      </arg>
121
97
    </cmdsynopsis>
145
121
      <command>&COMMANDNAME;</command> is a client program that
146
122
      communicates with <citerefentry><refentrytitle
147
123
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>
148
 
      to get a password.  In slightly more detail, this client program
149
 
      brings up network interfaces, uses the interfaces’ IPv6
150
 
      link-local addresses to get network connectivity, uses Zeroconf
151
 
      to find servers on the local network, and communicates with
152
 
      servers using TLS with an OpenPGP key to ensure authenticity and
153
 
      confidentiality.  This client program keeps running, trying all
154
 
      servers on the network, until it receives a satisfactory reply
155
 
      or a TERM signal.  After all servers have been tried, all
156
 
      servers are periodically retried.  If no servers are found it
157
 
      will wait indefinitely for new servers to appear.
158
 
    </para>
159
 
    <para>
160
 
      The network interfaces are selected like this: If any interfaces
161
 
      are specified using the <option>--interface</option> option,
162
 
      those interface are used.  Otherwise,
163
 
      <command>&COMMANDNAME;</command> will use all interfaces that
164
 
      are not loopback interfaces, are not point-to-point interfaces,
165
 
      are capable of broadcasting and do not have the NOARP flag (see
166
 
      <citerefentry><refentrytitle>netdevice</refentrytitle>
167
 
      <manvolnum>7</manvolnum></citerefentry>).  (If the
168
 
      <option>--connect</option> option is used, point-to-point
169
 
      interfaces and non-broadcast interfaces are accepted.)  If any
170
 
      used interfaces are not up and running, they are first taken up
171
 
      (and later taken down again on program exit).
172
 
    </para>
173
 
    <para>
174
 
      Before network interfaces are selected, all <quote>network
175
 
      hooks</quote> are run; see <xref linkend="network-hooks"/>.
 
124
      to get a password.  It uses IPv6 link-local addresses to get
 
125
      network connectivity, Zeroconf to find servers, and TLS with an
 
126
      OpenPGP key to ensure authenticity and confidentiality.  It
 
127
      keeps running, trying all servers on the network, until it
 
128
      receives a satisfactory reply or a TERM signal is received.
176
129
    </para>
177
130
    <para>
178
131
      This program is not meant to be run directly; it is really meant
225
178
            assumed to separate the address from the port number.
226
179
          </para>
227
180
          <para>
228
 
            Normally, Zeroconf would be used to locate Mandos servers,
229
 
            in which case this option would only be used when testing
230
 
            and debugging.
 
181
            This option is normally only useful for testing and
 
182
            debugging.
231
183
          </para>
232
184
        </listitem>
233
185
      </varlistentry>
234
186
      
235
187
      <varlistentry>
236
 
        <term><option>--interface=<replaceable
237
 
        >NAME</replaceable><arg rep='repeat'>,<replaceable
238
 
        >NAME</replaceable></arg></option></term>
 
188
        <term><option>--interface=
 
189
        <replaceable>NAME</replaceable></option></term>
239
190
        <term><option>-i
240
 
        <replaceable>NAME</replaceable><arg rep='repeat'>,<replaceable
241
 
        >NAME</replaceable></arg></option></term>
 
191
        <replaceable>NAME</replaceable></option></term>
242
192
        <listitem>
243
193
          <para>
244
 
            Comma separated list of network interfaces that will be
245
 
            brought up and scanned for Mandos servers to connect to.
246
 
            The default is the empty string, which will automatically
247
 
            use all appropriate interfaces.
248
 
          </para>
249
 
          <para>
250
 
            If the <option>--connect</option> option is used, and
251
 
            exactly one interface name is specified (except
252
 
            <quote><literal>none</literal></quote>), this specifies
253
 
            the interface to use to connect to the address given.
254
 
          </para>
255
 
          <para>
256
 
            Note that since this program will normally run in the
257
 
            initial RAM disk environment, the interface must be an
258
 
            interface which exists at that stage.  Thus, the interface
259
 
            can normally not be a pseudo-interface such as
260
 
            <quote>br0</quote> or <quote>tun0</quote>; such interfaces
261
 
            will not exist until much later in the boot process, and
262
 
            can not be used by this program, unless created by a
263
 
            <quote>network hook</quote> — see <xref
264
 
            linkend="network-hooks"/>.
265
 
          </para>
266
 
          <para>
267
 
            <replaceable>NAME</replaceable> can be the string
268
 
            <quote><literal>none</literal></quote>; this will make
269
 
            <command>&COMMANDNAME;</command> only bring up interfaces
270
 
            specified <emphasis>before</emphasis> this string.  This
271
 
            is not recommended, and only meant for advanced users.
 
194
            Network interface that will be brought up and scanned for
 
195
            Mandos servers to connect to.  The default it
 
196
            <quote><literal>eth0</literal></quote>.
 
197
          </para>
 
198
          <para>
 
199
            If the <option>--connect</option> option is used, this
 
200
            specifies the interface to use to connect to the address
 
201
            given.
272
202
          </para>
273
203
        </listitem>
274
204
      </varlistentry>
316
246
        <listitem>
317
247
          <para>
318
248
            Sets the number of bits to use for the prime number in the
319
 
            TLS Diffie-Hellman key exchange.  The default value is
320
 
            selected automatically based on the OpenPGP key.  Note
321
 
            that if the <option>--dh-params</option> option is used,
322
 
            the values from that file will be used instead.
323
 
          </para>
324
 
        </listitem>
325
 
      </varlistentry>
326
 
      
327
 
      <varlistentry>
328
 
        <term><option>--dh-params=<replaceable
329
 
        >FILE</replaceable></option></term>
330
 
        <listitem>
331
 
          <para>
332
 
            Specifies a PEM-encoded PKCS#3 file to read the parameters
333
 
            needed by the TLS Diffie-Hellman key exchange from.  If
334
 
            this option is not given, or if the file for some reason
335
 
            could not be used, the parameters will be generated on
336
 
            startup, which will take some time and processing power.
337
 
            Those using servers running under time, power or processor
338
 
            constraints may want to generate such a file in advance
339
 
            and use this option.
340
 
          </para>
341
 
        </listitem>
342
 
      </varlistentry>
343
 
 
344
 
      <varlistentry>
345
 
        <term><option>--delay=<replaceable
346
 
        >SECONDS</replaceable></option></term>
347
 
        <listitem>
348
 
          <para>
349
 
            After bringing a network interface up, the program waits
350
 
            for the interface to arrive in a <quote>running</quote>
351
 
            state before proceeding.  During this time, the kernel log
352
 
            level will be lowered to reduce clutter on the system
353
 
            console, alleviating any other plugins which might be
354
 
            using the system console.  This option sets the upper
355
 
            limit of seconds to wait.  The default is 2.5 seconds.
356
 
          </para>
357
 
        </listitem>
358
 
      </varlistentry>
359
 
 
360
 
      <varlistentry>
361
 
        <term><option>--retry=<replaceable
362
 
        >SECONDS</replaceable></option></term>
363
 
        <listitem>
364
 
          <para>
365
 
            All Mandos servers are tried repeatedly until a password
366
 
            is received.  This value specifies, in seconds, how long
367
 
            between each successive try <emphasis>for the same
368
 
            server</emphasis>.  The default is 10 seconds.
369
 
          </para>
370
 
        </listitem>
371
 
      </varlistentry>
372
 
 
373
 
      <varlistentry>
374
 
        <term><option>--network-hook-dir=<replaceable
375
 
        >DIR</replaceable></option></term>
376
 
        <listitem>
377
 
          <para>
378
 
            Network hook directory.  The default directory is
379
 
            <quote><filename class="directory"
380
 
            >/lib/mandos/network-hooks.d</filename></quote>.
 
249
            TLS Diffie-Hellman key exchange.  Default is 1024.
381
250
          </para>
382
251
        </listitem>
383
252
      </varlistentry>
447
316
      <refentrytitle>plugin-runner</refentrytitle>
448
317
      <manvolnum>8mandos</manvolnum></citerefentry>) is used to run
449
318
      both this program and others in in parallel,
450
 
      <emphasis>one</emphasis> of which (<citerefentry>
451
 
      <refentrytitle>password-prompt</refentrytitle>
452
 
      <manvolnum>8mandos</manvolnum></citerefentry>) will prompt for
453
 
      passwords on the system console.
 
319
      <emphasis>one</emphasis> of which will prompt for passwords on
 
320
      the system console.
454
321
    </para>
455
322
  </refsect1>
456
323
  
461
328
      server could be found and the password received from it could be
462
329
      successfully decrypted and output on standard output.  The
463
330
      program will exit with a non-zero exit status only if a critical
464
 
      error occurs.  Otherwise, it will forever connect to any
465
 
      discovered <application>Mandos</application> servers, trying to
466
 
      get a decryptable password and print it.
 
331
      error occurs.  Otherwise, it will forever connect to new
 
332
      <application>Mandos</application> servers as they appear, trying
 
333
      to get a decryptable password and print it.
467
334
    </para>
468
335
  </refsect1>
469
336
  
470
337
  <refsect1 id="environment">
471
338
    <title>ENVIRONMENT</title>
472
 
    <variablelist>
473
 
      <varlistentry>
474
 
        <term><envar>MANDOSPLUGINHELPERDIR</envar></term>
475
 
        <listitem>
476
 
          <para>
477
 
            This environment variable will be assumed to contain the
478
 
            directory containing any helper executables.  The use and
479
 
            nature of these helper executables, if any, is
480
 
            purposefully not documented.
481
 
        </para>
482
 
        </listitem>
483
 
      </varlistentry>
484
 
    </variablelist>
485
339
    <para>
486
 
      This program does not use any other environment variables, not
487
 
      even the ones provided by <citerefentry><refentrytitle
 
340
      This program does not use any environment variables, not even
 
341
      the ones provided by <citerefentry><refentrytitle
488
342
      >cryptsetup</refentrytitle><manvolnum>8</manvolnum>
489
343
    </citerefentry>.
490
344
    </para>
491
345
  </refsect1>
492
346
  
493
 
  <refsect1 id="network-hooks">
494
 
    <title>NETWORK HOOKS</title>
495
 
    <para>
496
 
      If a network interface like a bridge or tunnel is required to
497
 
      find a Mandos server, this requires the interface to be up and
498
 
      running before <command>&COMMANDNAME;</command> starts looking
499
 
      for Mandos servers.  This can be accomplished by creating a
500
 
      <quote>network hook</quote> program, and placing it in a special
501
 
      directory.
502
 
    </para>
503
 
    <para>
504
 
      Before the network is used (and again before program exit), any
505
 
      runnable programs found in the network hook directory are run
506
 
      with the argument <quote><literal>start</literal></quote> or
507
 
      <quote><literal>stop</literal></quote>.  This should bring up or
508
 
      down, respectively, any network interface which
509
 
      <command>&COMMANDNAME;</command> should use.
510
 
    </para>
511
 
    <refsect2 id="hook-requirements">
512
 
      <title>REQUIREMENTS</title>
513
 
      <para>
514
 
        A network hook must be an executable file, and its name must
515
 
        consist entirely of upper and lower case letters, digits,
516
 
        underscores, periods, and hyphens.
517
 
      </para>
518
 
      <para>
519
 
        A network hook will receive one argument, which can be one of
520
 
        the following:
521
 
      </para>
522
 
      <variablelist>
523
 
        <varlistentry>
524
 
          <term><literal>start</literal></term>
525
 
          <listitem>
526
 
            <para>
527
 
              This should make the network hook create (if necessary)
528
 
              and bring up a network interface.
529
 
            </para>
530
 
          </listitem>
531
 
        </varlistentry>
532
 
        <varlistentry>
533
 
          <term><literal>stop</literal></term>
534
 
          <listitem>
535
 
            <para>
536
 
              This should make the network hook take down a network
537
 
              interface, and delete it if it did not exist previously.
538
 
            </para>
539
 
          </listitem>
540
 
        </varlistentry>
541
 
        <varlistentry>
542
 
          <term><literal>files</literal></term>
543
 
          <listitem>
544
 
            <para>
545
 
              This should make the network hook print, <emphasis>one
546
 
              file per line</emphasis>, all the files needed for it to
547
 
              run.  (These files will be copied into the initial RAM
548
 
              filesystem.)  Typical use is for a network hook which is
549
 
              a shell script to print its needed binaries.
550
 
            </para>
551
 
            <para>
552
 
              It is not necessary to print any non-executable files
553
 
              already in the network hook directory, these will be
554
 
              copied implicitly if they otherwise satisfy the name
555
 
              requirements.
556
 
            </para>
557
 
          </listitem>
558
 
        </varlistentry>
559
 
        <varlistentry>
560
 
          <term><literal>modules</literal></term>
561
 
          <listitem>
562
 
            <para>
563
 
              This should make the network hook print, <emphasis>on
564
 
              separate lines</emphasis>, all the kernel modules needed
565
 
              for it to run.  (These modules will be copied into the
566
 
              initial RAM filesystem.)  For instance, a tunnel
567
 
              interface needs the
568
 
              <quote><literal>tun</literal></quote> module.
569
 
            </para>
570
 
          </listitem>
571
 
        </varlistentry>
572
 
      </variablelist>
573
 
      <para>
574
 
        The network hook will be provided with a number of environment
575
 
        variables:
576
 
      </para>
577
 
      <variablelist>
578
 
        <varlistentry>
579
 
          <term><envar>MANDOSNETHOOKDIR</envar></term>
580
 
          <listitem>
581
 
            <para>
582
 
              The network hook directory, specified to
583
 
              <command>&COMMANDNAME;</command> by the
584
 
              <option>--network-hook-dir</option> option.  Note: this
585
 
              should <emphasis>always</emphasis> be used by the
586
 
              network hook to refer to itself or any files in the hook
587
 
              directory it may require.
588
 
            </para>
589
 
          </listitem>
590
 
        </varlistentry>
591
 
        <varlistentry>
592
 
          <term><envar>DEVICE</envar></term>
593
 
          <listitem>
594
 
            <para>
595
 
              The network interfaces, as specified to
596
 
              <command>&COMMANDNAME;</command> by the
597
 
              <option>--interface</option> option, combined to one
598
 
              string and separated by commas.  If this is set, and
599
 
              does not contain the interface a hook will bring up,
600
 
              there is no reason for a hook to continue.
601
 
            </para>
602
 
          </listitem>
603
 
        </varlistentry>
604
 
        <varlistentry>
605
 
          <term><envar>MODE</envar></term>
606
 
          <listitem>
607
 
            <para>
608
 
              This will be the same as the first argument;
609
 
              i.e. <quote><literal>start</literal></quote>,
610
 
              <quote><literal>stop</literal></quote>,
611
 
              <quote><literal>files</literal></quote>, or
612
 
              <quote><literal>modules</literal></quote>.
613
 
            </para>
614
 
          </listitem>
615
 
        </varlistentry>
616
 
        <varlistentry>
617
 
          <term><envar>VERBOSITY</envar></term>
618
 
          <listitem>
619
 
            <para>
620
 
              This will be the <quote><literal>1</literal></quote> if
621
 
              the <option>--debug</option> option is passed to
622
 
              <command>&COMMANDNAME;</command>, otherwise
623
 
              <quote><literal>0</literal></quote>.
624
 
            </para>
625
 
          </listitem>
626
 
        </varlistentry>
627
 
        <varlistentry>
628
 
          <term><envar>DELAY</envar></term>
629
 
          <listitem>
630
 
            <para>
631
 
              This will be the same as the <option>--delay</option>
632
 
              option passed to <command>&COMMANDNAME;</command>.  Is
633
 
              only set if <envar>MODE</envar> is
634
 
              <quote><literal>start</literal></quote> or
635
 
              <quote><literal>stop</literal></quote>.
636
 
            </para>
637
 
          </listitem>
638
 
        </varlistentry>
639
 
        <varlistentry>
640
 
          <term><envar>CONNECT</envar></term>
641
 
          <listitem>
642
 
            <para>
643
 
              This will be the same as the <option>--connect</option>
644
 
              option passed to <command>&COMMANDNAME;</command>.  Is
645
 
              only set if <option>--connect</option> is passed and
646
 
              <envar>MODE</envar> is
647
 
              <quote><literal>start</literal></quote> or
648
 
              <quote><literal>stop</literal></quote>.
649
 
            </para>
650
 
          </listitem>
651
 
        </varlistentry>
652
 
      </variablelist>
653
 
      <para>
654
 
        A hook may not read from standard input, and should be
655
 
        restrictive in printing to standard output or standard error
656
 
        unless <varname>VERBOSITY</varname> is
657
 
        <quote><literal>1</literal></quote>.
658
 
      </para>
659
 
    </refsect2>
660
 
  </refsect1>
661
 
  
662
 
  <refsect1 id="files">
 
347
  <refsect1 id="file">
663
348
    <title>FILES</title>
664
349
    <variablelist>
665
350
      <varlistentry>
676
361
          </para>
677
362
        </listitem>
678
363
      </varlistentry>
679
 
      <varlistentry>
680
 
        <term><filename
681
 
        class="directory">/lib/mandos/network-hooks.d</filename></term>
682
 
        <listitem>
683
 
          <para>
684
 
            Directory where network hooks are located.  Change this
685
 
            with the <option>--network-hook-dir</option> option.  See
686
 
            <xref linkend="network-hooks"/>.
687
 
          </para>
688
 
        </listitem>
689
 
      </varlistentry>
690
364
    </variablelist>
691
365
  </refsect1>
692
366
  
706
380
    </para>
707
381
    <informalexample>
708
382
      <para>
709
 
        Normal invocation needs no options, if the network interfaces
710
 
        can be automatically determined:
 
383
        Normal invocation needs no options, if the network interface
 
384
        is <quote>eth0</quote>:
711
385
      </para>
712
386
      <para>
713
387
        <userinput>&COMMANDNAME;</userinput>
715
389
    </informalexample>
716
390
    <informalexample>
717
391
      <para>
718
 
        Search for Mandos servers (and connect to them) using one
719
 
        specific interface:
 
392
        Search for Mandos servers (and connect to them) using another
 
393
        interface:
720
394
      </para>
721
395
      <para>
722
396
        <!-- do not wrap this line -->
737
411
    <informalexample>
738
412
      <para>
739
413
        Run in debug mode, with a custom key, and do not use Zeroconf
740
 
        to locate a server; connect directly to the IPv6 link-local
741
 
        address <quote><systemitem class="ipaddress"
742
 
        >fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
743
 
        using interface eth2:
 
414
        to locate a server; connect directly to the IPv6 address
 
415
        <quote><systemitem class="ipaddress"
 
416
        >2001:db8:f983:bd0b:30de:ae4a:71f2:f672</systemitem></quote>,
 
417
        port 4711, using interface eth2:
744
418
      </para>
745
419
      <para>
746
420
 
747
421
<!-- do not wrap this line -->
748
 
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect fe80::aede:48ff:fe71:f6f2:4711 --interface eth2</userinput>
 
422
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect 2001:db8:f983:bd0b:30de:ae4a:71f2:f672:4711 --interface eth2</userinput>
749
423
 
750
424
      </para>
751
425
    </informalexample>
786
460
    <para>
787
461
      It will also help if the checker program on the server is
788
462
      configured to request something from the client which can not be
789
 
      spoofed by someone else on the network, like SSH server key
790
 
      fingerprints, and unlike unencrypted <acronym>ICMP</acronym>
791
 
      echo (<quote>ping</quote>) replies.
 
463
      spoofed by someone else on the network, unlike unencrypted
 
464
      <acronym>ICMP</acronym> echo (<quote>ping</quote>) replies.
792
465
    </para>
793
466
    <para>
794
467
      <emphasis>Note</emphasis>: This makes it completely insecure to
802
475
  <refsect1 id="see_also">
803
476
    <title>SEE ALSO</title>
804
477
    <para>
805
 
      <citerefentry><refentrytitle>intro</refentrytitle>
806
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
807
478
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
808
479
      <manvolnum>8</manvolnum></citerefentry>,
809
480
      <citerefentry><refentrytitle>crypttab</refentrytitle>
887
558
              <para>
888
559
                This client uses IPv6 link-local addresses, which are
889
560
                immediately usable since a link-local addresses is
890
 
                automatically assigned to a network interface when it
 
561
                automatically assigned to a network interfaces when it
891
562
                is brought up.
892
563
              </para>
893
564
            </listitem>