/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: 2009-02-25 12:20:01 UTC
  • Revision ID: teddy@fukt.bsnet.se-20090225122001-ty7zobjk6snyo0o3
* plugins.d/mandos-client.c (start_mandos_communication): "sin6_family"
                                                          in the
                                                          "sockaddr_in6"
                                                          struct is a
                                                          "sa_family_t",
                                                          not
                                                          "uint16_t".

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 "2014-01-20">
 
5
<!ENTITY TIMESTAMP "2009-02-09">
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>2012</year>
37
 
      <year>2013</year>
38
36
      <holder>Teddy Hogeborn</holder>
39
37
      <holder>Björn Påhlsson</holder>
40
38
    </copyright>
65
63
        ><replaceable>PORT</replaceable></option></arg>
66
64
      </group>
67
65
      <sbr/>
68
 
      <group rep='repeat'>
 
66
      <group>
69
67
        <arg choice="plain"><option>--interface
70
 
        <replaceable>NAME</replaceable><arg rep='repeat'
71
 
        >,<replaceable>NAME</replaceable></arg></option></arg>
72
 
        <arg choice="plain"><option>-i <replaceable>NAME</replaceable
73
 
        ><arg rep='repeat'>,<replaceable>NAME</replaceable></arg
74
 
        ></option></arg>
 
68
        <replaceable>NAME</replaceable></option></arg>
 
69
        <arg choice="plain"><option>-i
 
70
        <replaceable>NAME</replaceable></option></arg>
75
71
      </group>
76
72
      <sbr/>
77
73
      <group>
101
97
      </arg>
102
98
      <sbr/>
103
99
      <arg>
104
 
        <option>--retry <replaceable>SECONDS</replaceable></option>
105
 
      </arg>
106
 
      <sbr/>
107
 
      <arg>
108
 
        <option>--network-hook-dir
109
 
        <replaceable>DIR</replaceable></option>
110
 
      </arg>
111
 
      <sbr/>
112
 
      <arg>
113
100
        <option>--debug</option>
114
101
      </arg>
115
102
    </cmdsynopsis>
140
127
      communicates with <citerefentry><refentrytitle
141
128
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>
142
129
      to get a password.  In slightly more detail, this client program
143
 
      brings up network interfaces, uses the interfaces’ IPv6
144
 
      link-local addresses to get network connectivity, uses Zeroconf
145
 
      to find servers on the local network, and communicates with
146
 
      servers using TLS with an OpenPGP key to ensure authenticity and
 
130
      brings up a network interface, uses the interface’s IPv6
 
131
      link-local address to get network connectivity, uses Zeroconf to
 
132
      find servers on the local network, and communicates with servers
 
133
      using TLS with an OpenPGP key to ensure authenticity and
147
134
      confidentiality.  This client program keeps running, trying all
148
135
      servers on the network, until it receives a satisfactory reply
149
 
      or a TERM signal.  After all servers have been tried, all
150
 
      servers are periodically retried.  If no servers are found it
151
 
      will wait indefinitely for new servers to appear.
152
 
    </para>
153
 
    <para>
154
 
      The network interfaces are selected like this: If any interfaces
155
 
      are specified using the <option>--interface</option> option,
156
 
      those interface are used.  Otherwise,
157
 
      <command>&COMMANDNAME;</command> will use all interfaces that
158
 
      are not loopback interfaces, are not point-to-point interfaces,
159
 
      are capable of broadcasting and do not have the NOARP flag (see
160
 
      <citerefentry><refentrytitle>netdevice</refentrytitle>
161
 
      <manvolnum>7</manvolnum></citerefentry>).  (If the
162
 
      <option>--connect</option> option is used, point-to-point
163
 
      interfaces and non-broadcast interfaces are accepted.)  If any
164
 
      used interfaces are not up and running, they are first taken up
165
 
      (and later taken down again on program exit).
