/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: 2018-01-29 19:43:17 UTC
  • Revision ID: teddy@recompile.se-20180129194317-07fz89jdxefuphq1
Use "simply expanded" variables in Makefile

* (Makefile): Use "simply expanded" variables where possible.

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-10-03">
 
5
<!ENTITY TIMESTAMP "2017-02-23">
6
6
<!ENTITY % common SYSTEM "../common.ent">
7
7
%common;
8
8
]>
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>
105
 
        <option>--network-hook-dir<replaceable>DIR</replaceable></option>
 
118
        <option>--network-hook-dir
 
119
        <replaceable>DIR</replaceable></option>
106
120
      </arg>
107
121
      <sbr/>
108
122
      <arg>
136
150
      communicates with <citerefentry><refentrytitle
137
151
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>
138
152
      to get a password.  In slightly more detail, this client program
139
 
      brings up a network interface, uses the interface’s IPv6
140
 
      link-local address to get network connectivity, uses Zeroconf to
141
 
      find servers on the local network, and communicates with servers
142
 
      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
143
157
      confidentiality.  This client program keeps running, trying all
144
158
      servers on the network, until it receives a satisfactory reply
145
159
      or a TERM signal.  After all servers have been tried, all
147
161
      will wait indefinitely for new servers to appear.
148
162
    </para>
149
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>
150
182
      This program is not meant to be run directly; it is really meant
151
183
      to run as a plugin of the <application>Mandos</application>
152
184
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
197
229
            assumed to separate the address from the port number.
198
230
          </para>
199
231
          <para>
200
 
            This option is normally only useful for testing and
201
 
            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.
202
235
          </para>
203
236
        </listitem>
204
237
      </varlistentry>
205
238
      
206
239
      <varlistentry>
207
240
        <term><option>--interface=<replaceable
208
 
        >NAME</replaceable></option></term>
 
241
        >NAME</replaceable><arg rep='repeat'>,<replaceable
 
242
        >NAME</replaceable></arg></option></term>
209
243
        <term><option>-i
210
 
        <replaceable>NAME</replaceable></option></term>
 
244
        <replaceable>NAME</replaceable><arg rep='repeat'>,<replaceable
 
245
        >NAME</replaceable></arg></option></term>
211
246
        <listitem>
212
247
          <para>
213
 
            Network interface that will be brought up and scanned for
214
 
            Mandos servers to connect to.  The default is the empty
215
 
            string, which will automatically choose an appropriate
216
 
            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.
217
252
          </para>
218
253
          <para>
219
 
            If the <option>--connect</option> option is used, this
220
 
            specifies the interface to use to connect to the address
221
 
            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.
222
258
          </para>
223
259
          <para>
224
260
            Note that since this program will normally run in the
225
261
            initial RAM disk environment, the interface must be an
226
262
            interface which exists at that stage.  Thus, the interface
227
 
            can not be a pseudo-interface such as <quote>br0</quote>
228
 
            or <quote>tun0</quote>; such interfaces will not exist
229
 
            until much later in the boot process, and can not be used
230
 
            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"/>.
231
269
          </para>
232
270
          <para>
233
271
            <replaceable>NAME</replaceable> can be the string
234
 
            <quote><literal>none</literal></quote>; this will not use
235
 
            any specific interface, and will not bring up an interface
236
 
            on startup.  This is not recommended, and only meant for
237
 
            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.
238
276
          </para>
239
277
        </listitem>
240
278
      </varlistentry>
282
320
        <listitem>
283
321
          <para>
284
322
            Sets the number of bits to use for the prime number in the
285
 
            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.
286
344
          </para>
287
345
        </listitem>
288
346
      </varlistentry>
292
350
        >SECONDS</replaceable></option></term>
293
351
        <listitem>
294
352
          <para>
295
 
            After bringing the network interface up, the program waits
 
353
            After bringing a network interface up, the program waits
296
354
            for the interface to arrive in a <quote>running</quote>
297
355
            state before proceeding.  During this time, the kernel log
298
356
            level will be lowered to reduce clutter on the system
393
451
      <refentrytitle>plugin-runner</refentrytitle>
394
452
      <manvolnum>8mandos</manvolnum></citerefentry>) is used to run
