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 1294
- compare with another revision
- download diff
- download tarball
- view history from revision 1294
- Committer: Teddy Hogeborn
- Date: 2024-09-09 01:36:41 UTC
- Revision ID: teddy@recompile.se-20240909013641-6zu6kx2f7meu134k
Make all required directories when installing
When installing into a normal system, one can assume that target
directories, such as /usr/bin, already exists. But when installing
into a subdirectory for the purpose of creating a package, one cannot
assume that all directories already exist. Therefore, when
installing, we must not check if any directories exist, and must
instead always create any directories we want to install into.
* Makefile (confdir/mandos.conf, confdir/clients.conf, install-html):
Use the "-D" option to "install" instead of creating the directory
separately.
(install-server): Move creation of $(CONFDIR) down to before it is
needed. Don't check if the $(TMPFILES) or $(SYSUSERS) directories
exist; instead create them by using the "-D" option to "install".
Create the $(PREFIX)/sbin directory. Always use
"--target-directory" if possible; i.e. if the file name is the same.
Create the $(DBUSPOLICYDIR) and $(DESTDIR)/etc/init.d directories by
using the "-D" option to "install". Don't check if the $(SYSTEMD)
directory exists; instead create it by using the "-D" option to
"install". Create the $(DESTDIR)/etc/default and $(MANDIR)/man8
directories by using the "-D" option to "install". Create the
$(MANDIR)/man5 directories explicitly.
(install-client-nokey): Remove unnecessary creation of the
$(CONFDIR) directory. Don't check if the $(SYSUSERS) directory
exists; instead create it by using the "-D" option to "install".
Move the "--directory" argument to be the first argument, for
clarity. Create the $(PREFIX)/sbin directory. Use the "-D"
argument to "install" when installing
$(INITRAMFSTOOLS)/hooks/mandos,
$(INITRAMFSTOOLS)/conf.d/mandos-conf,
$(INITRAMFSTOOLS)/conf-hooks.d/zz-mandos,
$(INITRAMFSTOOLS)/scripts/init-premount/mandos,
$(INITRAMFSTOOLS)/scripts/local-premount/mandos,
$(DRACUTMODULE)/ask-password-mandos.path, and
$(DRACUTMODULE)/dracut-module/ask-password-mandos.service. Create
the $(MANDIR)/man8 directory.
Reported-By: Erich Eckner <erich@eckner.net>
Thanks: Erich Eckner <erich@eckner.net> for analysis
When installing into a normal system, one can assume that target
directories, such as /usr/bin, already exists. But when installing
into a subdirectory for the purpose of creating a package, one cannot
assume that all directories already exist. Therefore, when
installing, we must not check if any directories exist, and must
instead always create any directories we want to install into.
* Makefile (confdir/mandos.conf, confdir/clients.conf, install-html):
Use the "-D" option to "install" instead of creating the directory
separately.
(install-server): Move creation of $(CONFDIR) down to before it is
needed. Don't check if the $(TMPFILES) or $(SYSUSERS) directories
exist; instead create them by using the "-D" option to "install".
Create the $(PREFIX)/sbin directory. Always use
"--target-directory" if possible; i.e. if the file name is the same.
Create the $(DBUSPOLICYDIR) and $(DESTDIR)/etc/init.d directories by
using the "-D" option to "install". Don't check if the $(SYSTEMD)
directory exists; instead create it by using the "-D" option to
"install". Create the $(DESTDIR)/etc/default and $(MANDIR)/man8
directories by using the "-D" option to "install". Create the
$(MANDIR)/man5 directories explicitly.
(install-client-nokey): Remove unnecessary creation of the
$(CONFDIR) directory. Don't check if the $(SYSUSERS) directory
exists; instead create it by using the "-D" option to "install".
Move the "--directory" argument to be the first argument, for
clarity. Create the $(PREFIX)/sbin directory. Use the "-D"
argument to "install" when installing
$(INITRAMFSTOOLS)/hooks/mandos,
$(INITRAMFSTOOLS)/conf.d/mandos-conf,
$(INITRAMFSTOOLS)/conf-hooks.d/zz-mandos,
$(INITRAMFSTOOLS)/scripts/init-premount/mandos,
$(INITRAMFSTOOLS)/scripts/local-premount/mandos,
$(DRACUTMODULE)/ask-password-mandos.path, and
$(DRACUTMODULE)/dracut-module/ask-password-mandos.service. Create
the $(MANDIR)/man8 directory.
Reported-By: Erich Eckner <erich@eckner.net>
Thanks: Erich Eckner <erich@eckner.net> for analysis
- 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 "2011-10-03">
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>
36
37
<year>2011</year>
38
<year>2012</year>
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>
37
46
<holder>Teddy Hogeborn</holder>
38
47
<holder>Björn Påhlsson</holder>
39
48
</copyright>
64
73
><replaceable>PORT</replaceable></option></arg>
65
74
</group>
66
75
<sbr/>
67
<group>
76
<group rep='repeat'>
68
77
<arg choice="plain"><option>--interface
69
<replaceable>NAME</replaceable></option></arg>
70
<arg choice="plain"><option>-i
71
<replaceable>NAME</replaceable></option></arg>
78
<replaceable>NAME</replaceable><arg rep='repeat'
79
>,<replaceable>NAME</replaceable></arg></option></arg>
80
<arg choice="plain"><option>-i <replaceable>NAME</replaceable
81
><arg rep='repeat'>,<replaceable>NAME</replaceable></arg
82
></option></arg>
72
83
</group>
73
84
<sbr/>
74
85
<group>
85
96
<replaceable>FILE</replaceable></option></arg>
86
97
</group>
87
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/>
88
113
<arg>
89
114
<option>--priority <replaceable>STRING</replaceable></option>
90
115
</arg>
94
119
</arg>
95
120
<sbr/>
96
121
<arg>
122
<option>--dh-params <replaceable>FILE</replaceable></option>
123
</arg>
124
<sbr/>
125
<arg>
97
126
<option>--delay <replaceable>SECONDS</replaceable></option>
98
127
</arg>
99
128
<sbr/>
102
131
</arg>
103
132
<sbr/>
104
133
<arg>
105
<option>--network-hook-dir<replaceable>DIR</replaceable></option>
134
<option>--network-hook-dir
135
<replaceable>DIR</replaceable></option>
106
136
</arg>
107
137
<sbr/>
108
138
<arg>
136
166
communicates with <citerefentry><refentrytitle
137
167
>mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>
138
168
to get a password. In slightly more detail, this client program
139
brings up a network interface, uses the interface’s IPv6
140
link-local address to get network connectivity, uses Zeroconf to
141
find servers on the local network, and communicates with servers
142
using TLS with an OpenPGP key to ensure authenticity and
143
confidentiality. This client program keeps running, trying all
144
servers on the network, until it receives a satisfactory reply
145
or a TERM signal. After all servers have been tried, all
169
brings up network interfaces, uses the interfaces’ IPv6
170
link-local addresses to get network connectivity, uses Zeroconf
171
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
146
176
servers are periodically retried. If no servers are found it
147
177
will wait indefinitely for new servers to appear.
148
178
</para>
149
179
<para>
180
The network interfaces are selected like this: If any interfaces
181
are specified using the <option>--interface</option> option,
182
those interface are used. Otherwise,
183
<command>&COMMANDNAME;</command> will use all interfaces that
184
are not loopback interfaces, are not point-to-point interfaces,
185
are capable of broadcasting and do not have the NOARP flag (see
186
<citerefentry><refentrytitle>netdevice</refentrytitle>
187
<manvolnum>7</manvolnum></citerefentry>). (If the
188
<option>--connect</option> option is used, point-to-point
189
interfaces and non-broadcast interfaces are accepted.) If any
190
used interfaces are not up and running, they are first taken up
191
(and later taken down again on program exit).
192
</para>
193
<para>
194
Before network interfaces are selected, all <quote>network
195
hooks</quote> are run; see <xref linkend="network-hooks"/>.
196
</para>
197
<para>
150
198
This program is not meant to be run directly; it is really meant
151
to run as a plugin of the <application>Mandos</application>
152
<citerefentry><refentrytitle>plugin-runner</refentrytitle>
153
<manvolnum>8mandos</manvolnum></citerefentry>, which runs in the
154
initial <acronym>RAM</acronym> disk environment because it is
155
specified as a <quote>keyscript</quote> in the <citerefentry>
156
<refentrytitle>crypttab</refentrytitle><manvolnum>5</manvolnum>
157
</citerefentry> file.
199
to be run by other programs in the initial
200
<acronym>RAM</acronym> disk environment; see <xref
201
linkend="overview"/>.
158
202
</para>
159
203
</refsect1>
160
204
172
216
<title>OPTIONS</title>
173
217
<para>
174
218
This program is commonly not invoked from the command line; it
175
is normally started by the <application>Mandos</application>
176
plugin runner, see <citerefentry><refentrytitle
177
>plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum>
178
</citerefentry>. Any command line options this program accepts
179
are therefore normally provided by the plugin runner, and not
180
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.
181
223
</para>
182
224
183
225
<variablelist>
197
239
assumed to separate the address from the port number.
198
240
</para>
199
241
<para>
200
This option is normally only useful for testing and
201
debugging.
242
Normally, Zeroconf would be used to locate Mandos servers,
243
in which case this option would only be used when testing
244
and debugging.
202
245
</para>
203
246
</listitem>
204
247
</varlistentry>
205
248
206
249
<varlistentry>
207
250
<term><option>--interface=<replaceable
208
>NAME</replaceable></option></term>
251
>NAME</replaceable><arg rep='repeat'>,<replaceable
252
>NAME</replaceable></arg></option></term>
209
253
<term><option>-i
210
<replaceable>NAME</replaceable></option></term>
254
<replaceable>NAME</replaceable><arg rep='repeat'>,<replaceable
255
>NAME</replaceable></arg></option></term>
211
256
<listitem>
212
257
<para>
213
Network interface that will be brought up and scanned for
214
Mandos servers to connect to. The default is the empty
215
string, which will automatically choose an appropriate
216
interface.
258
Comma separated list of network interfaces that will be
259
brought up and scanned for Mandos servers to connect to.
260
The default is the empty string, which will automatically
261
use all appropriate interfaces.
217
262
</para>
218
263
<para>
219
If the <option>--connect</option> option is used, this
220
specifies the interface to use to connect to the address
221
given.
264
If the <option>--connect</option> option is used, and
265
exactly one interface name is specified (except
266
<quote><literal>none</literal></quote>), this specifies
267
the interface to use to connect to the address given.
222
268
</para>
223
269
<para>
224
270
Note that since this program will normally run in the
225
271
initial RAM disk environment, the interface must be an
226
272
interface which exists at that stage. Thus, the interface
227
can not be a pseudo-interface such as <quote>br0</quote>
228
or <quote>tun0</quote>; such interfaces will not exist
229
until much later in the boot process, and can not be used
230
by this program.
273
can normally not be a pseudo-interface such as
274
<quote>br0</quote> or <quote>tun0</quote>; such interfaces
275
will not exist until much later in the boot process, and
276
can not be used by this program, unless created by a
277
<quote>network hook</quote> — see <xref
278
linkend="network-hooks"/>.
231
279
</para>
232
280
<para>
233
281
<replaceable>NAME</replaceable> can be the string
234
<quote><literal>none</literal></quote>; this will not use
235
any specific interface, and will not bring up an interface
236
on startup. This is not recommended, and only meant for
237
advanced users.
282
<quote><literal>none</literal></quote>; this will make
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.
238
286
</para>
239
287
</listitem>
240
288
</varlistentry>
268
316
</varlistentry>
269
317
270
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>
271
347
<term><option>--priority=<replaceable
272
348
>STRING</replaceable></option></term>
273
349
<listitem>
282
358
<listitem>
283
359
<para>
284
360
Sets the number of bits to use for the prime number in the
285
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.
286
383
</para>
287
384
</listitem>
288
385
</varlistentry>
292
389
>SECONDS</replaceable></option></term>
293
390
<listitem>
294
391
<para>
295
After bringing the network interface up, the program waits
392
After bringing a network interface up, the program waits
296
393
for the interface to arrive in a <quote>running</quote>
297
394
state before proceeding. During this time, the kernel log
298
395
level will be lowered to reduce clutter on the system
379
476
<title>OVERVIEW</title>
380
477
<xi:include href="../overview.xml"/>
381
478
<para>
382
This program is the client part. It is a plugin started by
383
<citerefentry><refentrytitle>plugin-runner</refentrytitle>
384
<manvolnum>8mandos</manvolnum></citerefentry> which will run in
385
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.
386
504
</para>
387
505
<para>
388
506
This program could, theoretically, be used as a keyscript in
389
507
<filename>/etc/crypttab</filename>, but it would then be
390
508
impossible to enter a password for the encrypted root disk at
391
509
the console, since this program does not read from the console
392
at all. This is why a separate plugin runner (<citerefentry>
393
<refentrytitle>plugin-runner</refentrytitle>
394
<manvolnum>8mandos</manvolnum></citerefentry>) is used to run
395
both this program and others in in parallel,
396
<emphasis>one</emphasis> of which will prompt for passwords on
397
the system console.
510
at all.
398
511
</para>
399
512
</refsect1>
400
513
413
526
414
527
<refsect1 id="environment">
415
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>
416
542
<para>
417
This program does not use any environment variables, not even
418
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
419
545
>cryptsetup</refentrytitle><manvolnum>8</manvolnum>
420
546
</citerefentry>.
421
547
</para>
422
548
</refsect1>
423
549
550
<refsect1 id="network-hooks">
551
<title>NETWORK HOOKS</title>
552
<para>
553
If a network interface like a bridge or tunnel is required to
554
find a Mandos server, this requires the interface to be up and
555
running before <command>&COMMANDNAME;</command> starts looking
556
for Mandos servers. This can be accomplished by creating a
557
<quote>network hook</quote> program, and placing it in a special
558
directory.
559
</para>
560
<para>
561
Before the network is used (and again before program exit), any
562
runnable programs found in the network hook directory are run
563
with the argument <quote><literal>start</literal></quote> or
564
<quote><literal>stop</literal></quote>. This should bring up or
565
down, respectively, any network interface which
566
<command>&COMMANDNAME;</command> should use.
567
</para>
568
<refsect2 id="hook-requirements">
569
<title>REQUIREMENTS</title>
570
<para>
571
A network hook must be an executable file, and its name must
572
consist entirely of upper and lower case letters, digits,
573
underscores, periods, and hyphens.
574
</para>
575
<para>
576
A network hook will receive one argument, which can be one of
577
the following:
578
</para>
579
<variablelist>
580
<varlistentry>
581
<term><literal>start</literal></term>
582
<listitem>
583
<para>
584
This should make the network hook create (if necessary)
585
and bring up a network interface.
586
</para>
587
</listitem>
588
</varlistentry>
589
<varlistentry>
590
<term><literal>stop</literal></term>
591
<listitem>
592
<para>
593
This should make the network hook take down a network
594
interface, and delete it if it did not exist previously.
595
</para>
596
</listitem>
597
</varlistentry>
598
<varlistentry>
599
<term><literal>files</literal></term>
600
<listitem>
601
<para>
602
This should make the network hook print, <emphasis>one
603
file per line</emphasis>, all the files needed for it to
604
run. (These files will be copied into the initial RAM
605
filesystem.) Typical use is for a network hook which is
606
a shell script to print its needed binaries.
607
</para>
608
<para>
609
It is not necessary to print any non-executable files
610
already in the network hook directory, these will be
611
copied implicitly if they otherwise satisfy the name
612
requirements.
613
</para>
614
</listitem>
615
</varlistentry>
616
<varlistentry>
617
<term><literal>modules</literal></term>
618
<listitem>
619
<para>
620
This should make the network hook print, <emphasis>on
621
separate lines</emphasis>, all the kernel modules needed
622
for it to run. (These modules will be copied into the
623
initial RAM filesystem.) For instance, a tunnel
624
interface needs the
625
<quote><literal>tun</literal></quote> module.
626
</para>
627
</listitem>
628
</varlistentry>
629
</variablelist>
630
<para>
631
The network hook will be provided with a number of environment
632
variables:
633
</para>
634
<variablelist>
635
<varlistentry>
636
<term><envar>MANDOSNETHOOKDIR</envar></term>
637
<listitem>
638
<para>
639
The network hook directory, specified to
640
<command>&COMMANDNAME;</command> by the
641
<option>--network-hook-dir</option> option. Note: this
642
should <emphasis>always</emphasis> be used by the
643
network hook to refer to itself or any files in the hook
644
directory it may require.
645
</para>
646
</listitem>
647
</varlistentry>
648
<varlistentry>
649
<term><envar>DEVICE</envar></term>
650
<listitem>
651
<para>
652
The network interfaces, as specified to
653
<command>&COMMANDNAME;</command> by the
654
<option>--interface</option> option, combined to one
655
string and separated by commas. If this is set, and
656
does not contain the interface a hook will bring up,
657
there is no reason for a hook to continue.
658
</para>
659
</listitem>
660
</varlistentry>
661
<varlistentry>
662
<term><envar>MODE</envar></term>
663
<listitem>
664
<para>
665
This will be the same as the first argument;
666
i.e. <quote><literal>start</literal></quote>,
667
<quote><literal>stop</literal></quote>,
668
<quote><literal>files</literal></quote>, or
669
<quote><literal>modules</literal></quote>.
670
</para>
671
</listitem>
672
</varlistentry>
673
<varlistentry>
674
<term><envar>VERBOSITY</envar></term>
675
<listitem>
676
<para>
677
This will be the <quote><literal>1</literal></quote> if
678
the <option>--debug</option> option is passed to
679
<command>&COMMANDNAME;</command>, otherwise
680
<quote><literal>0</literal></quote>.
681
</para>
682
</listitem>
683
</varlistentry>
684
<varlistentry>
685
<term><envar>DELAY</envar></term>
686
<listitem>
687
<para>
688
This will be the same as the <option>--delay</option>
689
option passed to <command>&COMMANDNAME;</command>. Is
690
only set if <envar>MODE</envar> is
691
<quote><literal>start</literal></quote> or
692
<quote><literal>stop</literal></quote>.
693
</para>
694
</listitem>
695
</varlistentry>
696
<varlistentry>
697
<term><envar>CONNECT</envar></term>
698
<listitem>
699
<para>
700
This will be the same as the <option>--connect</option>
701
option passed to <command>&COMMANDNAME;</command>. Is
702
only set if <option>--connect</option> is passed and
703
<envar>MODE</envar> is
704
<quote><literal>start</literal></quote> or
705
<quote><literal>stop</literal></quote>.
706
</para>
707
</listitem>
708
</varlistentry>
709
</variablelist>
710
<para>
711
A hook may not read from standard input, and should be
712
restrictive in printing to standard output or standard error
713
unless <varname>VERBOSITY</varname> is
714
<quote><literal>1</literal></quote>.
715
</para>
716
</refsect2>
717
</refsect1>
718
424
719
<refsect1 id="files">
425
720
<title>FILES</title>
426
721
<variablelist>
438
733
</para>
439
734
</listitem>
440
735
</varlistentry>
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>
751
<term><filename
752
class="directory">/lib/mandos/network-hooks.d</filename></term>
753
<listitem>
754
<para>
755
Directory where network hooks are located. Change this
756
with the <option>--network-hook-dir</option> option. See
757
<xref linkend="network-hooks"/>.
758
</para>
759
</listitem>
760
</varlistentry>
441
761
</variablelist>
442
762
</refsect1>
443
763
444
<!-- <refsect1 id="bugs"> -->
445
<!-- <title>BUGS</title> -->
446
<!-- <para> -->
447
<!-- </para> -->
448
<!-- </refsect1> -->
764
<refsect1 id="bugs">
765
<title>BUGS</title>
766
<xi:include href="../bugs.xml"/>
767
</refsect1>
449
768
450
769
<refsect1 id="example">
451
770
<title>EXAMPLE</title>
452
771
<para>
453
772
Note that normally, command line options will not be given
454
directly, but via options for the Mandos <citerefentry
455
><refentrytitle>plugin-runner</refentrytitle>
456
<manvolnum>8mandos</manvolnum></citerefentry>.
773
directly, but passed on via the program responsible for starting
774
this program; see <xref linkend="overview"/>.
457
775
</para>
458
776
<informalexample>
459
777
<para>
460
Normal invocation needs no options, if the network interface
461
is <quote>eth0</quote>:
778
Normal invocation needs no options, if the network interfaces
779
can be automatically determined:
462
780
</para>
463
781
<para>
464
782
<userinput>&COMMANDNAME;</userinput>
466
784
</informalexample>
467
785
<informalexample>
468
786
<para>
469
Search for Mandos servers (and connect to them) using another
470
interface:
787
Search for Mandos servers (and connect to them) using one
788
specific interface:
471
789
</para>
472
790
<para>
473
791
<!-- do not wrap this line -->
476
794
</informalexample>
477
795
<informalexample>
478
796
<para>
479
Run in debug mode, and use a custom key:
797
Run in debug mode, and use custom keys:
480
798
</para>
481
799
<para>
482
800
483
801
<!-- do not wrap this line -->
484
<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>
485
803
486
804
</para>
487
805
</informalexample>
488
806
<informalexample>
489
807
<para>
490
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
491
809
to locate a server; connect directly to the IPv6 link-local
492
810
address <quote><systemitem class="ipaddress"
493
811
>fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
496
814
<para>
497
815
498
816
<!-- do not wrap this line -->
499
<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>
500
818
501
819
</para>
502
820
</informalexample>
505
823
<refsect1 id="security">
506
824
<title>SECURITY</title>
507
825
<para>
508
This program is set-uid to root, but will switch back to the
509
original (and presumably non-privileged) user and group after
510
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.
511
829
</para>
512
830
<para>
513
831
To use this program for its intended purpose (see <xref
526
844
<para>
527
845
The only remaining weak point is that someone with physical
528
846
access to the client hard drive might turn off the client
529
computer, read the OpenPGP keys directly from the hard drive,
530
and communicate with the server. To safeguard against this, the
531
server is supposed to notice the client disappearing and stop
532
giving out the encrypted data. Therefore, it is important to
533
set the timeout and checker interval values tightly on the
534
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
535
853
>mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
536
854
</para>
537
855
<para>
538
856
It will also help if the checker program on the server is
539
857
configured to request something from the client which can not be
540
spoofed by someone else on the network, unlike unencrypted
541
<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.
542
861
</para>
543
862
<para>
544
863
<emphasis>Note</emphasis>: This makes it completely insecure to
560
879
<manvolnum>5</manvolnum></citerefentry>,
561
880
<citerefentry><refentrytitle>mandos</refentrytitle>
562
881
<manvolnum>8</manvolnum></citerefentry>,
563
<citerefentry><refentrytitle>password-prompt</refentrytitle>
882
<citerefentry><refentrytitle>password-agent</refentrytitle>
564
883
<manvolnum>8mandos</manvolnum></citerefentry>,
565
884
<citerefentry><refentrytitle>plugin-runner</refentrytitle>
566
885
<manvolnum>8mandos</manvolnum></citerefentry>
579
898
</varlistentry>
580
899
<varlistentry>
581
900
<term>
582
<ulink url="http://www.avahi.org/">Avahi</ulink>
901
<ulink url="https://www.avahi.org/">Avahi</ulink>
583
902
</term>
584
903
<listitem>
585
904
<para>
590
909
</varlistentry>
591
910
<varlistentry>
592
911
<term>
593
<ulink url="http://www.gnu.org/software/gnutls/"
594
>GnuTLS</ulink>
912
<ulink url="https://www.gnutls.org/">GnuTLS</ulink>
595
913
</term>
596
914
<listitem>
597
915
<para>
598
916
GnuTLS is the library this client uses to implement TLS for
599
917
communicating securely with the server, and at the same time
600
send the public OpenPGP key to the server.
918
send the public key to the server.
601
919
</para>
602
920
</listitem>
603
921
</varlistentry>
604
922
<varlistentry>
605
923
<term>
606
<ulink url="http://www.gnupg.org/related_software/gpgme/"
924
<ulink url="https://www.gnupg.org/related_software/gpgme/"
607
925
>GPGME</ulink>
608
926
</term>
609
927
<listitem>
637
955
<para>
638
956
This client uses IPv6 link-local addresses, which are
639
957
immediately usable since a link-local addresses is
640
automatically assigned to a network interfaces when it
958
automatically assigned to a network interface when it
641
959
is brought up.
642
960
</para>
643
961
</listitem>
647
965
</varlistentry>
648
966
<varlistentry>
649
967
<term>
650
RFC 4346: <citetitle>The Transport Layer Security (TLS)
651
Protocol Version 1.1</citetitle>
968
RFC 5246: <citetitle>The Transport Layer Security (TLS)
969
Protocol Version 1.2</citetitle>
652
970
</term>
653
971
<listitem>
654
972
<para>
655
TLS 1.1 is the protocol implemented by GnuTLS.
973
TLS 1.2 is the protocol implemented by GnuTLS.
656
974
</para>
657
975
</listitem>
658
976
</varlistentry>
669
987
</varlistentry>
670
988
<varlistentry>
671
989
<term>
672
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
673
1005
Security</citetitle>
674
1006
</term>
675
1007
<listitem>
676
1008
<para>
677
This is implemented by GnuTLS and used by this program so
678
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.
679
1012
</para>
680
1013
</listitem>
681
1014
</varlistentry>
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0