166
 
    </para>
167
 
    <para>
168
 
      Before network interfaces are selected, all <quote>network
169
 
      hooks</quote> are run; see <xref linkend="network-hooks"/>.
 
136
      or a TERM signal is received.  If no servers are found, or after
 
137
      all servers have been tried, it waits indefinitely for new
 
138
      servers to appear.
170
139
    </para>
171
140
    <para>
172
141
      This program is not meant to be run directly; it is really meant
219
188
            assumed to separate the address from the port number.
220
189
          </para>
221
190
          <para>
222
 
            Normally, Zeroconf would be used to locate Mandos servers,
223
 
            in which case this option would only be used when testing
224
 
            and debugging.
 
191
            This option is normally only useful for testing and
 
192
            debugging.
225
193
          </para>
226
194
        </listitem>
227
195
      </varlistentry>
228
196
      
229
197
      <varlistentry>
230
198
        <term><option>--interface=<replaceable
231
 
        >NAME</replaceable><arg rep='repeat'>,<replaceable
232
 
        >NAME</replaceable></arg></option></term>
 
199
        >NAME</replaceable></option></term>
233
200
        <term><option>-i
234
 
        <replaceable>NAME</replaceable><arg rep='repeat'>,<replaceable
235
 
        >NAME</replaceable></arg></option></term>
 
201
        <replaceable>NAME</replaceable></option></term>
236
202
        <listitem>
237
203
          <para>
238
 
            Comma separated list of network interfaces that will be
239
 
            brought up and scanned for Mandos servers to connect to.
240
 
            The default is the empty string, which will automatically
241
 
            use all appropriate interfaces.
 
204
            Network interface that will be brought up and scanned for
 
205
            Mandos servers to connect to.  The default is
 
206
            <quote><literal>eth0</literal></quote>.
242
207
          </para>
243
208
          <para>
244
 
            If the <option>--connect</option> option is used, and
245
 
            exactly one interface name is specified (except
246
 
            <quote><literal>none</literal></quote>), this specifies
247
 
            the interface to use to connect to the address given.
 
209
            If the <option>--connect</option> option is used, this
 
210
            specifies the interface to use to connect to the address
 
211
            given.
248
212
          </para>
249
213
          <para>
250
214
            Note that since this program will normally run in the
251
215
            initial RAM disk environment, the interface must be an
252
216
            interface which exists at that stage.  Thus, the interface
253
 
            can normally not be a pseudo-interface such as
254
 
            <quote>br0</quote> or <quote>tun0</quote>; such interfaces
255
 
            will not exist until much later in the boot process, and
256
 
            can not be used by this program, unless created by a
257
 
            <quote>network hook</quote> — see <xref
258
 
            linkend="network-hooks"/>.
 
217
            can not be a pseudo-interface such as <quote>br0</quote>
 
218
            or <quote>tun0</quote>; such interfaces will not exist
 
219
            until much later in the boot process, and can not be used
 
220
            by this program.
259
221
          </para>
260
222
          <para>
261
 
            <replaceable>NAME</replaceable> can be the string
262
 
            <quote><literal>none</literal></quote>; this will make
263
 
            <command>&COMMANDNAME;</command> not bring up
264
 
            <emphasis>any</emphasis> interfaces specified
265
 
            <emphasis>after</emphasis> this string.  This is not
 
223
            <replaceable>NAME</replaceable> can be the empty string;
 
224
            this will not use any specific interface, and will not
 
225
            bring up an interface on startup.  This is not
266
226
            recommended, and only meant for advanced users.
267
227
          </para>
268
228
        </listitem>
321
281
        >SECONDS</replaceable></option></term>
322
282
        <listitem>
323
283
          <para>
324
 
            After bringing a network interface up, the program waits
 
284
            After bringing the network interface up, the program waits
325
285
            for the interface to arrive in a <quote>running</quote>
