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-08-08">
5
<!ENTITY TIMESTAMP "2009-01-04">
6
6
<!ENTITY % common SYSTEM "../common.ent">
131
126
<command>&COMMANDNAME;</command> is a client program that
132
127
communicates with <citerefentry><refentrytitle
133
128
>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.
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.
146
136
This program is not meant to be run directly; it is really meant
203
<term><option>--interface=<replaceable
204
>NAME</replaceable></option></term>
193
<term><option>--interface=
194
<replaceable>NAME</replaceable></option></term>
206
196
<replaceable>NAME</replaceable></option></term>
209
199
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
200
Mandos servers to connect to. The default it
201
<quote><literal>eth0</literal></quote>.
215
204
If the <option>--connect</option> option is used, this
216
205
specifies the interface to use to connect to the address
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
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
303
<term><option>--retry=<replaceable
304
>SECONDS</replaceable></option></term>
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.
316
276
<term><option>--debug</option></term>
389
349
server could be found and the password received from it could be
390
350
successfully decrypted and output on standard output. The
391
351
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.
352
error occurs. Otherwise, it will forever connect to new
353
<application>Mandos</application> servers as they appear, trying
354
to get a decryptable password and print it.
472
432
<informalexample>
474
434
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:
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:
482
442
<!-- 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>
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>
486
446
</informalexample>
536
496
<refsect1 id="see_also">
537
497
<title>SEE ALSO</title>
539
<citerefentry><refentrytitle>intro</refentrytitle>
540
<manvolnum>8mandos</manvolnum></citerefentry>,
541
499
<citerefentry><refentrytitle>cryptsetup</refentrytitle>
542
500
<manvolnum>8</manvolnum></citerefentry>,
543
501
<citerefentry><refentrytitle>crypttab</refentrytitle>
added
removed
plugins.d/mandos-client.xml
