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 "2014-06-22">
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
39
<holder>Teddy Hogeborn</holder>
35
40
<holder>Björn Påhlsson</holder>
37
42
<xi:include href="../legalnotice.xml"/>
41
46
<refentrytitle>&COMMANDNAME;</refentrytitle>
42
47
<manvolnum>8mandos</manvolnum>
46
51
<refname><command>&COMMANDNAME;</command></refname>
53
Client for <application>Mandos</application>
54
59
<command>&COMMANDNAME;</command>
56
61
<arg choice="plain"><option>--connect
57
<replaceable>IPADDR</replaceable><literal>:</literal
62
<replaceable>ADDRESS</replaceable><literal>:</literal
58
63
><replaceable>PORT</replaceable></option></arg>
59
64
<arg choice="plain"><option>-c
60
<replaceable>IPADDR</replaceable><literal>:</literal
65
<replaceable>ADDRESS</replaceable><literal>:</literal
61
66
><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
70
<arg choice="plain"><option>--interface
73
<replaceable>NAME</replaceable></option></arg>
74
<arg choice="plain"><option>-i
75
<replaceable>NAME</replaceable></option></arg>
71
<replaceable>NAME</replaceable><arg rep='repeat'
72
>,<replaceable>NAME</replaceable></arg></option></arg>
73
<arg choice="plain"><option>-i <replaceable>NAME</replaceable
74
><arg rep='repeat'>,<replaceable>NAME</replaceable></arg
122
135
</refsynopsisdiv>
124
137
<refsect1 id="description">
125
138
<title>DESCRIPTION</title>
127
140
<command>&COMMANDNAME;</command> is a client program that
128
141
communicates with <citerefentry><refentrytitle
129
142
>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.
143
to get a password. In slightly more detail, this client program
144
brings up network interfaces, uses the interfaces’ IPv6
145
link-local addresses to get network connectivity, uses Zeroconf
146
to find servers on the local network, and communicates with
147
servers using TLS with an OpenPGP key to ensure authenticity and
148
confidentiality. This client program keeps running, trying all
149
servers on the network, until it receives a satisfactory reply
150
or a TERM signal. After all servers have been tried, all
151
servers are periodically retried. If no servers are found it
152
will wait indefinitely for new servers to appear.
155
The network interfaces are selected like this: If any interfaces
156
are specified using the <option>--interface</option> option,
157
those interface are used. Otherwise,
158
<command>&COMMANDNAME;</command> will use all interfaces that
159
are not loopback interfaces, are not point-to-point interfaces,
160
are capable of broadcasting and do not have the NOARP flag (see
161
<citerefentry><refentrytitle>netdevice</refentrytitle>
162
<manvolnum>7</manvolnum></citerefentry>). (If the
163
<option>--connect</option> option is used, point-to-point
164
interfaces and non-broadcast interfaces are accepted.) If any
165
used interfaces are not up and running, they are first taken up
166
(and later taken down again on program exit).
169
Before network interfaces are selected, all <quote>network
170
hooks</quote> are run; see <xref linkend="network-hooks"/>.
137
173
This program is not meant to be run directly; it is really meant
184
220
assumed to separate the address from the port number.
187
This option is normally only useful for testing and
223
Normally, Zeroconf would be used to locate Mandos servers,
224
in which case this option would only be used when testing
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>
231
<term><option>--interface=<replaceable
232
>NAME</replaceable><arg rep='repeat'>,<replaceable
233
>NAME</replaceable></arg></option></term>
213
<replaceable>NAME</replaceable></option></term>
235
<replaceable>NAME</replaceable><arg rep='repeat'>,<replaceable
236
>NAME</replaceable></arg></option></term>
216
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>.
221
If the <option>--connect</option> option is used, this
222
specifies the interface to use to connect to the address
239
Comma separated list of network interfaces that will be
240
brought up and scanned for Mandos servers to connect to.
241
The default is the empty string, which will automatically
242
use all appropriate interfaces.
245
If the <option>--connect</option> option is used, and
246
exactly one interface name is specified (except
247
<quote><literal>none</literal></quote>), this specifies
248
the interface to use to connect to the address given.
251
Note that since this program will normally run in the
252
initial RAM disk environment, the interface must be an
253
interface which exists at that stage. Thus, the interface
254
can normally not be a pseudo-interface such as
255
<quote>br0</quote> or <quote>tun0</quote>; such interfaces
256
will not exist until much later in the boot process, and
257
can not be used by this program, unless created by a
258
<quote>network hook</quote> — see <xref
259
linkend="network-hooks"/>.
262
<replaceable>NAME</replaceable> can be the string
263
<quote><literal>none</literal></quote>; this will make
264
<command>&COMMANDNAME;</command> only bring up interfaces
265
specified <emphasis>before</emphasis> this string. This
266
is not recommended, and only meant for advanced users.
320
<term><option>--delay=<replaceable
321
>SECONDS</replaceable></option></term>
324
After bringing a network interface up, the program waits
325
for the interface to arrive in a <quote>running</quote>
326
state before proceeding. During this time, the kernel log
327
level will be lowered to reduce clutter on the system
328
console, alleviating any other plugins which might be
329
using the system console. This option sets the upper
330
limit of seconds to wait. The default is 2.5 seconds.
336
<term><option>--retry=<replaceable
337
>SECONDS</replaceable></option></term>
340
All Mandos servers are tried repeatedly until a password
341
is received. This value specifies, in seconds, how long
342
between each successive try <emphasis>for the same
343
server</emphasis>. The default is 10 seconds.
349
<term><option>--network-hook-dir=<replaceable
350
>DIR</replaceable></option></term>
353
Network hook directory. The default directory is
354
<quote><filename class="directory"
355
>/lib/mandos/network-hooks.d</filename></quote>.
279
361
<term><option>--debug</option></term>
455
<refsect1 id="network-hooks">
456
<title>NETWORK HOOKS</title>
458
If a network interface like a bridge or tunnel is required to
459
find a Mandos server, this requires the interface to be up and
460
running before <command>&COMMANDNAME;</command> starts looking
461
for Mandos servers. This can be accomplished by creating a
462
<quote>network hook</quote> program, and placing it in a special
466
Before the network is used (and again before program exit), any
467
runnable programs found in the network hook directory are run
468
with the argument <quote><literal>start</literal></quote> or
469
<quote><literal>stop</literal></quote>. This should bring up or
470
down, respectively, any network interface which
471
<command>&COMMANDNAME;</command> should use.
473
<refsect2 id="hook-requirements">
474
<title>REQUIREMENTS</title>
476
A network hook must be an executable file, and its name must
477
consist entirely of upper and lower case letters, digits,
478
underscores, periods, and hyphens.
481
A network hook will receive one argument, which can be one of
486
<term><literal>start</literal></term>
489
This should make the network hook create (if necessary)
490
and bring up a network interface.
495
<term><literal>stop</literal></term>
498
This should make the network hook take down a network
499
interface, and delete it if it did not exist previously.
504
<term><literal>files</literal></term>
507
This should make the network hook print, <emphasis>one
508
file per line</emphasis>, all the files needed for it to
509
run. (These files will be copied into the initial RAM
510
filesystem.) Typical use is for a network hook which is
511
a shell script to print its needed binaries.
514
It is not necessary to print any non-executable files
515
already in the network hook directory, these will be
516
copied implicitly if they otherwise satisfy the name
522
<term><literal>modules</literal></term>
525
This should make the network hook print, <emphasis>on
526
separate lines</emphasis>, all the kernel modules needed
527
for it to run. (These modules will be copied into the
528
initial RAM filesystem.) For instance, a tunnel
530
<quote><literal>tun</literal></quote> module.
536
The network hook will be provided with a number of environment
541
<term><envar>MANDOSNETHOOKDIR</envar></term>
544
The network hook directory, specified to
545
<command>&COMMANDNAME;</command> by the
546
<option>--network-hook-dir</option> option. Note: this
547
should <emphasis>always</emphasis> be used by the
548
network hook to refer to itself or any files in the hook
549
directory it may require.
554
<term><envar>DEVICE</envar></term>
557
The network interfaces, as specified to
558
<command>&COMMANDNAME;</command> by the
559
<option>--interface</option> option, combined to one
560
string and separated by commas. If this is set, and
561
does not contain the interface a hook will bring up,
562
there is no reason for a hook to continue.
567
<term><envar>MODE</envar></term>
570
This will be the same as the first argument;
571
i.e. <quote><literal>start</literal></quote>,
572
<quote><literal>stop</literal></quote>,
573
<quote><literal>files</literal></quote>, or
574
<quote><literal>modules</literal></quote>.
579
<term><envar>VERBOSITY</envar></term>
582
This will be the <quote><literal>1</literal></quote> if
583
the <option>--debug</option> option is passed to
584
<command>&COMMANDNAME;</command>, otherwise
585
<quote><literal>0</literal></quote>.
590
<term><envar>DELAY</envar></term>
593
This will be the same as the <option>--delay</option>
594
option passed to <command>&COMMANDNAME;</command>. Is
595
only set if <envar>MODE</envar> is
596
<quote><literal>start</literal></quote> or
597
<quote><literal>stop</literal></quote>.
602
<term><envar>CONNECT</envar></term>
605
This will be the same as the <option>--connect</option>
606
option passed to <command>&COMMANDNAME;</command>. Is
607
only set if <option>--connect</option> is passed and
608
<envar>MODE</envar> is
609
<quote><literal>start</literal></quote> or
610
<quote><literal>stop</literal></quote>.
616
A hook may not read from standard input, and should be
617
restrictive in printing to standard output or standard error
618
unless <varname>VERBOSITY</varname> is
619
<quote><literal>1</literal></quote>.
624
<refsect1 id="files">
368
625
<title>FILES</title>
418
687
</informalexample>
419
688
<informalexample>
421
Run in debug mode, and use a custom key directory:
690
Run in debug mode, and use a custom key:
424
<!-- do not wrap this line -->
425
<userinput>&COMMANDNAME; --debug --keydir keydir</userinput>
694
<!-- do not wrap this line -->
695
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt</userinput>
427
698
</informalexample>
428
699
<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
701
Run in debug mode, with a custom key, and do not use Zeroconf
702
to locate a server; connect directly to the IPv6 link-local
432
703
address <quote><systemitem class="ipaddress"
433
>2001:db8:f983:bd0b:30de:ae4a:71f2:f672</systemitem></quote>,
434
port 4711, using interface eth2:
704
>fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
705
using interface eth2:
438
709
<!-- do not wrap this line -->
439
<userinput>&COMMANDNAME; --debug --keydir keydir --connect 2001:db8:f983:bd0b:30de:ae4a:71f2:f672:4711 --interface eth2</userinput>
710
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect fe80::aede:48ff:fe71:f6f2:4711 --interface eth2</userinput>
442
713
</informalexample>
445
716
<refsect1 id="security">
446
717
<title>SECURITY</title>
719
This program is set-uid to root, but will switch back to the
720
original (and presumably non-privileged) user and group after
721
bringing up the network interface.
724
To use this program for its intended purpose (see <xref
725
linkend="purpose"/>), the password for the root file system will
726
have to be given out to be stored in a server computer, after
727
having been encrypted using an OpenPGP key. This encrypted data
728
which will be stored in a server can only be decrypted by the
729
OpenPGP key, and the data will only be given out to those
730
clients who can prove they actually have that key. This key,
731
however, is stored unencrypted on the client side in its initial
732
<acronym>RAM</acronym> disk image file system. This is normally
733
readable by all, but this is normally fixed during installation
734
of this program; file permissions are set so that no-one is able
738
The only remaining weak point is that someone with physical
739
access to the client hard drive might turn off the client
740
computer, read the OpenPGP keys directly from the hard drive,
741
and communicate with the server. To safeguard against this, the
742
server is supposed to notice the client disappearing and stop
743
giving out the encrypted data. Therefore, it is important to
744
set the timeout and checker interval values tightly on the
745
server. See <citerefentry><refentrytitle
746
>mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
749
It will also help if the checker program on the server is
750
configured to request something from the client which can not be
751
spoofed by someone else on the network, like SSH server key
752
fingerprints, and unlike unencrypted <acronym>ICMP</acronym>
753
echo (<quote>ping</quote>) replies.
756
<emphasis>Note</emphasis>: This makes it completely insecure to
757
have <application >Mandos</application> clients which dual-boot
758
to another operating system which is <emphasis>not</emphasis>
759
trusted to keep the initial <acronym>RAM</acronym> disk image
451
764
<refsect1 id="see_also">
452
765
<title>SEE ALSO</title>
767
<citerefentry><refentrytitle>intro</refentrytitle>
768
<manvolnum>8mandos</manvolnum></citerefentry>,
769
<citerefentry><refentrytitle>cryptsetup</refentrytitle>
770
<manvolnum>8</manvolnum></citerefentry>,
771
<citerefentry><refentrytitle>crypttab</refentrytitle>
772
<manvolnum>5</manvolnum></citerefentry>,
454
773
<citerefentry><refentrytitle>mandos</refentrytitle>
455
774
<manvolnum>8</manvolnum></citerefentry>,
456
775
<citerefentry><refentrytitle>password-prompt</refentrytitle>
458
777
<citerefentry><refentrytitle>plugin-runner</refentrytitle>
459
778
<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>
783
<ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
787
Zeroconf is the network protocol standard used for finding
788
Mandos servers on the local network.
794
<ulink url="http://www.avahi.org/">Avahi</ulink>
798
Avahi is the library this program calls to find Zeroconf
805
<ulink url="http://www.gnu.org/software/gnutls/"
810
GnuTLS is the library this client uses to implement TLS for
811
communicating securely with the server, and at the same time
812
send the public OpenPGP key to the server.
818
<ulink url="http://www.gnupg.org/related_software/gpgme/"
823
GPGME is the library used to decrypt the OpenPGP data sent
830
RFC 4291: <citetitle>IP Version 6 Addressing
831
Architecture</citetitle>
836
<term>Section 2.2: <citetitle>Text Representation of
837
Addresses</citetitle></term>
838
<listitem><para/></listitem>
841
<term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
842
Address</citetitle></term>
843
<listitem><para/></listitem>
846
<term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
847
Addresses</citetitle></term>
850
This client uses IPv6 link-local addresses, which are
851
immediately usable since a link-local addresses is
852
automatically assigned to a network interface when it
862
RFC 4346: <citetitle>The Transport Layer Security (TLS)
863
Protocol Version 1.1</citetitle>
867
TLS 1.1 is the protocol implemented by GnuTLS.
873
RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
877
The data received from the server is binary encrypted
884
RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
889
This is implemented by GnuTLS and used by this program so
890
that OpenPGP keys can be used.
500
898
<!-- Local Variables: -->
501
899
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
502
900
<!-- time-stamp-end: "[\"']>" -->