/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: 2015-07-06 20:29:34 UTC
  • mfrom: (738.1.6 route-external)
  • Revision ID: teddy@recompile.se-20150706202934-09j06jm2fiw1bn80
Merge change to add local route when network is "unreachable".

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 "2009-02-09">
 
5
<!ENTITY TIMESTAMP "2015-07-06">
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@fukt.bsnet.se</email>
 
22
          <email>belorn@recompile.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@fukt.bsnet.se</email>
 
29
          <email>teddy@recompile.se</email>
30
30
        </address>
31
31
      </author>
32
32
    </authorgroup>
33
33
    <copyright>
34
34
      <year>2008</year>
35
35
      <year>2009</year>
 
36
      <year>2012</year>
 
37
      <year>2013</year>
 
38
      <year>2014</year>
 
39
      <year>2015</year>
36
40
      <holder>Teddy Hogeborn</holder>
37
41
      <holder>Björn Påhlsson</holder>
38
42
    </copyright>
63
67
        ><replaceable>PORT</replaceable></option></arg>
64
68
      </group>
65
69
      <sbr/>
66
 
      <group>
 
70
      <group rep='repeat'>
67
71
        <arg choice="plain"><option>--interface
68
 
        <replaceable>NAME</replaceable></option></arg>
69
 
        <arg choice="plain"><option>-i
70
 
        <replaceable>NAME</replaceable></option></arg>
 
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>
71
77
      </group>
72
78
      <sbr/>
73
79
      <group>
97
103
      </arg>
98
104
      <sbr/>
99
105
      <arg>
 
106
        <option>--retry <replaceable>SECONDS</replaceable></option>
 
107
      </arg>
 
108
      <sbr/>
 
109
      <arg>
 
110
        <option>--network-hook-dir
 
111
        <replaceable>DIR</replaceable></option>
 
112
      </arg>
 
113
      <sbr/>
 
114
      <arg>
100
115
        <option>--debug</option>
101
116
      </arg>
102
117
    </cmdsynopsis>
127
142
      communicates with <citerefentry><refentrytitle
128
143
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>
129
144
      to get a password.  In slightly more detail, this client program
130
 
      brings up a network interface, uses the interface’s IPv6
131
 
      link-local address to get network connectivity, uses Zeroconf to
132
 
      find servers on the local network, and communicates with servers
133
 
      using TLS with an OpenPGP key to ensure authenticity and
 
145
      brings up network interfaces, uses the interfaces’ IPv6
 
146
      link-local addresses to get network connectivity, uses Zeroconf
 
147
      to find servers on the local network, and communicates with
 
148
      servers using TLS with an OpenPGP key to ensure authenticity and
134
149
      confidentiality.  This client program keeps running, trying all
135
150
      servers on the network, until it receives a satisfactory reply
136
 
      or a TERM signal is received.  If no servers are found, or after
137
 
      all servers have been tried, it waits indefinitely for new
138
 
      servers to appear.
 
151
      or a TERM signal.  After all servers have been tried, all
 
152
      servers are periodically retried.  If no servers are found it
 
153
      will wait indefinitely for new servers to appear.
 
154
    </para>
 
155
    <para>
 
156
      The network interfaces are selected like this: If any interfaces
 
157
      are specified using the <option>--interface</option> option,
 
158
      those interface are used.  Otherwise,
 
159
      <command>&COMMANDNAME;</command> will use all interfaces that
 
160
      are not loopback interfaces, are not point-to-point interfaces,
 
161
      are capable of broadcasting and do not have the NOARP flag (see
 
162
      <citerefentry><refentrytitle>netdevice</refentrytitle>
 
163
      <manvolnum>7</manvolnum></citerefentry>).  (If the
 
164
      <option>--connect</option> option is used, point-to-point
 
165
      interfaces and non-broadcast interfaces are accepted.)  If any
 
166
      used interfaces are not up and running, they are first taken up
 
167
      (and later taken down again on program exit).
 
168
    </para>
 
169
    <para>
 
170
      Before network interfaces are selected, all <quote>network
 
171
      hooks</quote> are run; see <xref linkend="network-hooks"/>.
139
172
    </para>
140
173
    <para>
141
174
      This program is not meant to be run directly; it is really meant
188
221
            assumed to separate the address from the port number.
