/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-01-06 20:39:35 UTC
  • Revision ID: teddy@fukt.bsnet.se-20090106203935-d2qbnqan0px7p7yp
* debian/control (Build-Depends): Removed "po-debconf".

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 "2011-10-03">
 
5
<!ENTITY TIMESTAMP "2009-01-04">
6
6
<!ENTITY % common SYSTEM "../common.ent">
7
7
%common;
8
8
]>
19
19
        <firstname>Björn</firstname>
20
20
        <surname>Påhlsson</surname>
21
21
        <address>
22
 
          <email>belorn@recompile.se</email>
 
22
          <email>belorn@fukt.bsnet.se</email>
23
23
        </address>
24
24
      </author>
25
25
      <author>
26
26
        <firstname>Teddy</firstname>
27
27
        <surname>Hogeborn</surname>
28
28
        <address>
29
 
          <email>teddy@recompile.se</email>
 
29
          <email>teddy@fukt.bsnet.se</email>
30
30
        </address>
31
31
      </author>
32
32
    </authorgroup>
33
33
    <copyright>
34
34
      <year>2008</year>
35
35
      <year>2009</year>
36
 
      <year>2011</year>
37
36
      <holder>Teddy Hogeborn</holder>
38
37
      <holder>Björn Påhlsson</holder>
39
38
    </copyright>
94
93
      </arg>
95
94
      <sbr/>
96
95
      <arg>
97
 
        <option>--delay <replaceable>SECONDS</replaceable></option>
98
 
      </arg>
99
 
      <sbr/>
100
 
      <arg>
101
 
        <option>--retry <replaceable>SECONDS</replaceable></option>
102
 
      </arg>
103
 
      <sbr/>
104
 
      <arg>
105
96
        <option>--debug</option>
106
97
      </arg>
107
98
    </cmdsynopsis>
131
122
      <command>&COMMANDNAME;</command> is a client program that
132
123
      communicates with <citerefentry><refentrytitle
133
124
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>
134
 
      to get a password.  In slightly more detail, this client program
135
 
      brings up a network interface, uses the interface’s IPv6
136
 
      link-local address to get network connectivity, uses Zeroconf to
137
 
      find servers on the local network, and communicates with servers
138
 
      using TLS with an OpenPGP key to ensure authenticity and
139
 
      confidentiality.  This client program keeps running, trying all
140
 
      servers on the network, until it receives a satisfactory reply
141
 
      or a TERM signal.  After all servers have been tried, all
142
 
      servers are periodically retried.  If no servers are found it
143
 
      will wait indefinitely for new 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.
144
130
    </para>
145
131
    <para>
146
132
      This program is not meant to be run directly; it is really meant
200
186
      </varlistentry>
201
187
      
202
188
      <varlistentry>
203
 
        <term><option>--interface=<replaceable
204
 
        >NAME</replaceable></option></term>
 
189
        <term><option>--interface=
 
190
        <replaceable>NAME</replaceable></option></term>
205
191
        <term><option>-i
206
192
        <replaceable>NAME</replaceable></option></term>
207
193
        <listitem>
208
194
          <para>
209
195
            Network interface that will be brought up and scanned for
210
 
            Mandos servers to connect to.  The default is the empty
211
 
            string, which will automatically choose an appropriate
212
 
            interface.
 
196
            Mandos servers to connect to.  The default it
 
197
            <quote><literal>eth0</literal></quote>.
213
198
          </para>
214
199
          <para>
215
200
            If the <option>--connect</option> option is used, this
216
201
            specifies the interface to use to connect to the address
217
202
            given.
218
203
          </para>
219
 
          <para>
220
 
            Note that since this program will normally run in the
221
 
            initial RAM disk environment, the interface must be an
222
 
            interface which exists at that stage.  Thus, the interface
223
 
            can not be a pseudo-interface such as <quote>br0</quote>
224
 
            or <quote>tun0</quote>; such interfaces will not exist
225
 
            until much later in the boot process, and can not be used
226
 
            by this program.
227
 
          </para>
228
 
          <para>
229
 
            <replaceable>NAME</replaceable> can be the string
230
 
            <quote><literal>none</literal></quote>; this will not use
231
 
            any specific interface, and will not bring up an interface
232
 
            on startup.  This is not recommended, and only meant for
233
 
            advanced users.
234
 
          </para>
235
204
        </listitem>
236
205
      </varlistentry>
237
206
      
282
251
          </para>
283
252
        </listitem>
284
253
      </varlistentry>
285
 
 
286
 
      <varlistentry>
287
 
        <term><option>--delay=<replaceable
288
 
        >SECONDS</replaceable></option></term>
289
 
        <listitem>
290
 
          <para>
291
 
            After bringing the network interface up, the program waits
292
 
            for the interface to arrive in a <quote>running</quote>
293
 
            state before proceeding.  During this time, the kernel log
294
 
            level will be lowered to reduce clutter on the system
295
 
            console, alleviating any other plugins which might be
296
 
            using the system console.  This option sets the upper
297
 
            limit of seconds to wait.  The default is 2.5 seconds.
298
 
          </para>
299
 
        </listitem>
300
 
      </varlistentry>
301
 
 
302
 
      <varlistentry>
303
 
        <term><option>--retry=<replaceable
304
 
        >SECONDS</replaceable></option></term>
305
 
        <listitem>
306
 
          <para>
307
 
            All Mandos servers are tried repeatedly until a password
308
 
            is received.  This value specifies, in seconds, how long
309
 
            between each successive try <emphasis>for the same
310
 
            server</emphasis>.  The default is 10 seconds.
311
 
          </para>
312
 
        </listitem>
313
 
      </varlistentry>
314
254
      
315
255
      <varlistentry>
316
256
        <term><option>--debug</option></term>
389
329
      server could be found and the password received from it could be
390
330
      successfully decrypted and output on standard output.  The
391
331
      program will exit with a non-zero exit status only if a critical
392
 
      error occurs.  Otherwise, it will forever connect to any
393
 
      discovered <application>Mandos</application> servers, trying to
394
 
      get a decryptable password and print it.
 
332
      error occurs.  Otherwise, it will forever connect to new
 
333
      <application>Mandos</application> servers as they appear, trying
 
334
      to get a decryptable password and print it.
395
335
    </para>
396
336
  </refsect1>
397
337
  
472
412
    <informalexample>
473
413
      <para>
474
414
        Run in debug mode, with a custom key, and do not use Zeroconf
475
 
        to locate a server; connect directly to the IPv6 link-local
476
 
        address <quote><systemitem class="ipaddress"
477
 
        >fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
478
 
        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:
479
419
      </para>
480
420
      <para>
481
421
 
482
422
<!-- do not wrap this line -->
483
 
<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>
484
424
 
485
425
      </para>
486
426
    </informalexample>
536
476
  <refsect1 id="see_also">
537
477
    <title>SEE ALSO</title>
538
478
    <para>
539
 
      <citerefentry><refentrytitle>intro</refentrytitle>
540
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
541
479
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
542
480
      <manvolnum>8</manvolnum></citerefentry>,
543
481
      <citerefentry><refentrytitle>crypttab</refentrytitle>