/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: 2013-10-13 19:12:58 UTC
  • mfrom: (237.4.35 release)
  • Revision ID: teddy@recompile.se-20131013191258-2a4lmsq5eqbw0sy1
Merge from release branch.

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 "2013-06-21">
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
37
      <holder>Teddy Hogeborn</holder>
38
38
      <holder>Björn Påhlsson</holder>
39
39
    </copyright>
64
64
        ><replaceable>PORT</replaceable></option></arg>
65
65
      </group>
66
66
      <sbr/>
67
 
      <group>
 
67
      <group rep='repeat'>
68
68
        <arg choice="plain"><option>--interface
69
 
        <replaceable>NAME</replaceable></option></arg>
70
 
        <arg choice="plain"><option>-i
71
 
        <replaceable>NAME</replaceable></option></arg>
 
69
        <replaceable>NAME</replaceable><arg rep='repeat'
 
70
        >,<replaceable>NAME</replaceable></arg></option></arg>
 
71
        <arg choice="plain"><option>-i <replaceable>NAME</replaceable
 
72
        ><arg rep='repeat'>,<replaceable>NAME</replaceable></arg
 
73
        ></option></arg>
72
74
      </group>
73
75
      <sbr/>
74
76
      <group>
137
139
      communicates with <citerefentry><refentrytitle
138
140
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>
139
141
      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
 
142
      brings up network interfaces, uses the interfaces’ IPv6
 
143
      link-local addresses to get network connectivity, uses Zeroconf
 
144
      to find servers on the local network, and communicates with
 
145
      servers using TLS with an OpenPGP key to ensure authenticity and
144
146
      confidentiality.  This client program keeps running, trying all
145
147
      servers on the network, until it receives a satisfactory reply
146
148
      or a TERM signal.  After all servers have been tried, all
148
150
      will wait indefinitely for new servers to appear.
149
151
    </para>
150
152
    <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
 
153
      The network interfaces are selected like this: If any interfaces
 
154
      are specified using the <option>--interface</option> option,
 
155
      those interface are used.  Otherwise,
 
156
      <command>&COMMANDNAME;</command> will use all interfaces that
 
157
      are not loopback interfaces, are not point-to-point interfaces,
 
158
      are capable of broadcasting and do not have the NOARP flag (see
157
159
      <citerefentry><refentrytitle>netdevice</refentrytitle>
158
160
      <manvolnum>7</manvolnum></citerefentry>).  (If the
159
161
      <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).
 
162
      interfaces and non-broadcast interfaces are accepted.)  If any
 
163
      used interfaces are not up and running, they are first taken up
 
164
      (and later taken down again on program exit).
165
165
    </para>
166
166
    <para>
167
 
      Before a network interface is selected, all <quote>network
 
167
      Before network interfaces are selected, all <quote>network
168
168
      hooks</quote> are run; see <xref linkend="network-hooks"/>.
169
169
    </para>
170
170
    <para>
226
226
      
227
227
      <varlistentry>
228
228
        <term><option>--interface=<replaceable
229
 
        >NAME</replaceable></option></term>
 
229
        >NAME</replaceable><arg rep='repeat'>,<replaceable
 
230
        >NAME</replaceable></arg></option></term>
230
231
        <term><option>-i
231
 
        <replaceable>NAME</replaceable></option></term>
 
232
        <replaceable>NAME</replaceable><arg rep='repeat'>,<replaceable
 
233
        >NAME</replaceable></arg></option></term>
232
234
        <listitem>
233
235
          <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.
 
236
            Comma separated list of network interfaces that will be
 
237
            brought up and scanned for Mandos servers to connect to.
 
238
            The default is the empty string, which will automatically
 
239
            use all appropriate interfaces.
238
240
          </para>
239
241
          <para>
240
 
            If the <option>--connect</option> option is used, this
241
 
            specifies the interface to use to connect to the address
242
 
            given.
 
242
            If the <option>--connect</option> option is used, and
 
243
            exactly one interface name is specified (except
 
244
            <quote><literal>none</literal></quote>), this specifies
 
245
            the interface to use to connect to the address given.
243
246
          </para>
244
247
          <para>
245
248
            Note that since this program will normally run in the
246
249
            initial RAM disk environment, the interface must be an
247
250
            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"/>.
 
