/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-02-10 13:23:58 UTC
  • Revision ID: teddy@recompile.se-20180210132358-8pfvo9vshq9l32y5
Remove unnecessary text left from old example init.d file

* init.d-mandos: Remove unnecessary text left from old example init.d
  file.

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