/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: 2014-03-28 22:32:21 UTC
  • Revision ID: teddy@recompile.se-20140328223221-w579qlvlex5if3dn
Fix location and format of signing key file.

* debian/upstream/signing-key.asc: Added.
* debian/upstream-signing-key.pgp: Removed.

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 "2011-11-27">
 
5
<!ENTITY TIMESTAMP "2014-03-05">
6
6
<!ENTITY % common SYSTEM "../common.ent">
7
7
%common;
8
8
]>
33
33
    <copyright>
34
34
      <year>2008</year>
35
35
      <year>2009</year>
36
 
      <year>2011</year>
 
36
      <year>2012</year>
 
37
      <year>2013</year>
 
38
      <year>2014</year>
37
39
      <holder>Teddy Hogeborn</holder>
38
40
      <holder>Björn Påhlsson</holder>
39
41
    </copyright>
64
66
        ><replaceable>PORT</replaceable></option></arg>
65
67
      </group>
66
68
      <sbr/>
67
 
      <group>
 
69
      <group rep='repeat'>
68
70
        <arg choice="plain"><option>--interface
69
 
        <replaceable>NAME</replaceable></option></arg>
70
 
        <arg choice="plain"><option>-i
71
 
        <replaceable>NAME</replaceable></option></arg>
 
71
        <replaceable>NAME</replaceable><arg rep='repeat'
 
72
        >,<replaceable>NAME</replaceable></arg></option></arg>
 
73
        <arg choice="plain"><option>-i <replaceable>NAME</replaceable
 
74
        ><arg rep='repeat'>,<replaceable>NAME</replaceable></arg
 
75
        ></option></arg>
72
76
      </group>
73
77
      <sbr/>
74
78
      <group>
137
141
      communicates with <citerefentry><refentrytitle
138
142
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>
139
143
      to get a password.  In slightly more detail, this client program
140
 
      brings up a network interface, uses the interface’s IPv6
141
 
      link-local address to get network connectivity, uses Zeroconf to
142
 
      find servers on the local network, and communicates with servers
143
 
      using TLS with an OpenPGP key to ensure authenticity and
 
144
      brings up network interfaces, uses the interfaces’ IPv6
 
145
      link-local addresses to get network connectivity, uses Zeroconf
 
146
      to find servers on the local network, and communicates with
 
147
      servers using TLS with an OpenPGP key to ensure authenticity and
144
148
      confidentiality.  This client program keeps running, trying all
145
149
      servers on the network, until it receives a satisfactory reply
146
150
      or a TERM signal.  After all servers have been tried, all
148
152
      will wait indefinitely for new servers to appear.
149
153
    </para>
150
154
    <para>
151
 
      The network interface is selected like this: If an interface is
152
 
      specified using the <option>--interface</option> option, that
153
 
      interface is used.  Otherwise, <command>&COMMANDNAME;</command>
154
 
      will choose any interface that is up and running and is not a
155
 
      loopback interface, is not a point-to-point interface, is
156
 
      capable of broadcasting and does not have the NOARP flag (see
 
155
      The network interfaces are selected like this: If any interfaces
 
156
      are specified using the <option>--interface</option> option,
 
157
      those interface are used.  Otherwise,
 
158
      <command>&COMMANDNAME;</command> will use all interfaces that
 
159
      are not loopback interfaces, are not point-to-point interfaces,
 
160
      are capable of broadcasting and do not have the NOARP flag (see
157
161
      <citerefentry><refentrytitle>netdevice</refentrytitle>
158
162
      <manvolnum>7</manvolnum></citerefentry>).  (If the
159
163
      <option>--connect</option> option is used, point-to-point
160
 
      interfaces and non-broadcast interfaces are accepted.)  If no
161
 
      acceptable interfaces are found, re-run the check but without
162
 
      the <quote>up and running</quote> requirement, and manually take
163
 
      the selected interface up (and later take it down on program
164
 
      exit).
 
164
      interfaces and non-broadcast interfaces are accepted.)  If any
 
