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
123
128
communicates with <citerefentry><refentrytitle
124
129
>mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>
125
130
to get a password. It uses IPv6 link-local addresses to get
126
network connectivity, Zeroconf to find servers, and TLS with an
127
OpenPGP key to ensure authenticity and confidentiality. It
131
network connectivity, Zeroconf to find the server, and TLS with
132
an OpenPGP key to ensure authenticity and confidentiality. It
128
133
keeps running, trying all servers on the network, until it
129
receives a satisfactory reply or a TERM signal is received.
134
receives a satisfactory reply.
132
137
This program is not meant to be run directly; it is really meant
133
138
to run as a plugin of the <application>Mandos</application>
134
139
<citerefentry><refentrytitle>plugin-runner</refentrytitle>
135
<manvolnum>8mandos</manvolnum></citerefentry>, which runs in the
136
initial <acronym>RAM</acronym> disk environment because it is
137
specified as a <quote>keyscript</quote> in the <citerefentry>
138
<refentrytitle>crypttab</refentrytitle><manvolnum>5</manvolnum>
139
</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.
302
<refsect1 id="overview">
303
<title>OVERVIEW</title>
304
<xi:include href="../overview.xml"/>
306
This program is the client part. It is a plugin started by
307
<citerefentry><refentrytitle>plugin-runner</refentrytitle>
308
<manvolnum>8mandos</manvolnum></citerefentry> which will run in
309
an initial <acronym>RAM</acronym> disk environment.
312
This program could, theoretically, be used as a keyscript in
313
<filename>/etc/crypttab</filename>, but it would then be
314
impossible to enter a password for the encrypted root disk at
315
the console, since this program does not read from the console
316
at all. This is why a separate plugin runner (<citerefentry>
317
<refentrytitle>plugin-runner</refentrytitle>
318
<manvolnum>8mandos</manvolnum></citerefentry>) is used to run
319
both this program and others in in parallel,
320
<emphasis>one</emphasis> of which will prompt for passwords on
325
336
<refsect1 id="exit_status">
326
337
<title>EXIT STATUS</title>
330
341
successfully decrypted and output on standard output. The
331
342
program will exit with a non-zero exit status only if a critical
332
343
error occurs. Otherwise, it will forever connect to new
333
<application>Mandos</application> servers as they appear, trying
334
to get a decryptable password and print it.
338
<refsect1 id="environment">
339
<title>ENVIRONMENT</title>
341
This program does not use any environment variables, not even
342
the ones provided by <citerefentry><refentrytitle
343
>cryptsetup</refentrytitle><manvolnum>8</manvolnum>
348
<refsect1 id="files">
352
<term><filename>/conf/conf.d/mandos/pubkey.txt</filename
354
<term><filename>/conf/conf.d/mandos/seckey.txt</filename
358
OpenPGP public and private key files, in <quote>ASCII
359
Armor</quote> format. These are the default file names,
360
they can be changed with the <option>--pubkey</option> and
361
<option>--seckey</option> options.
368
<!-- <refsect1 id="bugs"> -->
369
<!-- <title>BUGS</title> -->
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. -->
372
354
<!-- </refsect1> -->
374
368
<refsect1 id="example">
375
369
<title>EXAMPLE</title>
377
Note that normally, command line options will not be given
378
directly, but via options for the Mandos <citerefentry
379
><refentrytitle>plugin-runner</refentrytitle>
380
<manvolnum>8mandos</manvolnum></citerefentry>.
384
Normal invocation needs no options, if the network interface
385
is <quote>eth0</quote>:
388
<userinput>&COMMANDNAME;</userinput>
393
Search for Mandos servers (and connect to them) using another
397
<!-- do not wrap this line -->
398
<userinput>&COMMANDNAME; --interface eth1</userinput>
403
Run in debug mode, and use a custom key:
407
<!-- do not wrap this line -->
408
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt</userinput>
414
Run in debug mode, with a custom key, and do not use Zeroconf
415
to locate a server; connect directly to the IPv6 address
416
<quote><systemitem class="ipaddress"
417
>2001:db8:f983:bd0b:30de:ae4a:71f2:f672</systemitem></quote>,
418
port 4711, using interface eth2:
422
<!-- do not wrap this line -->
423
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect 2001:db8:f983:bd0b:30de:ae4a:71f2:f672:4711 --interface eth2</userinput>
429
374
<refsect1 id="security">
430
375
<title>SECURITY</title>
432
This program is set-uid to root, but will switch back to the
433
original (and presumably non-privileged) user and group after
434
bringing up the network interface.
437
To use this program for its intended purpose (see <xref
438
linkend="purpose"/>), the password for the root file system will
439
have to be given out to be stored in a server computer, after
440
having been encrypted using an OpenPGP key. This encrypted data
441
which will be stored in a server can only be decrypted by the
442
OpenPGP key, and the data will only be given out to those
443
clients who can prove they actually have that key. This key,
444
however, is stored unencrypted on the client side in its initial
445
<acronym>RAM</acronym> disk image file system. This is normally
446
readable by all, but this is normally fixed during installation
447
of this program; file permissions are set so that no-one is able
451
The only remaining weak point is that someone with physical
452
access to the client hard drive might turn off the client
453
computer, read the OpenPGP keys directly from the hard drive,
454
and communicate with the server. To safeguard against this, the
455
server is supposed to notice the client disappearing and stop
456
giving out the encrypted data. Therefore, it is important to
457
set the timeout and checker interval values tightly on the
458
server. See <citerefentry><refentrytitle
459
>mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
462
It will also help if the checker program on the server is
463
configured to request something from the client which can not be
464
spoofed by someone else on the network, unlike unencrypted
465
<acronym>ICMP</acronym> echo (<quote>ping</quote>) replies.
468
<emphasis>Note</emphasis>: This makes it completely insecure to
469
have <application >Mandos</application> clients which dual-boot
470
to another operating system which is <emphasis>not</emphasis>
471
trusted to keep the initial <acronym>RAM</acronym> disk image
476
380
<refsect1 id="see_also">
477
381
<title>SEE ALSO</title>
479
<citerefentry><refentrytitle>cryptsetup</refentrytitle>
480
<manvolnum>8</manvolnum></citerefentry>,
481
<citerefentry><refentrytitle>crypttab</refentrytitle>
482
<manvolnum>5</manvolnum></citerefentry>,
483
383
<citerefentry><refentrytitle>mandos</refentrytitle>
484
384
<manvolnum>8</manvolnum></citerefentry>,
485
385
<citerefentry><refentrytitle>password-prompt</refentrytitle>
487
387
<citerefentry><refentrytitle>plugin-runner</refentrytitle>
488
388
<manvolnum>8mandos</manvolnum></citerefentry>
493
<ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
497
Zeroconf is the network protocol standard used for finding
498
Mandos servers on the local network.
504
<ulink url="http://www.avahi.org/">Avahi</ulink>
508
Avahi is the library this program calls to find Zeroconf
515
<ulink url="http://www.gnu.org/software/gnutls/"
520
GnuTLS is the library this client uses to implement TLS for
521
communicating securely with the server, and at the same time
522
send the public OpenPGP key to the server.
528
<ulink url="http://www.gnupg.org/related_software/gpgme/"
533
GPGME is the library used to decrypt the OpenPGP data sent
540
RFC 4291: <citetitle>IP Version 6 Addressing
541
Architecture</citetitle>
546
<term>Section 2.2: <citetitle>Text Representation of
547
Addresses</citetitle></term>
548
<listitem><para/></listitem>
551
<term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
552
Address</citetitle></term>
553
<listitem><para/></listitem>
556
<term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
557
Addresses</citetitle></term>
560
This client uses IPv6 link-local addresses, which are
561
immediately usable since a link-local addresses is
562
automatically assigned to a network interfaces when it
572
RFC 4346: <citetitle>The Transport Layer Security (TLS)
573
Protocol Version 1.1</citetitle>
577
TLS 1.1 is the protocol implemented by GnuTLS.
583
RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
587
The data received from the server is binary encrypted
594
RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
599
This is implemented by GnuTLS and used by this program so
600
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>
608
429
<!-- Local Variables: -->
609
430
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
610
431
<!-- time-stamp-end: "[\"']>" -->