/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: Björn Påhlsson
  • Date: 2011-10-02 19:18:24 UTC
  • mto: This revision was merged to the branch mainline in revision 505.
  • Revision ID: belorn@fukt.bsnet.se-20111002191824-eweh4pvneeg3qzia
transitional stuff actually working
documented change to D-Bus API

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