To get this branch, use:
bzr branch
http://bzr.recompile.se/loggerhead/mandos/trunk
« back to all changes in this revision
Viewing changes to plugins.d/mandos-client.xml
- browse files at revision 1310
- compare with another revision
- download diff
- download tarball
- view history from revision 1310
- Committer: Teddy Hogeborn
- Date: 2024-11-17 16:53:00 UTC
- Revision ID: teddy@recompile.se-20241117165300-02hxm96s8cj9528e
mandos: Avoid closing configured server network socket
If we are passed a pre-created created network socket as a file
descriptor, we must avoid later closing it (when stdin, stdout and
stderr are dup2()ed over with /dev/null) by making sure that the
network file descriptor is not 0, 1, or 2, by creating a new file
descriptor if necessary.
However, when we create a new file descriptor we must check that the
new file descriptor is not 0, 1, or 2 either, and try again until we
get a suitable file descriptor.
If we are passed a pre-created created network socket as a file
descriptor, we must avoid later closing it (when stdin, stdout and
stderr are dup2()ed over with /dev/null) by making sure that the
network file descriptor is not 0, 1, or 2, by creating a new file
descriptor if necessary.
However, when we create a new file descriptor we must check that the
new file descriptor is not 0, 1, or 2 either, and try again until we
get a suitable file descriptor.
- files added:
- bugs.xml
- debian/tests
- debian/upstream
- dracut-module
- plugin-helpers
- files removed:
- initramfs-tools-hook-conf
- files modified:
- .bzrignore
added
removed
plugins.d/mandos-client.xml
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 "2014-01-20">
5
<!ENTITY TIMESTAMP "2023-10-21">
6
6
<!ENTITY % common SYSTEM "../common.ent">
7
7
%common;
8
8
]>
33
33
<copyright>
34
34
<year>2008</year>
35
35
<year>2009</year>
36
<year>2010</year>
37
<year>2011</year>
36
38
<year>2012</year>
37
39
<year>2013</year>
40
<year>2014</year>
41
<year>2015</year>
42
<year>2016</year>
43
<year>2017</year>
44
<year>2018</year>
45
<year>2019</year>
38
46
<holder>Teddy Hogeborn</holder>
39
47
<holder>Björn Påhlsson</holder>
40
48
</copyright>
88
96
<replaceable>FILE</replaceable></option></arg>
89
97
</group>
90
98
<sbr/>
99
<group>
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>
104
</group>
105
<sbr/>
106
<group>
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>
111
</group>
112
<sbr/>
91
113
<arg>
92
114
<option>--priority <replaceable>STRING</replaceable></option>
93
115
</arg>
97
119
</arg>
98
120
<sbr/>
99
121
<arg>
122
<option>--dh-params <replaceable>FILE</replaceable></option>
123
</arg>
124
<sbr/>
125
<arg>
100
126
<option>--delay <replaceable>SECONDS</replaceable></option>
101
127
</arg>
102
128
<sbr/>
143
169
brings up network interfaces, uses the interfaces’ IPv6
144
170
link-local addresses to get network connectivity, uses Zeroconf
145
171
to find servers on the local network, and communicates with
146
servers using TLS with an OpenPGP key to ensure authenticity and
147
confidentiality. This client program keeps running, trying all
148
servers on the network, until it receives a satisfactory reply
149
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
150
176
servers are periodically retried. If no servers are found it
151
177
will wait indefinitely for new servers to appear.
152
178
</para>
170
196
</para>
171
197
<para>
172
198
This program is not meant to be run directly; it is really meant
173
to run as a plugin of the <application>Mandos</application>
174
<citerefentry><refentrytitle>plugin-runner</refentrytitle>
175
<manvolnum>8mandos</manvolnum></citerefentry>, which runs in the
176
initial <acronym>RAM</acronym> disk environment because it is
177
specified as a <quote>keyscript</quote> in the <citerefentry>
178
<refentrytitle>crypttab</refentrytitle><manvolnum>5</manvolnum>
179
</citerefentry> file.
199
to be run by other programs in the initial
200
<acronym>RAM</acronym> disk environment; see <xref
201
linkend="overview"/>.
180
202
</para>
181
203
</refsect1>
182
204
194
216
<title>OPTIONS</title>
195
217
<para>
196
218
This program is commonly not invoked from the command line; it
197
is normally started by the <application>Mandos</application>
198
plugin runner, see <citerefentry><refentrytitle
199
>plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum>
200
</citerefentry>. Any command line options this program accepts
201
are therefore normally provided by the plugin runner, and not
202
directly.
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,
222
and not directly.
203
223
</para>
204
224
205
225
<variablelist>
260
280
<para>
261
281
<replaceable>NAME</replaceable> can be the string
262
282
<quote><literal>none</literal></quote>; this will make
263
<command>&COMMANDNAME;</command> not bring up
264
<emphasis>any</emphasis> interfaces specified
265
<emphasis>after</emphasis> this string. This is not
266
recommended, and only meant for advanced users.
283
<command>&COMMANDNAME;</command> only bring up interfaces
284
specified <emphasis>before</emphasis> this string. This
285
is not recommended, and only meant for advanced users.
267
286
</para>
268
287
</listitem>
269
288
</varlistentry>
297
316
</varlistentry>
298
317
299
318
<varlistentry>
319
<term><option>--tls-pubkey=<replaceable
320
>FILE</replaceable></option></term>
321
<term><option>-T
322
<replaceable>FILE</replaceable></option></term>
323
<listitem>
324
<para>
325
TLS raw public key file name. The default name is
326
<quote><filename>/conf/conf.d/mandos/tls-pubkey.pem</filename
327
></quote>.
328
</para>
329
</listitem>
330
</varlistentry>
331
332
<varlistentry>
333
<term><option>--tls-privkey=<replaceable
334
>FILE</replaceable></option></term>
335
<term><option>-t
336
<replaceable>FILE</replaceable></option></term>
337
<listitem>
338
<para>
339
TLS secret key file name. The default name is
340
<quote><filename>/conf/conf.d/mandos/tls-privkey.pem</filename
341
></quote>.
342
</para>
343
</listitem>
344
</varlistentry>
345
346
<varlistentry>
300
347
<term><option>--priority=<replaceable
301
348
>STRING</replaceable></option></term>
302
349
<listitem>
311
358
<listitem>
312
359
<para>
313
360
Sets the number of bits to use for the prime number in the
314
TLS Diffie-Hellman key exchange. Default is 1024.
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.
366
</para>
367
</listitem>
368
</varlistentry>
369
370
<varlistentry>
371
<term><option>--dh-params=<replaceable
372
>FILE</replaceable></option></term>
373
<listitem>
374
<para>
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
382
and use this option.
315
383
</para>
316
384
</listitem>
317
385
</varlistentry>
408
476
<title>OVERVIEW</title>
409
477
<xi:include href="../overview.xml"/>
410
478
<para>
411
This program is the client part. It is a plugin started by
412
<citerefentry><refentrytitle>plugin-runner</refentrytitle>
413
<manvolnum>8mandos</manvolnum></citerefentry> which will run in
414
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.
481
</para>
482
<para>
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.
492
</para>
493
<para>
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.
415
504
</para>
416
505
<para>
417
506
This program could, theoretically, be used as a keyscript in
418
507
<filename>/etc/crypttab</filename>, but it would then be
419
508
impossible to enter a password for the encrypted root disk at
420
509
the console, since this program does not read from the console
421
at all. This is why a separate plugin runner (<citerefentry>
422
<refentrytitle>plugin-runner</refentrytitle>
423
<manvolnum>8mandos</manvolnum></citerefentry>) is used to run
424
both this program and others in in parallel,
425
<emphasis>one</emphasis> of which (<citerefentry>
426
<refentrytitle>password-prompt</refentrytitle>
427
<manvolnum>8mandos</manvolnum></citerefentry>) will prompt for
428
passwords on the system console.
510
at all.
429
511
</para>
430
512
</refsect1>
431
513
444
526
445
527
<refsect1 id="environment">
446
528
<title>ENVIRONMENT</title>
529
<variablelist>
530
<varlistentry>
531
<term><envar>MANDOSPLUGINHELPERDIR</envar></term>
532
<listitem>
533
<para>
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
537
not documented.
538
</para>
539
</listitem>
540
</varlistentry>
541
</variablelist>
447
542
<para>
448
This program does not use any environment variables, not even
449
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
450
545
>cryptsetup</refentrytitle><manvolnum>8</manvolnum>
451
546
</citerefentry>.
452
547
</para>
639
734
</listitem>
640
735
</varlistentry>
641
736
<varlistentry>
737
<term><filename>/conf/conf.d/mandos/tls-pubkey.pem</filename
738
></term>
739
<term><filename>/conf/conf.d/mandos/tls-privkey.pem</filename
740
></term>
741
<listitem>
742
<para>
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.
747
</para>
748
</listitem>
749
</varlistentry>
750
<varlistentry>
642
751
<term><filename
643
752
class="directory">/lib/mandos/network-hooks.d</filename></term>
644
753
<listitem>
652
761
</variablelist>
653
762
</refsect1>
654
763
655
<!-- <refsect1 id="bugs"> -->
656
<!-- <title>BUGS</title> -->
657
<!-- <para> -->
658
<!-- </para> -->
659
<!-- </refsect1> -->
764
<refsect1 id="bugs">
765
<title>BUGS</title>
766
<xi:include href="../bugs.xml"/>
767
</refsect1>
660
768
661
769
<refsect1 id="example">
662
770
<title>EXAMPLE</title>
663
771
<para>
664
772
Note that normally, command line options will not be given
665
directly, but via options for the Mandos <citerefentry
666
><refentrytitle>plugin-runner</refentrytitle>
667
<manvolnum>8mandos</manvolnum></citerefentry>.
773
directly, but passed on via the program responsible for starting
774
this program; see <xref linkend="overview"/>.
668
775
</para>
669
776
<informalexample>
670
777
<para>
687
794
</informalexample>
688
795
<informalexample>
689
796
<para>
690
Run in debug mode, and use a custom key:
797
Run in debug mode, and use custom keys:
691
798
</para>
692
799
<para>
693
800
694
801
<!-- do not wrap this line -->
695
<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>
696
803
697
804
</para>
698
805
</informalexample>
699
806
<informalexample>
700
807
<para>
701
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
702
809
to locate a server; connect directly to the IPv6 link-local
703
810
address <quote><systemitem class="ipaddress"
704
811
>fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
707
814
<para>
708
815
709
816
<!-- do not wrap this line -->
710
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect fe80::aede:48ff:fe71:f6f2:4711 --interface eth2</userinput>
817
<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>
711
818
712
819
</para>
713
820
</informalexample>
716
823
<refsect1 id="security">
717
824
<title>SECURITY</title>
718
825
<para>
719
This program is set-uid to root, but will switch back to the
720
original (and presumably non-privileged) user and group after
721
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.
722
829
</para>
723
830
<para>
724
831
To use this program for its intended purpose (see <xref
737
844
<para>
738
845
The only remaining weak point is that someone with physical
739
846
access to the client hard drive might turn off the client
740
computer, read the OpenPGP keys directly from the hard drive,
741
and communicate with the server. To safeguard against this, the
742
server is supposed to notice the client disappearing and stop
743
giving out the encrypted data. Therefore, it is important to
744
set the timeout and checker interval values tightly on the
745
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
746
853
>mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
747
854
</para>
748
855
<para>
749
856
It will also help if the checker program on the server is
750
857
configured to request something from the client which can not be
751
spoofed by someone else on the network, unlike unencrypted
752
<acronym>ICMP</acronym> echo (<quote>ping</quote>) replies.
858
spoofed by someone else on the network, like SSH server key
859
fingerprints, and unlike unencrypted <acronym>ICMP</acronym>
860
echo (<quote>ping</quote>) replies.
753
861
</para>
754
862
<para>
755
863
<emphasis>Note</emphasis>: This makes it completely insecure to
771
879
<manvolnum>5</manvolnum></citerefentry>,
772
880
<citerefentry><refentrytitle>mandos</refentrytitle>
773
881
<manvolnum>8</manvolnum></citerefentry>,
774
<citerefentry><refentrytitle>password-prompt</refentrytitle>
882
<citerefentry><refentrytitle>password-agent</refentrytitle>
775
883
<manvolnum>8mandos</manvolnum></citerefentry>,
776
884
<citerefentry><refentrytitle>plugin-runner</refentrytitle>
777
885
<manvolnum>8mandos</manvolnum></citerefentry>
790
898
</varlistentry>
791
899
<varlistentry>
792
900
<term>
793
<ulink url="http://www.avahi.org/">Avahi</ulink>
901
<ulink url="https://www.avahi.org/">Avahi</ulink>
794
902
</term>
795
903
<listitem>
796
904
<para>
801
909
</varlistentry>
802
910
<varlistentry>
803
911
<term>
804
<ulink url="http://www.gnu.org/software/gnutls/"
805
>GnuTLS</ulink>
912
<ulink url="https://www.gnutls.org/">GnuTLS</ulink>
806
913
</term>
807
914
<listitem>
808
915
<para>
809
916
GnuTLS is the library this client uses to implement TLS for
810
917
communicating securely with the server, and at the same time
811
send the public OpenPGP key to the server.
918
send the public key to the server.
812
919
</para>
813
920
</listitem>
814
921
</varlistentry>
815
922
<varlistentry>
816
923
<term>
817
<ulink url="http://www.gnupg.org/related_software/gpgme/"
924
<ulink url="https://www.gnupg.org/related_software/gpgme/"
818
925
>GPGME</ulink>
819
926
</term>
820
927
<listitem>
858
965
</varlistentry>
859
966
<varlistentry>
860
967
<term>
861
RFC 4346: <citetitle>The Transport Layer Security (TLS)
862
Protocol Version 1.1</citetitle>
968
RFC 5246: <citetitle>The Transport Layer Security (TLS)
969
Protocol Version 1.2</citetitle>
863
970
</term>
864
971
<listitem>
865
972
<para>
866
TLS 1.1 is the protocol implemented by GnuTLS.
973
TLS 1.2 is the protocol implemented by GnuTLS.
867
974
</para>
868
975
</listitem>
869
976
</varlistentry>
880
987
</varlistentry>
881
988
<varlistentry>
882
989
<term>
883
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
992
(DTLS)</citetitle>
993
</term>
994
<listitem>
995
<para>
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
998
used.
999
</para>
1000
</listitem>
1001
</varlistentry>
1002
<varlistentry>
1003
<term>
1004
RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
884
1005
Security</citetitle>
885
1006
</term>
886
1007
<listitem>
887
1008
<para>
888
This is implemented by GnuTLS and used by this program so
889
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
1011
used.
890
1012
</para>
891
1013
</listitem>
892
1014
</varlistentry>
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0