/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

Merge from Björn.

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-03-08">
 
5
<!ENTITY TIMESTAMP "2010-09-26">
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
35
      <year>2009</year>
36
 
      <year>2012</year>
37
 
      <year>2013</year>
38
 
      <year>2014</year>
39
36
      <holder>Teddy Hogeborn</holder>
40
37
      <holder>Björn Påhlsson</holder>
41
38
    </copyright>
66
63
        ><replaceable>PORT</replaceable></option></arg>
67
64
      </group>
68
65
      <sbr/>
69
 
      <group rep='repeat'>
 
66
      <group>
70
67
        <arg choice="plain"><option>--interface
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>
 
68
        <replaceable>NAME</replaceable></option></arg>
 
69
        <arg choice="plain"><option>-i
 
70
        <replaceable>NAME</replaceable></option></arg>
76
71
      </group>
77
72
      <sbr/>
78
73
      <group>
106
101
      </arg>
107
102
      <sbr/>
108
103
      <arg>
109
 
        <option>--network-hook-dir
110
 
        <replaceable>DIR</replaceable></option>
111
 
      </arg>
112
 
      <sbr/>
113
 
      <arg>
114
104
        <option>--debug</option>
115
105
      </arg>
116
106
    </cmdsynopsis>
141
131
      communicates with <citerefentry><refentrytitle
142
132
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>
143
133
      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
 
134
      brings up a network interface, uses the interface’s IPv6
 
135
      link-local address to get network connectivity, uses Zeroconf to
 
136
      find servers on the local network, and communicates with servers
 
137
      using TLS with an OpenPGP key to ensure authenticity and
148
138
      confidentiality.  This client program keeps running, trying all
149
139
      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"/>.
 
140
      or a TERM signal is received.  If no servers are found, or after
 
141
      all servers have been tried, it waits indefinitely for new
 
142
      servers to appear.
171
143
    </para>
172
144
    <para>
173
145
      This program is not meant to be run directly; it is really meant
220
192
            assumed to separate the address from the port number.
221
193
          </para>
222
194
          <para>
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.
 
195
            This option is normally only useful for testing and
 
196
            debugging.
226
197
          </para>
227
198
        </listitem>
228
199
      </varlistentry>
229
200
      
230
201
      <varlistentry>
231
202
        <term><option>--interface=<replaceable
232
 
        >NAME</replaceable><arg rep='repeat'>,<replaceable
233
 
        >NAME</replaceable></arg></option></term>
 
203
        >NAME</replaceable></option></term>
234
204
        <term><option>-i
235
 
        <replaceable>NAME</replaceable><arg rep='repeat'>,<replaceable
236
 
        >NAME</replaceable></arg></option></term>
 
205
        <replaceable>NAME</replaceable></option></term>
237
206
        <listitem>
238
207
          <para>
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.
 
208
            Network interface that will be brought up and scanned for
 
209
            Mandos servers to connect to.  The default is the empty
 
210
            string, which will automatically choose an appropriate
 
211
            interface.
243
212
          </para>
244
213
          <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.
 
214
            If the <option>--connect</option> option is used, this
 
215
            specifies the interface to use to connect to the address
 
216
            given.
249
217
          </para>
250
218
          <para>
251
219
            Note that since this program will normally run in the
252
220
            initial RAM disk environment, the interface must be an
253
221
            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"/>.
 
222
            can not be a pseudo-interface such as <quote>br0</quote>
 
223
            or <quote>tun0</quote>; such interfaces will not exist
 
224
            until much later in the boot process, and can not be used
 
225
            by this program.
260
226
          </para>
261
227
          <para>
262
228
            <replaceable>NAME</replaceable> can be the string
263
 
            <quote><literal>none</literal></quote>; this will make
264
 
            <command>&COMMANDNAME;</command> only bring up interfaces
265
 
            specified <emphasis>before</emphasis> this string.  This
266
 
            is not recommended, and only meant for advanced users.
 
229
            <quote><literal>none</literal></quote>; this will not use
 
230
            any specific interface, and will not bring up an interface
 
231
            on startup.  This is not recommended, and only meant for
 
232
            advanced users.
267
233
          </para>
268
234
        </listitem>
269
235
      </varlistentry>
311
277
        <listitem>
312
278
          <para>