189
222
          </para>
190
223
          <para>
191
 
            This option is normally only useful for testing and
192
 
            debugging.
 
224
            Normally, Zeroconf would be used to locate Mandos servers,
 
225
            in which case this option would only be used when testing
 
226
            and debugging.
193
227
          </para>
194
228
        </listitem>
195
229
      </varlistentry>
196
230
      
197
231
      <varlistentry>
198
232
        <term><option>--interface=<replaceable
199
 
        >NAME</replaceable></option></term>
 
233
        >NAME</replaceable><arg rep='repeat'>,<replaceable
 
234
        >NAME</replaceable></arg></option></term>
200
235
        <term><option>-i
201
 
        <replaceable>NAME</replaceable></option></term>
 
236
        <replaceable>NAME</replaceable><arg rep='repeat'>,<replaceable
 
237
        >NAME</replaceable></arg></option></term>
202
238
        <listitem>
203
239
          <para>
204
 
            Network interface that will be brought up and scanned for
205
 
            Mandos servers to connect to.  The default is
206
 
            <quote><literal>eth0</literal></quote>.
 
240
            Comma separated list of network interfaces that will be
 
241
            brought up and scanned for Mandos servers to connect to.
 
242
            The default is the empty string, which will automatically
 
243
            use all appropriate interfaces.
207
244
          </para>
208
245
          <para>
209
 
            If the <option>--connect</option> option is used, this
210
 
            specifies the interface to use to connect to the address
211
 
            given.
 
246
            If the <option>--connect</option> option is used, and
 
247
            exactly one interface name is specified (except
 
248
            <quote><literal>none</literal></quote>), this specifies
 
249
            the interface to use to connect to the address given.
212
250
          </para>
213
251
          <para>
214
252
            Note that since this program will normally run in the
215
253
            initial RAM disk environment, the interface must be an
216
254
            interface which exists at that stage.  Thus, the interface
217
 
            can not be a pseudo-interface such as <quote>br0</quote>
218
 
            or <quote>tun0</quote>; such interfaces will not exist
219
 
            until much later in the boot process, and can not be used
220
 
            by this program.
 
255
            can normally not be a pseudo-interface such as
 
256
            <quote>br0</quote> or <quote>tun0</quote>; such interfaces
 
257
            will not exist until much later in the boot process, and
 
258
            can not be used by this program, unless created by a
 
259
            <quote>network hook</quote> — see <xref
 
260
            linkend="network-hooks"/>.
221
261
          </para>
222
262
          <para>
223
 
            <replaceable>NAME</replaceable> can be the empty string;
224
 
            this will not use any specific interface, and will not
225
 
            bring up an interface on startup.  This is not
226
 
            recommended, and only meant for advanced users.
 
263
            <replaceable>NAME</replaceable> can be the string
 
264
            <quote><literal>none</literal></quote>; this will make
 
265
            <command>&COMMANDNAME;</command> only bring up interfaces
 
266
            specified <emphasis>before</emphasis> this string.  This
 
267
            is not recommended, and only meant for advanced users.
227
268
          </para>
228
269
        </listitem>
229
270
      </varlistentry>
271
312
        <listitem>
272
313
          <para>
273
314
            Sets the number of bits to use for the prime number in the
274
 
            TLS Diffie-Hellman key exchange.  Default is 1024.
 
315
            TLS Diffie-Hellman key exchange.  The default value is
 
316
            selected automatically based on the OpenPGP key.
275
317
          </para>
276
318
        </listitem>
277
319
      </varlistentry>
281
323
        >SECONDS</replaceable></option></term>
282
324
        <listitem>
283
325
          <para>
284
 
            After bringing the network interface up, the program waits
 
326
            After bringing a network interface up, the program waits
285
327
            for the interface to arrive in a <quote>running</quote>
286
328
            state before proceeding.  During this time, the kernel log
287
329
            level will be lowered to reduce clutter on the system
291
333
          </para>
292
334
        </listitem>
293
335
      </varlistentry>
 
336
 
 
337
      <varlistentry>
 
338
        <term><option>--retry=<replaceable
 
339
        >SECONDS</replaceable></option></term>
 
340
        <listitem>
 
341
          <para>
 
342
            All Mandos servers are tried repeatedly until a password
 
