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 COMMANDNAME "mandos-client">
5
<!ENTITY TIMESTAMP "2011-10-03">
6
<!ENTITY % common SYSTEM "../common.ent">
4
<!ENTITY VERSION "1.0">
5
<!ENTITY COMMANDNAME "password-request">
6
<!ENTITY TIMESTAMP "2008-09-02">
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>
37
34
<holder>Teddy Hogeborn</holder>
38
35
<holder>Björn Påhlsson</holder>
40
37
<xi:include href="../legalnotice.xml"/>
44
41
<refentrytitle>&COMMANDNAME;</refentrytitle>
45
42
<manvolnum>8mandos</manvolnum>
49
46
<refname><command>&COMMANDNAME;</command></refname>
51
Client for <application>Mandos</application>
57
54
<command>&COMMANDNAME;</command>
59
56
<arg choice="plain"><option>--connect
60
<replaceable>ADDRESS</replaceable><literal>:</literal
57
<replaceable>IPADDR</replaceable><literal>:</literal
61
58
><replaceable>PORT</replaceable></option></arg>
62
59
<arg choice="plain"><option>-c
63
<replaceable>ADDRESS</replaceable><literal>:</literal
60
<replaceable>IPADDR</replaceable><literal>:</literal
64
61
><replaceable>PORT</replaceable></option></arg>
65
<arg choice="plain"><option>--keydir
66
<replaceable>DIRECTORY</replaceable></option></arg>
67
<arg choice="plain"><option>-d
68
<replaceable>DIRECTORY</replaceable></option></arg>
68
72
<arg choice="plain"><option>--interface
69
73
<replaceable>NAME</replaceable></option></arg>
70
74
<arg choice="plain"><option>-i
130
122
</refsynopsisdiv>
132
124
<refsect1 id="description">
133
125
<title>DESCRIPTION</title>
135
127
<command>&COMMANDNAME;</command> is a client program that
136
128
communicates with <citerefentry><refentrytitle
137
129
>mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>
138
to get a password. In slightly more detail, this client program
139
brings up a network interface, uses the interface’s IPv6
140
link-local address to get network connectivity, uses Zeroconf to
141
find servers on the local network, and communicates with servers
142
using TLS with an OpenPGP key to ensure authenticity and
143
confidentiality. This client program keeps running, trying all
144
servers on the network, until it receives a satisfactory reply
145
or a TERM signal. After all servers have been tried, all
146
servers are periodically retried. If no servers are found it
147
will wait indefinitely for new servers to appear.
130
to get a password. It uses IPv6 link-local addresses to get
131
network connectivity, Zeroconf to find the server, and TLS with
132
an OpenPGP key to ensure authenticity and confidentiality. It
133
keeps running, trying all servers on the network, until it
134
receives a satisfactory reply.
150
137
This program is not meant to be run directly; it is really meant
151
138
to run as a plugin of the <application>Mandos</application>
152
139
<citerefentry><refentrytitle>plugin-runner</refentrytitle>
153
<manvolnum>8mandos</manvolnum></citerefentry>, which runs in the
154
initial <acronym>RAM</acronym> disk environment because it is
155
specified as a <quote>keyscript</quote> in the <citerefentry>
156
<refentrytitle>crypttab</refentrytitle><manvolnum>5</manvolnum>
157
</citerefentry> file.
140
<manvolnum>8mandos</manvolnum></citerefentry>, which in turn
141
runs as a <quote>keyscript</quote> specified in the
142
<citerefentry><refentrytitle>crypttab</refentrytitle>
143
<manvolnum>5</manvolnum></citerefentry> file.
197
202
assumed to separate the address from the port number.
200
This option is normally only useful for testing and
205
This option is normally only useful for debugging.
207
<term><option>--interface=<replaceable
208
>NAME</replaceable></option></term>
211
<term><option>--keydir=<replaceable
212
>DIRECTORY</replaceable></option></term>
214
<replaceable>DIRECTORY</replaceable></option></term>
217
Directory to read the OpenPGP key files
218
<filename>pubkey.txt</filename> and
219
<filename>seckey.txt</filename> from. The default is
220
<filename>/conf/conf.d/mandos</filename> (in the initial
221
<acronym>RAM</acronym> disk environment).
227
<term><option>--interface=
228
<replaceable>NAME</replaceable></option></term>
210
230
<replaceable>NAME</replaceable></option></term>
213
233
Network interface that will be brought up and scanned for
214
Mandos servers to connect to. The default is the empty
215
string, which will automatically choose an appropriate
219
If the <option>--connect</option> option is used, this
220
specifies the interface to use to connect to the address
224
Note that since this program will normally run in the
225
initial RAM disk environment, the interface must be an
226
interface which exists at that stage. Thus, the interface
227
can not be a pseudo-interface such as <quote>br0</quote>
228
or <quote>tun0</quote>; such interfaces will not exist
229
until much later in the boot process, and can not be used
233
<replaceable>NAME</replaceable> can be the string
234
<quote><literal>none</literal></quote>; this will not use
235
any specific interface, and will not bring up an interface
236
on startup. This is not recommended, and only meant for
234
Mandos servers to connect to. The default it
235
<quote><literal>eth0</literal></quote>.
291
<term><option>--delay=<replaceable
292
>SECONDS</replaceable></option></term>
295
After bringing the network interface up, the program waits
296
for the interface to arrive in a <quote>running</quote>
297
state before proceeding. During this time, the kernel log
298
level will be lowered to reduce clutter on the system
299
console, alleviating any other plugins which might be
300
using the system console. This option sets the upper
301
limit of seconds to wait. The default is 2.5 seconds.
307
<term><option>--retry=<replaceable
308
>SECONDS</replaceable></option></term>
311
All Mandos servers are tried repeatedly until a password
312
is received. This value specifies, in seconds, how long
313
between each successive try <emphasis>for the same
314
server</emphasis>. The default is 10 seconds.
320
<term><option>--network-hook-dir=<replaceable
321
>DIR</replaceable></option></term>
324
Network hook directory. The default directory is
325
<quote><filename class="directory"
326
>/lib/mandos/network-hooks.d</filename></quote>.
332
290
<term><option>--debug</option></term>
378
<refsect1 id="overview">
379
<title>OVERVIEW</title>
380
<xi:include href="../overview.xml"/>
382
This program is the client part. It is a plugin started by
383
<citerefentry><refentrytitle>plugin-runner</refentrytitle>
384
<manvolnum>8mandos</manvolnum></citerefentry> which will run in
385
an initial <acronym>RAM</acronym> disk environment.
388
This program could, theoretically, be used as a keyscript in
389
<filename>/etc/crypttab</filename>, but it would then be
390
impossible to enter a password for the encrypted root disk at
391
the console, since this program does not read from the console
392
at all. This is why a separate plugin runner (<citerefentry>
393
<refentrytitle>plugin-runner</refentrytitle>
394
<manvolnum>8mandos</manvolnum></citerefentry>) is used to run
395
both this program and others in in parallel,
396
<emphasis>one</emphasis> of which will prompt for passwords on
401
336
<refsect1 id="exit_status">
402
337
<title>EXIT STATUS</title>
405
340
server could be found and the password received from it could be
406
341
successfully decrypted and output on standard output. The
407
342
program will exit with a non-zero exit status only if a critical
408
error occurs. Otherwise, it will forever connect to any
409
discovered <application>Mandos</application> servers, trying to
410
get a decryptable password and print it.
414
<refsect1 id="environment">
415
<title>ENVIRONMENT</title>
417
This program does not use any environment variables, not even
418
the ones provided by <citerefentry><refentrytitle
419
>cryptsetup</refentrytitle><manvolnum>8</manvolnum>
424
<refsect1 id="files">
428
<term><filename>/conf/conf.d/mandos/pubkey.txt</filename
430
<term><filename>/conf/conf.d/mandos/seckey.txt</filename
434
OpenPGP public and private key files, in <quote>ASCII
435
Armor</quote> format. These are the default file names,
436
they can be changed with the <option>--pubkey</option> and
437
<option>--seckey</option> options.
444
<!-- <refsect1 id="bugs"> -->
445
<!-- <title>BUGS</title> -->
343
error occurs. Otherwise, it will forever connect to new
344
<application>Mandosservers</application> servers as they appear,
345
trying to get a decryptable password.
349
<!-- <refsect1 id="environment"> -->
350
<!-- <title>ENVIRONMENT</title> -->
352
<!-- This program does not use any environment variables. -->
448
354
<!-- </refsect1> -->
450
368
<refsect1 id="example">
451
369
<title>EXAMPLE</title>
453
Note that normally, command line options will not be given
454
directly, but via options for the Mandos <citerefentry
455
><refentrytitle>plugin-runner</refentrytitle>
456
<manvolnum>8mandos</manvolnum></citerefentry>.
460
Normal invocation needs no options, if the network interface
461
is <quote>eth0</quote>:
464
<userinput>&COMMANDNAME;</userinput>
469
Search for Mandos servers (and connect to them) using another
473
<!-- do not wrap this line -->
474
<userinput>&COMMANDNAME; --interface eth1</userinput>
479
Run in debug mode, and use a custom key:
483
<!-- do not wrap this line -->
484
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt</userinput>
490
Run in debug mode, with a custom key, and do not use Zeroconf
491
to locate a server; connect directly to the IPv6 link-local
492
address <quote><systemitem class="ipaddress"
493
>fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
494
using interface eth2:
498
<!-- do not wrap this line -->
499
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect fe80::aede:48ff:fe71:f6f2:4711 --interface eth2</userinput>
505
374
<refsect1 id="security">
506
375
<title>SECURITY</title>
508
This program is set-uid to root, but will switch back to the
509
original (and presumably non-privileged) user and group after
510
bringing up the network interface.
513
To use this program for its intended purpose (see <xref
514
linkend="purpose"/>), the password for the root file system will
515
have to be given out to be stored in a server computer, after
516
having been encrypted using an OpenPGP key. This encrypted data
517
which will be stored in a server can only be decrypted by the
518
OpenPGP key, and the data will only be given out to those
519
clients who can prove they actually have that key. This key,
520
however, is stored unencrypted on the client side in its initial
521
<acronym>RAM</acronym> disk image file system. This is normally
522
readable by all, but this is normally fixed during installation
523
of this program; file permissions are set so that no-one is able
527
The only remaining weak point is that someone with physical
528
access to the client hard drive might turn off the client
529
computer, read the OpenPGP keys directly from the hard drive,
530
and communicate with the server. To safeguard against this, the
531
server is supposed to notice the client disappearing and stop
532
giving out the encrypted data. Therefore, it is important to
533
set the timeout and checker interval values tightly on the
534
server. See <citerefentry><refentrytitle
535
>mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
538
It will also help if the checker program on the server is
539
configured to request something from the client which can not be
540
spoofed by someone else on the network, unlike unencrypted
541
<acronym>ICMP</acronym> echo (<quote>ping</quote>) replies.
544
<emphasis>Note</emphasis>: This makes it completely insecure to
545
have <application >Mandos</application> clients which dual-boot
546
to another operating system which is <emphasis>not</emphasis>
547
trusted to keep the initial <acronym>RAM</acronym> disk image
552
380
<refsect1 id="see_also">
553
381
<title>SEE ALSO</title>
555
<citerefentry><refentrytitle>intro</refentrytitle>
556
<manvolnum>8mandos</manvolnum></citerefentry>,
557
<citerefentry><refentrytitle>cryptsetup</refentrytitle>
558
<manvolnum>8</manvolnum></citerefentry>,
559
<citerefentry><refentrytitle>crypttab</refentrytitle>
560
<manvolnum>5</manvolnum></citerefentry>,
561
383
<citerefentry><refentrytitle>mandos</refentrytitle>
562
384
<manvolnum>8</manvolnum></citerefentry>,
563
385
<citerefentry><refentrytitle>password-prompt</refentrytitle>
565
387
<citerefentry><refentrytitle>plugin-runner</refentrytitle>
566
388
<manvolnum>8mandos</manvolnum></citerefentry>
571
<ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
575
Zeroconf is the network protocol standard used for finding
576
Mandos servers on the local network.
582
<ulink url="http://www.avahi.org/">Avahi</ulink>
586
Avahi is the library this program calls to find Zeroconf
593
<ulink url="http://www.gnu.org/software/gnutls/"
598
GnuTLS is the library this client uses to implement TLS for
599
communicating securely with the server, and at the same time
600
send the public OpenPGP key to the server.
606
<ulink url="http://www.gnupg.org/related_software/gpgme/"
611
GPGME is the library used to decrypt the OpenPGP data sent
618
RFC 4291: <citetitle>IP Version 6 Addressing
619
Architecture</citetitle>
624
<term>Section 2.2: <citetitle>Text Representation of
625
Addresses</citetitle></term>
626
<listitem><para/></listitem>
629
<term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
630
Address</citetitle></term>
631
<listitem><para/></listitem>
634
<term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
635
Addresses</citetitle></term>
638
This client uses IPv6 link-local addresses, which are
639
immediately usable since a link-local addresses is
640
automatically assigned to a network interfaces when it
650
RFC 4346: <citetitle>The Transport Layer Security (TLS)
651
Protocol Version 1.1</citetitle>
655
TLS 1.1 is the protocol implemented by GnuTLS.
661
RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
665
The data received from the server is binary encrypted
672
RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
677
This is implemented by GnuTLS and used by this program so
678
that OpenPGP keys can be used.
392
<ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
396
<ulink url="http://www.avahi.org/">Avahi</ulink>
401
url="http://www.gnu.org/software/gnutls/">GnuTLS</ulink>
406
url="http://www.gnupg.org/related_software/gpgme/">
411
<citation>RFC 4880: <citetitle>OpenPGP Message
412
Format</citetitle></citation>
416
<citation>RFC 5081: <citetitle>Using OpenPGP Keys for
417
Transport Layer Security</citetitle></citation>
421
<citation>RFC 4291: <citetitle>IP Version 6 Addressing
422
Architecture</citetitle>, section 2.5.6, Link-Local IPv6
423
Unicast Addresses</citation>
686
429
<!-- Local Variables: -->
687
430
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
688
431
<!-- time-stamp-end: "[\"']>" -->