/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-28 10:04:05 UTC
  • Revision ID: teddy@recompile.se-20131028100405-u6miovq7y39m69x7
Doc fix: Refer to architecture libdir.

* debian/mandos-client.README.Debian: Refer to architecture libdir.

Show diffs side-by-side

added added

removed removed

Lines of Context:
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-10-20">
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>
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>
226
227
      
227
228
      <varlistentry>
228
229
        <term><option>--interface=<replaceable
229
 
        >NAME</replaceable></option></term>
 
230
        >NAME</replaceable><arg rep='repeat'>,<replaceable
 
231
        >NAME</replaceable></arg></option></term>
230
232
        <term><option>-i
231
 
        <replaceable>NAME</replaceable></option></term>
 
233
        <replaceable>NAME</replaceable><arg rep='repeat'>,<replaceable
 
234
        >NAME</replaceable></arg></option></term>
232
235
        <listitem>
233
236
          <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.
 
237
            Comma separated list of network interfaces that will be
 
238
            brought up and scanned for Mandos servers to connect to.
 
239
            The default is the empty string, which will automatically
 
240
            use all appropriate interfaces.
238
241
          </para>
239
242
          <para>
240
 
            If the <option>--connect</option> option is used, this
241
 
            specifies the interface to use to connect to the address
242
 
            given.
 
243
            If the <option>--connect</option> option is used, and
 
244
            exactly one interface name is specified (except
 
245
            <quote><literal>none</literal></quote>), this specifies
 
246
            the interface to use to connect to the address given.
243
247
          </para>
244
248
          <para>
245
249
            Note that since this program will normally run in the
246
250
            initial RAM disk environment, the interface must be an
247
251
            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"/>.
 
252
            can normally not be a pseudo-interface such as
 
253
            <quote>br0</quote> or <quote>tun0</quote>; such interfaces
 
254
            will not exist until much later in the boot process, and
 
255
            can not be used by this program, unless created by a
 
256
            <quote>network hook</quote> — see <xref
 
257
            linkend="network-hooks"/>.
253
258
          </para>
254
259
          <para>
255
260
            <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.
 
261
            <quote><literal>none</literal></quote>; this will make
 
262
            <command>&COMMANDNAME;</command> not bring up
 
263
            <emphasis>any</emphasis> interfaces specified
 
264
            <emphasis>after</emphasis> this string.  This is not
 
265
            recommended, and only meant for advanced users.
260
266
          </para>
261
267
        </listitem>
262
268
      </varlistentry>
314
320
        >SECONDS</replaceable></option></term>
315
321
        <listitem>
316
322
          <para>
317
 
            After bringing the network interface up, the program waits
 
323
            After bringing a network interface up, the program waits
318
324
            for the interface to arrive in a <quote>running</quote>
319
325
            state before proceeding.  During this time, the kernel log
320
326
            level will be lowered to reduce clutter on the system
507
513
              It is not necessary to print any non-executable files
508
514
              already in the network hook directory, these will be
509
515
              copied implicitly if they otherwise satisfy the name
510
 
              requirement.
 
516
              requirements.
511
517
            </para>
512
518
          </listitem>
513
519
        </varlistentry>
547
553
          <term><envar>DEVICE</envar></term>
548
554
          <listitem>
549
555
            <para>
550
 
              The network interface, as specified to
 
556
              The network interfaces, as specified to
551
557
              <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.
 
558
              <option>--interface</option> option, combined to one
 
559
              string and separated by commas.  If this is set, and
 
560
              does not contain the interface a hook will bring up,
 
561
              there is no reason for a hook to continue.
555
562
            </para>
556
563
          </listitem>
557
564
        </varlistentry>
583
590
          <listitem>
584
591
            <para>
585
592
              This will be the same as the <option>--delay</option>
586
 
              option passed to <command>&COMMANDNAME;</command>.
 
593
              option passed to <command>&COMMANDNAME;</command>.  Is
 
594
              only set if <envar>MODE</envar> is
 
595
              <quote><literal>start</literal></quote> or
 
596
              <quote><literal>stop</literal></quote>.
 
597
            </para>
 
598
          </listitem>
 
599
        </varlistentry>
 
600
        <varlistentry>
 
601
          <term><envar>CONNECT</envar></term>
 
602
          <listitem>
 
603
            <para>
 
604
              This will be the same as the <option>--connect</option>
 
605
              option passed to <command>&COMMANDNAME;</command>.  Is
 
606
              only set if <option>--connect</option> is passed and
 
607
              <envar>MODE</envar> is
 
608
              <quote><literal>start</literal></quote> or
 
609
              <quote><literal>stop</literal></quote>.
587
610
            </para>
588
611
          </listitem>
589
612
        </varlistentry>
644
667
    </para>
645
668
    <informalexample>
646
669
      <para>
647
 
        Normal invocation needs no options, if the network interface
648
 
        is <quote>eth0</quote>:
 
670
        Normal invocation needs no options, if the network interfaces
 
671
        can be automatically determined:
649
672
      </para>
650
673
      <para>
651
674
        <userinput>&COMMANDNAME;</userinput>
653
676
    </informalexample>
654
677
    <informalexample>
655
678
      <para>
656
 
        Search for Mandos servers (and connect to them) using another
657
 
        interface:
 
679
        Search for Mandos servers (and connect to them) using one
 
680
        specific interface:
658
681
      </para>
659
682
      <para>
660
683
        <!-- do not wrap this line -->
824
847
              <para>
825
848
                This client uses IPv6 link-local addresses, which are
826
849
                immediately usable since a link-local addresses is
827
 
                automatically assigned to a network interfaces when it
 
850
                automatically assigned to a network interface when it
828
851
                is brought up.
829
852
              </para>
830
853
            </listitem>