/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: Use all interfaces.

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 "2012-05-27">
 
5
<!ENTITY TIMESTAMP "2012-06-13">
6
6
<!ENTITY % common SYSTEM "../common.ent">
7
7
%common;
8
8
]>
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>
231
231
        <replaceable>NAME</replaceable></option></term>
232
232
        <listitem>
233
233
          <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.
 
234
            Comma separated list of network interfaces that will be
 
235
            brought up and scanned for Mandos servers to connect to.
 
236
            The default is the empty string, which will automatically
 
237
            use all appropriate interfaces.
238
238
          </para>
239
239
          <para>
240
240
            If the <option>--connect</option> option is used, this
245
245
            Note that since this program will normally run in the
246
246
            initial RAM disk environment, the interface must be an
247
247
            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"/>.
 
248
            can normally not be a pseudo-interface such as
 
249
            <quote>br0</quote> or <quote>tun0</quote>; such interfaces
 
250
            will not exist until much later in the boot process, and
 
251
            can not be used by this program, unless created by a
 
252
            <quote>network hook</quote> — see <xref
 
253
            linkend="network-hooks"/>.
253
254
          </para>
254
255
          <para>
255
256
            <replaceable>NAME</replaceable> can be the string
314
315
        >SECONDS</replaceable></option></term>
315
316
        <listitem>
316
317
          <para>
317
 
            After bringing the network interface up, the program waits
 
318
            After bringing a network interface up, the program waits
318
319
            for the interface to arrive in a <quote>running</quote>
319
320
            state before proceeding.  During this time, the kernel log
320
321
            level will be lowered to reduce clutter on the system
547
548
          <term><envar>DEVICE</envar></term>
548
549
          <listitem>
549
550
            <para>
550
 
              The network interface, as specified to
 
551
              The network interfaces, as specified to
551
552
              <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.
 
553
              <option>--interface</option> option, combined to one
 
554
              string and separated by commas.  If this is set, and
 
555
              does not contain the interface a hook will bring up,
 
556
              there is no reason for a hook to continue.
555
557
            </para>
556
558
          </listitem>
557
559
        </varlistentry>