/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: 2009-02-09 02:13:58 UTC
  • Revision ID: teddy@fukt.bsnet.se-20090209021358-6nrlc91oi08hn5hb
* initramfs-tools-hook: Whitespace change 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-04">
 
5
<!ENTITY TIMESTAMP "2009-02-09">
6
6
<!ENTITY % common SYSTEM "../common.ent">
7
7
%common;
8
8
]>
126
126
      <command>&COMMANDNAME;</command> is a client program that
127
127
      communicates with <citerefentry><refentrytitle
128
128
      >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.
 
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.
134
139
    </para>
135
140
    <para>
136
141
      This program is not meant to be run directly; it is really meant
190
195
      </varlistentry>
191
196
      
192
197
      <varlistentry>
193
 
        <term><option>--interface=
194
 
        <replaceable>NAME</replaceable></option></term>
 
198
        <term><option>--interface=<replaceable
 
199
        >NAME</replaceable></option></term>
195
200
        <term><option>-i
196
201
        <replaceable>NAME</replaceable></option></term>
197
202
        <listitem>
198
203
          <para>
199
204
            Network interface that will be brought up and scanned for
200
 
            Mandos servers to connect to.  The default it
 
205
            Mandos servers to connect to.  The default is
201
206
            <quote><literal>eth0</literal></quote>.
202
207
          </para>
203
208
          <para>
205
210
            specifies the interface to use to connect to the address
206
211
            given.
207
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>
208
228
        </listitem>
209
229
      </varlistentry>
210
230
      
432
452
    <informalexample>
433
453
      <para>
434
454
        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:
 
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:
439
459
      </para>
440
460
      <para>
441
461
 
442
462
<!-- 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>
 
463
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect fe80::aede:48ff:fe71:f6f2:4711 --interface eth2</userinput>
444
464
 
445
465
      </para>
446
466
    </informalexample>