/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: 2009-10-25 19:16:56 UTC
  • Revision ID: teddy@fukt.bsnet.se-20091025191656-zc9xzphyanlr88hq
Tags: version-1.0.14-1
* Makefile (version): Changed to "1.0.14".
* NEWS (Version 1.0.14): New entry.
* debian/changelog (1.0.14-1): - '' -

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