165
      used interfaces are not up and running, they are first taken up
 
166
      (and later taken down again on program exit).
165
167
    </para>
166
168
    <para>
167
 
      Before a network interface is selected, all <quote>network
 
169
      Before network interfaces are selected, all <quote>network
168
170
      hooks</quote> are run; see <xref linkend="network-hooks"/>.
169
171
    </para>
170
172
    <para>
218
220
            assumed to separate the address from the port number.
219
221
          </para>
220
222
          <para>
221
 
            This option is normally only useful for testing and
222
 
            debugging.
 
223
            Normally, Zeroconf would be used to locate Mandos servers,
 
224
            in which case this option would only be used when testing
 
225
            and debugging.
223
226
          </para>
224
227
        </listitem>
225
228
      </varlistentry>
226
229
      
227
230
      <varlistentry>
228
231
        <term><option>--interface=<replaceable
229
 
        >NAME</replaceable></option></term>
 
232
        >NAME</replaceable><arg rep='repeat'>,<replaceable
 
233
        >NAME</replaceable></arg></option></term>
230
234
        <term><option>-i
231
 
        <replaceable>NAME</replaceable></option></term>
 
235
        <replaceable>NAME</replaceable><arg rep='repeat'>,<replaceable
 
236
        >NAME</replaceable></arg></option></term>
232
237
        <listitem>
233
238
          <para>
234
 
            Network interface that will be brought up and scanned for
235
 
            Mandos servers to connect to.  The default is the empty
236
 
            string, which will automatically choose an appropriate
237
 
            interface.
 
239
            Comma separated list of network interfaces that will be
 
240
            brought up and scanned for Mandos servers to connect to.
 
241
            The default is the empty string, which will automatically
 
242
            use all appropriate interfaces.
238
243
          </para>
239
244
          <para>
240
 
            If the <option>--connect</option> option is used, this
241
 
            specifies the interface to use to connect to the address
242
 
            given.
 
245
            If the <option>--connect</option> option is used, and
 
246
            exactly one interface name is specified (except
 
247
            <quote><literal>none</literal></quote>), this specifies
 
248
            the interface to use to connect to the address given.
243
249
          </para>
244
250
          <para>
245
251
            Note that since this program will normally run in the
246
252
            initial RAM disk environment, the interface must be an
247
253
            interface which exists at that stage.  Thus, the interface
248
 
            can not be a pseudo-interface such as <quote>br0</quote>
249
 
            or <quote>tun0</quote>; such interfaces will not exist
250
 
            until much later in the boot process, and can not be used
251
 
            by this program, unless created by a <quote>network
252
 
            hook</quote> — see <xref linkend="network-hooks"/>.
 
254
            can normally not be a pseudo-interface such as
 
255
            <quote>br0</quote> or <quote>tun0</quote>; such interfaces
 
256
            will not exist until much later in the boot process, and
 
257
            can not be used by this program, unless created by a
 
258
            <quote>network hook</quote> — see <xref
 
259
            linkend="network-hooks"/>.
253
260
          </para>
254
261
          <para>
255
262
            <replaceable>NAME</replaceable> can be the string
256
 
            <quote><literal>none</literal></quote>; this will not use
257
 
            any specific interface, and will not bring up an interface
258
 
            on startup.  This is not recommended, and only meant for
259
 
            advanced users.
 
263
            <quote><literal>none</literal></quote>; this will make
 
264
            <command>&COMMANDNAME;</command> only bring up interfaces
 
265
            specified <emphasis>before</emphasis> this string.  This
 
266
            is not recommended, and only meant for advanced users.
260
267
          </para>
261
268
        </listitem>
262
269
      </varlistentry>
314
321
        >SECONDS</replaceable></option></term>
315
322
        <listitem>
316
323
          <para>
317
 
            After bringing the network interface up, the program waits
 
324
            After bringing a network interface up, the program waits
