/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: 2017-08-20 16:20:54 UTC
  • Revision ID: teddy@recompile.se-20170820162054-jwig602syxx2k4l0
Alter copyright notices slightly.  Actual license is unchanged!

This alters all copyright notices to use the Free Software
Foundation's recommendations for license notices; from
<https://www.gnu.org/licenses/gpl-howto.html>:

  For programs that are more than one file, it is better to replace
  “this program” with the name of the program, and begin the statement
  with a line saying “This file is part of NAME”.

* DBUS-API: Use program name "Mandos" explicitly in license notice.
* debian/copyright: - '' -
* initramfs-unpack: - '' -
* legalnotice.xml: - '' -
* mandos: - '' -
* mandos-ctl: - '' -
* mandos-keygen: - '' -
* mandos-monitor: - '' -
* plugin-helpers/mandos-client-iprouteadddel.c: - '' -
* plugin-runner.c: - '' -
* plugins.d/askpass-fifo.c: - '' -
* plugins.d/mandos-client.c: - '' -
* plugins.d/password-prompt.c: - '' -
* plugins.d/plymouth.c: - '' -
* plugins.d/splashy.c: - '' -
* plugins.d/usplash.c: - '' -

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 "2011-08-08">
 
5
<!ENTITY TIMESTAMP "2017-02-23">
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>2010</year>
36
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
      <year>2017</year>
37
44
      <holder>Teddy Hogeborn</holder>
38
45
      <holder>Björn Påhlsson</holder>
39
46
    </copyright>
64
71
        ><replaceable>PORT</replaceable></option></arg>
65
72
      </group>
66
73
      <sbr/>
67
 
      <group>
 
74
      <group rep='repeat'>
68
75
        <arg choice="plain"><option>--interface
69
 
        <replaceable>NAME</replaceable></option></arg>
70
 
        <arg choice="plain"><option>-i
71
 
        <replaceable>NAME</replaceable></option></arg>
 
76
        <replaceable>NAME</replaceable><arg rep='repeat'
 
77
        >,<replaceable>NAME</replaceable></arg></option></arg>
 
78
        <arg choice="plain"><option>-i <replaceable>NAME</replaceable
 
79
        ><arg rep='repeat'>,<replaceable>NAME</replaceable></arg
 
80
        ></option></arg>
72
81
      </group>
73
82
      <sbr/>
74
83
      <group>
94
103
      </arg>
95
104
      <sbr/>
96
105
      <arg>
 
106
        <option>--dh-params <replaceable>FILE</replaceable></option>
 
107
      </arg>
 
108
      <sbr/>
 
109
      <arg>
97
110
        <option>--delay <replaceable>SECONDS</replaceable></option>
98
111
      </arg>
99
112
      <sbr/>
102
115
      </arg>
103
116
      <sbr/>
104
117
      <arg>
 
118
        <option>--network-hook-dir
 
119
        <replaceable>DIR</replaceable></option>
 
120
      </arg>
 
121
      <sbr/>
 
122
      <arg>
105
123
        <option>--debug</option>
106
124
      </arg>
107
125
    </cmdsynopsis>
132
150
      communicates with <citerefentry><refentrytitle
133
151
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>
134
152
      to get a password.  In slightly more detail, this client program
135
 
      brings up a network interface, uses the interface’s IPv6
136
 
      link-local address to get network connectivity, uses Zeroconf to
137
 
      find servers on the local network, and communicates with servers
138
 
      using TLS with an OpenPGP key to ensure authenticity and
 
153
      brings up network interfaces, uses the interfaces’ IPv6
 
154
      link-local addresses to get network connectivity, uses Zeroconf
 
155
      to find servers on the local network, and communicates with
 
156
      servers using TLS with an OpenPGP key to ensure authenticity and
139
157
      confidentiality.  This client program keeps running, trying all
140
158
      servers on the network, until it receives a satisfactory reply