326
286
            state before proceeding.  During this time, the kernel log
327
287
            level will be lowered to reduce clutter on the system
331
291
          </para>
332
292
        </listitem>
333
293
      </varlistentry>
334
 
 
335
 
      <varlistentry>
336
 
        <term><option>--retry=<replaceable
337
 
        >SECONDS</replaceable></option></term>
338
 
        <listitem>
339
 
          <para>
340
 
            All Mandos servers are tried repeatedly until a password
341
 
            is received.  This value specifies, in seconds, how long
342
 
            between each successive try <emphasis>for the same
343
 
            server</emphasis>.  The default is 10 seconds.
344
 
          </para>
345
 
        </listitem>
346
 
      </varlistentry>
347
 
 
348
 
      <varlistentry>
349
 
        <term><option>--network-hook-dir=<replaceable
350
 
        >DIR</replaceable></option></term>
351
 
        <listitem>
352
 
          <para>
353
 
            Network hook directory.  The default directory is
354
 
            <quote><filename class="directory"
355
 
            >/lib/mandos/network-hooks.d</filename></quote>.
356
 
          </para>
357
 
        </listitem>
358
 
      </varlistentry>
359
294
      
360
295
      <varlistentry>
361
296
        <term><option>--debug</option></term>
422
357
      <refentrytitle>plugin-runner</refentrytitle>
423
358
      <manvolnum>8mandos</manvolnum></citerefentry>) is used to run
424
359
      both this program and others in in parallel,
425
 
      <emphasis>one</emphasis> of which (<citerefentry>
426
 
      <refentrytitle>password-prompt</refentrytitle>
427
 
      <manvolnum>8mandos</manvolnum></citerefentry>) will prompt for
428
 
      passwords on the system console.
 
360
      <emphasis>one</emphasis> of which will prompt for passwords on
 
361
      the system console.
429
362
    </para>
430
363
  </refsect1>
431
364
  
436
369
      server could be found and the password received from it could be
437
370
      successfully decrypted and output on standard output.  The
438
371
      program will exit with a non-zero exit status only if a critical
439
 
      error occurs.  Otherwise, it will forever connect to any
440
 
      discovered <application>Mandos</application> servers, trying to
441
 
      get a decryptable password and print it.
 
372
      error occurs.  Otherwise, it will forever connect to new
 
373
      <application>Mandos</application> servers as they appear, trying
 
374
      to get a decryptable password and print it.
442
375
    </para>
443
376
  </refsect1>
444
377
  
452
385
    </para>
453
386
  </refsect1>
454
387
  
455
 
  <refsect1 id="network-hooks">
456
 
    <title>NETWORK HOOKS</title>
457
 
    <para>
458
 
      If a network interface like a bridge or tunnel is required to
459
 
      find a Mandos server, this requires the interface to be up and
460
 
      running before <command>&COMMANDNAME;</command> starts looking
461
 
      for Mandos servers.  This can be accomplished by creating a
462
 
      <quote>network hook</quote> program, and placing it in a special
463
 
      directory.
464
 
    </para>
465
 
    <para>
466
 
      Before the network is used (and again before program exit), any
467
 
      runnable programs found in the network hook directory are run
468
 
      with the argument <quote><literal>start</literal></quote> or
469
 
      <quote><literal>stop</literal></quote>.  This should bring up or
470
 
      down, respectively, any network interface which
471
 
      <command>&COMMANDNAME;</command> should use.
472
 
    </para>
473
 
    <refsect2 id="hook-requirements">
474
 
      <title>REQUIREMENTS</title>
475
 
      <para>
476
 
        A network hook must be an executable file, and its name must
477
 
        consist entirely of upper and lower case letters, digits,
478
 
        underscores, periods, and hyphens.
479
 
      </para>
480
 
      <para>
481
 
        A network hook will receive one argument, which can be one of
482
 
        the following:
483
 
      </para>