318
325
            for the interface to arrive in a <quote>running</quote>
319
326
            state before proceeding.  During this time, the kernel log
320
327
            level will be lowered to reduce clutter on the system
468
475
      <para>
469
476
        A network hook must be an executable file, and its name must
470
477
        consist entirely of upper and lower case letters, digits,
471
 
        underscores, and hyphens.
 
478
        underscores, periods, and hyphens.
472
479
      </para>
473
480
      <para>
474
481
        A network hook will receive one argument, which can be one of
497
504
          <term><literal>files</literal></term>
498
505
          <listitem>
499
506
            <para>
500
 
              This should make the network hook print, <emphasis>on
501
 
              separate lines</emphasis>, all the files needed for it
502
 
              to run.  (These files will be copied into the initial
503
 
              RAM filesystem.)  Intended use is for a network hook
504
 
              which is a shell script to print its needed binaries.
 
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.
505
512
            </para>
506
513
            <para>
507
514
              It is not necessary to print any non-executable files
508
515
              already in the network hook directory, these will be
509
516
              copied implicitly if they otherwise satisfy the name
510
 
              requirement.
 
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.
511
531
            </para>
512
532
          </listitem>
513
533
        </varlistentry>
525
545
              <command>&COMMANDNAME;</command> by the
526
546
              <option>--network-hook-dir</option> option.  Note: this
527
547
              should <emphasis>always</emphasis> be used by the
528
 
              network hook to refer to itself or any files it may
529
 
              require.
 
548
              network hook to refer to itself or any files in the hook
 
549
              directory it may require.
530
550
            </para>
531
551
          </listitem>
532
552
        </varlistentry>
534
554
          <term><envar>DEVICE</envar></term>
535
555
          <listitem>
536
556
            <para>
537
 
              The network interface, as specified to
 
557
              The network interfaces, as specified to
538
558
              <command>&COMMANDNAME;</command> by the
539
 
              <option>--interface</option> option.  If this is not the
540
 
              interface a hook will bring up, there is no reason for a
541
 
              hook to continue.
 
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.
542
563
            </para>
543
564
          </listitem>
544
565
        </varlistentry>
548
569
            <para>
549
570
              This will be the same as the first argument;
550
571
              i.e. <quote><literal>start</literal></quote>,
551
 
              <quote><literal>stop</literal></quote>, or
552
 
              <quote><literal>files</literal></quote>.
 
572
              <quote><literal>stop</literal></quote>,
 
573
              <quote><literal>files</literal></quote>, or
 
574
              <quote><literal>modules</literal></quote>.
553
575
            </para>
554
576
          </listitem>
555
577
        </varlistentry>
569
591
          <listitem>
570
592
            <para>
571
593
              This will be the same as the <option>--delay</option>
572
 
              option passed to <command>&COMMANDNAME;</command>.
 
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>.
573
611
            </para>
574
612
          </listitem>
575
613
        </varlistentry>
630
668
    </para>
631
669
    <informalexample>
632
670
      <para>
633
 
        Normal invocation needs no options, if the network interface
634
 
        is <quote>eth0</quote>:
 
671
        Normal invocation needs no options, if the network interfaces
 
672
        can be automatically determined:
635
673
      </para>
636
674
      <para>
637
675
        <userinput>&COMMANDNAME;</userinput>
639
677
    </informalexample>
640
678
    <informalexample>
641
679
      <para>
642
 
        Search for Mandos servers (and connect to them) using another
643
 
        interface:
 
680
        Search for Mandos servers (and connect to them) using one
 
681
        specific interface:
644
682
      </para>
645
683
      <para>
646
684
        <!-- do not wrap this line -->
810
848
              <para>
811
849
                This client uses IPv6 link-local addresses, which are
812
850
                immediately usable since a link-local addresses is
813
 
                automatically assigned to a network interfaces when it
 
851
                automatically assigned to a network interface when it
814
852
                is brought up.
815
853
              </para>
816
854
            </listitem>