/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

* plugins.d/mandos-client.c (main): Do not even try to work around
                                    Debian bug 633582 if --seckey or
                                    --pubkey specifies a different
                                    directory.  Bug fix: Remove all
                                    files in GPG temporary directory.

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 "2018-02-08">
 
5
<!ENTITY TIMESTAMP "2010-09-26">
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
 
      <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>
45
36
      <holder>Teddy Hogeborn</holder>
46
37
      <holder>Björn Påhlsson</holder>
47
38
    </copyright>
72
63
        ><replaceable>PORT</replaceable></option></arg>
73
64
      </group>
74
65
      <sbr/>
75
 
      <group rep='repeat'>
 
66
      <group>
76
67
        <arg choice="plain"><option>--interface
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>
 
68
        <replaceable>NAME</replaceable></option></arg>
 
69
        <arg choice="plain"><option>-i
 
70
        <replaceable>NAME</replaceable></option></arg>
82
71
      </group>
83
72
      <sbr/>
84
73
      <group>
104
93
      </arg>
105
94
      <sbr/>
106
95
      <arg>
107
 
        <option>--dh-params <replaceable>FILE</replaceable></option>
108
 
      </arg>
109
 
      <sbr/>
110
 
      <arg>
111
96
        <option>--delay <replaceable>SECONDS</replaceable></option>
112
97
      </arg>
113
98
      <sbr/>
116
101
      </arg>
117
102
      <sbr/>
118
103
      <arg>
119
 
        <option>--network-hook-dir
120
 
        <replaceable>DIR</replaceable></option>
121
 
      </arg>
122
 
      <sbr/>
123
 
      <arg>
124
104
        <option>--debug</option>
125
105
      </arg>
126
106
    </cmdsynopsis>
151
131
      communicates with <citerefentry><refentrytitle
152
132
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>
153
133
      to get a password.  In slightly more detail, this client program
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
 
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
158
138
      confidentiality.  This client program keeps running, trying all
159
139
      servers on the network, until it receives a satisfactory reply
160
140
      or a TERM signal.  After all servers have been tried, all
162
142
      will wait indefinitely for new servers to appear.
163
143
    </para>
164
144
    <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>
183
145
      This program is not meant to be run directly; it is really meant
184
146
      to run as a plugin of the <application>Mandos</application>
185
147
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
230
192
            assumed to separate the address from the port number.
231
193
          </para>
232
194
          <para>
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.
 
195
            This option is normally only useful for testing and
 
196
            debugging.
236
197
          </para>
237
198
        </listitem>
238
199
      </varlistentry>
239
200
      
240
201
      <varlistentry>
241
202
        <term><option>--interface=<replaceable
242
 
        >NAME</replaceable><arg rep='repeat'>,<replaceable
243
 
        >NAME</replaceable></arg></option></term>
 
203
        >NAME</replaceable></option></term>
244
204
        <term><option>-i
245
 
        <replaceable>NAME</replaceable><arg rep='repeat'>,<replaceable
246
 
        >NAME</replaceable></arg></option></term>
 
205
        <replaceable>NAME</replaceable></option></term>
247
206
        <listitem>
248
207
          <para>
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.
 
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.
253
212
          </para>
254
213
          <para>
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.
 
214
            If the <option>--connect</option> option is used, this
 
215
            specifies the interface to use to connect to the address
 
216
            given.
259
217
          </para>
260
218
          <para>
261
219
            Note that since this program will normally run in the
262
220
            initial RAM disk environment, the interface must be an
263
221
            interface which exists at that stage.  Thus, the interface
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"/>.
 
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.
270
226
          </para>
271
227
          <para>
272
228
            <replaceable>NAME</replaceable> can be the string
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.
 
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.
277
233
          </para>
278
234
        </listitem>
279
235
      </varlistentry>
321
277
        <listitem>
322
278
          <para>
323
279
            Sets the number of bits to use for the prime number in the
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.
 
280
            TLS Diffie-Hellman key exchange.  Default is 1024.
345
281
          </para>
346
282
        </listitem>
347
283
      </varlistentry>
351
287
        >SECONDS</replaceable></option></term>
352
288
        <listitem>
353
289
          <para>
354
 
            After bringing a network interface up, the program waits
 
290
            After bringing the network interface up, the program waits
355
291
            for the interface to arrive in a <quote>running</quote>
356
292
            state before proceeding.  During this time, the kernel log
357
293
            level will be lowered to reduce clutter on the system
374
310
          </para>
375
311
        </listitem>
376
312
      </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>
389
313
      
390
314
      <varlistentry>
391
315
        <term><option>--debug</option></term>
452
376
      <refentrytitle>plugin-runner</refentrytitle>
453
377
      <manvolnum>8mandos</manvolnum></citerefentry>) is used to run