484
 
      <variablelist>
485
 
        <varlistentry>
486
 
          <term><literal>start</literal></term>
487
 
          <listitem>
488
 
            <para>
489
 
              This should make the network hook create (if necessary)
490
 
              and bring up a network interface.
491
 
            </para>
492
 
          </listitem>
493
 
        </varlistentry>
494
 
        <varlistentry>
495
 
          <term><literal>stop</literal></term>
496
 
          <listitem>
497
 
            <para>
498
 
              This should make the network hook take down a network
499
 
              interface, and delete it if it did not exist previously.
500
 
            </para>
501
 
          </listitem>
502
 
        </varlistentry>
503
 
        <varlistentry>
504
 
          <term><literal>files</literal></term>
505
 
          <listitem>
506
 
            <para>
507
 
              This should make the network hook print, <emphasis>one
508
 
              file per line</emphasis>, all the files needed for it to
509
 
              run.  (These files will be copied into the initial RAM
510
 
              filesystem.)  Typical use is for a network hook which is
511
 
              a shell script to print its needed binaries.
512
 
            </para>
513
 
            <para>
514
 
              It is not necessary to print any non-executable files
515
 
              already in the network hook directory, these will be
516
 
              copied implicitly if they otherwise satisfy the name
517
 
              requirements.
518
 
            </para>
519
 
          </listitem>
520
 
        </varlistentry>
521
 
        <varlistentry>
522
 
          <term><literal>modules</literal></term>
523
 
          <listitem>
524
 
            <para>
525
 
              This should make the network hook print, <emphasis>on
526
 
              separate lines</emphasis>, all the kernel modules needed
527
 
              for it to run.  (These modules will be copied into the
528
 
              initial RAM filesystem.)  For instance, a tunnel
529
 
              interface needs the
530
 
              <quote><literal>tun</literal></quote> module.
531
 
            </para>
532
 
          </listitem>
533
 
        </varlistentry>
534
 
      </variablelist>
535
 
      <para>
536
 
        The network hook will be provided with a number of environment
537
 
        variables:
538
 
      </para>
539
 
      <variablelist>
540
 
        <varlistentry>
541
 
          <term><envar>MANDOSNETHOOKDIR</envar></term>
542
 
          <listitem>
543
 
            <para>
544
 
              The network hook directory, specified to
545
 
              <command>&COMMANDNAME;</command> by the
546
 
              <option>--network-hook-dir</option> option.  Note: this
547
 
              should <emphasis>always</emphasis> be used by the
548
 
              network hook to refer to itself or any files in the hook
549
 
              directory it may require.
550
 
            </para>
551
 
          </listitem>
552
 
        </varlistentry>
553
 
        <varlistentry>
554
 
          <term><envar>DEVICE</envar></term>
555
 
          <listitem>
556
 
            <para>
557
 
              The network interfaces, as specified to
558
 
              <command>&COMMANDNAME;</command> by the
559
 
              <option>--interface</option> option, combined to one
560
 
              string and separated by commas.  If this is set, and
561
 
              does not contain the interface a hook will bring up,
562
 
              there is no reason for a hook to continue.
563
 
            </para>
564
 
          </listitem>
565
 
        </varlistentry>
566
 
        <varlistentry>
567
 
          <term><envar>MODE</envar></term>
568
 
          <listitem>
569
 
            <para>
570
 
              This will be the same as the first argument;
571
 
              i.e. <quote><literal>start</literal></quote>,
572
 
              <quote><literal>stop</literal></quote>,
573
 
              <quote><literal>files</literal></quote>, or
574
 
              <quote><literal>modules</literal></quote>.
575
 
            </para>
576
 
          </listitem>
577
 
        </varlistentry>
578
 
        <varlistentry>
579
 
          <term><envar>VERBOSITY</envar></term>
580
 
          <listitem>
581
 
            <para>
582
 
              This will be the <quote><literal>1</literal></quote> if
