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 "2009-01-24">
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>
46
48
<refname><command>&COMMANDNAME;</command></refname>
50
Client for <application>Mandos</application>
54
56
<command>&COMMANDNAME;</command>
56
58
<arg choice="plain"><option>--connect
57
<replaceable>IPADDR</replaceable><literal>:</literal
59
<replaceable>ADDRESS</replaceable><literal>:</literal
58
60
><replaceable>PORT</replaceable></option></arg>
59
61
<arg choice="plain"><option>-c
60
<replaceable>IPADDR</replaceable><literal>:</literal
62
<replaceable>ADDRESS</replaceable><literal>:</literal
61
63
><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
67
<arg choice="plain"><option>--interface
73
68
<replaceable>NAME</replaceable></option></arg>
74
69
<arg choice="plain"><option>-i
122
121
</refsynopsisdiv>
124
123
<refsect1 id="description">
125
124
<title>DESCRIPTION</title>
127
126
<command>&COMMANDNAME;</command> is a client program that
128
127
communicates with <citerefentry><refentrytitle
129
128
>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.
129
to get a password. In slightly more detail, this client program
130
brings up a network interface, uses the interface’s IPv6
131
link-local address to get network connectivity, uses Zeroconf to
132
find servers on the local network, and communicates with servers
133
using TLS with an OpenPGP key to ensure authenticity and
134
confidentiality. This client program keeps running, trying all
135
servers on the network, until it receives a satisfactory reply
136
or a TERM signal is received. If no servers are found, or after
137
all servers have been tried, it waits indefinitely for new
137
141
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
198
<term><option>--interface=
211
199
<replaceable>NAME</replaceable></option></term>
222
210
specifies the interface to use to connect to the address
214
Note that since this program will normally run in the
215
initial RAM disk environment, the interface must be an
216
interface which exists at that stage. Thus, the interface
217
can not be a pseudo-interface such as <quote>br0</quote>
218
or <quote>tun0</quote>; such interfaces will not exist
219
until much later in the boot process, and can not be used
232
229
<replaceable>FILE</replaceable></option></term>
235
OpenPGP public key file base name. This will be combined
236
with the directory from the <option>--keydir</option>
237
option to form an absolute file name. The default name is
238
<quote><literal>pubkey.txt</literal></quote>.
232
OpenPGP public key file name. The default name is
233
<quote><filename>/conf/conf.d/mandos/pubkey.txt</filename
244
240
<term><option>--seckey=<replaceable
245
241
>FILE</replaceable></option></term>
247
243
<replaceable>FILE</replaceable></option></term>
250
OpenPGP secret key file base name. This will be combined
251
with the directory from the <option>--keydir</option>
252
option to form an absolute file name. The default name is
253
<quote><literal>seckey.txt</literal></quote>.
246
OpenPGP secret key file name. The default name is
247
<quote><filename>/conf/conf.d/mandos/seckey.txt</filename
274
<term><option>--delay=<replaceable
275
>SECONDS</replaceable></option></term>
278
After bringing the network interface up, the program waits
279
for the interface to arrive in a <quote>running</quote>
280
state before proceeding. During this time, the kernel log
281
level will be lowered to reduce clutter on the system
282
console, alleviating any other plugins which might be
283
using the system console. This option sets the upper
284
limit of seconds to wait. The default is 2.5 seconds.
279
290
<term><option>--debug</option></term>
336
347
<filename>/etc/crypttab</filename>, but it would then be
337
348
impossible to enter a password for the encrypted root disk at
338
349
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.
350
at all. This is why a separate plugin runner (<citerefentry>
351
<refentrytitle>plugin-runner</refentrytitle>
352
<manvolnum>8mandos</manvolnum></citerefentry>) is used to run
353
both this program and others in in parallel,
354
<emphasis>one</emphasis> of which will prompt for passwords on
418
434
</informalexample>
419
435
<informalexample>
421
Run in debug mode, and use a custom key directory:
437
Run in debug mode, and use a custom key:
424
<!-- do not wrap this line -->
425
<userinput>&COMMANDNAME; --debug --keydir keydir</userinput>
441
<!-- do not wrap this line -->
442
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt</userinput>
427
445
</informalexample>
428
446
<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
432
address <quote><systemitem class="ipaddress"
448
Run in debug mode, with a custom key, and do not use Zeroconf
449
to locate a server; connect directly to the IPv6 address
450
<quote><systemitem class="ipaddress"
433
451
>2001:db8:f983:bd0b:30de:ae4a:71f2:f672</systemitem></quote>,
434
452
port 4711, using interface eth2:
438
456
<!-- do not wrap this line -->
439
<userinput>&COMMANDNAME; --debug --keydir keydir --connect 2001:db8:f983:bd0b:30de:ae4a:71f2:f672:4711 --interface eth2</userinput>
457
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect 2001:db8:f983:bd0b:30de:ae4a:71f2:f672:4711 --interface eth2</userinput>
442
460
</informalexample>
445
463
<refsect1 id="security">
446
464
<title>SECURITY</title>
448
466
This program is set-uid to root, but will switch back to the
449
original user and group after bringing up the network interface.
467
original (and presumably non-privileged) user and group after
468
bringing up the network interface.
452
471
To use this program for its intended purpose (see <xref
466
485
The only remaining weak point is that someone with physical
467
486
access to the client hard drive might turn off the client
468
487
computer, read the OpenPGP keys directly from the hard drive,
469
and communicate with the server. The defense against this is
470
that the server is supposed to notice the client disappearing
471
and will stop giving out the encrypted data. Therefore, it is
472
important to set the timeout and checker interval values tightly
473
on the server. See <citerefentry><refentrytitle
488
and communicate with the server. To safeguard against this, the
489
server is supposed to notice the client disappearing and stop
490
giving out the encrypted data. Therefore, it is important to
491
set the timeout and checker interval values tightly on the
492
server. See <citerefentry><refentrytitle
474
493
>mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
477
<emphasis>Note</emphasis>: This makes it impossible to have
478
<application >Mandos</application> clients which dual-boot to
479
another operating system which does <emphasis>not</emphasis> run
480
a <application>Mandos</application> client.
496
It will also help if the checker program on the server is
497
configured to request something from the client which can not be
498
spoofed by someone else on the network, unlike unencrypted
499
<acronym>ICMP</acronym> echo (<quote>ping</quote>) replies.
502
<emphasis>Note</emphasis>: This makes it completely insecure to
503
have <application >Mandos</application> clients which dual-boot
504
to another operating system which is <emphasis>not</emphasis>
505
trusted to keep the initial <acronym>RAM</acronym> disk image
484
510
<refsect1 id="see_also">
485
511
<title>SEE ALSO</title>
513
<citerefentry><refentrytitle>cryptsetup</refentrytitle>
514
<manvolnum>8</manvolnum></citerefentry>,
515
<citerefentry><refentrytitle>crypttab</refentrytitle>
516
<manvolnum>5</manvolnum></citerefentry>,
487
517
<citerefentry><refentrytitle>mandos</refentrytitle>
488
518
<manvolnum>8</manvolnum></citerefentry>,
489
519
<citerefentry><refentrytitle>password-prompt</refentrytitle>
491
521
<citerefentry><refentrytitle>plugin-runner</refentrytitle>
492
522
<manvolnum>8mandos</manvolnum></citerefentry>
496
<ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
500
<ulink url="http://www.avahi.org/">Avahi</ulink>
505
url="http://www.gnu.org/software/gnutls/">GnuTLS</ulink>
510
url="http://www.gnupg.org/related_software/gpgme/"
515
<citation>RFC 4880: <citetitle>OpenPGP Message
516
Format</citetitle></citation>
520
<citation>RFC 5081: <citetitle>Using OpenPGP Keys for
521
Transport Layer Security</citetitle></citation>
525
<citation>RFC 4291: <citetitle>IP Version 6 Addressing
526
Architecture</citetitle>, section 2.5.6, Link-Local IPv6
527
Unicast Addresses</citation>
527
<ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
531
Zeroconf is the network protocol standard used for finding
532
Mandos servers on the local network.
538
<ulink url="http://www.avahi.org/">Avahi</ulink>
542
Avahi is the library this program calls to find Zeroconf
549
<ulink url="http://www.gnu.org/software/gnutls/"
554
GnuTLS is the library this client uses to implement TLS for
555
communicating securely with the server, and at the same time
556
send the public OpenPGP key to the server.
562
<ulink url="http://www.gnupg.org/related_software/gpgme/"
567
GPGME is the library used to decrypt the OpenPGP data sent
574
RFC 4291: <citetitle>IP Version 6 Addressing
575
Architecture</citetitle>
580
<term>Section 2.2: <citetitle>Text Representation of
581
Addresses</citetitle></term>
582
<listitem><para/></listitem>
585
<term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
586
Address</citetitle></term>
587
<listitem><para/></listitem>
590
<term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
591
Addresses</citetitle></term>
594
This client uses IPv6 link-local addresses, which are
595
immediately usable since a link-local addresses is
596
automatically assigned to a network interfaces when it
606
RFC 4346: <citetitle>The Transport Layer Security (TLS)
607
Protocol Version 1.1</citetitle>
611
TLS 1.1 is the protocol implemented by GnuTLS.
617
RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
621
The data received from the server is binary encrypted
628
RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
633
This is implemented by GnuTLS and used by this program so
634
that OpenPGP keys can be used.
533
642
<!-- Local Variables: -->
534
643
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
535
644
<!-- time-stamp-end: "[\"']>" -->