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 "2009-01-24">
6
<!ENTITY % common SYSTEM "../common.ent">
4
<!ENTITY VERSION "1.0">
5
<!ENTITY COMMANDNAME "password-request">
6
<!ENTITY TIMESTAMP "2008-09-03">
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>
48
46
<refname><command>&COMMANDNAME;</command></refname>
50
Client for <application>Mandos</application>
56
54
<command>&COMMANDNAME;</command>
58
56
<arg choice="plain"><option>--connect
59
<replaceable>ADDRESS</replaceable><literal>:</literal
57
<replaceable>IPADDR</replaceable><literal>:</literal
60
58
><replaceable>PORT</replaceable></option></arg>
61
59
<arg choice="plain"><option>-c
62
<replaceable>ADDRESS</replaceable><literal>:</literal
60
<replaceable>IPADDR</replaceable><literal>:</literal
63
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>
67
72
<arg choice="plain"><option>--interface
68
73
<replaceable>NAME</replaceable></option></arg>
69
74
<arg choice="plain"><option>-i
121
122
</refsynopsisdiv>
123
124
<refsect1 id="description">
124
125
<title>DESCRIPTION</title>
126
127
<command>&COMMANDNAME;</command> is a client program that
127
128
communicates with <citerefentry><refentrytitle
128
129
>mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>
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
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.
141
137
This program is not meant to be run directly; it is really meant
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.
290
279
<term><option>--debug</option></term>
347
336
<filename>/etc/crypttab</filename>, but it would then be
348
337
impossible to enter a password for the encrypted root disk at
349
338
the console, since this program does not read from the console
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
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.
434
418
</informalexample>
435
419
<informalexample>
437
Run in debug mode, and use a custom key:
421
Run in debug mode, and use a custom key directory:
441
<!-- do not wrap this line -->
442
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt</userinput>
424
<!-- do not wrap this line -->
425
<userinput>&COMMANDNAME; --debug --keydir keydir</userinput>
445
427
</informalexample>
446
428
<informalexample>
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"
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"
451
433
>2001:db8:f983:bd0b:30de:ae4a:71f2:f672</systemitem></quote>,
452
434
port 4711, using interface eth2:
456
438
<!-- do not wrap this line -->
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>
439
<userinput>&COMMANDNAME; --debug --keydir keydir --connect 2001:db8:f983:bd0b:30de:ae4a:71f2:f672:4711 --interface eth2</userinput>
460
442
</informalexample>
463
445
<refsect1 id="security">
464
446
<title>SECURITY</title>
466
This program is set-uid to root, but will switch back to the
467
original (and presumably non-privileged) user and group after
468
bringing up the network interface.
471
To use this program for its intended purpose (see <xref
472
linkend="purpose"/>), the password for the root file system will
473
have to be given out to be stored in a server computer, after
474
having been encrypted using an OpenPGP key. This encrypted data
475
which will be stored in a server can only be decrypted by the
476
OpenPGP key, and the data will only be given out to those
477
clients who can prove they actually have that key. This key,
478
however, is stored unencrypted on the client side in its initial
479
<acronym>RAM</acronym> disk image file system. This is normally
480
readable by all, but this is normally fixed during installation
481
of this program; file permissions are set so that no-one is able
485
The only remaining weak point is that someone with physical
486
access to the client hard drive might turn off the client
487
computer, read the OpenPGP keys directly from the hard drive,
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
493
>mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
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
510
451
<refsect1 id="see_also">
511
452
<title>SEE ALSO</title>
513
<citerefentry><refentrytitle>cryptsetup</refentrytitle>
514
<manvolnum>8</manvolnum></citerefentry>,
515
<citerefentry><refentrytitle>crypttab</refentrytitle>
516
<manvolnum>5</manvolnum></citerefentry>,
517
454
<citerefentry><refentrytitle>mandos</refentrytitle>
518
455
<manvolnum>8</manvolnum></citerefentry>,
519
456
<citerefentry><refentrytitle>password-prompt</refentrytitle>
521
458
<citerefentry><refentrytitle>plugin-runner</refentrytitle>
522
459
<manvolnum>8mandos</manvolnum></citerefentry>
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.
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>
642
500
<!-- Local Variables: -->
643
501
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
644
502
<!-- time-stamp-end: "[\"']>" -->