313
279
            Sets the number of bits to use for the prime number in the
314
 
            TLS Diffie-Hellman key exchange.  The default value is
315
 
            selected automatically based on the OpenPGP key.
 
280
            TLS Diffie-Hellman key exchange.  Default is 1024.
316
281
          </para>
317
282
        </listitem>
318
283
      </varlistentry>
322
287
        >SECONDS</replaceable></option></term>
323
288
        <listitem>
324
289
          <para>
325
 
            After bringing a network interface up, the program waits
 
290
            After bringing the network interface up, the program waits
326
291
            for the interface to arrive in a <quote>running</quote>
327
292
            state before proceeding.  During this time, the kernel log
328
293
            level will be lowered to reduce clutter on the system
338
303
        >SECONDS</replaceable></option></term>
339
304
        <listitem>
340
305
          <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>.
 
306
            All Mandos servers servers are tried repeatedly until a
 
307
            password is received.  This value specifies, in seconds,
 
308
            how long between each successive try <emphasis>for the
 
309
            same server</emphasis>.  The default is 10 seconds.
357
310
          </para>
358
311
        </listitem>
359
312
      </varlistentry>
423
376
      <refentrytitle>plugin-runner</refentrytitle>
424
377
      <manvolnum>8mandos</manvolnum></citerefentry>) is used to run
425
378
      both this program and others in in parallel,
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.
 
379
      <emphasis>one</emphasis> of which will prompt for passwords on
 
380
      the system console.
430
381
    </para>
431
382
  </refsect1>
432
383
  
437
388
      server could be found and the password received from it could be
438
389
      successfully decrypted and output on standard output.  The
439
390
      program will exit with a non-zero exit status only if a critical
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.
 
391
      error occurs.  Otherwise, it will forever connect to new
 
392
      <application>Mandos</application> servers as they appear, trying
 
393
      to get a decryptable password and print it.
443
394
    </para>
444
395
  </refsect1>
445
396
  
453
404
    </para>
454
405
  </refsect1>
455
406
  
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
407
  <refsect1 id="files">
626
408
    <title>FILES</title>
627
409
    <variablelist>
639
421
          </para>
640
422
        </listitem>
641
423
      </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>
653
424
    </variablelist>
654
425
  </refsect1>
655
426
  
669
440
    </para>
670
441
    <informalexample>
671
442
      <para>
672
 
        Normal invocation needs no options, if the network interfaces
673
 
        can be automatically determined:
 
443
        Normal invocation needs no options, if the network interface
 
444
        is <quote>eth0</quote>:
674
445
      </para>
675
446
      <para>
676
447
        <userinput>&COMMANDNAME;</userinput>
678
449
    </informalexample>
679
450
    <informalexample>
680
451
      <para>
681
 
        Search for Mandos servers (and connect to them) using one
682
 
        specific interface:
 
452
        Search for Mandos servers (and connect to them) using another
 
453
        interface:
683
454
      </para>
684
455
      <para>
685
456
        <!-- do not wrap this line -->
749
520
    <para>
750
521
      It will also help if the checker program on the server is
751
522
      configured to request something from the client which can not be
752
 
      spoofed by someone else on the network, like SSH server key
753
 
      fingerprints, and unlike unencrypted <acronym>ICMP</acronym>
754
 
      echo (<quote>ping</quote>) replies.
 
523
      spoofed by someone else on the network, unlike unencrypted
 
524
      <acronym>ICMP</acronym> echo (<quote>ping</quote>) replies.
755
525
    </para>
756
526
    <para>
757
527
      <emphasis>Note</emphasis>: This makes it completely insecure to
765
535
  <refsect1 id="see_also">
766
536
    <title>SEE ALSO</title>
767
537
    <para>
768
 
      <citerefentry><refentrytitle>intro</refentrytitle>
769
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
770
538
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
771
539
      <manvolnum>8</manvolnum></citerefentry>,
772
540
      <citerefentry><refentrytitle>crypttab</refentrytitle>
850
618
              <para>
851
619
                This client uses IPv6 link-local addresses, which are
852
620
                immediately usable since a link-local addresses is
853
 
                automatically assigned to a network interface when it
 
621
                automatically assigned to a network interfaces when it
854
622
                is brought up.
855
623
              </para>
856
624
            </listitem>