/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to plugins.d/mandos-client.xml

* Makefile (DOCS): Added "intro.8mandos".
  (intro.8mandos, intro.8mandos.xhtml): New.
* README: Replaced text with link, reference and short summary.
* intro.xml: New.
* mandos-clients.conf.xml (SEE ALSO): Added "intro(8mandos)".
* mandos-ctl.xml (SEE ALSO): - '' -
* mandos-keygen.xml (SEE ALSO): - '' -
* mandos-monitor.xml (SEE ALSO): - '' -
* mandos.conf.xml (SEE ALSO): - '' -
* mandos.xml (SEE ALSO): - '' -
* plugin-runner.xml (SEE ALSO): - '' -
* plugins.d/askpass-fifo.xml (SEE ALSO): - '' -
* plugins.d/mandos-client.xml (SEE ALSO): - '' -
* plugins.d/password-prompt.xml (SEE ALSO): - '' -
* plugins.d/plymouth.xml (SEE ALSO): - '' -
* plugins.d/splashy.xml (SEE ALSO): - '' -
* plugins.d/usplash.xml (SEE ALSO): - '' -

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 "2017-02-23">
 
5
<!ENTITY TIMESTAMP "2011-08-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@recompile.se</email>
 
22
          <email>belorn@fukt.bsnet.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@recompile.se</email>
 
29
          <email>teddy@fukt.bsnet.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
36
      <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
37
      <holder>Teddy Hogeborn</holder>
45
38
      <holder>Björn Påhlsson</holder>
46
39
    </copyright>
71
64
        ><replaceable>PORT</replaceable></option></arg>
72
65
      </group>
73
66
      <sbr/>
74
 
      <group rep='repeat'>
 
67
      <group>
75
68
        <arg choice="plain"><option>--interface
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>
 
69
        <replaceable>NAME</replaceable></option></arg>
 
70
        <arg choice="plain"><option>-i
 
71
        <replaceable>NAME</replaceable></option></arg>
81
72
      </group>
82
73
      <sbr/>
83
74
      <group>
103
94
      </arg>
104
95
      <sbr/>
105
96
      <arg>
106
 
        <option>--dh-params <replaceable>FILE</replaceable></option>
107
 
      </arg>
108
 
      <sbr/>
109
 
      <arg>
110
97
        <option>--delay <replaceable>SECONDS</replaceable></option>
111
98
      </arg>
112
99
      <sbr/>
115
102
      </arg>
116
103
      <sbr/>
117
104
      <arg>
118
 
        <option>--network-hook-dir
119
 
        <replaceable>DIR</replaceable></option>
120
 
      </arg>
121
 
      <sbr/>
122
 
      <arg>
123
105
        <option>--debug</option>
124
106
      </arg>
125
107
    </cmdsynopsis>
150
132
      communicates with <citerefentry><refentrytitle
151
133
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>
152
134
      to get a password.  In slightly more detail, this client program
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
 
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
157
139
      confidentiality.  This client program keeps running, trying all
158
140
      servers on the network, until it receives a satisfactory reply
159
141
      or a TERM signal.  After all servers have been tried, all
161
143
      will wait indefinitely for new servers to appear.
162
144
    </para>
163
145
    <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>
182
146
      This program is not meant to be run directly; it is really meant
183
147
      to run as a plugin of the <application>Mandos</application>
184
148
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
229
193
            assumed to separate the address from the port number.
230
194
          </para>
231
195
          <para>
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.
 
196
            This option is normally only useful for testing and
 
197
            debugging.
235
198
          </para>
236
199
        </listitem>
237
200
      </varlistentry>
238
201
      
239
202
      <varlistentry>
240
203
        <term><option>--interface=<replaceable
241
 
        >NAME</replaceable><arg rep='repeat'>,<replaceable
242
 
        >NAME</replaceable></arg></option></term>
 
204
        >NAME</replaceable></option></term>
243
205
        <term><option>-i
244
 
        <replaceable>NAME</replaceable><arg rep='repeat'>,<replaceable
245
 
        >NAME</replaceable></arg></option></term>
 
206
        <replaceable>NAME</replaceable></option></term>
246
207
        <listitem>
247
208
          <para>
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.
 
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.
252
213
          </para>
253
214
          <para>
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.
 
215
            If the <option>--connect</option> option is used, this
 
216
            specifies the interface to use to connect to the address
 
217
            given.
258
218
          </para>
259
219
          <para>
260
220
            Note that since this program will normally run in the
261
221
            initial RAM disk environment, the interface must be an
262
222
            interface which exists at that stage.  Thus, the interface
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"/>.
 
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.
269
227
          </para>
270
228
          <para>
271
229
            <replaceable>NAME</replaceable> can be the string
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.
 
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.
276
234
          </para>
277
235
        </listitem>
278
236
      </varlistentry>
320
278
        <listitem>
321
279
          <para>
322
280
            Sets the number of bits to use for the prime number in the
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.
 
281
            TLS Diffie-Hellman key exchange.  Default is 1024.
344
282
          </para>
345
283
        </listitem>
346
284
      </varlistentry>