141
159
      or a TERM signal.  After all servers have been tried, all
143
161
      will wait indefinitely for new servers to appear.
144
162
    </para>
145
163
    <para>
 
164
      The network interfaces are selected like this: If any interfaces
 
165
      are specified using the <option>--interface</option> option,
 
166
      those interface are used.  Otherwise,
 
167
      <command>&COMMANDNAME;</command> will use all interfaces that
 
168
      are not loopback interfaces, are not point-to-point interfaces,
 
169
      are capable of broadcasting and do not have the NOARP flag (see
 
170
      <citerefentry><refentrytitle>netdevice</refentrytitle>
 
171
      <manvolnum>7</manvolnum></citerefentry>).  (If the
 
172
      <option>--connect</option> option is used, point-to-point
 
173
      interfaces and non-broadcast interfaces are accepted.)  If any
 
174
      used interfaces are not up and running, they are first taken up
 
175
      (and later taken down again on program exit).
 
176
    </para>
 
177
    <para>
 
178
      Before network interfaces are selected, all <quote>network
 
179
      hooks</quote> are run; see <xref linkend="network-hooks"/>.
 
180
    </para>
 
181
    <para>
146
182
      This program is not meant to be run directly; it is really meant
147
183
      to run as a plugin of the <application>Mandos</application>
148
184
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
193
229
            assumed to separate the address from the port number.
194
230
          </para>
195
231
          <para>
196
 
            This option is normally only useful for testing and
197
 
            debugging.
 
232
            Normally, Zeroconf would be used to locate Mandos servers,
 
233
            in which case this option would only be used when testing
 
234
            and debugging.
198
235
          </para>
199
236
        </listitem>
200
237
      </varlistentry>
201
238
      
202
239
      <varlistentry>
203
240
        <term><option>--interface=<replaceable
204
 
        >NAME</replaceable></option></term>
 
241
        >NAME</replaceable><arg rep='repeat'>,<replaceable
 
242
        >NAME</replaceable></arg></option></term>
205
243
        <term><option>-i
206
 
        <replaceable>NAME</replaceable></option></term>
 
244
        <replaceable>NAME</replaceable><arg rep='repeat'>,<replaceable
 
245
        >NAME</replaceable></arg></option></term>
207
246
        <listitem>
208
247
          <para>
209
 
            Network interface that will be brought up and scanned for
210
 
            Mandos servers to connect to.  The default is the empty
211
 
            string, which will automatically choose an appropriate
212
 
            interface.
 
248
            Comma separated list of network interfaces that will be
 
249
            brought up and scanned for Mandos servers to connect to.
 
250
            The default is the empty string, which will automatically
 
251
            use all appropriate interfaces.
213
252
          </para>
214
253
          <para>
215
 
            If the <option>--connect</option> option is used, this
216
 
            specifies the interface to use to connect to the address
217
 
            given.
 
254
            If the <option>--connect</option> option is used, and
 
255
            exactly one interface name is specified (except
 
256
            <quote><literal>none</literal></quote>), this specifies
 
257
            the interface to use to connect to the address given.
218
258
          </para>
219
259
          <para>
220
260
            Note that since this program will normally run in the
221
261
            initial RAM disk environment, the interface must be an
222
262
            interface which exists at that stage.  Thus, the interface
223
 
            can not be a pseudo-interface such as <quote>br0</quote>
224
 
            or <quote>tun0</quote>; such interfaces will not exist
225
 
            until much later in the boot process, and can not be used
226
 
            by this program.
 
263
            can normally not be a pseudo-interface such as
 
264
            <quote>br0</quote> or <quote>tun0</quote>; such interfaces
 
265
            will not exist until much later in the boot process, and
 
266
            can not be used by this program, unless created by a
 
267
            <quote>network hook</quote> — see <xref
 
268
            linkend="network-hooks"/>.
227
269
          </para>
228
270
          <para>
229
271
            <replaceable>NAME</replaceable> can be the string