343
            is received.  This value specifies, in seconds, how long
 
344
            between each successive try <emphasis>for the same
 
345
            server</emphasis>.  The default is 10 seconds.
 
346
          </para>
 
347
        </listitem>
 
348
      </varlistentry>
 
349
 
 
350
      <varlistentry>
 
351
        <term><option>--network-hook-dir=<replaceable
 
352
        >DIR</replaceable></option></term>
 
353
        <listitem>
 
354
          <para>
 
355
            Network hook directory.  The default directory is
 
356
            <quote><filename class="directory"
 
357
            >/lib/mandos/network-hooks.d</filename></quote>.
 
358
          </para>
 
359
        </listitem>
 
360
      </varlistentry>
294
361
      
295
362
      <varlistentry>
296
363
        <term><option>--debug</option></term>
357
424
      <refentrytitle>plugin-runner</refentrytitle>
358
425
      <manvolnum>8mandos</manvolnum></citerefentry>) is used to run
359
426
      both this program and others in in parallel,
360
 
      <emphasis>one</emphasis> of which will prompt for passwords on
361
 
      the system console.
 
427
      <emphasis>one</emphasis> of which (<citerefentry>
 
428
      <refentrytitle>password-prompt</refentrytitle>
 
429
      <manvolnum>8mandos</manvolnum></citerefentry>) will prompt for
 
430
      passwords on the system console.
362
431
    </para>
363
432
  </refsect1>
364
433
  
369
438
      server could be found and the password received from it could be
370
439
      successfully decrypted and output on standard output.  The
371
440
      program will exit with a non-zero exit status only if a critical
372
 
      error occurs.  Otherwise, it will forever connect to new
373
 
      <application>Mandos</application> servers as they appear, trying
374
 
      to get a decryptable password and print it.
 
441
      error occurs.  Otherwise, it will forever connect to any
 
442
      discovered <application>Mandos</application> servers, trying to
 
443
      get a decryptable password and print it.
375
444
    </para>
376
445
  </refsect1>
377
446
  
378
447
  <refsect1 id="environment">
379
448
    <title>ENVIRONMENT</title>
 
449
    <variablelist>
 
450
      <varlistentry>
 
451
        <term><envar>MANDOSPLUGINHELPERDIR</envar></term>
 
452
        <listitem>
 
453
          <para>
 
454
            This environment variable will be assumed to contain the
 
455
            directory containing any helper executables.  The use and
 
456
            nature of these helper executables, if any, is
 
457
            purposefully not documented.
 
458
        </para>
 
459
        </listitem>
 
460
      </varlistentry>
 
461
    </variablelist>
380
462
    <para>
381
 
      This program does not use any environment variables, not even
382
 
      the ones provided by <citerefentry><refentrytitle
 
463
      This program does not use any other environment variables, not
 
464
      even the ones provided by <citerefentry><refentrytitle
383
465
      >cryptsetup</refentrytitle><manvolnum>8</manvolnum>
384
466
    </citerefentry>.
385
467
    </para>
386
468
  </refsect1>
387
469
  
 
470
  <refsect1 id="network-hooks">
 
471
    <title>NETWORK HOOKS</title>
 
472
    <para>
 
473
      If a network interface like a bridge or tunnel is required to
 
474
      find a Mandos server, this requires the interface to be up and
 
475
      running before <command>&COMMANDNAME;</command> starts looking
 
476
      for Mandos servers.  This can be accomplished by creating a
 
477
      <quote>network hook</quote> program, and placing it in a special
 
478
      directory.
 
479
    </para>
 
480
    <para>
 
481
      Before the network is used (and again before program exit), any
 
482
      runnable programs found in the network hook directory are run
 
483
      with the argument <quote><literal>start</literal></quote> or
 
484
      <quote><literal>stop</literal></quote>.  This should bring up or
 
485
      down, respectively, any network interface which
 
486
      <command>&COMMANDNAME;</command> should use.
 
487
    </para>
 
488
    <refsect2 id="hook-requirements">
 
489
      <title>REQUIREMENTS</title>
 
490
      <para>
 
491
        A network hook must be an executable file, and its name must
 
492
        consist entirely of upper and lower case letters, digits,
 
493
        underscores, periods, and hyphens.
 
494
      </para>
 
