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 "2023-10-21">
5
<!ENTITY TIMESTAMP "2015-06-29">
6
6
<!ENTITY % common SYSTEM "../common.ent">
96
90
<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>
114
94
<option>--priority <replaceable>STRING</replaceable></option>
169
145
brings up network interfaces, uses the interfaces’ IPv6
170
146
link-local addresses to get network connectivity, uses Zeroconf
171
147
to find servers on the local network, and communicates with
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
148
servers using TLS with an OpenPGP key to ensure authenticity and
149
confidentiality. This client program keeps running, trying all
150
servers on the network, until it receives a satisfactory reply
151
or a TERM signal. After all servers have been tried, all
176
152
servers are periodically retried. If no servers are found it
177
153
will wait indefinitely for new servers to appear.
198
174
This program is not meant to be run directly; it is really meant
199
to be run by other programs in the initial
200
<acronym>RAM</acronym> disk environment; see <xref
201
linkend="overview"/>.
175
to run as a plugin of the <application>Mandos</application>
176
<citerefentry><refentrytitle>plugin-runner</refentrytitle>
177
<manvolnum>8mandos</manvolnum></citerefentry>, which runs in the
178
initial <acronym>RAM</acronym> disk environment because it is
179
specified as a <quote>keyscript</quote> in the <citerefentry>
180
<refentrytitle>crypttab</refentrytitle><manvolnum>5</manvolnum>
181
</citerefentry> file.
216
196
<title>OPTIONS</title>
218
198
This program is commonly not invoked from the command line; it
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,
199
is normally started by the <application>Mandos</application>
200
plugin runner, see <citerefentry><refentrytitle
201
>plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum>
202
</citerefentry>. Any command line options this program accepts
203
are therefore normally provided by the plugin runner, and not
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
347
301
<term><option>--priority=<replaceable
348
302
>STRING</replaceable></option></term>
360
314
Sets the number of bits to use for the prime number in the
361
TLS Diffie-Hellman key exchange. The default value is
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
315
TLS Diffie-Hellman key exchange. Default is 1024.
476
409
<title>OVERVIEW</title>
477
410
<xi:include href="../overview.xml"/>
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.
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.
506
418
This program could, theoretically, be used as a keyscript in
507
419
<filename>/etc/crypttab</filename>, but it would then be
508
420
impossible to enter a password for the encrypted root disk at
509
421
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.
534
453
This environment variable will be assumed to contain the
535
454
directory containing any helper executables. The use and
536
nature of these helper executables, if any, is purposely
455
nature of these helper executables, if any, is
456
purposefully not documented.
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.
752
657
class="directory">/lib/mandos/network-hooks.d</filename></term>
766
<xi:include href="../bugs.xml"/>
669
<!-- <refsect1 id="bugs"> -->
670
<!-- <title>BUGS</title> -->
769
675
<refsect1 id="example">
770
676
<title>EXAMPLE</title>
772
678
Note that normally, command line options will not be given
773
directly, but passed on via the program responsible for starting
774
this program; see <xref linkend="overview"/>.
679
directly, but via options for the Mandos <citerefentry
680
><refentrytitle>plugin-runner</refentrytitle>
681
<manvolnum>8mandos</manvolnum></citerefentry>.
776
683
<informalexample>
794
701
</informalexample>
795
702
<informalexample>
797
Run in debug mode, and use custom keys:
704
Run in debug mode, and use a custom key:
801
708
<!-- do not wrap this line -->
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>
709
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt</userinput>
805
712
</informalexample>
806
713
<informalexample>
808
Run in debug mode, with custom keys, and do not use Zeroconf
715
Run in debug mode, with a custom key, and do not use Zeroconf
809
716
to locate a server; connect directly to the IPv6 link-local
810
717
address <quote><systemitem class="ipaddress"
811
718
>fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
823
730
<refsect1 id="security">
824
731
<title>SECURITY</title>
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.
733
This program is set-uid to root, but will switch back to the
734
original (and presumably non-privileged) user and group after
735
bringing up the network interface.
831
738
To use this program for its intended purpose (see <xref
845
752
The only remaining weak point is that someone with physical
846
753
access to the client hard drive might turn off the client
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
754
computer, read the OpenPGP keys directly from the hard drive,
755
and communicate with the server. To safeguard against this, the
756
server is supposed to notice the client disappearing and stop
757
giving out the encrypted data. Therefore, it is important to
758
set the timeout and checker interval values tightly on the
759
server. See <citerefentry><refentrytitle
853
760
>mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
879
786
<manvolnum>5</manvolnum></citerefentry>,
880
787
<citerefentry><refentrytitle>mandos</refentrytitle>
881
788
<manvolnum>8</manvolnum></citerefentry>,
882
<citerefentry><refentrytitle>password-agent</refentrytitle>
789
<citerefentry><refentrytitle>password-prompt</refentrytitle>
883
790
<manvolnum>8mandos</manvolnum></citerefentry>,
884
791
<citerefentry><refentrytitle>plugin-runner</refentrytitle>
885
792
<manvolnum>8mandos</manvolnum></citerefentry>
912
<ulink url="https://www.gnutls.org/">GnuTLS</ulink>
819
<ulink url="http://www.gnu.org/software/gnutls/"
916
824
GnuTLS is the library this client uses to implement TLS for
917
825
communicating securely with the server, and at the same time
918
send the public key to the server.
826
send the public OpenPGP key to the server.
924
<ulink url="https://www.gnupg.org/related_software/gpgme/"
832
<ulink url="http://www.gnupg.org/related_software/gpgme/"
968
RFC 5246: <citetitle>The Transport Layer Security (TLS)
969
Protocol Version 1.2</citetitle>
876
RFC 4346: <citetitle>The Transport Layer Security (TLS)
877
Protocol Version 1.1</citetitle>
973
TLS 1.2 is the protocol implemented by GnuTLS.
881
TLS 1.1 is the protocol implemented by GnuTLS.
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
898
RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
1005
899
Security</citetitle>
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
903
This is implemented by GnuTLS and used by this program so
904
that OpenPGP keys can be used.