230
 
            <quote><literal>none</literal></quote>; this will not use
231
 
            any specific interface, and will not bring up an interface
232
 
            on startup.  This is not recommended, and only meant for
233
 
            advanced users.
 
272
            <quote><literal>none</literal></quote>; this will make
 
273
            <command>&COMMANDNAME;</command> only bring up interfaces
 
274
            specified <emphasis>before</emphasis> this string.  This
 
275
            is not recommended, and only meant for advanced users.
234
276
          </para>
235
277
        </listitem>
236
278
      </varlistentry>
278
320
        <listitem>
279
321
          <para>
280
322
            Sets the number of bits to use for the prime number in the
281
 
            TLS Diffie-Hellman key exchange.  Default is 1024.
 
323
            TLS Diffie-Hellman key exchange.  The default value is
 
324
            selected automatically based on the OpenPGP key.  Note
 
325
            that if the <option>--dh-params</option> option is used,
 
326
            the values from that file will be used instead.
 
327
          </para>
 
328
        </listitem>
 
329
      </varlistentry>
 
330
      
 
331
      <varlistentry>
 
332
        <term><option>--dh-params=<replaceable
 
333
        >FILE</replaceable></option></term>
 
334
        <listitem>
 
335
          <para>
 
336
            Specifies a PEM-encoded PKCS#3 file to read the parameters
 
337
            needed by the TLS Diffie-Hellman key exchange from.  If
 
338
            this option is not given, or if the file for some reason
 
339
            could not be used, the parameters will be generated on
 
340
            startup, which will take some time and processing power.
 
341
            Those using servers running under time, power or processor
 
342
            constraints may want to generate such a file in advance
 
343
            and use this option.
282
344
          </para>
283
345
        </listitem>
284
346
      </varlistentry>
288
350
        >SECONDS</replaceable></option></term>
289
351
        <listitem>
290
352
          <para>
291
 
            After bringing the network interface up, the program waits
 
353
            After bringing a network interface up, the program waits
292
354
            for the interface to arrive in a <quote>running</quote>
293
355
            state before proceeding.  During this time, the kernel log
294
356
            level will be lowered to reduce clutter on the system
311
373
          </para>
312
374
        </listitem>
313
375
      </varlistentry>
 
376
 
 
377
      <varlistentry>
 
378
        <term><option>--network-hook-dir=<replaceable
 
379
        >DIR</replaceable></option></term>
 
380
        <listitem>
 
381
          <para>
 
382
            Network hook directory.  The default directory is
 
383
            <quote><filename class="directory"
 
384
            >/lib/mandos/network-hooks.d</filename></quote>.
 
385
          </para>
 
386
        </listitem>
 
387
      </varlistentry>
314
388
      
315
389
      <varlistentry>
316
390
        <term><option>--debug</option></term>
377
451
      <refentrytitle>plugin-runner</refentrytitle>
378
452
      <manvolnum>8mandos</manvolnum></citerefentry>) is used to run
379
453
      both this program and others in in parallel,
380
 
      <emphasis>one</emphasis> of which will prompt for passwords on
381
 
      the system console.
 
454
      <emphasis>one</emphasis> of which (<citerefentry>
 
455
      <refentrytitle>password-prompt</refentrytitle>
 
456
      <manvolnum>8mandos</manvolnum></citerefentry>) will prompt for
 
457
      passwords on the system console.
382
458
    </para>
383
459
  </refsect1>
384
460
  
397
473
  
398
474
  <refsect1 id="environment">
399
475
    <title>ENVIRONMENT</title>
 
476
    <variablelist>
 
477
      <varlistentry>
 
478
        <term><envar>MANDOSPLUGINHELPERDIR</envar></term>
 
479
        <listitem>
 
480
          <para>
 
481
            This environment variable will be assumed to contain the
 
482
            directory containing any helper executables.  The use and
 