495
      <para>
 
496
        A network hook will receive one argument, which can be one of
 
497
        the following:
 
498
      </para>
 
499
      <variablelist>
 
500
        <varlistentry>
 
501
          <term><literal>start</literal></term>
 
502
          <listitem>
 
503
            <para>
 
504
              This should make the network hook create (if necessary)
 
505
              and bring up a network interface.
 
506
            </para>
 
507
          </listitem>
 
508
        </varlistentry>
 
509
        <varlistentry>
 
510
          <term><literal>stop</literal></term>
 
511
          <listitem>
 
512
            <para>
 
513
              This should make the network hook take down a network
 
514
              interface, and delete it if it did not exist previously.
 
515
            </para>
 
516
          </listitem>
 
517
        </varlistentry>
 
518
        <varlistentry>
 
519
          <term><literal>files</literal></term>
 
520
          <listitem>
 
521
            <para>
 
522
              This should make the network hook print, <emphasis>one
 
523
              file per line</emphasis>, all the files needed for it to
 
524
              run.  (These files will be copied into the initial RAM
 
525
              filesystem.)  Typical use is for a network hook which is
 
526
              a shell script to print its needed binaries.
 
527
            </para>
 
528
            <para>
 
529
              It is not necessary to print any non-executable files
 
530
              already in the network hook directory, these will be
 
531
              copied implicitly if they otherwise satisfy the name
 
532
              requirements.
 
533
            </para>
 
534
          </listitem>
 
535
        </varlistentry>
 
536
        <varlistentry>
 
537
          <term><literal>modules</literal></term>
 
538
          <listitem>
 
539
            <para>
 
540
              This should make the network hook print, <emphasis>on
 
541
              separate lines</emphasis>, all the kernel modules needed
 
542
              for it to run.  (These modules will be copied into the
 
543
              initial RAM filesystem.)  For instance, a tunnel
 
544
              interface needs the
 
545
              <quote><literal>tun</literal></quote> module.
 
546
            </para>
 
547
          </listitem>
 
548
        </varlistentry>
 
549
      </variablelist>
 
550
      <para>
 
551
        The network hook will be provided with a number of environment
 
552
        variables:
 
553
      </para>
 
554
      <variablelist>
 
555
        <varlistentry>
 
556
          <term><envar>MANDOSNETHOOKDIR</envar></term>
 
557
          <listitem>
 
558
            <para>
 
559
              The network hook directory, specified to
 
560
              <command>&COMMANDNAME;</command> by the
 
561
              <option>--network-hook-dir</option> option.  Note: this
 
562
              should <emphasis>always</emphasis> be used by the
 
563
              network hook to refer to itself or any files in the hook
 
564
              directory it may require.
 
565
            </para>
 
566
          </listitem>
 
567
        </varlistentry>
 
568
        <varlistentry>
 
569
          <term><envar>DEVICE</envar></term>
 
570
          <listitem>
 
571
            <para>
 
572
              The network interfaces, as specified to
 
573
              <command>&COMMANDNAME;</command> by the
 
574
              <option>--interface</option> option, combined to one
 
575
              string and separated by commas.  If this is set, and
 
576
              does not contain the interface a hook will bring up,
 
577
              there is no reason for a hook to continue.
 
578
            </para>
 
579
          </listitem>
 
580
        </varlistentry>
 
581
        <varlistentry>
 
582
          <term><envar>MODE</envar></term>
 
583
          <listitem>
 
584
            <para>
 
585
              This will be the same as the first argument;
 
586
              i.e. <quote><literal>start</literal></quote>,
 
587
              <quote><literal>stop</literal></quote>,
 
588
              <quote><literal>files</literal></quote>, or
 
589
              <quote><literal>modules</literal></quote>.
 
590
            </para>
 
591
          </listitem>
 
592
        </varlistentry>
 
593
        <varlistentry>
 
594
          <term><envar>VERBOSITY</envar></term>
 
595
          <listitem>
 
596
            <para>
 
597
              This will be the <quote><literal>1</literal></quote> if
 
598
              the <option>--debug</option> option is passed to
 
599
              <command>&COMMANDNAME;</command>, otherwise
 
600
              <quote><literal>0</literal></quote>.
 
601
            </para>
 
602
          </listitem>
 
603
        </varlistentry>
 
