/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-05-23 12:07:07 UTC
  • Revision ID: teddy@recompile.se-20150523120707-t5fq0brh2kxkvw8g
mandos: Some more minor changes to prepare for Python 3.

Show diffs side-by-side

added added

removed removed

Lines of Context:
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 "2010-09-26">
 
5
<!ENTITY TIMESTAMP "2015-03-08">
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>
36
39
      <holder>Teddy Hogeborn</holder>
37
40
      <holder>Björn Påhlsson</holder>
38
41
    </copyright>
63
66
        ><replaceable>PORT</replaceable></option></arg>
64
67
      </group>
65
68
      <sbr/>
66
 
      <group>
 
69
      <group rep='repeat'>
67
70
        <arg choice="plain"><option>--interface
68
 
        <replaceable>NAME</replaceable></option></arg>
69
 
        <arg choice="plain"><option>-i
70
 
        <replaceable>NAME</replaceable></option></arg>
 
71
        <replaceable>NAME</replaceable><arg rep='repeat'
 
72
        >,<replaceable>NAME</replaceable></arg></option></arg>
 
73
        <arg choice="plain"><option>-i <replaceable>NAME</replaceable
 
74
        ><arg rep='repeat'>,<replaceable>NAME</replaceable></arg
 
75
        ></option></arg>
71
76
      </group>
72
77
      <sbr/>
73
78
      <group>
97
102
      </arg>
98
103
      <sbr/>
99
104
      <arg>
 
105
        <option>--retry <replaceable>SECONDS</replaceable></option>
 
106
      </arg>
 
107
      <sbr/>
 
108
      <arg>
 
109
        <option>--network-hook-dir
 
110
        <replaceable>DIR</replaceable></option>
 
111
      </arg>
 
112
      <sbr/>
 
113
      <arg>
100
114
        <option>--debug</option>
101
115
      </arg>
102
116
    </cmdsynopsis>
127
141
      communicates with <citerefentry><refentrytitle
128
142
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>
129
143
      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
 
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
148
      confidentiality.  This client program keeps running, trying all
135
149
      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.
 
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"/>.
139
171
    </para>
140
172
    <para>
141
173
      This program is not meant to be run directly; it is really meant
188
220
            assumed to separate the address from the port number.
189
221
          </para>
190
222
          <para>
191
 
            This option is normally only useful for testing and
192
 
            debugging.
 
223
            Normally, Zeroconf would be used to locate Mandos servers,
 
224
            in which case this option would only be used when testing
 
225
            and debugging.
193
226
          </para>
194
227
        </listitem>
195
228
      </varlistentry>
196
229
      
197
230
      <varlistentry>
198
231
        <term><option>--interface=<replaceable
199
 
        >NAME</replaceable></option></term>
 
232
        >NAME</replaceable><arg rep='repeat'>,<replaceable
 
233
        >NAME</replaceable></arg></option></term>
200
234
        <term><option>-i
201
 
        <replaceable>NAME</replaceable></option></term>
 
235
        <replaceable>NAME</replaceable><arg rep='repeat'>,<replaceable
 
236
        >NAME</replaceable></arg></option></term>
202
237
        <listitem>
203
238
          <para>
204
 
            Network interface that will be brought up and scanned for
205
 
            Mandos servers to connect to.  The default is the empty
206
 
            string, which will automatically choose an appropriate
207
 
            interface.
 
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
243
          </para>
209
244
          <para>
210
 
            If the <option>--connect</option> option is used, this
211
 
            specifies the interface to use to connect to the address
212
 
            given.
 
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.
213
249
          </para>
214
250
          <para>
215
251
            Note that since this program will normally run in the
216
252
            initial RAM disk environment, the interface must be an
217
253
            interface which exists at that stage.  Thus, the interface
218
 
            can not be a pseudo-interface such as <quote>br0</quote>
219
 
            or <quote>tun0</quote>; such interfaces will not exist
220
 
            until much later in the boot process, and can not be used
221
 
            by this program.
 
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
260
          </para>
223
261
          <para>
224
262
            <replaceable>NAME</replaceable> can be the string
225
 
            <quote><literal>none</literal></quote>; this will not use
226
 
            any specific interface, and will not bring up an interface
227
 
            on startup.  This is not recommended, and only meant for
228
 
            advanced users.
 
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
267
          </para>
230
268
        </listitem>
231
269
      </varlistentry>
273
311
        <listitem>
274
312
          <para>
275
313
            Sets the number of bits to use for the prime number in the
276
 
            TLS Diffie-Hellman key exchange.  Default is 1024.
 
314
            TLS Diffie-Hellman key exchange.  The default value is
 
315
            selected automatically based on the OpenPGP key.
277
316
          </para>
278
317
        </listitem>
279
318
      </varlistentry>
283
322
        >SECONDS</replaceable></option></term>
284
323
        <listitem>
285
324
          <para>
286
 
            After bringing the network interface up, the program waits
 
325
            After bringing a network interface up, the program waits
287
326
            for the interface to arrive in a <quote>running</quote>
288
327
            state before proceeding.  During this time, the kernel log
