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 "2012-06-13">
5
<!ENTITY TIMESTAMP "2019-07-24">
6
6
<!ENTITY % common SYSTEM "../common.ent">
87
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>
91
114
<option>--priority <replaceable>STRING</replaceable></option>
142
169
brings up network interfaces, uses the interfaces’ IPv6
143
170
link-local addresses to get network connectivity, uses Zeroconf
144
171
to find servers on the local network, and communicates with
145
servers using TLS with an OpenPGP key to ensure authenticity and
146
confidentiality. This client program keeps running, trying all
147
servers on the network, until it receives a satisfactory reply
148
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
149
176
servers are periodically retried. If no servers are found it
150
177
will wait indefinitely for new servers to appear.
218
245
assumed to separate the address from the port number.
221
This option is normally only useful for testing and
248
Normally, Zeroconf would be used to locate Mandos servers,
249
in which case this option would only be used when testing
228
256
<term><option>--interface=<replaceable
229
>NAME</replaceable></option></term>
257
>NAME</replaceable><arg rep='repeat'>,<replaceable
258
>NAME</replaceable></arg></option></term>
231
<replaceable>NAME</replaceable></option></term>
260
<replaceable>NAME</replaceable><arg rep='repeat'>,<replaceable
261
>NAME</replaceable></arg></option></term>
234
264
Comma separated list of network interfaces that will be
237
267
use all appropriate interfaces.
240
If the <option>--connect</option> option is used, this
241
specifies the interface to use to connect to the address
270
If the <option>--connect</option> option is used, and
271
exactly one interface name is specified (except
272
<quote><literal>none</literal></quote>), this specifies
273
the interface to use to connect to the address given.
245
276
Note that since this program will normally run in the
256
287
<replaceable>NAME</replaceable> can be the string
257
<quote><literal>none</literal></quote>; this will not use
258
any specific interface, and will not bring up an interface
259
on startup. This is not recommended, and only meant for
288
<quote><literal>none</literal></quote>; this will make
289
<command>&COMMANDNAME;</command> only bring up interfaces
290
specified <emphasis>before</emphasis> this string. This
291
is not recommended, and only meant for advanced users.
325
<term><option>--tls-pubkey=<replaceable
326
>FILE</replaceable></option></term>
328
<replaceable>FILE</replaceable></option></term>
331
TLS raw public key file name. The default name is
332
<quote><filename>/conf/conf.d/mandos/tls-pubkey.pem</filename
339
<term><option>--tls-privkey=<replaceable
340
>FILE</replaceable></option></term>
342
<replaceable>FILE</replaceable></option></term>
345
TLS secret key file name. The default name is
346
<quote><filename>/conf/conf.d/mandos/tls-privkey.pem</filename
294
353
<term><option>--priority=<replaceable
295
354
>STRING</replaceable></option></term>
307
366
Sets the number of bits to use for the prime number in the
308
TLS Diffie-Hellman key exchange. Default is 1024.
367
TLS Diffie-Hellman key exchange. The default value is
368
selected automatically based on the GnuTLS security
369
profile set in its priority string. Note that if the
370
<option>--dh-params</option> option is used, the values
371
from that file will be used instead.
377
<term><option>--dh-params=<replaceable
378
>FILE</replaceable></option></term>
381
Specifies a PEM-encoded PKCS#3 file to read the parameters
382
needed by the TLS Diffie-Hellman key exchange from. If
383
this option is not given, or if the file for some reason
384
could not be used, the parameters will be generated on
385
startup, which will take some time and processing power.
386
Those using servers running under time, power or processor
387
constraints may want to generate such a file in advance
439
519
<refsect1 id="environment">
440
520
<title>ENVIRONMENT</title>
523
<term><envar>MANDOSPLUGINHELPERDIR</envar></term>
526
This environment variable will be assumed to contain the
527
directory containing any helper executables. The use and
528
nature of these helper executables, if any, is purposely
442
This program does not use any environment variables, not even
443
the ones provided by <citerefentry><refentrytitle
535
This program does not use any other environment variables, not
536
even the ones provided by <citerefentry><refentrytitle
444
537
>cryptsetup</refentrytitle><manvolnum>8</manvolnum>
729
<term><filename>/conf/conf.d/mandos/tls-pubkey.pem</filename
731
<term><filename>/conf/conf.d/mandos/tls-privkey.pem</filename
735
Public and private raw key files, in <quote>PEM</quote>
736
format. These are the default file names, they can be
737
changed with the <option>--tls-pubkey</option> and
738
<option>--tls-privkey</option> options.
637
744
class="directory">/lib/mandos/network-hooks.d</filename></term>
681
787
</informalexample>
682
788
<informalexample>
684
Run in debug mode, and use a custom key:
790
Run in debug mode, and use custom keys:
688
794
<!-- do not wrap this line -->
689
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt</userinput>
795
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --tls-pubkey keydir/tls-pubkey.pem --tls-privkey keydir/tls-privkey.pem</userinput>
692
798
</informalexample>
693
799
<informalexample>
695
Run in debug mode, with a custom key, and do not use Zeroconf
801
Run in debug mode, with custom keys, and do not use Zeroconf
696
802
to locate a server; connect directly to the IPv6 link-local
697
803
address <quote><systemitem class="ipaddress"
698
804
>fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
703
809
<!-- do not wrap this line -->
704
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect fe80::aede:48ff:fe71:f6f2:4711 --interface eth2</userinput>
810
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --tls-pubkey keydir/tls-pubkey.pem --tls-privkey keydir/tls-privkey.pem --connect fe80::aede:48ff:fe71:f6f2:4711 --interface eth2</userinput>
707
813
</informalexample>
710
816
<refsect1 id="security">
711
817
<title>SECURITY</title>
713
This program is set-uid to root, but will switch back to the
714
original (and presumably non-privileged) user and group after
715
bringing up the network interface.
819
This program assumes that it is set-uid to root, and will switch
820
back to the original (and presumably non-privileged) user and
821
group after bringing up the network interface.
718
824
To use this program for its intended purpose (see <xref
732
838
The only remaining weak point is that someone with physical
733
839
access to the client hard drive might turn off the client
734
computer, read the OpenPGP keys directly from the hard drive,
735
and communicate with the server. To safeguard against this, the
736
server is supposed to notice the client disappearing and stop
737
giving out the encrypted data. Therefore, it is important to
738
set the timeout and checker interval values tightly on the
739
server. See <citerefentry><refentrytitle
840
computer, read the OpenPGP and TLS keys directly from the hard
841
drive, and communicate with the server. To safeguard against
842
this, the server is supposed to notice the client disappearing
843
and stop giving out the encrypted data. Therefore, it is
844
important to set the timeout and checker interval values tightly
845
on the server. See <citerefentry><refentrytitle
740
846
>mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
743
849
It will also help if the checker program on the server is
744
850
configured to request something from the client which can not be
745
spoofed by someone else on the network, unlike unencrypted
746
<acronym>ICMP</acronym> echo (<quote>ping</quote>) replies.
851
spoofed by someone else on the network, like SSH server key
852
fingerprints, and unlike unencrypted <acronym>ICMP</acronym>
853
echo (<quote>ping</quote>) replies.
749
856
<emphasis>Note</emphasis>: This makes it completely insecure to
798
<ulink url="http://www.gnu.org/software/gnutls/"
905
<ulink url="https://www.gnutls.org/">GnuTLS</ulink>
803
909
GnuTLS is the library this client uses to implement TLS for
804
910
communicating securely with the server, and at the same time
805
send the public OpenPGP key to the server.
911
send the public key to the server.
811
<ulink url="http://www.gnupg.org/related_software/gpgme/"
917
<ulink url="https://www.gnupg.org/related_software/gpgme/"
843
949
This client uses IPv6 link-local addresses, which are
844
950
immediately usable since a link-local addresses is
845
automatically assigned to a network interfaces when it
951
automatically assigned to a network interface when it
855
RFC 4346: <citetitle>The Transport Layer Security (TLS)
856
Protocol Version 1.1</citetitle>
961
RFC 5246: <citetitle>The Transport Layer Security (TLS)
962
Protocol Version 1.2</citetitle>
860
TLS 1.1 is the protocol implemented by GnuTLS.
966
TLS 1.2 is the protocol implemented by GnuTLS.
877
RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
983
RFC 7250: <citetitle>Using Raw Public Keys in Transport
984
Layer Security (TLS) and Datagram Transport Layer Security
989
This is implemented by GnuTLS in version 3.6.6 and is, if
990
present, used by this program so that raw public keys can be
997
RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
878
998
Security</citetitle>
882
This is implemented by GnuTLS and used by this program so
883
that OpenPGP keys can be used.
1002
This is implemented by GnuTLS before version 3.6.0 and is,
1003
if present, used by this program so that OpenPGP keys can be
added
removed
plugins.d/mandos-client.xml