483
            nature of these helper executables, if any, is
 
484
            purposefully not documented.
 
485
        </para>
 
486
        </listitem>
 
487
      </varlistentry>
 
488
    </variablelist>
400
489
    <para>
401
 
      This program does not use any environment variables, not even
402
 
      the ones provided by <citerefentry><refentrytitle
 
490
      This program does not use any other environment variables, not
 
491
      even the ones provided by <citerefentry><refentrytitle
403
492
      >cryptsetup</refentrytitle><manvolnum>8</manvolnum>
404
493
    </citerefentry>.
405
494
    </para>
406
495
  </refsect1>
407
496
  
 
497
  <refsect1 id="network-hooks">
 
498
    <title>NETWORK HOOKS</title>
 
499
    <para>
 
500
      If a network interface like a bridge or tunnel is required to
 
501
      find a Mandos server, this requires the interface to be up and
 
502
      running before <command>&COMMANDNAME;</command> starts looking
 
503
      for Mandos servers.  This can be accomplished by creating a
 
504
      <quote>network hook</quote> program, and placing it in a special
 
505
      directory.
 
506
    </para>
 
507
    <para>
 
508
      Before the network is used (and again before program exit), any
 
509
      runnable programs found in the network hook directory are run
 
510
      with the argument <quote><literal>start</literal></quote> or
 
511
      <quote><literal>stop</literal></quote>.  This should bring up or
 
512
      down, respectively, any network interface which
 
513
      <command>&COMMANDNAME;</command> should use.
 
514
    </para>
 
515
    <refsect2 id="hook-requirements">
 
516
      <title>REQUIREMENTS</title>
 
517
      <para>
 
518
        A network hook must be an executable file, and its name must
 
519
        consist entirely of upper and lower case letters, digits,
 
520
        underscores, periods, and hyphens.
 
521
      </para>
 
522
      <para>
 
523
        A network hook will receive one argument, which can be one of
 
524
        the following:
 
525
      </para>
 
526
      <variablelist>
 
527
        <varlistentry>
 
528
          <term><literal>start</literal></term>
 
529
          <listitem>
 
530
            <para>
 
531
              This should make the network hook create (if necessary)
 
532
              and bring up a network interface.
 
533
            </para>
 
534
          </listitem>
 
535
        </varlistentry>
 
536
        <varlistentry>
 
537
          <term><literal>stop</literal></term>
 
538
          <listitem>
 
539
            <para>
 
540
              This should make the network hook take down a network
 
541
              interface, and delete it if it did not exist previously.
 
542
            </para>
 
543
          </listitem>
 
544
        </varlistentry>
 
545
        <varlistentry>
 
546
          <term><literal>files</literal></term>
 
547
          <listitem>
 
548
            <para>
 
549
              This should make the network hook print, <emphasis>one
 
550
              file per line</emphasis>, all the files needed for it to
 
551
              run.  (These files will be copied into the initial RAM
 
552
              filesystem.)  Typical use is for a network hook which is
 
553
              a shell script to print its needed binaries.
 
554
            </para>
 
555
            <para>
 
556
              It is not necessary to print any non-executable files
 
557
              already in the network hook directory, these will be
 
558
              copied implicitly if they otherwise satisfy the name
 
559
              requirements.
 
560
            </para>
 
561
          </listitem>
 
562
        </varlistentry>
 
563
        <varlistentry>
 
564
          <term><literal>modules</literal></term>
 
565
          <listitem>
 
566
            <para>
 
567
              This should make the network hook print, <emphasis>on
 
568
              separate lines</emphasis>, all the kernel modules needed
 
569
              for it to run.  (These modules will be copied into the
 
570
              initial RAM filesystem.)  For instance, a tunnel
 
571
              interface needs the
 
572
              <quote><literal>tun</literal></quote> module.
 
573
            </para>
 
574
          </listitem>
 
575
        </varlistentry>
 
576
      </variablelist>
 
