/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

Merge from trunk.

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-24">
 
5
<!ENTITY TIMESTAMP "2011-10-03">
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@fukt.bsnet.se</email>
 
22
          <email>belorn@recompile.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@fukt.bsnet.se</email>
 
29
          <email>teddy@recompile.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>
36
37
      <holder>Teddy Hogeborn</holder>
37
38
      <holder>Björn Påhlsson</holder>
38
39
    </copyright>
97
98
      </arg>
98
99
      <sbr/>
99
100
      <arg>
 
101
        <option>--retry <replaceable>SECONDS</replaceable></option>
 
102
      </arg>
 
103
      <sbr/>
 
104
      <arg>
100
105
        <option>--debug</option>
101
106
      </arg>
102
107
    </cmdsynopsis>
133
138
      using TLS with an OpenPGP key to ensure authenticity and
134
139
      confidentiality.  This client program keeps running, trying all
135
140
      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.
 
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.
139
144
    </para>
140
145
    <para>
141
146
      This program is not meant to be run directly; it is really meant
195
200
      </varlistentry>
196
201
      
197
202
      <varlistentry>
198
 
        <term><option>--interface=
199
 
        <replaceable>NAME</replaceable></option></term>
 
203
        <term><option>--interface=<replaceable
 
204
        >NAME</replaceable></option></term>
200
205
        <term><option>-i
201
206
        <replaceable>NAME</replaceable></option></term>
202
207
        <listitem>
203
208
          <para>
204
209
            Network interface that will be brought up and scanned for
205
 
            Mandos servers to connect to.  The default it
206
 
            <quote><literal>eth0</literal></quote>.
 
210
            Mandos servers to connect to.  The default is the empty
 
211
            string, which will automatically choose an appropriate
 
212
            interface.
207
213
          </para>
208
214
          <para>
209
215
            If the <option>--connect</option> option is used, this
219
225
            until much later in the boot process, and can not be used
220
226
            by this program.
221
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>
222
235
        </listitem>
223
236
      </varlistentry>
224
237
      
285
298
          </para>
286
299
        </listitem>
287
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>
288
314
      
289
315
      <varlistentry>
290
316
        <term><option>--debug</option></term>
363
389
      server could be found and the password received from it could be
364
390
      successfully decrypted and output on standard output.  The
365
391
      program will exit with a non-zero exit status only if a critical
366
 
      error occurs.  Otherwise, it will forever connect to new
367
 
      <application>Mandos</application> servers as they appear, trying
368
 
      to get a decryptable password and print it.
 
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.
369
395
    </para>
370
396
  </refsect1>
371
397
  
446
472
    <informalexample>
447
473
      <para>
448
474
        Run in debug mode, with a custom key, and do not use Zeroconf
449
 
        to locate a server; connect directly to the IPv6 address
450
 
        <quote><systemitem class="ipaddress"
451
 
        >2001:db8:f983:bd0b:30de:ae4a:71f2:f672</systemitem></quote>,
452
 
        port 4711, using interface eth2:
 
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:
453
479
      </para>
454
480
      <para>
455
481
 
456
482
<!-- do not wrap this line -->
457
 
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect 2001:db8:f983:bd0b:30de:ae4a:71f2:f672:4711 --interface eth2</userinput>
 
483
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect fe80::aede:48ff:fe71:f6f2:4711 --interface eth2</userinput>
458
484
 
459
485
      </para>
460
486
    </informalexample>
510
536
  <refsect1 id="see_also">
511
537
    <title>SEE ALSO</title>
512
538
    <para>
 
539
      <citerefentry><refentrytitle>intro</refentrytitle>
 
540
      <manvolnum>8mandos</manvolnum></citerefentry>,
513
541
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
514
542
      <manvolnum>8</manvolnum></citerefentry>,
515
543
      <citerefentry><refentrytitle>crypttab</refentrytitle>