/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

* plugin-runner.c: Whitespace changes only.

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 "2009-01-24">
 
5
<!ENTITY TIMESTAMP "2009-02-09">
6
6
<!ENTITY % common SYSTEM "../common.ent">
7
7
%common;
8
8
]>
93
93
      </arg>
94
94
      <sbr/>
95
95
      <arg>
 
96
        <option>--delay <replaceable>SECONDS</replaceable></option>
 
97
      </arg>
 
98
      <sbr/>
 
99
      <arg>
96
100
        <option>--debug</option>
97
101
      </arg>
98
102
    </cmdsynopsis>
122
126
      <command>&COMMANDNAME;</command> is a client program that
123
127
      communicates with <citerefentry><refentrytitle
124
128
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>
125
 
      to get a password.  It brings up a network interface, uses its
126
 
      IPv6 link-local address to get network connectivity, uses
127
 
      Zeroconf to find servers, and uses TLS with an OpenPGP key to
128
 
      ensure authenticity and confidentiality.  It keeps running,
129
 
      trying all servers on the network, until it receives a
130
 
      satisfactory reply or a TERM signal is received.
 
129
      to get a password.  In slightly more detail, this client program
 
130
      brings up a network interface, uses the interface’s IPv6
 
131
      link-local address to get network connectivity, uses Zeroconf to
 
132
      find servers on the local network, and communicates with servers
 
133
      using TLS with an OpenPGP key to ensure authenticity and
 
134
      confidentiality.  This client program keeps running, trying all
 
135
      servers on the network, until it receives a satisfactory reply
 
136
      or a TERM signal is received.  If no servers are found, or after
 
137
      all servers have been tried, it waits indefinitely for new
 
138
      servers to appear.
131
139
    </para>
132
140
    <para>
133
141
      This program is not meant to be run directly; it is really meant
187
195
      </varlistentry>
188
196
      
189
197
      <varlistentry>
190
 
        <term><option>--interface=
191
 
        <replaceable>NAME</replaceable></option></term>
 
198
        <term><option>--interface=<replaceable
 
199
        >NAME</replaceable></option></term>
192
200
        <term><option>-i
193
201
        <replaceable>NAME</replaceable></option></term>
194
202
        <listitem>
195
203
          <para>
196
204
            Network interface that will be brought up and scanned for
197
 
            Mandos servers to connect to.  The default it
 
205
            Mandos servers to connect to.  The default is
198
206
            <quote><literal>eth0</literal></quote>.
199
207
          </para>
200
208
          <para>
202
210
            specifies the interface to use to connect to the address
203
211
            given.
204
212
          </para>
 
213
          <para>
 
214
            Note that since this program will normally run in the
 
215
            initial RAM disk environment, the interface must be an
 
216
            interface which exists at that stage.  Thus, the interface
 
217
            can not be a pseudo-interface such as <quote>br0</quote>
 
218
            or <quote>tun0</quote>; such interfaces will not exist
 
219
            until much later in the boot process, and can not be used
 
220
            by this program.
 
221
          </para>
 
222
          <para>
 
223
            <replaceable>NAME</replaceable> can be the empty string;
 
224
            this will not use any specific interface, and will not
 
225
            bring up an interface on startup.  This is not
 
226
            recommended, and only meant for advanced users.
 
227
          </para>
205
228
        </listitem>
206
229
      </varlistentry>
207
230
      
252
275
          </para>
253
276
        </listitem>
254
277
      </varlistentry>
 
278
 
 
279
      <varlistentry>
 
280
        <term><option>--delay=<replaceable
 
281
        >SECONDS</replaceable></option></term>
 
282
        <listitem>
 
283
          <para>
 
284
            After bringing the network interface up, the program waits
 
285
            for the interface to arrive in a <quote>running</quote>
 
286
            state before proceeding.  During this time, the kernel log
 
287
            level will be lowered to reduce clutter on the system
 
288
            console, alleviating any other plugins which might be
 
289
            using the system console.  This option sets the upper
 
290
            limit of seconds to wait.  The default is 2.5 seconds.
 
291
          </para>
 
292
        </listitem>
 
293
      </varlistentry>
255
294
      
256
295
      <varlistentry>
257
296
        <term><option>--debug</option></term>
413
452
    <informalexample>
414
453
      <para>
415
454
        Run in debug mode, with a custom key, and do not use Zeroconf
416
 
        to locate a server; connect directly to the IPv6 address
417
 
        <quote><systemitem class="ipaddress"
418
 
        >2001:db8:f983:bd0b:30de:ae4a:71f2:f672</systemitem></quote>,
419
 
        port 4711, using interface eth2:
 
455
        to locate a server; connect directly to the IPv6 link-local
 
456
        address <quote><systemitem class="ipaddress"
 
457
        >fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
 
458
        using interface eth2:
420
459
      </para>
421
460
      <para>
422
461
 
423
462
<!-- do not wrap this line -->
424
 
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect 2001:db8:f983:bd0b:30de:ae4a:71f2:f672:4711 --interface eth2</userinput>
 
463
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect fe80::aede:48ff:fe71:f6f2:4711 --interface eth2</userinput>
425
464
 
426
465
      </para>
427
466
    </informalexample>