/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

Merge from trunk; fixes for debian/changelog suggested by sponsor.

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-02-09">
 
5
<!ENTITY TIMESTAMP "2009-01-04">
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>
100
96
        <option>--debug</option>
101
97
      </arg>
102
98
    </cmdsynopsis>
126
122
      <command>&COMMANDNAME;</command> is a client program that
127
123
      communicates with <citerefentry><refentrytitle
128
124
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>
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.
 
125
      to get a password.  It uses IPv6 link-local addresses to get
 
126
      network connectivity, Zeroconf to find servers, and TLS with an
 
127
      OpenPGP key to ensure authenticity and confidentiality.  It
 
128
      keeps running, trying all servers on the network, until it
 
129
      receives a satisfactory reply or a TERM signal is received.
139
130
    </para>
140
131
    <para>
141
132
      This program is not meant to be run directly; it is really meant
195
186
      </varlistentry>
196
187
      
197
188
      <varlistentry>
198
 
        <term><option>--interface=<replaceable
199
 
        >NAME</replaceable></option></term>
 
189
        <term><option>--interface=
 
190
        <replaceable>NAME</replaceable></option></term>
200
191
        <term><option>-i
201
192
        <replaceable>NAME</replaceable></option></term>
202
193
        <listitem>
203
194
          <para>
204
195
            Network interface that will be brought up and scanned for
205
 
            Mandos servers to connect to.  The default is
 
196
            Mandos servers to connect to.  The default it
206
197
            <quote><literal>eth0</literal></quote>.
207
198
          </para>
208
199
          <para>
210
201
            specifies the interface to use to connect to the address
211
202
            given.
212
203
          </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>
228
204
        </listitem>
229
205
      </varlistentry>
230
206
      
275
251
          </para>
276
252
        </listitem>
277
253
      </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>
294
254
      
295
255
      <varlistentry>
296
256
        <term><option>--debug</option></term>
452
412
    <informalexample>
453
413
      <para>
454
414
        Run in debug mode, with a custom key, and do not use Zeroconf
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:
 
415
        to locate a server; connect directly to the IPv6 address
 
416
        <quote><systemitem class="ipaddress"
 
417
        >2001:db8:f983:bd0b:30de:ae4a:71f2:f672</systemitem></quote>,
 
418
        port 4711, using interface eth2:
459
419
      </para>
460
420
      <para>
461
421
 
462
422
<!-- do not wrap this line -->
463
 
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect fe80::aede:48ff:fe71:f6f2:4711 --interface eth2</userinput>
 
423
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect 2001:db8:f983:bd0b:30de:ae4a:71f2:f672:4711 --interface eth2</userinput>
464
424
 
465
425
      </para>
466
426
    </informalexample>