454
378
      both this program and others in in parallel,
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.
 
379
      <emphasis>one</emphasis> of which will prompt for passwords on
 
380
      the system console.
459
381
    </para>
460
382
  </refsect1>
461
383
  
474
396
  
475
397
  <refsect1 id="environment">
476
398
    <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>
490
399
    <para>
491
 
      This program does not use any other environment variables, not
492
 
      even the ones provided by <citerefentry><refentrytitle
 
400
      This program does not use any environment variables, not even
 
401
      the ones provided by <citerefentry><refentrytitle
493
402
      >cryptsetup</refentrytitle><manvolnum>8</manvolnum>
494
403
    </citerefentry>.
495
404
    </para>
496
405
  </refsect1>
497
406
  
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
 
  
667
407
  <refsect1 id="files">
668
408
    <title>FILES</title>
669
409
    <variablelist>
681
421
          </para>
682
422
        </listitem>
683
423
      </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>
695
424
    </variablelist>
696
425
  </refsect1>
697
426
  
698
 
  <refsect1 id="bugs">
699
 
    <title>BUGS</title>
700
 
    <xi:include href="../bugs.xml"/>
701
 
  </refsect1>
 
427
<!--   <refsect1 id="bugs"> -->
 
428
<!--     <title>BUGS</title> -->
 
429
<!--     <para> -->
 
430
<!--     </para> -->
 
431
<!--   </refsect1> -->
702
432
  
703
433
  <refsect1 id="example">
704
434
    <title>EXAMPLE</title>
710
440
    </para>
711
441
    <informalexample>
712
442
      <para>
713
 
        Normal invocation needs no options, if the network interfaces
714
 
        can be automatically determined:
 
443
        Normal invocation needs no options, if the network interface
 
444
        is <quote>eth0</quote>:
715
445
      </para>
716
446
      <para>
717
447
        <userinput>&COMMANDNAME;</userinput>
719
449
    </informalexample>
720
450
    <informalexample>
721
451
      <para>
722
 
        Search for Mandos servers (and connect to them) using one
723
 
        specific interface:
 
452
        Search for Mandos servers (and connect to them) using another
 
453
        interface:
724
454
      </para>
725
455
      <para>
726
456
        <!-- do not wrap this line -->
790
520
    <para>
791
521
      It will also help if the checker program on the server is
792
522
      configured to request something from the client which can not be
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.
 
523
      spoofed by someone else on the network, unlike unencrypted
 
524
      <acronym>ICMP</acronym> echo (<quote>ping</quote>) replies.
796
525
    </para>
797
526
    <para>
798
527
      <emphasis>Note</emphasis>: This makes it completely insecure to
806
535
  <refsect1 id="see_also">
807
536
    <title>SEE ALSO</title>
808
537
    <para>
809
 
      <citerefentry><refentrytitle>intro</refentrytitle>
810
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
811
538
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
812
539
      <manvolnum>8</manvolnum></citerefentry>,
813
540
      <citerefentry><refentrytitle>crypttab</refentrytitle>
844
571
      </varlistentry>
845
572
      <varlistentry>
846
573
        <term>
847
 
          <ulink url="https://www.gnutls.org/">GnuTLS</ulink>
 
574
          <ulink url="http://www.gnu.org/software/gnutls/"
 
575
          >GnuTLS</ulink>
848
576
        </term>
849
577
      <listitem>
850
578
        <para>
856
584
      </varlistentry>
857
585
      <varlistentry>
858
586
        <term>
859
 
          <ulink url="https://www.gnupg.org/related_software/gpgme/"
 
587
          <ulink url="http://www.gnupg.org/related_software/gpgme/"
860
588
                 >GPGME</ulink>
861
589
        </term>
862
590
        <listitem>
890
618
              <para>
891
619
                This client uses IPv6 link-local addresses, which are
892
620
                immediately usable since a link-local addresses is
893
 
                automatically assigned to a network interface when it
 
621
                automatically assigned to a network interfaces when it
894
622
                is brought up.
895
623
              </para>
896
624
            </listitem>
900
628
      </varlistentry>
901
629
      <varlistentry>
902
630
        <term>
903
 
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
904
 
          Protocol Version 1.2</citetitle>
 
631
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
632
          Protocol Version 1.1</citetitle>
905
633
        </term>
906
634
      <listitem>
907
635
        <para>
908
 
          TLS 1.2 is the protocol implemented by GnuTLS.
 
636
          TLS 1.1 is the protocol implemented by GnuTLS.
909
637
        </para>
910
638
      </listitem>
911
639
      </varlistentry>
922
650
      </varlistentry>
923
651
      <varlistentry>
924
652
        <term>
925
 
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
 
653
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
926
654
          Security</citetitle>
927
655
        </term>
928
656
      <listitem>