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">
4
5
<!ENTITY COMMANDNAME "mandos-client">
5
<!ENTITY TIMESTAMP "2010-09-26">
6
<!ENTITY % common SYSTEM "../common.ent">
6
<!ENTITY TIMESTAMP "2008-09-06">
10
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
12
11
<title>Mandos Manual</title>
13
<!-- NWalsh’s docbook scripts use this to generate the footer: -->
12
<!-- Nwalsh’s docbook scripts use this to generate the footer: -->
14
13
<productname>Mandos</productname>
15
<productnumber>&version;</productnumber>
14
<productnumber>&VERSION;</productnumber>
16
15
<date>&TIMESTAMP;</date>
36
34
<holder>Teddy Hogeborn</holder>
37
35
<holder>Björn Påhlsson</holder>
39
37
<xi:include href="../legalnotice.xml"/>
43
41
<refentrytitle>&COMMANDNAME;</refentrytitle>
44
42
<manvolnum>8mandos</manvolnum>
125
115
</refsynopsisdiv>
127
117
<refsect1 id="description">
128
118
<title>DESCRIPTION</title>
130
120
<command>&COMMANDNAME;</command> is a client program that
131
121
communicates with <citerefentry><refentrytitle
132
122
>mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>
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 is received. If no servers are found, or after
141
all servers have been tried, it waits indefinitely for new
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.
145
130
This program is not meant to be run directly; it is really meant
202
<term><option>--interface=<replaceable
203
>NAME</replaceable></option></term>
187
<term><option>--interface=
188
<replaceable>NAME</replaceable></option></term>
205
190
<replaceable>NAME</replaceable></option></term>
208
193
Network interface that will be brought up and scanned for
209
Mandos servers to connect to. The default is the empty
210
string, which will automatically choose an appropriate
194
Mandos servers to connect to. The default it
195
<quote><literal>eth0</literal></quote>.
214
198
If the <option>--connect</option> option is used, this
215
199
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 servers are tried repeatedly until a
307
password is received. This value specifies, in seconds,
308
how long between each successive try <emphasis>for the
309
same server</emphasis>. The default is 10 seconds.
315
254
<term><option>--debug</option></term>
372
311
<filename>/etc/crypttab</filename>, but it would then be
373
312
impossible to enter a password for the encrypted root disk at
374
313
the console, since this program does not read from the console
375
at all. This is why a separate plugin runner (<citerefentry>
376
<refentrytitle>plugin-runner</refentrytitle>
377
<manvolnum>8mandos</manvolnum></citerefentry>) is used to run
378
both this program and others in in parallel,
379
<emphasis>one</emphasis> of which will prompt for passwords on
314
at all. This is why a separate plugin (<citerefentry>
315
<refentrytitle>password-prompt</refentrytitle>
316
<manvolnum>8mandos</manvolnum></citerefentry>) does that, which
317
will be run in parallel to this one by the plugin runner.
390
327
program will exit with a non-zero exit status only if a critical
391
328
error occurs. Otherwise, it will forever connect to new
392
329
<application>Mandos</application> servers as they appear, trying
393
to get a decryptable password and print it.
330
to get a decryptable password.
471
408
<informalexample>
473
410
Run in debug mode, with a custom key, and do not use Zeroconf
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:
411
to locate a server; connect directly to the IPv6 address
412
<quote><systemitem class="ipaddress"
413
>2001:db8:f983:bd0b:30de:ae4a:71f2:f672</systemitem></quote>,
414
port 4711, using interface eth2:
481
418
<!-- do not wrap this line -->
482
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect fe80::aede:48ff:fe71:f6f2:4711 --interface eth2</userinput>
419
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect 2001:db8:f983:bd0b:30de:ae4a:71f2:f672:4711 --interface eth2</userinput>
485
422
</informalexample>
488
425
<refsect1 id="security">
489
426
<title>SECURITY</title>
510
447
The only remaining weak point is that someone with physical
511
448
access to the client hard drive might turn off the client
512
449
computer, read the OpenPGP keys directly from the hard drive,
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
450
and communicate with the server. The defense against this is
451
that the server is supposed to notice the client disappearing
452
and will stop giving out the encrypted data. Therefore, it is
453
important to set the timeout and checker interval values tightly
454
on the server. See <citerefentry><refentrytitle
518
455
>mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
added
removed
plugins.d/mandos-client.xml