583
 
              the <option>--debug</option> option is passed to
584
 
              <command>&COMMANDNAME;</command>, otherwise
585
 
              <quote><literal>0</literal></quote>.
586
 
            </para>
587
 
          </listitem>
588
 
        </varlistentry>
589
 
        <varlistentry>
590
 
          <term><envar>DELAY</envar></term>
591
 
          <listitem>
592
 
            <para>
593
 
              This will be the same as the <option>--delay</option>
594
 
              option passed to <command>&COMMANDNAME;</command>.  Is
595
 
              only set if <envar>MODE</envar> is
596
 
              <quote><literal>start</literal></quote> or
597
 
              <quote><literal>stop</literal></quote>.
598
 
            </para>
599
 
          </listitem>
600
 
        </varlistentry>
601
 
        <varlistentry>
602
 
          <term><envar>CONNECT</envar></term>
603
 
          <listitem>
604
 
            <para>
605
 
              This will be the same as the <option>--connect</option>
606
 
              option passed to <command>&COMMANDNAME;</command>.  Is
607
 
              only set if <option>--connect</option> is passed and
608
 
              <envar>MODE</envar> is
609
 
              <quote><literal>start</literal></quote> or
610
 
              <quote><literal>stop</literal></quote>.
611
 
            </para>
612
 
          </listitem>
613
 
        </varlistentry>
614
 
      </variablelist>
615
 
      <para>
616
 
        A hook may not read from standard input, and should be
617
 
        restrictive in printing to standard output or standard error
618
 
        unless <varname>VERBOSITY</varname> is
619
 
        <quote><literal>1</literal></quote>.
620
 
      </para>
621
 
    </refsect2>
622
 
  </refsect1>
623
 
  
624
388
  <refsect1 id="files">
625
389
    <title>FILES</title>
626
390
    <variablelist>
638
402
          </para>
639
403
        </listitem>
640
404
      </varlistentry>
641
 
      <varlistentry>
642
 
        <term><filename
643
 
        class="directory">/lib/mandos/network-hooks.d</filename></term>
644
 
        <listitem>
645
 
          <para>
646
 
            Directory where network hooks are located.  Change this
647
 
            with the <option>--network-hook-dir</option> option.  See
648
 
            <xref linkend="network-hooks"/>.
649
 
          </para>
650
 
        </listitem>
651
 
      </varlistentry>
652
405
    </variablelist>
653
406
  </refsect1>
654
407
  
668
421
    </para>
669
422
    <informalexample>
670
423
      <para>
671
 
        Normal invocation needs no options, if the network interfaces
672
 
        can be automatically determined:
 
424
        Normal invocation needs no options, if the network interface
 
425
        is <quote>eth0</quote>:
673
426
      </para>
674
427
      <para>
675
428
        <userinput>&COMMANDNAME;</userinput>
677
430
    </informalexample>
678
431
    <informalexample>
679
432
      <para>
680
 
        Search for Mandos servers (and connect to them) using one
681
 
        specific interface:
 
433
        Search for Mandos servers (and connect to them) using another
 
434
        interface:
682
435
      </para>
683
436
      <para>
684
437
        <!-- do not wrap this line -->
763
516
  <refsect1 id="see_also">
764
517
    <title>SEE ALSO</title>
765
518
    <para>
766
 
      <citerefentry><refentrytitle>intro</refentrytitle>
767
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
768
519
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
769
520
      <manvolnum>8</manvolnum></citerefentry>,
770
521
      <citerefentry><refentrytitle>crypttab</refentrytitle>
848
599
              <para>
849
600
                This client uses IPv6 link-local addresses, which are
850
601
                immediately usable since a link-local addresses is
851
 
                automatically assigned to a network interface when it
 
602
                automatically assigned to a network interfaces when it
852
603
                is brought up.
853
604
              </para>
854
605
            </listitem>