54
54
<command>&COMMANDNAME;</command>
56
56
<arg choice="plain"><option>--connect
57
<replaceable>ADDRESS</replaceable><literal>:</literal
57
<replaceable>IPADDR</replaceable><literal>:</literal
58
58
><replaceable>PORT</replaceable></option></arg>
59
59
<arg choice="plain"><option>-c
60
<replaceable>ADDRESS</replaceable><literal>:</literal
60
<replaceable>IPADDR</replaceable><literal>:</literal
61
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>
65
72
<arg choice="plain"><option>--interface
66
73
<replaceable>NAME</replaceable></option></arg>
67
74
<arg choice="plain"><option>-i
124
131
network connectivity, Zeroconf to find servers, and TLS with an
125
132
OpenPGP key to ensure authenticity and confidentiality. It
126
133
keeps running, trying all servers on the network, until it
127
receives a satisfactory reply or a TERM signal is received.
134
receives a satisfactory reply or a TERM signal is recieved.
130
137
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).
187
210
<term><option>--interface=
188
211
<replaceable>NAME</replaceable></option></term>
209
232
<replaceable>FILE</replaceable></option></term>
212
OpenPGP public key file name. The default name is
213
<quote><filename>/conf/conf.d/mandos/pubkey.txt</filename
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>.
223
247
<replaceable>FILE</replaceable></option></term>
226
OpenPGP secret key file name. The default name is
227
<quote><filename>/conf/conf.d/mandos/seckey.txt</filename
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>.
311
336
<filename>/etc/crypttab</filename>, but it would then be
312
337
impossible to enter a password for the encrypted root disk at
313
338
the console, since this program does not read from the console
314
at all. This is why a separate plugin (<citerefentry>
315
<refentrytitle>password-prompt</refentrytitle>
316
<manvolnum>8mandos</manvolnum></citerefentry>) does that, which
317
will be run in parallel to this one by the plugin runner.
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.
396
418
</informalexample>
397
419
<informalexample>
399
Run in debug mode, and use a custom key:
421
Run in debug mode, and use a custom key directory:
403
<!-- do not wrap this line -->
404
<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>
407
427
</informalexample>
408
428
<informalexample>
410
Run in debug mode, with a custom key, and do not use Zeroconf
411
to locate a server; connect directly to the IPv6 address
412
<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"
413
433
>2001:db8:f983:bd0b:30de:ae4a:71f2:f672</systemitem></quote>,
414
434
port 4711, using interface eth2:
418
438
<!-- do not wrap this line -->
419
<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>
422
442
</informalexample>
425
445
<refsect1 id="security">
426
446
<title>SECURITY</title>
428
This program is set-uid to root, but will switch back to the
429
original (and presumably non-privileged) user and group after
430
bringing up the network interface.
433
To use this program for its intended purpose (see <xref
434
linkend="purpose"/>), the password for the root file system will
435
have to be given out to be stored in a server computer, after
436
having been encrypted using an OpenPGP key. This encrypted data
437
which will be stored in a server can only be decrypted by the
438
OpenPGP key, and the data will only be given out to those
439
clients who can prove they actually have that key. This key,
440
however, is stored unencrypted on the client side in its initial
441
<acronym>RAM</acronym> disk image file system. This is normally
442
readable by all, but this is normally fixed during installation
443
of this program; file permissions are set so that no-one is able
447
The only remaining weak point is that someone with physical
448
access to the client hard drive might turn off the client
449
computer, read the OpenPGP keys directly from the hard drive,
450
and communicate with the server. The defense against this is
451
that the server is supposed to notice the client disappearing
452
and will stop giving out the encrypted data. Therefore, it is
453
important to set the timeout and checker interval values tightly
454
on the server. See <citerefentry><refentrytitle
455
>mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
458
It will also help if the checker program on the server is
459
configured to request something from the client which can not be
460
spoofed by someone else on the network, unlike unencrypted
461
<acronym>ICMP</acronym> echo (<quote>ping</quote>) replies.
464
<emphasis>Note</emphasis>: This makes it completely insecure to
465
have <application >Mandos</application> clients which dual-boot
466
to another operating system which is <emphasis>not</emphasis>
467
trusted to keep the initial <acronym>RAM</acronym> disk image
472
451
<refsect1 id="see_also">
473
452
<title>SEE ALSO</title>
475
<citerefentry><refentrytitle>cryptsetup</refentrytitle>
476
<manvolnum>8</manvolnum></citerefentry>,
477
<citerefentry><refentrytitle>crypttab</refentrytitle>
478
<manvolnum>5</manvolnum></citerefentry>,
479
454
<citerefentry><refentrytitle>mandos</refentrytitle>
480
455
<manvolnum>8</manvolnum></citerefentry>,
481
456
<citerefentry><refentrytitle>password-prompt</refentrytitle>
483
458
<citerefentry><refentrytitle>plugin-runner</refentrytitle>
484
459
<manvolnum>8mandos</manvolnum></citerefentry>
489
<ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
493
Zeroconf is the network protocol standard used for finding
494
Mandos servers on the local network.
500
<ulink url="http://www.avahi.org/">Avahi</ulink>
504
Avahi is the library this program calls to find Zeroconf
511
<ulink url="http://www.gnu.org/software/gnutls/"
516
GnuTLS is the library this client uses to implement TLS for
517
communicating securely with the server, and at the same time
518
send the public OpenPGP key to the server.
524
<ulink url="http://www.gnupg.org/related_software/gpgme/"
529
GPGME is the library used to decrypt the OpenPGP data sent
536
RFC 4291: <citetitle>IP Version 6 Addressing
537
Architecture</citetitle>
542
<term>Section 2.2: <citetitle>Text Representation of
543
Addresses</citetitle></term>
544
<listitem><para/></listitem>
547
<term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
548
Address</citetitle></term>
549
<listitem><para/></listitem>
552
<term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
553
Addresses</citetitle></term>
556
This client uses IPv6 link-local addresses, which are
557
immediately usable since a link-local addresses is
558
automatically assigned to a network interfaces when it
568
RFC 4346: <citetitle>The Transport Layer Security (TLS)
569
Protocol Version 1.1</citetitle>
573
TLS 1.1 is the protocol implemented by GnuTLS.
579
RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
583
The data received from the server is binary encrypted
590
RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
595
This is implemented by GnuTLS and used by this program so
596
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>