251
            can normally not be a pseudo-interface such as
 
252
            <quote>br0</quote> or <quote>tun0</quote>; such interfaces
 
253
            will not exist until much later in the boot process, and
 
254
            can not be used by this program, unless created by a
 
255
            <quote>network hook</quote> — see <xref
 
256
            linkend="network-hooks"/>.
253
257
          </para>
254
258
          <para>
255
259
            <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.
 
260
            <quote><literal>none</literal></quote>; this will make
 
261
            <command>&COMMANDNAME;</command> not bring up
 
262
            <emphasis>any</emphasis> interfaces specified
 
263
            <emphasis>after</emphasis> this string.  This is not
 
264
            recommended, and only meant for advanced users.
260
265
          </para>
261
266
        </listitem>
262
267
      </varlistentry>
314
319
        >SECONDS</replaceable></option></term>
315
320
        <listitem>
316
321
          <para>
317
 
            After bringing the network interface up, the program waits
 
322
            After bringing a network interface up, the program waits
318
323
            for the interface to arrive in a <quote>running</quote>
319
324
            state before proceeding.  During this time, the kernel log
320
325
            level will be lowered to reduce clutter on the system
507
512
              It is not necessary to print any non-executable files
508
513
              already in the network hook directory, these will be
509
514
              copied implicitly if they otherwise satisfy the name
510
 
              requirement.
 
515
              requirements.
511
516
            </para>
512
517
          </listitem>
513
518
        </varlistentry>
547
552
          <term><envar>DEVICE</envar></term>
548
553
          <listitem>
549
554
            <para>
550
 
              The network interface, as specified to
 
555
              The network interfaces, as specified to
551
556
              <command>&COMMANDNAME;</command> by the
552
 
              <option>--interface</option> option.  If this is not the
553
 
              interface a hook will bring up, there is no reason for a
554
 
              hook to continue.
 
557
              <option>--interface</option> option, combined to one
 
558
              string and separated by commas.  If this is set, and
 
559
              does not contain the interface a hook will bring up,
 
560
              there is no reason for a hook to continue.
555
561
            </para>
556
562
          </listitem>
557
563
        </varlistentry>
583
589
          <listitem>
584
590
            <para>
585
591
              This will be the same as the <option>--delay</option>
586
 
              option passed to <command>&COMMANDNAME;</command>.
 
592
              option passed to <command>&COMMANDNAME;</command>.  Is
 
593
              only set if <envar>MODE</envar> is
 
594
              <quote><literal>start</literal></quote> or
 
595
              <quote><literal>stop</literal></quote>.
 
596
            </para>
 
597
          </listitem>
 
598
        </varlistentry>
 
599
        <varlistentry>
 
600
          <term><envar>CONNECT</envar></term>
 
601
          <listitem>
 
602
            <para>
 
603
              This will be the same as the <option>--connect</option>
 
604
              option passed to <command>&COMMANDNAME;</command>.  Is
 
605
              only set if <option>--connect</option> is passed and
 
606
              <envar>MODE</envar> is
 
607
              <quote><literal>start</literal></quote> or
 
608
              <quote><literal>stop</literal></quote>.
587
609
            </para>
588
610
          </listitem>
589
611
        </varlistentry>
644
666
    </para>
645
667
    <informalexample>
646
668
      <para>
647
 
        Normal invocation needs no options, if the network interface
648
 
        is <quote>eth0</quote>:
 
669
        Normal invocation needs no options, if the network interfaces
 
670
        can be automatically determined:
649
671
      </para>
650
672
      <para>
651
673
        <userinput>&COMMANDNAME;</userinput>
653
675
    </informalexample>
654
676
    <informalexample>
655
677
      <para>
656
 
        Search for Mandos servers (and connect to them) using another
657
 
        interface:
 
678
        Search for Mandos servers (and connect to them) using one
 
679
        specific interface:
658
680
      </para>
659
681
      <para>
660
682
        <!-- do not wrap this line -->
824
846
              <para>
825
847
                This client uses IPv6 link-local addresses, which are
826
848
                immediately usable since a link-local addresses is
827
 
                automatically assigned to a network interfaces when it
 
849
                automatically assigned to a network interface when it
828
850
                is brought up.
829
851
              </para>
830
852
            </listitem>