577
      <para>
 
578
        The network hook will be provided with a number of environment
 
579
        variables:
 
580
      </para>
 
581
      <variablelist>
 
582
        <varlistentry>
 
583
          <term><envar>MANDOSNETHOOKDIR</envar></term>
 
584
          <listitem>
 
585
            <para>
 
586
              The network hook directory, specified to
 
587
              <command>&COMMANDNAME;</command> by the
 
588
              <option>--network-hook-dir</option> option.  Note: this
 
589
              should <emphasis>always</emphasis> be used by the
 
590
              network hook to refer to itself or any files in the hook
 
591
              directory it may require.
 
592
            </para>
 
593
          </listitem>
 
594
        </varlistentry>
 
595
        <varlistentry>
 
596
          <term><envar>DEVICE</envar></term>
 
597
          <listitem>
 
598
            <para>
 
599
              The network interfaces, as specified to
 
600
              <command>&COMMANDNAME;</command> by the
 
601
              <option>--interface</option> option, combined to one
 
602
              string and separated by commas.  If this is set, and
 
603
              does not contain the interface a hook will bring up,
 
604
              there is no reason for a hook to continue.
 
605
            </para>
 
606
          </listitem>
 
607
        </varlistentry>
 
608
        <varlistentry>
 
609
          <term><envar>MODE</envar></term>
 
610
          <listitem>
 
611
            <para>
 
612
              This will be the same as the first argument;
 
613
              i.e. <quote><literal>start</literal></quote>,
 
614
              <quote><literal>stop</literal></quote>,
 
615
              <quote><literal>files</literal></quote>, or
 
616
              <quote><literal>modules</literal></quote>.
 
617
            </para>
 
618
          </listitem>
 
619
        </varlistentry>
 
620
        <varlistentry>
 
621
          <term><envar>VERBOSITY</envar></term>
 
622
          <listitem>
 
623
            <para>
 
624
              This will be the <quote><literal>1</literal></quote> if
 
625
              the <option>--debug</option> option is passed to
 
626
              <command>&COMMANDNAME;</command>, otherwise
 
627
              <quote><literal>0</literal></quote>.
 
628
            </para>
 
629
          </listitem>
 
630
        </varlistentry>
 
631
        <varlistentry>
 
632
          <term><envar>DELAY</envar></term>
 
633
          <listitem>
 
634
            <para>
 
635
              This will be the same as the <option>--delay</option>
 
636
              option passed to <command>&COMMANDNAME;</command>.  Is
 
637
              only set if <envar>MODE</envar> is
 
638
              <quote><literal>start</literal></quote> or
 
639
              <quote><literal>stop</literal></quote>.
 
640
            </para>
 
641
          </listitem>
 
642
        </varlistentry>
 
643
        <varlistentry>
 
644
          <term><envar>CONNECT</envar></term>
 
645
          <listitem>
 
646
            <para>
 
647
              This will be the same as the <option>--connect</option>
 
648
              option passed to <command>&COMMANDNAME;</command>.  Is
 
649
              only set if <option>--connect</option> is passed and
 
650
              <envar>MODE</envar> is
 
651
              <quote><literal>start</literal></quote> or
 
652
              <quote><literal>stop</literal></quote>.
 
653
            </para>
 
654
          </listitem>
 
655
        </varlistentry>
 
656
      </variablelist>
 
657
      <para>
 
658
        A hook may not read from standard input, and should be
 
659
        restrictive in printing to standard output or standard error
 
660
        unless <varname>VERBOSITY</varname> is
 
661
        <quote><literal>1</literal></quote>.
 
662
      </para>
 
663
    </refsect2>
 
664
  </refsect1>
 
665
  
408
666
  <refsect1 id="files">
409
667
    <title>FILES</title>
410
668
    <variablelist>
422
680
          </para>
423
681
        </listitem>
424
682
      </varlistentry>
 
683
      <varlistentry>
 