395
453
      both this program and others in in parallel,
396
 
      <emphasis>one</emphasis> of which will prompt for passwords on
397
 
      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.
398
458
    </para>
399
459
  </refsect1>
400
460
  
413
473
  
414
474
  <refsect1 id="environment">
415
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>
416
489
    <para>
417
 
      This program does not use any environment variables, not even
418
 
      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
419
492
      >cryptsetup</refentrytitle><manvolnum>8</manvolnum>
420
493
    </citerefentry>.
421
494
    </para>
422
495
  </refsect1>
423
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
  
424
666
  <refsect1 id="files">
425
667
    <title>FILES</title>
426
668
    <variablelist>
438
680
          </para>
439
681
        </listitem>
440
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>
441
694
    </variablelist>
442
695
  </refsect1>
443
696
  
444
 
<!--   <refsect1 id="bugs"> -->
445
 
<!--     <title>BUGS</title> -->
446
 
<!--     <para> -->
447
 
<!--     </para> -->
448
 
<!--   </refsect1> -->
 
697
  <refsect1 id="bugs">
 
698
    <title>BUGS</title>
 
699
    <xi:include href="../bugs.xml"/>
 
700
  </refsect1>
449
701
  
450
702
  <refsect1 id="example">
451
703
    <title>EXAMPLE</title>
457
709
    </para>
458
710
    <informalexample>
459
711
      <para>
460
 
        Normal invocation needs no options, if the network interface
461
 
        is <quote>eth0</quote>:
 
712
        Normal invocation needs no options, if the network interfaces
 
713
        can be automatically determined:
462
714
      </para>
463
715
      <para>
464
716
        <userinput>&COMMANDNAME;</userinput>
466
718
    </informalexample>
467
719
    <informalexample>
468
720
      <para>
469
 
        Search for Mandos servers (and connect to them) using another
470
 
        interface:
 
721
        Search for Mandos servers (and connect to them) using one
 
722
        specific interface:
471
723
      </para>
472
724
      <para>
473
725
        <!-- do not wrap this line -->
537
789
    <para>
538
790
      It will also help if the checker program on the server is
539
791
      configured to request something from the client which can not be
540
 
      spoofed by someone else on the network, unlike unencrypted
541
 
      <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.
542
795
    </para>
543
796
    <para>
544
797
      <emphasis>Note</emphasis>: This makes it completely insecure to
590
843
      </varlistentry>
591
844
      <varlistentry>
592
845
        <term>
593
 
          <ulink url="http://www.gnu.org/software/gnutls/"
594
 
          >GnuTLS</ulink>
 
846
          <ulink url="https://www.gnutls.org/">GnuTLS</ulink>
595
847
        </term>
596
848
      <listitem>
597
849
        <para>
603
855
      </varlistentry>
604
856
      <varlistentry>
605
857
        <term>
606
 
          <ulink url="http://www.gnupg.org/related_software/gpgme/"
 
858
          <ulink url="https://www.gnupg.org/related_software/gpgme/"
607
859
                 >GPGME</ulink>
608
860
        </term>
609
861
        <listitem>
637
889
              <para>
638
890
                This client uses IPv6 link-local addresses, which are
639
891
                immediately usable since a link-local addresses is
640
 
                automatically assigned to a network interfaces when it
 
892
                automatically assigned to a network interface when it
641
893
                is brought up.
642
894
              </para>
643
895
            </listitem>
647
899
      </varlistentry>
648
900
      <varlistentry>
649
901
        <term>
650
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
651
 
          Protocol Version 1.1</citetitle>
 
902
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
 
903
          Protocol Version 1.2</citetitle>
652
904
        </term>
653
905
      <listitem>
654
906
        <para>
655
 
          TLS 1.1 is the protocol implemented by GnuTLS.
 
907
          TLS 1.2 is the protocol implemented by GnuTLS.
656
908
        </para>
657
909
      </listitem>
658
910
      </varlistentry>
669
921
      </varlistentry>
670
922
      <varlistentry>
671
923
        <term>
672
 
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
 
924
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
673
925
          Security</citetitle>
674
926
        </term>
675
927
      <listitem>