/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-16 20:30:35 UTC
  • Revision ID: teddy@recompile.se-20150716203035-z7qjwm270o2vrjah
Assume the C11 language (ISO 9899:2011), when compiling C code.

* Makefile (LANGUAGE): Changed to "-std=gnu11".

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