684
        <term><filename
 
685
        class="directory">/lib/mandos/network-hooks.d</filename></term>
 
686
        <listitem>
 
687
          <para>
 
688
            Directory where network hooks are located.  Change this
 
689
            with the <option>--network-hook-dir</option> option.  See
 
690
            <xref linkend="network-hooks"/>.
 
691
          </para>
 
692
        </listitem>
 
693
      </varlistentry>
425
694
    </variablelist>
426
695
  </refsect1>
427
696
  
428
 
<!--   <refsect1 id="bugs"> -->
429
 
<!--     <title>BUGS</title> -->
430
 
<!--     <para> -->
431
 
<!--     </para> -->
432
 
<!--   </refsect1> -->
 
697
  <refsect1 id="bugs">
 
698
    <title>BUGS</title>
 
699
    <xi:include href="../bugs.xml"/>
 
700
  </refsect1>
433
701
  
434
702
  <refsect1 id="example">
435
703
    <title>EXAMPLE</title>
441
709
    </para>
442
710
    <informalexample>
443
711
      <para>
444
 
        Normal invocation needs no options, if the network interface
445
 
        is <quote>eth0</quote>:
 
712
        Normal invocation needs no options, if the network interfaces
 
713
        can be automatically determined:
446
714
      </para>
447
715
      <para>
448
716
        <userinput>&COMMANDNAME;</userinput>
450
718
    </informalexample>
451
719
    <informalexample>
452
720
      <para>
453
 
        Search for Mandos servers (and connect to them) using another
454
 
        interface:
 
721
        Search for Mandos servers (and connect to them) using one
 
722
        specific interface:
455
723
      </para>
456
724
      <para>
457
725
        <!-- do not wrap this line -->
521
789
    <para>
522
790
      It will also help if the checker program on the server is
523
791
      configured to request something from the client which can not be
524
 
      spoofed by someone else on the network, unlike unencrypted
525
 
      <acronym>ICMP</acronym> echo (<quote>ping</quote>) replies.
 
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.
526
795
    </para>
527
796
    <para>
528
797
      <emphasis>Note</emphasis>: This makes it completely insecure to
574
843
      </varlistentry>
575
844
      <varlistentry>
576
845
        <term>
577
 
          <ulink url="http://www.gnu.org/software/gnutls/"
578
 
          >GnuTLS</ulink>
 
846
          <ulink url="https://www.gnutls.org/">GnuTLS</ulink>
579
847
        </term>
580
848
      <listitem>
581
849
        <para>
587
855
      </varlistentry>
588
856
      <varlistentry>
589
857
        <term>
590
 
          <ulink url="http://www.gnupg.org/related_software/gpgme/"
 
858
          <ulink url="https://www.gnupg.org/related_software/gpgme/"
591
859
                 >GPGME</ulink>
592
860
        </term>
593
861
        <listitem>
621
889
              <para>
622
890
                This client uses IPv6 link-local addresses, which are
623
891
                immediately usable since a link-local addresses is
624
 
                automatically assigned to a network interfaces when it
 
892
                automatically assigned to a network interface when it
625
893
                is brought up.
626
894
              </para>
627
895
            </listitem>
631
899
      </varlistentry>
632
900
      <varlistentry>
633
901
        <term>
634
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
635
 
          Protocol Version 1.1</citetitle>
 
902
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
 
903
          Protocol Version 1.2</citetitle>
636
904
        </term>
637
905
      <listitem>
638
906
        <para>
639
 
          TLS 1.1 is the protocol implemented by GnuTLS.
 
907
          TLS 1.2 is the protocol implemented by GnuTLS.
640
908
        </para>
641
909
      </listitem>
642
910
      </varlistentry>
653
921
      </varlistentry>
654
922
      <varlistentry>
655
923
        <term>
656
 
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
 
924
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
657
925
          Security</citetitle>
658
926
        </term>
659
927
      <listitem>