/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: 2011-07-13 02:24:39 UTC
  • mfrom: (24.1.174 mandos)
  • Revision ID: teddy@fukt.bsnet.se-20110713022439-wbv6kghshdsc2x24
Merge from Björn.

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 "2009-01-04">
 
5
<!ENTITY TIMESTAMP "2010-09-26">
6
6
<!ENTITY % common SYSTEM "../common.ent">
7
7
%common;
8
8
]>
97
97
      </arg>
98
98
      <sbr/>
99
99
      <arg>
 
100
        <option>--retry <replaceable>SECONDS</replaceable></option>
 
101
      </arg>
 
102
      <sbr/>
 
103
      <arg>
100
104
        <option>--debug</option>
101
105
      </arg>
102
106
    </cmdsynopsis>
126
130
      <command>&COMMANDNAME;</command> is a client program that
127
131
      communicates with <citerefentry><refentrytitle
128
132
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>
129
 
      to get a password.  It uses IPv6 link-local addresses to get
130
 
      network connectivity, Zeroconf to find servers, and TLS with an
131
 
      OpenPGP key to ensure authenticity and confidentiality.  It
132
 
      keeps running, trying all servers on the network, until it
133
 
      receives a satisfactory reply or a TERM signal is received.
 
133
      to get a password.  In slightly more detail, this client program
 
134
      brings up a network interface, uses the interface’s IPv6
 
135
      link-local address to get network connectivity, uses Zeroconf to
 
136
      find servers on the local network, and communicates with servers
 
137
      using TLS with an OpenPGP key to ensure authenticity and
 
138
      confidentiality.  This client program keeps running, trying all
 
139
      servers on the network, until it receives a satisfactory reply
 
140
      or a TERM signal is received.  If no servers are found, or after
 
141
      all servers have been tried, it waits indefinitely for new
 
142
      servers to appear.
134
143
    </para>
135
144
    <para>
136
145
      This program is not meant to be run directly; it is really meant
190
199
      </varlistentry>
191
200
      
192
201
      <varlistentry>
193
 
        <term><option>--interface=
194
 
        <replaceable>NAME</replaceable></option></term>
 
202
        <term><option>--interface=<replaceable
 
203
        >NAME</replaceable></option></term>
195
204
        <term><option>-i
196
205
        <replaceable>NAME</replaceable></option></term>
197
206
        <listitem>
198
207
          <para>
199
208
            Network interface that will be brought up and scanned for
200
 
            Mandos servers to connect to.  The default it
201
 
            <quote><literal>eth0</literal></quote>.
 
209
            Mandos servers to connect to.  The default is the empty
 
210
            string, which will automatically choose an appropriate
 
211
            interface.
202
212
          </para>
203
213
          <para>
204
214
            If the <option>--connect</option> option is used, this
205
215
            specifies the interface to use to connect to the address
206
216
            given.
207
217
          </para>
 
218
          <para>
 
219
            Note that since this program will normally run in the
 
220
            initial RAM disk environment, the interface must be an
 
221
            interface which exists at that stage.  Thus, the interface
 
222
            can not be a pseudo-interface such as <quote>br0</quote>
 
223
            or <quote>tun0</quote>; such interfaces will not exist
 
224
            until much later in the boot process, and can not be used
 
225
            by this program.
 
226
          </para>
 
227
          <para>
 
228
            <replaceable>NAME</replaceable> can be the string
 
229
            <quote><literal>none</literal></quote>; this will not use
 
230
            any specific interface, and will not bring up an interface
 
231
            on startup.  This is not recommended, and only meant for
 
232
            advanced users.
 
233
          </para>
208
234
        </listitem>
209
235
      </varlistentry>
210
236
      
271
297
          </para>
272
298
        </listitem>
273
299
      </varlistentry>
 
300
 
 
301
      <varlistentry>
 
302
        <term><option>--retry=<replaceable
 
303
        >SECONDS</replaceable></option></term>
 
304
        <listitem>
 
305
          <para>
 
306
            All Mandos servers servers are tried repeatedly until a
 
307
            password is received.  This value specifies, in seconds,
 
308
            how long between each successive try <emphasis>for the
 
309
            same server</emphasis>.  The default is 10 seconds.
 
310
          </para>
 
311
        </listitem>
 
312
      </varlistentry>
274
313
      
275
314
      <varlistentry>
276
315
        <term><option>--debug</option></term>
432
471
    <informalexample>
433
472
      <para>
434
473
        Run in debug mode, with a custom key, and do not use Zeroconf
435
 
        to locate a server; connect directly to the IPv6 address
436
 
        <quote><systemitem class="ipaddress"
437
 
        >2001:db8:f983:bd0b:30de:ae4a:71f2:f672</systemitem></quote>,
438
 
        port 4711, using interface eth2:
 
474
        to locate a server; connect directly to the IPv6 link-local
 
475
        address <quote><systemitem class="ipaddress"
 
476
        >fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
 
477
        using interface eth2:
439
478
      </para>
440
479
      <para>
441
480
 
442
481
<!-- do not wrap this line -->
443
 
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect 2001:db8:f983:bd0b:30de:ae4a:71f2:f672:4711 --interface eth2</userinput>
 
482
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect fe80::aede:48ff:fe71:f6f2:4711 --interface eth2</userinput>
444
483
 
445
484
      </para>
446
485
    </informalexample>