1
1
<?xml version="1.0" encoding="UTF-8"?>
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
<!ENTITY VERSION "1.0">
5
4
<!ENTITY COMMANDNAME "mandos-client">
6
<!ENTITY TIMESTAMP "2008-09-12">
5
<!ENTITY TIMESTAMP "2010-09-26">
6
<!ENTITY % common SYSTEM "../common.ent">
9
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
11
12
<title>Mandos Manual</title>
12
<!-- Nwalsh’s docbook scripts use this to generate the footer: -->
13
<!-- NWalsh’s docbook scripts use this to generate the footer: -->
13
14
<productname>Mandos</productname>
14
<productnumber>&VERSION;</productnumber>
15
<productnumber>&version;</productnumber>
15
16
<date>&TIMESTAMP;</date>
120
130
<command>&COMMANDNAME;</command> is a client program that
121
131
communicates with <citerefentry><refentrytitle
122
132
>mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>
123
to get a password. It uses IPv6 link-local addresses to get
124
network connectivity, Zeroconf to find servers, and TLS with an
125
OpenPGP key to ensure authenticity and confidentiality. It
126
keeps running, trying all servers on the network, until it
127
receives a satisfactory reply or a TERM signal is received.
133
to get a password. In slightly more detail, this client program
134
brings up a network interface, uses the interface’s IPv6
135
link-local address to get network connectivity, uses Zeroconf to
136
find servers on the local network, and communicates with servers
137
using TLS with an OpenPGP key to ensure authenticity and
138
confidentiality. This client program keeps running, trying all
139
servers on the network, until it receives a satisfactory reply
140
or a TERM signal. After all servers have been tried, all
141
servers are periodically retried. If no servers are found it
142
will wait indefinitely for new servers to appear.
130
145
This program is not meant to be run directly; it is really meant
187
<term><option>--interface=
188
<replaceable>NAME</replaceable></option></term>
202
<term><option>--interface=<replaceable
203
>NAME</replaceable></option></term>
190
205
<replaceable>NAME</replaceable></option></term>
193
208
Network interface that will be brought up and scanned for
194
Mandos servers to connect to. The default it
195
<quote><literal>eth0</literal></quote>.
209
Mandos servers to connect to. The default is the empty
210
string, which will automatically choose an appropriate
198
214
If the <option>--connect</option> option is used, this
199
215
specifies the interface to use to connect to the address
219
Note that since this program will normally run in the
220
initial RAM disk environment, the interface must be an
221
interface which exists at that stage. Thus, the interface
222
can not be a pseudo-interface such as <quote>br0</quote>
223
or <quote>tun0</quote>; such interfaces will not exist
224
until much later in the boot process, and can not be used
228
<replaceable>NAME</replaceable> can be the string
229
<quote><literal>none</literal></quote>; this will not use
230
any specific interface, and will not bring up an interface
231
on startup. This is not recommended, and only meant for
286
<term><option>--delay=<replaceable
287
>SECONDS</replaceable></option></term>
290
After bringing the network interface up, the program waits
291
for the interface to arrive in a <quote>running</quote>
292
state before proceeding. During this time, the kernel log
293
level will be lowered to reduce clutter on the system
294
console, alleviating any other plugins which might be
295
using the system console. This option sets the upper
296
limit of seconds to wait. The default is 2.5 seconds.
302
<term><option>--retry=<replaceable
303
>SECONDS</replaceable></option></term>
306
All Mandos servers are tried repeatedly until a password
307
is received. This value specifies, in seconds, how long
308
between each successive try <emphasis>for the same
309
server</emphasis>. The default is 10 seconds.
254
315
<term><option>--debug</option></term>
327
388
server could be found and the password received from it could be
328
389
successfully decrypted and output on standard output. The
329
390
program will exit with a non-zero exit status only if a critical
330
error occurs. Otherwise, it will forever connect to new
331
<application>Mandos</application> servers as they appear, trying
332
to get a decryptable password and print it.
391
error occurs. Otherwise, it will forever connect to any
392
discovered <application>Mandos</application> servers, trying to
393
get a decryptable password and print it.
410
471
<informalexample>
412
473
Run in debug mode, with a custom key, and do not use Zeroconf
413
to locate a server; connect directly to the IPv6 address
414
<quote><systemitem class="ipaddress"
415
>2001:db8:f983:bd0b:30de:ae4a:71f2:f672</systemitem></quote>,
416
port 4711, using interface eth2:
474
to locate a server; connect directly to the IPv6 link-local
475
address <quote><systemitem class="ipaddress"
476
>fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
477
using interface eth2:
420
481
<!-- do not wrap this line -->
421
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect 2001:db8:f983:bd0b:30de:ae4a:71f2:f672:4711 --interface eth2</userinput>
482
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect fe80::aede:48ff:fe71:f6f2:4711 --interface eth2</userinput>
424
485
</informalexample>
449
510
The only remaining weak point is that someone with physical
450
511
access to the client hard drive might turn off the client
451
512
computer, read the OpenPGP keys directly from the hard drive,
452
and communicate with the server. The defense against this is
453
that the server is supposed to notice the client disappearing
454
and will stop giving out the encrypted data. Therefore, it is
455
important to set the timeout and checker interval values tightly
456
on the server. See <citerefentry><refentrytitle
513
and communicate with the server. To safeguard against this, the
514
server is supposed to notice the client disappearing and stop
515
giving out the encrypted data. Therefore, it is important to
516
set the timeout and checker interval values tightly on the
517
server. See <citerefentry><refentrytitle
457
518
>mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
added
removed
plugins.d/mandos-client.xml
