/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

  • Committer: Björn Påhlsson
  • Date: 2009-01-19 05:56:10 UTC
  • mto: (237.7.1 mandos) (24.1.154 mandos)
  • mto: This revision was merged to the branch mainline in revision 250.
  • Revision ID: belorn@braxen-20090119055610-rk2wwibxou0zngqy
small stuff

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-02-09">
 
5
<!ENTITY TIMESTAMP "2009-01-04">
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.  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.
 
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.
139
134
    </para>
140
135
    <para>
141
136
      This program is not meant to be run directly; it is really meant
195
190
      </varlistentry>
196
191
      
197
192
      <varlistentry>
198
 
        <term><option>--interface=<replaceable
199
 
        >NAME</replaceable></option></term>
 
193
        <term><option>--interface=
 
194
        <replaceable>NAME</replaceable></option></term>
200
195
        <term><option>-i
201
196
        <replaceable>NAME</replaceable></option></term>
202
197
        <listitem>
203
198
          <para>
204
199
            Network interface that will be brought up and scanned for
205
 
            Mandos servers to connect to.  The default is
 
200
            Mandos servers to connect to.  The default it
206
201
            <quote><literal>eth0</literal></quote>.
207
202
          </para>
208
203
          <para>
210
205
            specifies the interface to use to connect to the address
211
206
            given.
212
207
          </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
208
        </listitem>
229
209
      </varlistentry>
230
210
      
452
432
    <informalexample>
453
433
      <para>
454
434
        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:
 
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:
459
439
      </para>
460
440
      <para>
461
441
 
462
442
<!-- 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>
 
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>
464
444
 
465
445
      </para>
466
446
    </informalexample>