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 1298
- compare with another revision
- download diff
- download tarball
- view history from revision 1298
- Committer: Teddy Hogeborn
- Date: 2024-09-09 04:24:39 UTC
- Revision ID: teddy@recompile.se-20240909042439-j85mr20uli2hnyis
Eliminate compiler warnings
Many programs use nested functions, which now result in a linker
warning about executable stack. Hide this warning. Also, rewrite a
loop in the plymouth plugin to avoid warning about signed overflow.
This change also makes the plugin pick the alphabetically first
process entry instead of the last, in case many plymouth processes are
found (which should be unlikely).
* Makefile (plugin-runner, dracut-module/password-agent,
plugins.d/password-prompt, plugins.d/mandos-client,
plugins.d/plymouth): New target; set LDFLAGS to add "-Xlinker
--no-warn-execstack".
* plugins.d/plymouth.c (get_pid): When no pid files are found, and we
are looking through the process list, go though it from the start
instead of from the end, i.e. in normal alphabetical order and not
in reverse order.
Many programs use nested functions, which now result in a linker
warning about executable stack. Hide this warning. Also, rewrite a
loop in the plymouth plugin to avoid warning about signed overflow.
This change also makes the plugin pick the alphabetically first
process entry instead of the last, in case many plymouth processes are
found (which should be unlikely).
* Makefile (plugin-runner, dracut-module/password-agent,
plugins.d/password-prompt, plugins.d/mandos-client,
plugins.d/plymouth): New target; set LDFLAGS to add "-Xlinker
--no-warn-execstack".
* plugins.d/plymouth.c (get_pid): When no pid files are found, and we
are looking through the process list, go though it from the start
instead of from the end, i.e. in normal alphabetical order and not
in reverse order.
- files added:
- .bzr-builddeb
- debian
- debian/po
- debian/source
- debian/tests
- debian/upstream
- dracut-module
- network-hooks.d
- plugin-helpers
- files removed:
- initramfs-tools-hook-conf
- files renamed:
- plugins.d/password-request.c => plugins.d/mandos-client.c
- plugins.d/password-request.xml => plugins.d/mandos-client.xml
- files modified:
- .bzrignore
added
removed
plugins.d/mandos-client.xml
1
1
<?xml version="1.0" encoding="UTF-8"?>
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
<!ENTITY VERSION "1.0">
5
<!ENTITY COMMANDNAME "password-request">
6
<!ENTITY TIMESTAMP "2008-09-03">
4
<!ENTITY COMMANDNAME "mandos-client">
5
<!ENTITY TIMESTAMP "2023-10-21">
6
<!ENTITY % common SYSTEM "../common.ent">
7
%common;
7
8
]>
8
9
9
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
10
11
<refentryinfo>
11
12
<title>Mandos Manual</title>
12
<!-- Nwalsh’s docbook scripts use this to generate the footer: -->
13
<!-- NWalsh’s docbook scripts use this to generate the footer: -->
13
14
<productname>Mandos</productname>
14
<productnumber>&VERSION;</productnumber>
15
<productnumber>&version;</productnumber>
15
16
<date>&TIMESTAMP;</date>
16
17
<authorgroup>
17
18
<author>
18
19
<firstname>Björn</firstname>
19
20
<surname>Påhlsson</surname>
20
21
<address>
21
<email>belorn@fukt.bsnet.se</email>
22
<email>belorn@recompile.se</email>
22
23
</address>
23
24
</author>
24
25
<author>
25
26
<firstname>Teddy</firstname>
26
27
<surname>Hogeborn</surname>
27
28
<address>
28
<email>teddy@fukt.bsnet.se</email>
29
<email>teddy@recompile.se</email>
29
30
</address>
30
31
</author>
31
32
</authorgroup>
32
33
<copyright>
33
34
<year>2008</year>
35
<year>2009</year>
36
<year>2010</year>
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>
34
46
<holder>Teddy Hogeborn</holder>
35
47
<holder>Björn Påhlsson</holder>
36
48
</copyright>
37
49
<xi:include href="../legalnotice.xml"/>
38
50
</refentryinfo>
39
51
40
52
<refmeta>
41
53
<refentrytitle>&COMMANDNAME;</refentrytitle>
42
54
<manvolnum>8mandos</manvolnum>
45
57
<refnamediv>
46
58
<refname><command>&COMMANDNAME;</command></refname>
47
59
<refpurpose>
48
Client for mandos
60
Client for <application>Mandos</application>
49
61
</refpurpose>
50
62
</refnamediv>
51
63
52
64
<refsynopsisdiv>
53
65
<cmdsynopsis>
54
66
<command>&COMMANDNAME;</command>
55
67
<group>
56
68
<arg choice="plain"><option>--connect
57
<replaceable>IPADDR</replaceable><literal>:</literal
69
<replaceable>ADDRESS</replaceable><literal>:</literal
58
70
><replaceable>PORT</replaceable></option></arg>
59
71
<arg choice="plain"><option>-c
60
<replaceable>IPADDR</replaceable><literal>:</literal
72
<replaceable>ADDRESS</replaceable><literal>:</literal
61
73
><replaceable>PORT</replaceable></option></arg>
62
74
</group>
63
75
<sbr/>
64
<group>
65
<arg choice="plain"><option>--keydir
66
<replaceable>DIRECTORY</replaceable></option></arg>
67
<arg choice="plain"><option>-d
68
<replaceable>DIRECTORY</replaceable></option></arg>
69
</group>
70
<sbr/>
71
<group>
76
<group rep='repeat'>
72
77
<arg choice="plain"><option>--interface
73
<replaceable>NAME</replaceable></option></arg>
74
<arg choice="plain"><option>-i
75
<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>
76
83
</group>
77
84
<sbr/>
78
85
<group>
89
96
<replaceable>FILE</replaceable></option></arg>
90
97
</group>
91
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/>
92
113
<arg>
93
114
<option>--priority <replaceable>STRING</replaceable></option>
94
115
</arg>
98
119
</arg>
99
120
<sbr/>
100
121
<arg>
122
<option>--dh-params <replaceable>FILE</replaceable></option>
123
</arg>
124
<sbr/>
125
<arg>
126
<option>--delay <replaceable>SECONDS</replaceable></option>
127
</arg>
128
<sbr/>
129
<arg>
130
<option>--retry <replaceable>SECONDS</replaceable></option>
131
</arg>
132
<sbr/>
133
<arg>
134
<option>--network-hook-dir
135
<replaceable>DIR</replaceable></option>
136
</arg>
137
<sbr/>
138
<arg>
101
139
<option>--debug</option>
102
140
</arg>
103
141
</cmdsynopsis>
120
158
</group>
121
159
</cmdsynopsis>
122
160
</refsynopsisdiv>
123
161
124
162
<refsect1 id="description">
125
163
<title>DESCRIPTION</title>
126
164
<para>
127
165
<command>&COMMANDNAME;</command> is a client program that
128
166
communicates with <citerefentry><refentrytitle
129
167
>mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>
130
to get a password. It uses IPv6 link-local addresses to get
131
network connectivity, Zeroconf to find servers, and TLS with an
132
OpenPGP key to ensure authenticity and confidentiality. It
133
keeps running, trying all servers on the network, until it
134
receives a satisfactory reply or a TERM signal is recieved.
168
to get a password. In slightly more detail, this client program
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
176
servers are periodically retried. If no servers are found it
177
will wait indefinitely for new servers to appear.
178
</para>
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"/>.
135
196
</para>
136
197
<para>
137
198
This program is not meant to be run directly; it is really meant
138
to run as a plugin of the <application>Mandos</application>
139
<citerefentry><refentrytitle>plugin-runner</refentrytitle>
140
<manvolnum>8mandos</manvolnum></citerefentry>, which runs in the
141
initial <acronym>RAM</acronym> disk environment because it is
142
specified as a <quote>keyscript</quote> in the <citerefentry>
143
<refentrytitle>crypttab</refentrytitle><manvolnum>5</manvolnum>
144
</citerefentry> file.
199
to be run by other programs in the initial
200
<acronym>RAM</acronym> disk environment; see <xref
201
linkend="overview"/>.
145
202
</para>
146
203
</refsect1>
147
204
159
216
<title>OPTIONS</title>
160
217
<para>
161
218
This program is commonly not invoked from the command line; it
162
is normally started by the <application>Mandos</application>
163
plugin runner, see <citerefentry><refentrytitle
164
>plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum>
165
</citerefentry>. Any command line options this program accepts
166
are therefore normally provided by the plugin runner, and not
167
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.
168
223
</para>
169
224
170
225
<variablelist>
184
239
assumed to separate the address from the port number.
185
240
</para>
186
241
<para>
187
This option is normally only useful for testing and
188
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.
189
245
</para>
190
246
</listitem>
191
247
</varlistentry>
192
248
193
249
<varlistentry>
194
<term><option>--keydir=<replaceable
195
>DIRECTORY</replaceable></option></term>
196
<term><option>-d
197
<replaceable>DIRECTORY</replaceable></option></term>
198
<listitem>
199
<para>
200
Directory to read the OpenPGP key files
201
<filename>pubkey.txt</filename> and
202
<filename>seckey.txt</filename> from. The default is
203
<filename>/conf/conf.d/mandos</filename> (in the initial
204
<acronym>RAM</acronym> disk environment).
205
</para>
206
</listitem>
207
</varlistentry>
208
209
<varlistentry>
210
<term><option>--interface=
211
<replaceable>NAME</replaceable></option></term>
250
<term><option>--interface=<replaceable
251
>NAME</replaceable><arg rep='repeat'>,<replaceable
252
>NAME</replaceable></arg></option></term>
212
253
<term><option>-i
213
<replaceable>NAME</replaceable></option></term>
254
<replaceable>NAME</replaceable><arg rep='repeat'>,<replaceable
255
>NAME</replaceable></arg></option></term>
214
256
<listitem>
215
257
<para>
216
Network interface that will be brought up and scanned for
217
Mandos servers to connect to. The default it
218
<quote><literal>eth0</literal></quote>.
219
</para>
220
<para>
221
If the <option>--connect</option> option is used, this
222
specifies the interface to use to connect to the address
223
given.
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.
262
</para>
263
<para>
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.
268
</para>
269
<para>
270
Note that since this program will normally run in the
271
initial RAM disk environment, the interface must be an
272
interface which exists at that stage. Thus, the interface
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"/>.
279
</para>
280
<para>
281
<replaceable>NAME</replaceable> can be the string
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.
224
286
</para>
225
287
</listitem>
226
288
</varlistentry>
232
294
<replaceable>FILE</replaceable></option></term>
233
295
<listitem>
234
296
<para>
235
OpenPGP public key file base name. This will be combined
236
with the directory from the <option>--keydir</option>
237
option to form an absolute file name. The default name is
238
<quote><literal>pubkey.txt</literal></quote>.
297
OpenPGP public key file name. The default name is
298
<quote><filename>/conf/conf.d/mandos/pubkey.txt</filename
299
></quote>.
239
300
</para>
240
301
</listitem>
241
302
</varlistentry>
242
303
243
304
<varlistentry>
244
305
<term><option>--seckey=<replaceable
245
306
>FILE</replaceable></option></term>
247
308
<replaceable>FILE</replaceable></option></term>
248
309
<listitem>
249
310
<para>
250
OpenPGP secret key file base name. This will be combined
251
with the directory from the <option>--keydir</option>
252
option to form an absolute file name. The default name is
253
<quote><literal>seckey.txt</literal></quote>.
311
OpenPGP secret key file name. The default name is
312
<quote><filename>/conf/conf.d/mandos/seckey.txt</filename
313
></quote>.
254
314
</para>
255
315
</listitem>
256
316
</varlistentry>
257
317
258
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>
259
347
<term><option>--priority=<replaceable
260
348
>STRING</replaceable></option></term>
261
349
<listitem>
263
351
xpointer="priority"/>
264
352
</listitem>
265
353
</varlistentry>
266
354
267
355
<varlistentry>
268
356
<term><option>--dh-bits=<replaceable
269
357
>BITS</replaceable></option></term>
270
358
<listitem>
271
359
<para>
272
360
Sets the number of bits to use for the prime number in the
273
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.
383
</para>
384
</listitem>
385
</varlistentry>
386
387
<varlistentry>
388
<term><option>--delay=<replaceable
389
>SECONDS</replaceable></option></term>
390
<listitem>
391
<para>
392
After bringing a network interface up, the program waits
393
for the interface to arrive in a <quote>running</quote>
394
state before proceeding. During this time, the kernel log
395
level will be lowered to reduce clutter on the system
396
console, alleviating any other plugins which might be
397
using the system console. This option sets the upper
398
limit of seconds to wait. The default is 2.5 seconds.
399
</para>
400
</listitem>
401
</varlistentry>
402
403
<varlistentry>
404
<term><option>--retry=<replaceable
405
>SECONDS</replaceable></option></term>
406
<listitem>
407
<para>
408
All Mandos servers are tried repeatedly until a password
409
is received. This value specifies, in seconds, how long
410
between each successive try <emphasis>for the same
411
server</emphasis>. The default is 10 seconds.
412
</para>
413
</listitem>
414
</varlistentry>
415
416
<varlistentry>
417
<term><option>--network-hook-dir=<replaceable
418
>DIR</replaceable></option></term>
419
<listitem>
420
<para>
421
Network hook directory. The default directory is
422
<quote><filename class="directory"
423
>/lib/mandos/network-hooks.d</filename></quote>.
274
424
</para>
275
425
</listitem>
276
426
</varlistentry>
309
459
</para>
310
460
</listitem>
311
461
</varlistentry>
312
462
313
463
<varlistentry>
314
464
<term><option>--version</option></term>
315
465
<term><option>-V</option></term>
321
471
</varlistentry>
322
472
</variablelist>
323
473
</refsect1>
324
474
325
475
<refsect1 id="overview">
326
476
<title>OVERVIEW</title>
327
477
<xi:include href="../overview.xml"/>
328
478
<para>
329
This program is the client part. It is a plugin started by
330
<citerefentry><refentrytitle>plugin-runner</refentrytitle>
331
<manvolnum>8mandos</manvolnum></citerefentry> which will run in
332
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.
333
504
</para>
334
505
<para>
335
506
This program could, theoretically, be used as a keyscript in
336
507
<filename>/etc/crypttab</filename>, but it would then be
337
508
impossible to enter a password for the encrypted root disk at
338
509
the console, since this program does not read from the console
339
at all. This is why a separate plugin (<citerefentry>
340
<refentrytitle>password-prompt</refentrytitle>
341
<manvolnum>8mandos</manvolnum></citerefentry>) does that, which
342
will be run in parallell to this one by the plugin runner.
510
at all.
343
511
</para>
344
512
</refsect1>
345
513
350
518
server could be found and the password received from it could be
351
519
successfully decrypted and output on standard output. The
352
520
program will exit with a non-zero exit status only if a critical
353
error occurs. Otherwise, it will forever connect to new
354
<application>Mandos</application> servers as they appear, trying
355
to get a decryptable password.
521
error occurs. Otherwise, it will forever connect to any
522
discovered <application>Mandos</application> servers, trying to
523
get a decryptable password and print it.
356
524
</para>
357
525
</refsect1>
358
526
359
527
<refsect1 id="environment">
360
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>
361
542
<para>
362
This program does not use any environment variables, not even
363
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
364
545
>cryptsetup</refentrytitle><manvolnum>8</manvolnum>
365
546
</citerefentry>.
366
547
</para>
367
548
</refsect1>
368
549
369
<refsect1 id="file">
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
719
<refsect1 id="files">
370
720
<title>FILES</title>
371
721
<variablelist>
372
722
<varlistentry>
383
733
</para>
384
734
</listitem>
385
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>
386
761
</variablelist>
387
762
</refsect1>
388
763
389
<!-- <refsect1 id="bugs"> -->
390
<!-- <title>BUGS</title> -->
391
<!-- <para> -->
392
<!-- </para> -->
393
<!-- </refsect1> -->
394
764
<refsect1 id="bugs">
765
<title>BUGS</title>
766
<xi:include href="../bugs.xml"/>
767
</refsect1>
768
395
769
<refsect1 id="example">
396
770
<title>EXAMPLE</title>
397
771
<para>
398
772
Note that normally, command line options will not be given
399
directly, but via options for the Mandos <citerefentry
400
><refentrytitle>plugin-runner</refentrytitle>
401
<manvolnum>8mandos</manvolnum></citerefentry>.
773
directly, but passed on via the program responsible for starting
774
this program; see <xref linkend="overview"/>.
402
775
</para>
403
776
<informalexample>
404
777
<para>
405
Normal invocation needs no options, if the network interface
406
is <quote>eth0</quote>:
778
Normal invocation needs no options, if the network interfaces
779
can be automatically determined:
407
780
</para>
408
781
<para>
409
782
<userinput>&COMMANDNAME;</userinput>
411
784
</informalexample>
412
785
<informalexample>
413
786
<para>
414
Search for Mandos servers on another interface:
787
Search for Mandos servers (and connect to them) using one
788
specific interface:
415
789
</para>
416
790
<para>
417
791
<!-- do not wrap this line -->
420
794
</informalexample>
421
795
<informalexample>
422
796
<para>
423
Run in debug mode, and use a custom key directory:
797
Run in debug mode, and use custom keys:
424
798
</para>
425
799
<para>
426
<!-- do not wrap this line -->
427
<userinput>&COMMANDNAME; --debug --keydir keydir</userinput>
800
801
<!-- 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>
803
428
804
</para>
429
805
</informalexample>
430
806
<informalexample>
431
807
<para>
432
Run in debug mode, with a custom key directory, and do not use
433
Zeroconf to locate a server; connect directly to the IPv6
808
Run in debug mode, with custom keys, and do not use Zeroconf
809
to locate a server; connect directly to the IPv6 link-local
434
810
address <quote><systemitem class="ipaddress"
435
>2001:db8:f983:bd0b:30de:ae4a:71f2:f672</systemitem></quote>,
436
port 4711, using interface eth2:
811
>fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
812
using interface eth2:
437
813
</para>
438
814
<para>
439
815
440
816
<!-- do not wrap this line -->
441
<userinput>&COMMANDNAME; --debug --keydir keydir --connect 2001:db8:f983:bd0b:30de:ae4a:71f2:f672: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>
442
818
443
819
</para>
444
820
</informalexample>
445
821
</refsect1>
446
822
447
823
<refsect1 id="security">
448
824
<title>SECURITY</title>
449
825
<para>
450
This program is set-uid to root, but will switch back to the
451
original (and presumably non-privileged) user and group after
452
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.
453
829
</para>
454
830
<para>
455
831
To use this program for its intended purpose (see <xref
468
844
<para>
469
845
The only remaining weak point is that someone with physical
470
846
access to the client hard drive might turn off the client
471
computer, read the OpenPGP keys directly from the hard drive,
472
and communicate with the server. The defense against this is
473
that the server is supposed to notice the client disappearing
474
and will stop giving out the encrypted data. Therefore, it is
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
475
851
important to set the timeout and checker interval values tightly
476
852
on the server. See <citerefentry><refentrytitle
477
853
>mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
479
855
<para>
480
856
It will also help if the checker program on the server is
481
857
configured to request something from the client which can not be
482
spoofed by someone else on the network, unlike unencrypted
483
<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.
484
861
</para>
485
862
<para>
486
863
<emphasis>Note</emphasis>: This makes it completely insecure to
490
867
confidential.
491
868
</para>
492
869
</refsect1>
493
870
494
871
<refsect1 id="see_also">
495
872
<title>SEE ALSO</title>
496
873
<para>
874
<citerefentry><refentrytitle>intro</refentrytitle>
875
<manvolnum>8mandos</manvolnum></citerefentry>,
497
876
<citerefentry><refentrytitle>cryptsetup</refentrytitle>
498
877
<manvolnum>8</manvolnum></citerefentry>,
499
878
<citerefentry><refentrytitle>crypttab</refentrytitle>
500
879
<manvolnum>5</manvolnum></citerefentry>,
501
880
<citerefentry><refentrytitle>mandos</refentrytitle>
502
881
<manvolnum>8</manvolnum></citerefentry>,
503
<citerefentry><refentrytitle>password-prompt</refentrytitle>
882
<citerefentry><refentrytitle>password-agent</refentrytitle>
504
883
<manvolnum>8mandos</manvolnum></citerefentry>,
505
884
<citerefentry><refentrytitle>plugin-runner</refentrytitle>
506
885
<manvolnum>8mandos</manvolnum></citerefentry>
519
898
</varlistentry>
520
899
<varlistentry>
521
900
<term>
522
<ulink url="http://www.avahi.org/">Avahi</ulink>
901
<ulink url="https://www.avahi.org/">Avahi</ulink>
523
902
</term>
524
903
<listitem>
525
904
<para>
530
909
</varlistentry>
531
910
<varlistentry>
532
911
<term>
533
<ulink url="http://www.gnu.org/software/gnutls/"
534
>GnuTLS</ulink>
912
<ulink url="https://www.gnutls.org/">GnuTLS</ulink>
535
913
</term>
536
914
<listitem>
537
915
<para>
538
916
GnuTLS is the library this client uses to implement TLS for
539
917
communicating securely with the server, and at the same time
540
send the public OpenPGP key to the server.
918
send the public key to the server.
541
919
</para>
542
920
</listitem>
543
921
</varlistentry>
544
922
<varlistentry>
545
923
<term>
546
<ulink url="http://www.gnupg.org/related_software/gpgme/"
924
<ulink url="https://www.gnupg.org/related_software/gpgme/"
547
925
>GPGME</ulink>
548
926
</term>
549
927
<listitem>
577
955
<para>
578
956
This client uses IPv6 link-local addresses, which are
579
957
immediately usable since a link-local addresses is
580
automatically assigned to a network interfaces when it
958
automatically assigned to a network interface when it
581
959
is brought up.
582
960
</para>
583
961
</listitem>
587
965
</varlistentry>
588
966
<varlistentry>
589
967
<term>
590
RFC 4346: <citetitle>The Transport Layer Security (TLS)
591
Protocol Version 1.1</citetitle>
968
RFC 5246: <citetitle>The Transport Layer Security (TLS)
969
Protocol Version 1.2</citetitle>
592
970
</term>
593
971
<listitem>
594
972
<para>
595
TLS 1.1 is the protocol implemented by GnuTLS.
973
TLS 1.2 is the protocol implemented by GnuTLS.
596
974
</para>
597
975
</listitem>
598
976
</varlistentry>
609
987
</varlistentry>
610
988
<varlistentry>
611
989
<term>
612
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
613
1005
Security</citetitle>
614
1006
</term>
615
1007
<listitem>
616
1008
<para>
617
This is implemented by GnuTLS and used by this program so
618
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.
619
1012
</para>
620
1013
</listitem>
621
1014
</varlistentry>
622
1015
</variablelist>
623
1016
</refsect1>
624
625
1017
</refentry>
1018
626
1019
<!-- Local Variables: -->
627
1020
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
628
1021
<!-- time-stamp-end: "[\"']>" -->
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0