/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

  • Committer: Teddy Hogeborn
  • Date: 2014-02-22 17:13:00 UTC
  • mto: (237.7.272 trunk)
  • mto: This revision was merged to the branch mainline in revision 311.
  • Revision ID: teddy@recompile.se-20140222171300-a1alb0w871t1f174
* mandos (ClientDBus.start_checker): Removed unused variable
                                     "old_checker".
* mandos-monitor: Remove import of unused module "signal"

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 "2014-01-20">
6
6
<!ENTITY % common SYSTEM "../common.ent">
7
7
%common;
8
8
]>
34
34
      <year>2008</year>
35
35
      <year>2009</year>
36
36
      <year>2012</year>
 
37
      <year>2013</year>
37
38
      <holder>Teddy Hogeborn</holder>
38
39
      <holder>Björn Påhlsson</holder>
39
40
    </copyright>
64
65
        ><replaceable>PORT</replaceable></option></arg>
65
66
      </group>
66
67
      <sbr/>
67
 
      <group>
 
68
      <group rep='repeat'>
68
69
        <arg choice="plain"><option>--interface
69
 
        <replaceable>NAME</replaceable></option></arg>
70
 
        <arg choice="plain"><option>-i
71
 
        <replaceable>NAME</replaceable></option></arg>
 
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>
72
75
      </group>
73
76
      <sbr/>
74
77
      <group>
137
140
      communicates with <citerefentry><refentrytitle
138
141
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>
139
142
      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
 
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
144
147
      confidentiality.  This client program keeps running, trying all
145
148
      servers on the network, until it receives a satisfactory reply
146
149
      or a TERM signal.  After all servers have been tried, all
148
151
      will wait indefinitely for new servers to appear.
149
152
    </para>
150
153
    <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
 
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
157
160
      <citerefentry><refentrytitle>netdevice</refentrytitle>
158
161
      <manvolnum>7</manvolnum></citerefentry>).  (If the
159
162
      <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).
 
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).
165
166
    </para>
166
167
    <para>
167
 
      Before a network interface is selected, all <quote>network
 
168
      Before network interfaces are selected, all <quote>network
168
169
      hooks</quote> are run; see <xref linkend="network-hooks"/>.
169
170
    </para>
170
171
    <para>
218
219
            assumed to separate the address from the port number.
219
220
          </para>
220
221
          <para>
221
 
            This option is normally only useful for testing and
222
 
            debugging.
 
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.
223
225
          </para>
224
226
        </listitem>
225
227
      </varlistentry>
226
228
      
227
229
      <varlistentry>
228
230
        <term><option>--interface=<replaceable
229
 
        >NAME</replaceable></option></term>
 
231
        >NAME</replaceable><arg rep='repeat'>,<replaceable
 
232
        >NAME</replaceable></arg></option></term>
230
233
        <term><option>-i
231
 
        <replaceable>NAME</replaceable></option></term>
 
234
        <replaceable>NAME</replaceable><arg rep='repeat'>,<replaceable
 
235
        >NAME</replaceable></arg></option></term>
232
236
        <listitem>
233
237
          <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.
 
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.
238
242
          </para>
239
243
          <para>
240
 
            If the <option>--connect</option> option is used, this
241
 
            specifies the interface to use to connect to the address
242
 
            given.
 
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.
243
248
          </para>
244
249
          <para>
245
250
            Note that since this program will normally run in the
246
251
            initial RAM disk environment, the interface must be an
247
252
            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"/>.
 
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"/>.
253
259
          </para>
254
260
          <para>
255
261
            <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.
 
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
 
266
            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
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.
511
518
            </para>
512
519
          </listitem>
513
520
        </varlistentry>
547
554
          <term><envar>DEVICE</envar></term>
548
555
          <listitem>
549
556
            <para>
550
 
              The network interface, as specified to
 
557
              The network interfaces, as specified to
551
558
              <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.
 
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.
555
563
            </para>
556
564
          </listitem>
557
565
        </varlistentry>
660
668
    </para>
661
669
    <informalexample>
662
670
      <para>
663
 
        Normal invocation needs no options, if the network interface
 
671
        Normal invocation needs no options, if the network interfaces
664
672
        can be automatically determined:
665
673
      </para>
666
674
      <para>
669
677
    </informalexample>
670
678
    <informalexample>
671
679
      <para>
672
 
        Search for Mandos servers (and connect to them) using another
673
 
        interface:
 
680
        Search for Mandos servers (and connect to them) using one
 
681
        specific interface:
674
682
      </para>
675
683
      <para>
676
684
        <!-- do not wrap this line -->
840
848
              <para>
841
849
                This client uses IPv6 link-local addresses, which are
842
850
                immediately usable since a link-local addresses is
843
 
                automatically assigned to a network interfaces when it
 
851
                automatically assigned to a network interface when it
844
852
                is brought up.
845
853
              </para>
846
854
            </listitem>