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 "2015-06-29">
6
<!ENTITY % common SYSTEM "../common.ent">
6
<!ENTITY TIMESTAMP "2008-09-12">
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>
19
18
<firstname>Björn</firstname>
20
19
<surname>Påhlsson</surname>
22
<email>belorn@recompile.se</email>
21
<email>belorn@fukt.bsnet.se</email>
26
25
<firstname>Teddy</firstname>
27
26
<surname>Hogeborn</surname>
29
<email>teddy@recompile.se</email>
28
<email>teddy@fukt.bsnet.se</email>
40
34
<holder>Teddy Hogeborn</holder>
41
35
<holder>Björn Påhlsson</holder>
141
120
<command>&COMMANDNAME;</command> is a client program that
142
121
communicates with <citerefentry><refentrytitle
143
122
>mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>
144
to get a password. In slightly more detail, this client program
145
brings up network interfaces, uses the interfaces’ IPv6
146
link-local addresses to get network connectivity, uses Zeroconf
147
to find servers on the local network, and communicates with
148
servers using TLS with an OpenPGP key to ensure authenticity and
149
confidentiality. This client program keeps running, trying all
150
servers on the network, until it receives a satisfactory reply
151
or a TERM signal. After all servers have been tried, all
152
servers are periodically retried. If no servers are found it
153
will wait indefinitely for new servers to appear.
156
The network interfaces are selected like this: If any interfaces
157
are specified using the <option>--interface</option> option,
158
those interface are used. Otherwise,
159
<command>&COMMANDNAME;</command> will use all interfaces that
160
are not loopback interfaces, are not point-to-point interfaces,
161
are capable of broadcasting and do not have the NOARP flag (see
162
<citerefentry><refentrytitle>netdevice</refentrytitle>
163
<manvolnum>7</manvolnum></citerefentry>). (If the
164
<option>--connect</option> option is used, point-to-point
165
interfaces and non-broadcast interfaces are accepted.) If any
166
used interfaces are not up and running, they are first taken up
167
(and later taken down again on program exit).
170
Before network interfaces are selected, all <quote>network
171
hooks</quote> are run; see <xref linkend="network-hooks"/>.
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.
174
130
This program is not meant to be run directly; it is really meant
221
177
assumed to separate the address from the port number.
224
Normally, Zeroconf would be used to locate Mandos servers,
225
in which case this option would only be used when testing
180
This option is normally only useful for testing and
232
<term><option>--interface=<replaceable
233
>NAME</replaceable><arg rep='repeat'>,<replaceable
234
>NAME</replaceable></arg></option></term>
187
<term><option>--interface=
188
<replaceable>NAME</replaceable></option></term>
236
<replaceable>NAME</replaceable><arg rep='repeat'>,<replaceable
237
>NAME</replaceable></arg></option></term>
190
<replaceable>NAME</replaceable></option></term>
240
Comma separated list of network interfaces that will be
241
brought up and scanned for Mandos servers to connect to.
242
The default is the empty string, which will automatically
243
use all appropriate interfaces.
246
If the <option>--connect</option> option is used, and
247
exactly one interface name is specified (except
248
<quote><literal>none</literal></quote>), this specifies
249
the interface to use to connect to the address given.
252
Note that since this program will normally run in the
253
initial RAM disk environment, the interface must be an
254
interface which exists at that stage. Thus, the interface
255
can normally not be a pseudo-interface such as
256
<quote>br0</quote> or <quote>tun0</quote>; such interfaces
257
will not exist until much later in the boot process, and
258
can not be used by this program, unless created by a
259
<quote>network hook</quote> — see <xref
260
linkend="network-hooks"/>.
263
<replaceable>NAME</replaceable> can be the string
264
<quote><literal>none</literal></quote>; this will make
265
<command>&COMMANDNAME;</command> only bring up interfaces
266
specified <emphasis>before</emphasis> this string. This
267
is not recommended, and only meant for advanced users.
193
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>.
198
If the <option>--connect</option> option is used, this
199
specifies the interface to use to connect to the address
321
<term><option>--delay=<replaceable
322
>SECONDS</replaceable></option></term>
325
After bringing a network interface up, the program waits
326
for the interface to arrive in a <quote>running</quote>
327
state before proceeding. During this time, the kernel log
328
level will be lowered to reduce clutter on the system
329
console, alleviating any other plugins which might be
330
using the system console. This option sets the upper
331
limit of seconds to wait. The default is 2.5 seconds.
337
<term><option>--retry=<replaceable
338
>SECONDS</replaceable></option></term>
341
All Mandos servers are tried repeatedly until a password
342
is received. This value specifies, in seconds, how long
343
between each successive try <emphasis>for the same
344
server</emphasis>. The default is 10 seconds.
350
<term><option>--network-hook-dir=<replaceable
351
>DIR</replaceable></option></term>
354
Network hook directory. The default directory is
355
<quote><filename class="directory"
356
>/lib/mandos/network-hooks.d</filename></quote>.
362
254
<term><option>--debug</option></term>
437
327
server could be found and the password received from it could be
438
328
successfully decrypted and output on standard output. The
439
329
program will exit with a non-zero exit status only if a critical
440
error occurs. Otherwise, it will forever connect to any
441
discovered <application>Mandos</application> servers, trying to
442
get a decryptable password and print it.
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.
446
336
<refsect1 id="environment">
447
337
<title>ENVIRONMENT</title>
450
<term><envar>MANDOSPLUGINHELPERDIR</envar></term>
453
This environment variable will be assumed to contain the
454
directory containing any helper executables. The use and
455
nature of these helper executables, if any, is
456
purposefully not documented.
462
This program does not use any other environment variables, not
463
even the ones provided by <citerefentry><refentrytitle
339
This program does not use any environment variables, not even
340
the ones provided by <citerefentry><refentrytitle
464
341
>cryptsetup</refentrytitle><manvolnum>8</manvolnum>
469
<refsect1 id="network-hooks">
470
<title>NETWORK HOOKS</title>
472
If a network interface like a bridge or tunnel is required to
473
find a Mandos server, this requires the interface to be up and
474
running before <command>&COMMANDNAME;</command> starts looking
475
for Mandos servers. This can be accomplished by creating a
476
<quote>network hook</quote> program, and placing it in a special
480
Before the network is used (and again before program exit), any
481
runnable programs found in the network hook directory are run
482
with the argument <quote><literal>start</literal></quote> or
483
<quote><literal>stop</literal></quote>. This should bring up or
484
down, respectively, any network interface which
485
<command>&COMMANDNAME;</command> should use.
487
<refsect2 id="hook-requirements">
488
<title>REQUIREMENTS</title>
490
A network hook must be an executable file, and its name must
491
consist entirely of upper and lower case letters, digits,
492
underscores, periods, and hyphens.
495
A network hook will receive one argument, which can be one of
500
<term><literal>start</literal></term>
503
This should make the network hook create (if necessary)
504
and bring up a network interface.
509
<term><literal>stop</literal></term>
512
This should make the network hook take down a network
513
interface, and delete it if it did not exist previously.
518
<term><literal>files</literal></term>
521
This should make the network hook print, <emphasis>one
522
file per line</emphasis>, all the files needed for it to
523
run. (These files will be copied into the initial RAM
524
filesystem.) Typical use is for a network hook which is
525
a shell script to print its needed binaries.
528
It is not necessary to print any non-executable files
529
already in the network hook directory, these will be
530
copied implicitly if they otherwise satisfy the name
536
<term><literal>modules</literal></term>
539
This should make the network hook print, <emphasis>on
540
separate lines</emphasis>, all the kernel modules needed
541
for it to run. (These modules will be copied into the
542
initial RAM filesystem.) For instance, a tunnel
544
<quote><literal>tun</literal></quote> module.
550
The network hook will be provided with a number of environment
555
<term><envar>MANDOSNETHOOKDIR</envar></term>
558
The network hook directory, specified to
559
<command>&COMMANDNAME;</command> by the
560
<option>--network-hook-dir</option> option. Note: this
561
should <emphasis>always</emphasis> be used by the
562
network hook to refer to itself or any files in the hook
563
directory it may require.
568
<term><envar>DEVICE</envar></term>
571
The network interfaces, as specified to
572
<command>&COMMANDNAME;</command> by the
573
<option>--interface</option> option, combined to one
574
string and separated by commas. If this is set, and
575
does not contain the interface a hook will bring up,
576
there is no reason for a hook to continue.
581
<term><envar>MODE</envar></term>
584
This will be the same as the first argument;
585
i.e. <quote><literal>start</literal></quote>,
586
<quote><literal>stop</literal></quote>,
587
<quote><literal>files</literal></quote>, or
588
<quote><literal>modules</literal></quote>.
593
<term><envar>VERBOSITY</envar></term>
596
This will be the <quote><literal>1</literal></quote> if
597
the <option>--debug</option> option is passed to
598
<command>&COMMANDNAME;</command>, otherwise
599
<quote><literal>0</literal></quote>.
604
<term><envar>DELAY</envar></term>
607
This will be the same as the <option>--delay</option>
608
option passed to <command>&COMMANDNAME;</command>. Is
609
only set if <envar>MODE</envar> is
610
<quote><literal>start</literal></quote> or
611
<quote><literal>stop</literal></quote>.
616
<term><envar>CONNECT</envar></term>
619
This will be the same as the <option>--connect</option>
620
option passed to <command>&COMMANDNAME;</command>. Is
621
only set if <option>--connect</option> is passed and
622
<envar>MODE</envar> is
623
<quote><literal>start</literal></quote> or
624
<quote><literal>stop</literal></quote>.
630
A hook may not read from standard input, and should be
631
restrictive in printing to standard output or standard error
632
unless <varname>VERBOSITY</varname> is
633
<quote><literal>1</literal></quote>.
638
<refsect1 id="files">
639
347
<title>FILES</title>
752
449
The only remaining weak point is that someone with physical
753
450
access to the client hard drive might turn off the client
754
451
computer, read the OpenPGP keys directly from the hard drive,
755
and communicate with the server. To safeguard against this, the
756
server is supposed to notice the client disappearing and stop
757
giving out the encrypted data. Therefore, it is important to
758
set the timeout and checker interval values tightly on the
759
server. See <citerefentry><refentrytitle
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
760
457
>mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
763
460
It will also help if the checker program on the server is
764
461
configured to request something from the client which can not be
765
spoofed by someone else on the network, like SSH server key
766
fingerprints, and unlike unencrypted <acronym>ICMP</acronym>
767
echo (<quote>ping</quote>) replies.
462
spoofed by someone else on the network, unlike unencrypted
463
<acronym>ICMP</acronym> echo (<quote>ping</quote>) replies.
770
466
<emphasis>Note</emphasis>: This makes it completely insecure to