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 "2016-02-28">
5
<!ENTITY TIMESTAMP "2025-06-27">
6
6
<!ENTITY % common SYSTEM "../common.ent">
93
101
<replaceable>FILE</replaceable></option></arg>
105
<arg choice="plain"><option>--tls-privkey
106
<replaceable>FILE</replaceable></option></arg>
107
<arg choice="plain"><option>-t
108
<replaceable>FILE</replaceable></option></arg>
112
<arg choice="plain"><option>--tls-pubkey
113
<replaceable>FILE</replaceable></option></arg>
114
<arg choice="plain"><option>-T
115
<replaceable>FILE</replaceable></option></arg>
97
119
<option>--priority <replaceable>STRING</replaceable></option>
152
174
brings up network interfaces, uses the interfaces’ IPv6
153
175
link-local addresses to get network connectivity, uses Zeroconf
154
176
to find servers on the local network, and communicates with
155
servers using TLS with an OpenPGP key to ensure authenticity and
156
confidentiality. This client program keeps running, trying all
157
servers on the network, until it receives a satisfactory reply
158
or a TERM signal. After all servers have been tried, all
177
servers using TLS with a raw public key to ensure authenticity
178
and confidentiality. This client program keeps running, trying
179
all servers on the network, until it receives a satisfactory
180
reply or a TERM signal. After all servers have been tried, all
159
181
servers are periodically retried. If no servers are found it
160
182
will wait indefinitely for new servers to appear.
181
203
This program is not meant to be run directly; it is really meant
182
to run as a plugin of the <application>Mandos</application>
183
<citerefentry><refentrytitle>plugin-runner</refentrytitle>
184
<manvolnum>8mandos</manvolnum></citerefentry>, which runs in the
185
initial <acronym>RAM</acronym> disk environment because it is
186
specified as a <quote>keyscript</quote> in the <citerefentry>
187
<refentrytitle>crypttab</refentrytitle><manvolnum>5</manvolnum>
188
</citerefentry> file.
204
to be run by other programs in the initial
205
<acronym>RAM</acronym> disk environment; see <xref
206
linkend="overview"/>.
203
221
<title>OPTIONS</title>
205
223
This program is commonly not invoked from the command line; it
206
is normally started by the <application>Mandos</application>
207
plugin runner, see <citerefentry><refentrytitle
208
>plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum>
209
</citerefentry>. Any command line options this program accepts
210
are therefore normally provided by the plugin runner, and not
224
is normally started by another program as described in <xref
225
linkend="description"/>. Any command line options this program
226
accepts are therefore normally provided by the invoking program,
324
<term><option>--tls-pubkey=<replaceable
325
>FILE</replaceable></option></term>
327
<replaceable>FILE</replaceable></option></term>
330
TLS raw public key file name. The default name is
331
<quote><filename>/conf/conf.d/mandos/tls-pubkey.pem</filename
338
<term><option>--tls-privkey=<replaceable
339
>FILE</replaceable></option></term>
341
<replaceable>FILE</replaceable></option></term>
344
TLS secret key file name. The default name is
345
<quote><filename>/conf/conf.d/mandos/tls-privkey.pem</filename
308
352
<term><option>--priority=<replaceable
309
353
>STRING</replaceable></option></term>
321
365
Sets the number of bits to use for the prime number in the
322
366
TLS Diffie-Hellman key exchange. The default value is
323
selected automatically based on the OpenPGP key. Note
324
that if the <option>--dh-params</option> option is used,
325
the values from that file will be used instead.
367
selected automatically based on the GnuTLS security
368
profile set in its priority string. Note that if the
369
<option>--dh-params</option> option is used, the values
370
from that file will be used instead.
436
481
<title>OVERVIEW</title>
437
482
<xi:include href="../overview.xml"/>
439
This program is the client part. It is a plugin started by
440
<citerefentry><refentrytitle>plugin-runner</refentrytitle>
441
<manvolnum>8mandos</manvolnum></citerefentry> which will run in
442
an initial <acronym>RAM</acronym> disk environment.
484
This program is the client part. It is run automatically in an
485
initial <acronym>RAM</acronym> disk environment.
488
In an initial <acronym>RAM</acronym> disk environment using
489
<citerefentry><refentrytitle>systemd</refentrytitle>
490
<manvolnum>1</manvolnum></citerefentry>, this program is started
491
by the <application>Mandos</application> <citerefentry>
492
<refentrytitle>password-agent</refentrytitle>
493
<manvolnum>8mandos</manvolnum></citerefentry>, which in turn is
494
started automatically by the <citerefentry>
495
<refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum>
496
</citerefentry> <quote>Password Agent</quote> system.
499
In the case of a non-<citerefentry>
500
<refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum>
501
</citerefentry> environment, this program is started as a plugin
502
of the <application>Mandos</application> <citerefentry>
503
<refentrytitle>plugin-runner</refentrytitle>
504
<manvolnum>8mandos</manvolnum></citerefentry>, which runs in the
505
initial <acronym>RAM</acronym> disk environment because it is
506
specified as a <quote>keyscript</quote> in the <citerefentry>
507
<refentrytitle>crypttab</refentrytitle><manvolnum>5</manvolnum>
508
</citerefentry> file.
445
511
This program could, theoretically, be used as a keyscript in
446
512
<filename>/etc/crypttab</filename>, but it would then be
447
513
impossible to enter a password for the encrypted root disk at
448
514
the console, since this program does not read from the console
449
at all. This is why a separate plugin runner (<citerefentry>
450
<refentrytitle>plugin-runner</refentrytitle>
451
<manvolnum>8mandos</manvolnum></citerefentry>) is used to run
452
both this program and others in in parallel,
453
<emphasis>one</emphasis> of which (<citerefentry>
454
<refentrytitle>password-prompt</refentrytitle>
455
<manvolnum>8mandos</manvolnum></citerefentry>) will prompt for
456
passwords on the system console.
480
539
This environment variable will be assumed to contain the
481
540
directory containing any helper executables. The use and
482
nature of these helper executables, if any, is
483
purposefully not documented.
541
nature of these helper executables, if any, is purposely
742
<term><filename>/conf/conf.d/mandos/tls-pubkey.pem</filename
744
<term><filename>/conf/conf.d/mandos/tls-privkey.pem</filename
748
Public and private raw key files, in <quote>PEM</quote>
749
format. These are the default file names, they can be
750
changed with the <option>--tls-pubkey</option> and
751
<option>--tls-privkey</option> options.
684
757
class="directory">/lib/mandos/network-hooks.d</filename></term>
696
<!-- <refsect1 id="bugs"> -->
697
<!-- <title>BUGS</title> -->
771
<xi:include href="../bugs.xml"/>
702
774
<refsect1 id="example">
703
775
<title>EXAMPLE</title>
705
777
Note that normally, command line options will not be given
706
directly, but via options for the Mandos <citerefentry
707
><refentrytitle>plugin-runner</refentrytitle>
708
<manvolnum>8mandos</manvolnum></citerefentry>.
778
directly, but passed on via the program responsible for starting
779
this program; see <xref linkend="overview"/>.
710
781
<informalexample>
728
799
</informalexample>
729
800
<informalexample>
731
Run in debug mode, and use a custom key:
802
Run in debug mode, and use custom keys:
735
806
<!-- do not wrap this line -->
736
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt</userinput>
807
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --tls-pubkey keydir/tls-pubkey.pem --tls-privkey keydir/tls-privkey.pem</userinput>
739
810
</informalexample>
740
811
<informalexample>
742
Run in debug mode, with a custom key, and do not use Zeroconf
813
Run in debug mode, with custom keys, and do not use Zeroconf
743
814
to locate a server; connect directly to the IPv6 link-local
744
815
address <quote><systemitem class="ipaddress"
745
816
>fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
757
828
<refsect1 id="security">
758
829
<title>SECURITY</title>
760
This program is set-uid to root, but will switch back to the
761
original (and presumably non-privileged) user and group after
762
bringing up the network interface.
831
This program assumes that it is set-uid to root, and will switch
832
back to the original (and presumably non-privileged) user and
833
group after bringing up the network interface.
765
836
To use this program for its intended purpose (see <xref
779
850
The only remaining weak point is that someone with physical
780
851
access to the client hard drive might turn off the client
781
computer, read the OpenPGP keys directly from the hard drive,
782
and communicate with the server. To safeguard against this, the
783
server is supposed to notice the client disappearing and stop
784
giving out the encrypted data. Therefore, it is important to
785
set the timeout and checker interval values tightly on the
786
server. See <citerefentry><refentrytitle
852
computer, read the OpenPGP and TLS keys directly from the hard
853
drive, and communicate with the server. To safeguard against
854
this, the server is supposed to notice the client disappearing
855
and stop giving out the encrypted data. Therefore, it is
856
important to set the timeout and checker interval values tightly
857
on the server. See <citerefentry><refentrytitle
787
858
>mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
813
884
<manvolnum>5</manvolnum></citerefentry>,
814
885
<citerefentry><refentrytitle>mandos</refentrytitle>
815
886
<manvolnum>8</manvolnum></citerefentry>,
816
<citerefentry><refentrytitle>password-prompt</refentrytitle>
887
<citerefentry><refentrytitle>password-agent</refentrytitle>
817
888
<manvolnum>8mandos</manvolnum></citerefentry>,
818
889
<citerefentry><refentrytitle>plugin-runner</refentrytitle>
819
890
<manvolnum>8mandos</manvolnum></citerefentry>
846
<ulink url="http://www.gnu.org/software/gnutls/"
917
<ulink url="https://www.gnutls.org/">GnuTLS</ulink>
851
921
GnuTLS is the library this client uses to implement TLS for
852
922
communicating securely with the server, and at the same time
853
send the public OpenPGP key to the server.
923
send the public key to the server.
859
<ulink url="http://www.gnupg.org/related_software/gpgme/"
929
<ulink url="https://www.gnupg.org/related_software/gpgme/"
903
RFC 4346: <citetitle>The Transport Layer Security (TLS)
904
Protocol Version 1.1</citetitle>
973
RFC 5246: <citetitle>The Transport Layer Security (TLS)
974
Protocol Version 1.2</citetitle>
908
TLS 1.1 is the protocol implemented by GnuTLS.
978
TLS 1.2 is the protocol implemented by GnuTLS.
925
RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
995
RFC 7250: <citetitle>Using Raw Public Keys in Transport
996
Layer Security (TLS) and Datagram Transport Layer Security
1001
This is implemented by GnuTLS in version 3.6.6 and is, if
1002
present, used by this program so that raw public keys can be
1009
RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
926
1010
Security</citetitle>
930
This is implemented by GnuTLS and used by this program so
931
that OpenPGP keys can be used.
1014
This is implemented by GnuTLS before version 3.6.0 and is,
1015
if present, used by this program so that OpenPGP keys can be
added
removed
plugins.d/mandos-client.xml
