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
4
<!ENTITY COMMANDNAME "mandos-client">
5
<!ENTITY TIMESTAMP "2015-03-08">
5
<!ENTITY TIMESTAMP "2023-10-21">
6
6
<!ENTITY % common SYSTEM "../common.ent">
89
96
<replaceable>FILE</replaceable></option></arg>
100
<arg choice="plain"><option>--tls-privkey
101
<replaceable>FILE</replaceable></option></arg>
102
<arg choice="plain"><option>-t
103
<replaceable>FILE</replaceable></option></arg>
107
<arg choice="plain"><option>--tls-pubkey
108
<replaceable>FILE</replaceable></option></arg>
109
<arg choice="plain"><option>-T
110
<replaceable>FILE</replaceable></option></arg>
93
114
<option>--priority <replaceable>STRING</replaceable></option>
144
169
brings up network interfaces, uses the interfaces’ IPv6
145
170
link-local addresses to get network connectivity, uses Zeroconf
146
171
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
172
servers using TLS with a raw public key to ensure authenticity
173
and confidentiality. This client program keeps running, trying
174
all servers on the network, until it receives a satisfactory
175
reply or a TERM signal. After all servers have been tried, all
151
176
servers are periodically retried. If no servers are found it
152
177
will wait indefinitely for new servers to appear.
173
198
This program is not meant to be run directly; it is really meant
174
to run as a plugin of the <application>Mandos</application>
175
<citerefentry><refentrytitle>plugin-runner</refentrytitle>
176
<manvolnum>8mandos</manvolnum></citerefentry>, which runs in the
177
initial <acronym>RAM</acronym> disk environment because it is
178
specified as a <quote>keyscript</quote> in the <citerefentry>
179
<refentrytitle>crypttab</refentrytitle><manvolnum>5</manvolnum>
180
</citerefentry> file.
199
to be run by other programs in the initial
200
<acronym>RAM</acronym> disk environment; see <xref
201
linkend="overview"/>.
195
216
<title>OPTIONS</title>
197
218
This program is commonly not invoked from the command line; it
198
is normally started by the <application>Mandos</application>
199
plugin runner, see <citerefentry><refentrytitle
200
>plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum>
201
</citerefentry>. Any command line options this program accepts
202
are therefore normally provided by the plugin runner, and not
219
is normally started by another program as described in <xref
220
linkend="description"/>. Any command line options this program
221
accepts are therefore normally provided by the invoking program,
319
<term><option>--tls-pubkey=<replaceable
320
>FILE</replaceable></option></term>
322
<replaceable>FILE</replaceable></option></term>
325
TLS raw public key file name. The default name is
326
<quote><filename>/conf/conf.d/mandos/tls-pubkey.pem</filename
333
<term><option>--tls-privkey=<replaceable
334
>FILE</replaceable></option></term>
336
<replaceable>FILE</replaceable></option></term>
339
TLS secret key file name. The default name is
340
<quote><filename>/conf/conf.d/mandos/tls-privkey.pem</filename
300
347
<term><option>--priority=<replaceable
301
348
>STRING</replaceable></option></term>
313
360
Sets the number of bits to use for the prime number in the
314
361
TLS Diffie-Hellman key exchange. The default value is
315
selected automatically based on the OpenPGP key.
362
selected automatically based on the GnuTLS security
363
profile set in its priority string. Note that if the
364
<option>--dh-params</option> option is used, the values
365
from that file will be used instead.
371
<term><option>--dh-params=<replaceable
372
>FILE</replaceable></option></term>
375
Specifies a PEM-encoded PKCS#3 file to read the parameters
376
needed by the TLS Diffie-Hellman key exchange from. If
377
this option is not given, or if the file for some reason
378
could not be used, the parameters will be generated on
379
startup, which will take some time and processing power.
380
Those using servers running under time, power or processor
381
constraints may want to generate such a file in advance
409
476
<title>OVERVIEW</title>
410
477
<xi:include href="../overview.xml"/>
412
This program is the client part. It is a plugin started by
413
<citerefentry><refentrytitle>plugin-runner</refentrytitle>
414
<manvolnum>8mandos</manvolnum></citerefentry> which will run in
415
an initial <acronym>RAM</acronym> disk environment.
479
This program is the client part. It is run automatically in an
480
initial <acronym>RAM</acronym> disk environment.
483
In an initial <acronym>RAM</acronym> disk environment using
484
<citerefentry><refentrytitle>systemd</refentrytitle>
485
<manvolnum>1</manvolnum></citerefentry>, this program is started
486
by the <application>Mandos</application> <citerefentry>
487
<refentrytitle>password-agent</refentrytitle>
488
<manvolnum>8mandos</manvolnum></citerefentry>, which in turn is
489
started automatically by the <citerefentry>
490
<refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum>
491
</citerefentry> <quote>Password Agent</quote> system.
494
In the case of a non-<citerefentry>
495
<refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum>
496
</citerefentry> environment, this program is started as a plugin
497
of the <application>Mandos</application> <citerefentry>
498
<refentrytitle>plugin-runner</refentrytitle>
499
<manvolnum>8mandos</manvolnum></citerefentry>, which runs in the
500
initial <acronym>RAM</acronym> disk environment because it is
501
specified as a <quote>keyscript</quote> in the <citerefentry>
502
<refentrytitle>crypttab</refentrytitle><manvolnum>5</manvolnum>
503
</citerefentry> file.
418
506
This program could, theoretically, be used as a keyscript in
419
507
<filename>/etc/crypttab</filename>, but it would then be
420
508
impossible to enter a password for the encrypted root disk at
421
509
the console, since this program does not read from the console
422
at all. This is why a separate plugin runner (<citerefentry>
423
<refentrytitle>plugin-runner</refentrytitle>
424
<manvolnum>8mandos</manvolnum></citerefentry>) is used to run
425
both this program and others in in parallel,
426
<emphasis>one</emphasis> of which (<citerefentry>
427
<refentrytitle>password-prompt</refentrytitle>
428
<manvolnum>8mandos</manvolnum></citerefentry>) will prompt for
429
passwords on the system console.
446
527
<refsect1 id="environment">
447
528
<title>ENVIRONMENT</title>
531
<term><envar>MANDOSPLUGINHELPERDIR</envar></term>
534
This environment variable will be assumed to contain the
535
directory containing any helper executables. The use and
536
nature of these helper executables, if any, is purposely
449
This program does not use any environment variables, not even
450
the ones provided by <citerefentry><refentrytitle
543
This program does not use any other environment variables, not
544
even the ones provided by <citerefentry><refentrytitle
451
545
>cryptsetup</refentrytitle><manvolnum>8</manvolnum>
737
<term><filename>/conf/conf.d/mandos/tls-pubkey.pem</filename
739
<term><filename>/conf/conf.d/mandos/tls-privkey.pem</filename
743
Public and private raw key files, in <quote>PEM</quote>
744
format. These are the default file names, they can be
745
changed with the <option>--tls-pubkey</option> and
746
<option>--tls-privkey</option> options.
644
752
class="directory">/lib/mandos/network-hooks.d</filename></term>
656
<!-- <refsect1 id="bugs"> -->
657
<!-- <title>BUGS</title> -->
766
<xi:include href="../bugs.xml"/>
662
769
<refsect1 id="example">
663
770
<title>EXAMPLE</title>
665
772
Note that normally, command line options will not be given
666
directly, but via options for the Mandos <citerefentry
667
><refentrytitle>plugin-runner</refentrytitle>
668
<manvolnum>8mandos</manvolnum></citerefentry>.
773
directly, but passed on via the program responsible for starting
774
this program; see <xref linkend="overview"/>.
670
776
<informalexample>
688
794
</informalexample>
689
795
<informalexample>
691
Run in debug mode, and use a custom key:
797
Run in debug mode, and use custom keys:
695
801
<!-- do not wrap this line -->
696
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt</userinput>
802
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --tls-pubkey keydir/tls-pubkey.pem --tls-privkey keydir/tls-privkey.pem</userinput>
699
805
</informalexample>
700
806
<informalexample>
702
Run in debug mode, with a custom key, and do not use Zeroconf
808
Run in debug mode, with custom keys, and do not use Zeroconf
703
809
to locate a server; connect directly to the IPv6 link-local
704
810
address <quote><systemitem class="ipaddress"
705
811
>fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
717
823
<refsect1 id="security">
718
824
<title>SECURITY</title>
720
This program is set-uid to root, but will switch back to the
721
original (and presumably non-privileged) user and group after
722
bringing up the network interface.
826
This program assumes that it is set-uid to root, and will switch
827
back to the original (and presumably non-privileged) user and
828
group after bringing up the network interface.
725
831
To use this program for its intended purpose (see <xref
739
845
The only remaining weak point is that someone with physical
740
846
access to the client hard drive might turn off the client
741
computer, read the OpenPGP keys directly from the hard drive,
742
and communicate with the server. To safeguard against this, the
743
server is supposed to notice the client disappearing and stop
744
giving out the encrypted data. Therefore, it is important to
745
set the timeout and checker interval values tightly on the
746
server. See <citerefentry><refentrytitle
847
computer, read the OpenPGP and TLS keys directly from the hard
848
drive, and communicate with the server. To safeguard against
849
this, the server is supposed to notice the client disappearing
850
and stop giving out the encrypted data. Therefore, it is
851
important to set the timeout and checker interval values tightly
852
on the server. See <citerefentry><refentrytitle
747
853
>mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
773
879
<manvolnum>5</manvolnum></citerefentry>,
774
880
<citerefentry><refentrytitle>mandos</refentrytitle>
775
881
<manvolnum>8</manvolnum></citerefentry>,
776
<citerefentry><refentrytitle>password-prompt</refentrytitle>
882
<citerefentry><refentrytitle>password-agent</refentrytitle>
777
883
<manvolnum>8mandos</manvolnum></citerefentry>,
778
884
<citerefentry><refentrytitle>plugin-runner</refentrytitle>
779
885
<manvolnum>8mandos</manvolnum></citerefentry>
806
<ulink url="http://www.gnu.org/software/gnutls/"
912
<ulink url="https://www.gnutls.org/">GnuTLS</ulink>
811
916
GnuTLS is the library this client uses to implement TLS for
812
917
communicating securely with the server, and at the same time
813
send the public OpenPGP key to the server.
918
send the public key to the server.
819
<ulink url="http://www.gnupg.org/related_software/gpgme/"
924
<ulink url="https://www.gnupg.org/related_software/gpgme/"
863
RFC 4346: <citetitle>The Transport Layer Security (TLS)
864
Protocol Version 1.1</citetitle>
968
RFC 5246: <citetitle>The Transport Layer Security (TLS)
969
Protocol Version 1.2</citetitle>
868
TLS 1.1 is the protocol implemented by GnuTLS.
973
TLS 1.2 is the protocol implemented by GnuTLS.
885
RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
990
RFC 7250: <citetitle>Using Raw Public Keys in Transport
991
Layer Security (TLS) and Datagram Transport Layer Security
996
This is implemented by GnuTLS in version 3.6.6 and is, if
997
present, used by this program so that raw public keys can be
1004
RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
886
1005
Security</citetitle>
890
This is implemented by GnuTLS and used by this program so
891
that OpenPGP keys can be used.
1009
This is implemented by GnuTLS before version 3.6.0 and is,
1010
if present, used by this program so that OpenPGP keys can be
added
removed
plugins.d/mandos-client.xml