289
328
            level will be lowered to reduce clutter on the system
293
332
          </para>
294
333
        </listitem>
295
334
      </varlistentry>
 
335
 
 
336
      <varlistentry>
 
337
        <term><option>--retry=<replaceable
 
338
        >SECONDS</replaceable></option></term>
 
339
        <listitem>
 
340
          <para>
 
341
            All Mandos servers are tried repeatedly until a password
 
342
            is received.  This value specifies, in seconds, how long
 
343
            between each successive try <emphasis>for the same
 
344
            server</emphasis>.  The default is 10 seconds.
 
345
          </para>
 
346
        </listitem>
 
347
      </varlistentry>
 
348
 
 
349
      <varlistentry>
 
350
        <term><option>--network-hook-dir=<replaceable
 
351
        >DIR</replaceable></option></term>
 
352
        <listitem>
 
353
          <para>
 
354
            Network hook directory.  The default directory is
 
355
            <quote><filename class="directory"
 
356
            >/lib/mandos/network-hooks.d</filename></quote>.
 
357
          </para>
 
358
        </listitem>
 
359
      </varlistentry>
296
360
      
297
361
      <varlistentry>
298
362
        <term><option>--debug</option></term>
359
423
      <refentrytitle>plugin-runner</refentrytitle>
360
424
      <manvolnum>8mandos</manvolnum></citerefentry>) is used to run
361
425
      both this program and others in in parallel,
362
 
      <emphasis>one</emphasis> of which will prompt for passwords on
363
 
      the system console.
 
426
      <emphasis>one</emphasis> of which (<citerefentry>
 
427
      <refentrytitle>password-prompt</refentrytitle>
 
428
      <manvolnum>8mandos</manvolnum></citerefentry>) will prompt for
 
429
      passwords on the system console.
364
430
    </para>
365
431
  </refsect1>
366
432
  
371
437
      server could be found and the password received from it could be
372
438
      successfully decrypted and output on standard output.  The
373
439
      program will exit with a non-zero exit status only if a critical
374
 
      error occurs.  Otherwise, it will forever connect to new
375
 
      <application>Mandos</application> servers as they appear, trying
376
 
      to get a decryptable password and print it.
 
440
      error occurs.  Otherwise, it will forever connect to any
 
441
      discovered <application>Mandos</application> servers, trying to
 
442
      get a decryptable password and print it.
377
443
    </para>
378
444
  </refsect1>
379
445
  
387
453
    </para>
388
454
  </refsect1>
389
455
  
 
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
  
390
625
  <refsect1 id="files">
391
626
    <title>FILES</title>
392
627
    <variablelist>
404
639
          </para>
405
640
        </listitem>
406
641
      </varlistentry>
 
642
      <varlistentry>
 
643
        <term><filename
 
644
        class="directory">/lib/mandos/network-hooks.d</filename></term>
 
645
        <listitem>
 
646
          <para>
 
647
            Directory where network hooks are located.  Change this
 
648
            with the <option>--network-hook-dir</option> option.  See
 
649
            <xref linkend="network-hooks"/>.
 
650
          </para>
 
651
        </listitem>
 
652
      </varlistentry>
407
653
    </variablelist>
408
654
  </refsect1>
409
655
  
423
669
    </para>
424
670
    <informalexample>
425
671
      <para>
426
 
        Normal invocation needs no options, if the network interface
427
 
        is <quote>eth0</quote>:
 
672
        Normal invocation needs no options, if the network interfaces
 
673
        can be automatically determined:
428
674
      </para>
429
675
      <para>
430
676
        <userinput>&COMMANDNAME;</userinput>
432
678
    </informalexample>
433
679
    <informalexample>
434
680
      <para>
435
 
        Search for Mandos servers (and connect to them) using another
436
 
        interface:
 
681
        Search for Mandos servers (and connect to them) using one
 
682
        specific interface:
437
683
      </para>
438
684
      <para>
439
685
        <!-- do not wrap this line -->
503
749
    <para>
504
750
      It will also help if the checker program on the server is
505
751
      configured to request something from the client which can not be
506
 
      spoofed by someone else on the network, unlike unencrypted
507
 
      <acronym>ICMP</acronym> echo (<quote>ping</quote>) replies.
 
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.
508
755
    </para>
509
756
    <para>
510
757
      <emphasis>Note</emphasis>: This makes it completely insecure to
518
765
  <refsect1 id="see_also">
519
766
    <title>SEE ALSO</title>
520
767
    <para>
 
768
      <citerefentry><refentrytitle>intro</refentrytitle>
 
769
      <manvolnum>8mandos</manvolnum></citerefentry>,
521
770
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
522
771
      <manvolnum>8</manvolnum></citerefentry>,
523
772
      <citerefentry><refentrytitle>crypttab</refentrytitle>
601
850
              <para>
602
851
                This client uses IPv6 link-local addresses, which are
603
852
                immediately usable since a link-local addresses is
604
 
                automatically assigned to a network interfaces when it
 
853
                automatically assigned to a network interface when it
605
854
                is brought up.
606
855
              </para>
607
856
            </listitem>