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
<!ENTITY COMMANDNAME "password-request">
6
<!ENTITY TIMESTAMP "2008-09-03">
4
<!ENTITY COMMANDNAME "mandos-client">
5
<!ENTITY TIMESTAMP "2011-10-03">
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>
18
19
<firstname>Björn</firstname>
19
20
<surname>Påhlsson</surname>
21
<email>belorn@fukt.bsnet.se</email>
22
<email>belorn@recompile.se</email>
25
26
<firstname>Teddy</firstname>
26
27
<surname>Hogeborn</surname>
28
<email>teddy@fukt.bsnet.se</email>
29
<email>teddy@recompile.se</email>
34
37
<holder>Teddy Hogeborn</holder>
35
38
<holder>Björn Påhlsson</holder>
37
40
<xi:include href="../legalnotice.xml"/>
41
44
<refentrytitle>&COMMANDNAME;</refentrytitle>
42
45
<manvolnum>8mandos</manvolnum>
46
49
<refname><command>&COMMANDNAME;</command></refname>
51
Client for <application>Mandos</application>
54
57
<command>&COMMANDNAME;</command>
56
59
<arg choice="plain"><option>--connect
57
<replaceable>IPADDR</replaceable><literal>:</literal
60
<replaceable>ADDRESS</replaceable><literal>:</literal
58
61
><replaceable>PORT</replaceable></option></arg>
59
62
<arg choice="plain"><option>-c
60
<replaceable>IPADDR</replaceable><literal>:</literal
63
<replaceable>ADDRESS</replaceable><literal>:</literal
61
64
><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>
72
68
<arg choice="plain"><option>--interface
73
69
<replaceable>NAME</replaceable></option></arg>
74
70
<arg choice="plain"><option>-i
122
130
</refsynopsisdiv>
124
132
<refsect1 id="description">
125
133
<title>DESCRIPTION</title>
127
135
<command>&COMMANDNAME;</command> is a client program that
128
136
communicates with <citerefentry><refentrytitle
129
137
>mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>
130
to get a password. It uses IPv6 link-local addresses to get
131
network connectivity, Zeroconf to find servers, and TLS with an
132
OpenPGP key to ensure authenticity and confidentiality. It
133
keeps running, trying all servers on the network, until it
134
receives a satisfactory reply or a TERM signal is recieved.
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.
137
150
This program is not meant to be run directly; it is really meant
194
<term><option>--keydir=<replaceable
195
>DIRECTORY</replaceable></option></term>
197
<replaceable>DIRECTORY</replaceable></option></term>
200
Directory to read the OpenPGP key files
201
<filename>pubkey.txt</filename> and
202
<filename>seckey.txt</filename> from. The default is
203
<filename>/conf/conf.d/mandos</filename> (in the initial
204
<acronym>RAM</acronym> disk environment).
210
<term><option>--interface=
211
<replaceable>NAME</replaceable></option></term>
207
<term><option>--interface=<replaceable
208
>NAME</replaceable></option></term>
213
210
<replaceable>NAME</replaceable></option></term>
216
213
Network interface that will be brought up and scanned for
217
Mandos servers to connect to. The default it
218
<quote><literal>eth0</literal></quote>.
214
Mandos servers to connect to. The default is the empty
215
string, which will automatically choose an appropriate
221
219
If the <option>--connect</option> option is used, this
222
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
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>.
279
332
<term><option>--debug</option></term>
336
389
<filename>/etc/crypttab</filename>, but it would then be
337
390
impossible to enter a password for the encrypted root disk at
338
391
the console, since this program does not read from the console
339
at all. This is why a separate plugin does that, which will be
340
run in parallell to this one by the plugin runner.
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
348
405
server could be found and the password received from it could be
349
406
successfully decrypted and output on standard output. The
350
407
program will exit with a non-zero exit status only if a critical
351
error occurs. Otherwise, it will forever connect to new
352
<application>Mandos</application> servers as they appear, trying
353
to get a decryptable password.
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.
418
476
</informalexample>
419
477
<informalexample>
421
Run in debug mode, and use a custom key directory:
479
Run in debug mode, and use a custom key:
424
<!-- do not wrap this line -->
425
<userinput>&COMMANDNAME; --debug --keydir keydir</userinput>
483
<!-- do not wrap this line -->
484
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt</userinput>
427
487
</informalexample>
428
488
<informalexample>
430
Run in debug mode, with a custom key directory, and do not use
431
Zeroconf to locate a server; connect directly to the IPv6
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
432
492
address <quote><systemitem class="ipaddress"
433
>2001:db8:f983:bd0b:30de:ae4a:71f2:f672</systemitem></quote>,
434
port 4711, using interface eth2:
493
>fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
494
using interface eth2:
438
498
<!-- do not wrap this line -->
439
<userinput>&COMMANDNAME; --debug --keydir keydir --connect 2001:db8:f983:bd0b:30de:ae4a:71f2:f672:4711 --interface eth2</userinput>
499
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect fe80::aede:48ff:fe71:f6f2:4711 --interface eth2</userinput>
442
502
</informalexample>
445
505
<refsect1 id="security">
446
506
<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
451
552
<refsect1 id="see_also">
452
553
<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>,
454
561
<citerefentry><refentrytitle>mandos</refentrytitle>
455
562
<manvolnum>8</manvolnum></citerefentry>,
456
563
<citerefentry><refentrytitle>password-prompt</refentrytitle>
458
565
<citerefentry><refentrytitle>plugin-runner</refentrytitle>
459
566
<manvolnum>8mandos</manvolnum></citerefentry>
463
<ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
467
<ulink url="http://www.avahi.org/">Avahi</ulink>
472
url="http://www.gnu.org/software/gnutls/">GnuTLS</ulink>
477
url="http://www.gnupg.org/related_software/gpgme/"
482
<citation>RFC 4880: <citetitle>OpenPGP Message
483
Format</citetitle></citation>
487
<citation>RFC 5081: <citetitle>Using OpenPGP Keys for
488
Transport Layer Security</citetitle></citation>
492
<citation>RFC 4291: <citetitle>IP Version 6 Addressing
493
Architecture</citetitle>, section 2.5.6, Link-Local IPv6
494
Unicast Addresses</citation>
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.
500
686
<!-- Local Variables: -->
501
687
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
502
688
<!-- time-stamp-end: "[\"']>" -->