604
        <varlistentry>
 
605
          <term><envar>DELAY</envar></term>
 
606
          <listitem>
 
607
            <para>
 
608
              This will be the same as the <option>--delay</option>
 
609
              option passed to <command>&COMMANDNAME;</command>.  Is
 
610
              only set if <envar>MODE</envar> is
 
611
              <quote><literal>start</literal></quote> or
 
612
              <quote><literal>stop</literal></quote>.
 
613
            </para>
 
614
          </listitem>
 
615
        </varlistentry>
 
616
        <varlistentry>
 
617
          <term><envar>CONNECT</envar></term>
 
618
          <listitem>
 
619
            <para>
 
620
              This will be the same as the <option>--connect</option>
 
621
              option passed to <command>&COMMANDNAME;</command>.  Is
 
622
              only set if <option>--connect</option> is passed and
 
623
              <envar>MODE</envar> is
 
624
              <quote><literal>start</literal></quote> or
 
625
              <quote><literal>stop</literal></quote>.
 
626
            </para>
 
627
          </listitem>
 
628
        </varlistentry>
 
629
      </variablelist>
 
630
      <para>
 
631
        A hook may not read from standard input, and should be
 
632
        restrictive in printing to standard output or standard error
 
633
        unless <varname>VERBOSITY</varname> is
 
634
        <quote><literal>1</literal></quote>.
 
635
      </para>
 
636
    </refsect2>
 
637
  </refsect1>
 
638
  
388
639
  <refsect1 id="files">
389
640
    <title>FILES</title>
390
641
    <variablelist>
402
653
          </para>
403
654
        </listitem>
404
655
      </varlistentry>
 
656
      <varlistentry>
 
657
        <term><filename
 
658
        class="directory">/lib/mandos/network-hooks.d</filename></term>
 
659
        <listitem>
 
660
          <para>
 
661
            Directory where network hooks are located.  Change this
 
662
            with the <option>--network-hook-dir</option> option.  See
 
663
            <xref linkend="network-hooks"/>.
 
664
          </para>
 
665
        </listitem>
 
666
      </varlistentry>
405
667
    </variablelist>
406
668
  </refsect1>
407
669
  
421
683
    </para>
422
684
    <informalexample>
423
685
      <para>
424
 
        Normal invocation needs no options, if the network interface
425
 
        is <quote>eth0</quote>:
 
686
        Normal invocation needs no options, if the network interfaces
 
687
        can be automatically determined:
426
688
      </para>
427
689
      <para>
428
690
        <userinput>&COMMANDNAME;</userinput>
430
692
    </informalexample>
431
693
    <informalexample>
432
694
      <para>
433
 
        Search for Mandos servers (and connect to them) using another
434
 
        interface:
 
695
        Search for Mandos servers (and connect to them) using one
 
696
        specific interface:
435
697
      </para>
436
698
      <para>
437
699
        <!-- do not wrap this line -->
501
763
    <para>
502
764
      It will also help if the checker program on the server is
503
765
      configured to request something from the client which can not be
504
 
      spoofed by someone else on the network, unlike unencrypted
505
 
      <acronym>ICMP</acronym> echo (<quote>ping</quote>) replies.
 
766
      spoofed by someone else on the network, like SSH server key
 
767
      fingerprints, and unlike unencrypted <acronym>ICMP</acronym>
 
768
      echo (<quote>ping</quote>) replies.
506
769
    </para>
507
770
    <para>
508
771
      <emphasis>Note</emphasis>: This makes it completely insecure to
516
779
  <refsect1 id="see_also">
517
780
    <title>SEE ALSO</title>
518
781
    <para>
 
782
      <citerefentry><refentrytitle>intro</refentrytitle>
 
783
      <manvolnum>8mandos</manvolnum></citerefentry>,
519
784
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
520
785
      <manvolnum>8</manvolnum></citerefentry>,
521
786
      <citerefentry><refentrytitle>crypttab</refentrytitle>
599
864
              <para>
600
865
                This client uses IPv6 link-local addresses, which are
601
866
                immediately usable since a link-local addresses is
602
 
                automatically assigned to a network interfaces when it
 
867
                automatically assigned to a network interface when it
603
868
                is brought up.
604
869
              </para>
605
870
            </listitem>