350
288
        >SECONDS</replaceable></option></term>
351
289
        <listitem>
352
290
          <para>
353
 
            After bringing a network interface up, the program waits
 
291
            After bringing the network interface up, the program waits
354
292
            for the interface to arrive in a <quote>running</quote>
355
293
            state before proceeding.  During this time, the kernel log
356
294
            level will be lowered to reduce clutter on the system
373
311
          </para>
374
312
        </listitem>
375
313
      </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>
388
314
      
389
315
      <varlistentry>
390
316
        <term><option>--debug</option></term>
451
377
      <refentrytitle>plugin-runner</refentrytitle>
452
378
      <manvolnum>8mandos</manvolnum></citerefentry>) is used to run
453
379
      both this program and others in in parallel,
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.
 
380
      <emphasis>one</emphasis> of which will prompt for passwords on
 
381
      the system console.
458
382
    </para>
459
383
  </refsect1>
460
384
  
473
397
  
474
398
  <refsect1 id="environment">
475
399
    <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>
489
400
    <para>
490
 
      This program does not use any other environment variables, not
491
 
      even the ones provided by <citerefentry><refentrytitle
 
401
      This program does not use any environment variables, not even
 
402
      the ones provided by <citerefentry><refentrytitle
492
403
      >cryptsetup</refentrytitle><manvolnum>8</manvolnum>
493
404
    </citerefentry>.
494
405
    </para>
495
406
  </refsect1>
496
407
  
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
 
  
666
408
  <refsect1 id="files">
667
409
    <title>FILES</title>
668
410
    <variablelist>
680
422
          </para>
681
423
        </listitem>
682
424
      </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>
694
425
    </variablelist>
695
426
  </refsect1>
696
427
  
697
 
  <refsect1 id="bugs">
698
 
    <title>BUGS</title>
699
 
    <xi:include href="../bugs.xml"/>
700
 
  </refsect1>
 
428
<!--   <refsect1 id="bugs"> -->
 
429
<!--     <title>BUGS</title> -->
 
430
<!--     <para> -->
 
431
<!--     </para> -->
 
432
<!--   </refsect1> -->
701
433
  
702
434
  <refsect1 id="example">
703
435
    <title>EXAMPLE</title>
709
441
    </para>
710
442
    <informalexample>
711
443
      <para>
712
 
        Normal invocation needs no options, if the network interfaces
713
 
        can be automatically determined:
 
444
        Normal invocation needs no options, if the network interface
 
445
        is <quote>eth0</quote>:
714
446
      </para>
715
447
      <para>
716
448
        <userinput>&COMMANDNAME;</userinput>
718
450
    </informalexample>
719
451
    <informalexample>
720
452
      <para>
721
 
        Search for Mandos servers (and connect to them) using one
722
 
        specific interface:
 
453
        Search for Mandos servers (and connect to them) using another
 
454
        interface:
723
455
      </para>
724
456
      <para>
725
457
        <!-- do not wrap this line -->
789
521
    <para>
790
522
      It will also help if the checker program on the server is
791
523
      configured to request something from the client which can not be
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.
 
524
      spoofed by someone else on the network, unlike unencrypted
 
525
      <acronym>ICMP</acronym> echo (<quote>ping</quote>) replies.
795
526
    </para>
796
527
    <para>
797
528
      <emphasis>Note</emphasis>: This makes it completely insecure to
843
574
      </varlistentry>
844
575
      <varlistentry>
845
576
        <term>
846
 
          <ulink url="https://www.gnutls.org/">GnuTLS</ulink>
 
577
          <ulink url="http://www.gnu.org/software/gnutls/"
 
578
          >GnuTLS</ulink>
847
579
        </term>
848
580
      <listitem>
849
581
        <para>
855
587
      </varlistentry>
856
588
      <varlistentry>
857
589
        <term>
858
 
          <ulink url="https://www.gnupg.org/related_software/gpgme/"
 
590
          <ulink url="http://www.gnupg.org/related_software/gpgme/"
859
591
                 >GPGME</ulink>
860
592
        </term>
861
593
        <listitem>
889
621
              <para>
890
622
                This client uses IPv6 link-local addresses, which are
891
623
                immediately usable since a link-local addresses is
892
 
                automatically assigned to a network interface when it
 
624
                automatically assigned to a network interfaces when it
893
625
                is brought up.
894
626
              </para>
895
627
            </listitem>
899
631
      </varlistentry>
900
632
      <varlistentry>
901
633
        <term>
902
 
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
903
 
          Protocol Version 1.2</citetitle>
 
634
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
635
          Protocol Version 1.1</citetitle>
904
636
        </term>
905
637
      <listitem>
906
638
        <para>
907
 
          TLS 1.2 is the protocol implemented by GnuTLS.
 
639
          TLS 1.1 is the protocol implemented by GnuTLS.
908
640
        </para>
909
641
      </listitem>
910
642
      </varlistentry>
921
653
      </varlistentry>
922
654
      <varlistentry>
923
655
        <term>
924
 
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
 
656
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
925
657
          Security</citetitle>
926
658
        </term>
927
659
      <listitem>