/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

Add TODO entries about new D-Bus features we should use.

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 "2013-10-20">
 
5
<!ENTITY TIMESTAMP "2011-11-27">
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>2012</year>
37
 
      <year>2013</year>
 
36
      <year>2011</year>
38
37
      <holder>Teddy Hogeborn</holder>
39
38
      <holder>Björn Påhlsson</holder>
40
39
    </copyright>
65
64
        ><replaceable>PORT</replaceable></option></arg>
66
65
      </group>
67
66
      <sbr/>
68
 
      <group rep='repeat'>
 
67
      <group>
69
68
        <arg choice="plain"><option>--interface
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>
 
69
        <replaceable>NAME</replaceable></option></arg>
 
70
        <arg choice="plain"><option>-i
 
71
        <replaceable>NAME</replaceable></option></arg>
75
72
      </group>
76
73
      <sbr/>
77
74
      <group>
140
137
      communicates with <citerefentry><refentrytitle
141
138
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>
142
139
      to get a password.  In slightly more detail, this client program
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
 
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
147
144
      confidentiality.  This client program keeps running, trying all
148
145
      servers on the network, until it receives a satisfactory reply
149
146
      or a TERM signal.  After all servers have been tried, all
151
148
      will wait indefinitely for new servers to appear.
152
149
    </para>
153
150
    <para>
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
 
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
160
157
      <citerefentry><refentrytitle>netdevice</refentrytitle>
161
158
      <manvolnum>7</manvolnum></citerefentry>).  (If the
162
159
      <option>--connect</option> option is used, point-to-point
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).
 
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).
166
165
    </para>
167
166
    <para>
168
 
      Before network interfaces are selected, all <quote>network
 
167
      Before a network interface is selected, all <quote>network
169
168
      hooks</quote> are run; see <xref linkend="network-hooks"/>.
170
169
    </para>
171
170
    <para>
227
226
      
228
227
      <varlistentry>
229
228
        <term><option>--interface=<replaceable
230
 
        >NAME</replaceable><arg rep='repeat'>,<replaceable
231
 
        >NAME</replaceable></arg></option></term>
 
229
        >NAME</replaceable></option></term>
232
230
        <term><option>-i
233
 
        <replaceable>NAME</replaceable><arg rep='repeat'>,<replaceable
234
 
        >NAME</replaceable></arg></option></term>
 
231
        <replaceable>NAME</replaceable></option></term>
235
232
        <listitem>
236
233
          <para>
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.
 
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.
241
238
          </para>
242
239
          <para>
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.
 
240
            If the <option>--connect</option> option is used, this
 
241
            specifies the interface to use to connect to the address
 
242
            given.
247
243
          </para>
248
244
          <para>
249
245
            Note that since this program will normally run in the
250
246
            initial RAM disk environment, the interface must be an
251
247
            interface which exists at that stage.  Thus, the interface
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"/>.
 
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"/>.
258
253
          </para>
259
254
          <para>
260
255
            <replaceable>NAME</replaceable> can be the string
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.
 
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.
266
260
          </para>
267
261
        </listitem>
268
262
      </varlistentry>
320
314
        >SECONDS</replaceable></option></term>
321
315
        <listitem>
322
316
          <para>
323
 
            After bringing a network interface up, the program waits
 
317
            After bringing the network interface up, the program waits
324
318
            for the interface to arrive in a <quote>running</quote>
325
319
            state before proceeding.  During this time, the kernel log
326
320
            level will be lowered to reduce clutter on the system
513
507
              It is not necessary to print any non-executable files
514
508
              already in the network hook directory, these will be
515
509
              copied implicitly if they otherwise satisfy the name
516
 
              requirements.
 
510
              requirement.
517
511
            </para>
518
512
          </listitem>
519
513
        </varlistentry>
553
547
          <term><envar>DEVICE</envar></term>
554
548
          <listitem>
555
549
            <para>
556
 
              The network interfaces, as specified to
 
550
              The network interface, as specified to
557
551
              <command>&COMMANDNAME;</command> by the
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.
 
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.
562
555
            </para>
563
556
          </listitem>
564
557
        </varlistentry>
590
583
          <listitem>
591
584
            <para>
592
585
              This will be the same as the <option>--delay</option>
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>.
 
586
              option passed to <command>&COMMANDNAME;</command>.
610
587
            </para>
611
588
          </listitem>
612
589
        </varlistentry>
667
644
    </para>
668
645
    <informalexample>
669
646
      <para>
670
 
        Normal invocation needs no options, if the network interfaces
671
 
        can be automatically determined:
 
647
        Normal invocation needs no options, if the network interface
 
648
        is <quote>eth0</quote>:
672
649
      </para>
673
650
      <para>
674
651
        <userinput>&COMMANDNAME;</userinput>
676
653
    </informalexample>
677
654
    <informalexample>
678
655
      <para>
679
 
        Search for Mandos servers (and connect to them) using one
680
 
        specific interface:
 
656
        Search for Mandos servers (and connect to them) using another
 
657
        interface:
681
658
      </para>
682
659
      <para>
683
660
        <!-- do not wrap this line -->
847
824
              <para>
848
825
                This client uses IPv6 link-local addresses, which are
849
826
                immediately usable since a link-local addresses is
850
 
                automatically assigned to a network interface when it
 
827
                automatically assigned to a network interfaces when it
851
828
                is brought up.
852
829
              </para>
853
830
            </listitem>