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/password-request.xml
- browse files at revision 136
- compare with another revision
- download diff
- download tarball
- view history from revision 136
- Committer: Teddy Hogeborn
- Date: 2008-09-01 16:53:17 UTC
- Revision ID: teddy@fukt.bsnet.se-20080901165317-77dccp81zyqimt2j
* plugin-runner.c (add_environment): Override existing environment
variables when asked to do so.
All callers changed.
(main): Removed old argp.args_doc string. Parse argument file
before normal command line arguments. Use ARGP_IN_ORDER
flag in both calls to argp_parse. Do not strdup() strings
to be sent to add_environment().
* plugin-runner.xml (OPTIONS): Document "--global-env" and "--envs-for".
(FILES): Note that the config file is parsed before the command line
options.
variables when asked to do so.
All callers changed.
(main): Removed old argp.args_doc string. Parse argument file
before normal command line arguments. Use ARGP_IN_ORDER
flag in both calls to argp_parse. Do not strdup() strings
to be sent to add_environment().
* plugin-runner.xml (OPTIONS): Document "--global-env" and "--envs-for".
(FILES): Note that the config file is parsed before the command line
options.
- files added:
- initramfs-tools-hook-conf
- files removed:
- .bzr-builddeb
- debian
- debian/po
- debian/source
- debian/upstream
- network-hooks.d
- plugin-helpers
- files renamed:
- plugins.d/mandos-client.c => plugins.d/password-request.c
- plugins.d/mandos-client.xml => plugins.d/password-request.xml
- files modified:
- .bzrignore
added
removed
plugins.d/password-request.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 COMMANDNAME "mandos-client">
5
<!ENTITY TIMESTAMP "2019-02-09">
6
<!ENTITY % common SYSTEM "../common.ent">
7
%common;
4
<!ENTITY VERSION "1.0">
5
<!ENTITY COMMANDNAME "password-request">
6
<!ENTITY TIMESTAMP "2008-08-31">
8
7
]>
9
8
10
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
11
10
<refentryinfo>
12
11
<title>Mandos Manual</title>
13
<!-- NWalsh’s docbook scripts use this to generate the footer: -->
12
<!-- Nwalsh’s docbook scripts use this to generate the footer: -->
14
13
<productname>Mandos</productname>
15
<productnumber>&version;</productnumber>
14
<productnumber>&VERSION;</productnumber>
16
15
<date>&TIMESTAMP;</date>
17
16
<authorgroup>
18
17
<author>
19
18
<firstname>Björn</firstname>
20
19
<surname>Påhlsson</surname>
21
20
<address>
22
<email>belorn@recompile.se</email>
21
<email>belorn@fukt.bsnet.se</email>
23
22
</address>
24
23
</author>
25
24
<author>
26
25
<firstname>Teddy</firstname>
27
26
<surname>Hogeborn</surname>
28
27
<address>
29
<email>teddy@recompile.se</email>
28
<email>teddy@fukt.bsnet.se</email>
30
29
</address>
31
30
</author>
32
31
</authorgroup>
33
32
<copyright>
34
33
<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
34
<holder>Teddy Hogeborn</holder>
46
35
<holder>Björn Påhlsson</holder>
47
36
</copyright>
48
37
<xi:include href="../legalnotice.xml"/>
49
38
</refentryinfo>
50
39
51
40
<refmeta>
52
41
<refentrytitle>&COMMANDNAME;</refentrytitle>
53
42
<manvolnum>8mandos</manvolnum>
56
45
<refnamediv>
57
46
<refname><command>&COMMANDNAME;</command></refname>
58
47
<refpurpose>
59
Client for <application>Mandos</application>
48
Client for mandos
60
49
</refpurpose>
61
50
</refnamediv>
62
51
63
52
<refsynopsisdiv>
64
53
<cmdsynopsis>
65
54
<command>&COMMANDNAME;</command>
66
55
<group>
67
56
<arg choice="plain"><option>--connect
68
<replaceable>ADDRESS</replaceable><literal>:</literal
57
<replaceable>IPADDR</replaceable><literal>:</literal
69
58
><replaceable>PORT</replaceable></option></arg>
70
59
<arg choice="plain"><option>-c
71
<replaceable>ADDRESS</replaceable><literal>:</literal
60
<replaceable>IPADDR</replaceable><literal>:</literal
72
61
><replaceable>PORT</replaceable></option></arg>
73
62
</group>
74
63
<sbr/>
75
<group rep='repeat'>
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
72
<arg choice="plain"><option>--interface
77
<replaceable>NAME</replaceable><arg rep='repeat'
78
>,<replaceable>NAME</replaceable></arg></option></arg>
79
<arg choice="plain"><option>-i <replaceable>NAME</replaceable
80
><arg rep='repeat'>,<replaceable>NAME</replaceable></arg
81
></option></arg>
73
<replaceable>NAME</replaceable></option></arg>
74
<arg choice="plain"><option>-i
75
<replaceable>NAME</replaceable></option></arg>
82
76
</group>
83
77
<sbr/>
84
78
<group>
95
89
<replaceable>FILE</replaceable></option></arg>
96
90
</group>
97
91
<sbr/>
98
<group>
99
<arg choice="plain"><option>--tls-privkey
100
<replaceable>FILE</replaceable></option></arg>
101
<arg choice="plain"><option>-t
102
<replaceable>FILE</replaceable></option></arg>
103
</group>
104
<sbr/>
105
<group>
106
<arg choice="plain"><option>--tls-pubkey
107
<replaceable>FILE</replaceable></option></arg>
108
<arg choice="plain"><option>-T
109
<replaceable>FILE</replaceable></option></arg>
110
</group>
111
<sbr/>
112
92
<arg>
113
93
<option>--priority <replaceable>STRING</replaceable></option>
114
94
</arg>
118
98
</arg>
119
99
<sbr/>
120
100
<arg>
121
<option>--dh-params <replaceable>FILE</replaceable></option>
122
</arg>
123
<sbr/>
124
<arg>
125
<option>--delay <replaceable>SECONDS</replaceable></option>
126
</arg>
127
<sbr/>
128
<arg>
129
<option>--retry <replaceable>SECONDS</replaceable></option>
130
</arg>
131
<sbr/>
132
<arg>
133
<option>--network-hook-dir
134
<replaceable>DIR</replaceable></option>
135
</arg>
136
<sbr/>
137
<arg>
138
101
<option>--debug</option>
139
102
</arg>
140
103
</cmdsynopsis>
157
120
</group>
158
121
</cmdsynopsis>
159
122
</refsynopsisdiv>
160
123
161
124
<refsect1 id="description">
162
125
<title>DESCRIPTION</title>
163
126
<para>
164
<command>&COMMANDNAME;</command> is a client program that
165
communicates with <citerefentry><refentrytitle
166
>mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>
167
to get a password. In slightly more detail, this client program
168
brings up network interfaces, uses the interfaces’ IPv6
169
link-local addresses to get network connectivity, uses Zeroconf
170
to find servers on the local network, and communicates with
171
servers using TLS with a raw public key to ensure authenticity
172
and confidentiality. This client program keeps running, trying
173
all servers on the network, until it receives a satisfactory
174
reply or a TERM signal. After all servers have been tried, all
175
servers are periodically retried. If no servers are found it
176
will wait indefinitely for new servers to appear.
177
</para>
178
<para>
179
The network interfaces are selected like this: If any interfaces
180
are specified using the <option>--interface</option> option,
181
those interface are used. Otherwise,
182
<command>&COMMANDNAME;</command> will use all interfaces that
183
are not loopback interfaces, are not point-to-point interfaces,
184
are capable of broadcasting and do not have the NOARP flag (see
185
<citerefentry><refentrytitle>netdevice</refentrytitle>
186
<manvolnum>7</manvolnum></citerefentry>). (If the
187
<option>--connect</option> option is used, point-to-point
188
interfaces and non-broadcast interfaces are accepted.) If any
189
used interfaces are not up and running, they are first taken up
190
(and later taken down again on program exit).
191
</para>
192
<para>
193
Before network interfaces are selected, all <quote>network
194
hooks</quote> are run; see <xref linkend="network-hooks"/>.
195
</para>
196
<para>
197
This program is not meant to be run directly; it is really meant
198
to run as a plugin of the <application>Mandos</application>
199
<citerefentry><refentrytitle>plugin-runner</refentrytitle>
200
<manvolnum>8mandos</manvolnum></citerefentry>, which runs in the
201
initial <acronym>RAM</acronym> disk environment because it is
202
specified as a <quote>keyscript</quote> in the <citerefentry>
203
<refentrytitle>crypttab</refentrytitle><manvolnum>5</manvolnum>
204
</citerefentry> file.
205
</para>
206
</refsect1>
207
208
<refsect1 id="purpose">
209
<title>PURPOSE</title>
210
<para>
211
The purpose of this is to enable <emphasis>remote and unattended
212
rebooting</emphasis> of client host computer with an
213
<emphasis>encrypted root file system</emphasis>. See <xref
214
linkend="overview"/> for details.
127
<command>&COMMANDNAME;</command> is a mandos plugin that works
128
like a client program that through avahi detects mandos servers,
129
sets up a gnutls connect and request a encrypted password. Any
130
passwords given is automaticly decrypted and passed to
131
cryptsetup.
215
132
</para>
216
133
</refsect1>
217
134
218
135
<refsect1 id="options">
219
136
<title>OPTIONS</title>
220
137
<para>
221
This program is commonly not invoked from the command line; it
222
is normally started by the <application>Mandos</application>
223
plugin runner, see <citerefentry><refentrytitle
224
>plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum>
225
</citerefentry>. Any command line options this program accepts
226
are therefore normally provided by the plugin runner, and not
227
directly.
138
Commonly not invoked as command lines but from configuration
139
file of plugin runner.
228
140
</para>
229
141
230
142
<variablelist>
231
143
<varlistentry>
232
144
<term><option>--connect=<replaceable
233
>ADDRESS</replaceable><literal>:</literal><replaceable
145
>IPADDR</replaceable><literal>:</literal><replaceable
234
146
>PORT</replaceable></option></term>
235
147
<term><option>-c
236
<replaceable>ADDRESS</replaceable><literal>:</literal
148
<replaceable>IPADDR</replaceable><literal>:</literal
237
149
><replaceable>PORT</replaceable></option></term>
238
150
<listitem>
239
151
<para>
240
Do not use Zeroconf to locate servers. Connect directly
241
to only one specified <application>Mandos</application>
242
server. Note that an IPv6 address has colon characters in
243
it, so the <emphasis>last</emphasis> colon character is
244
assumed to separate the address from the port number.
152
Connect directly to a specified mandos server
245
153
</para>
154
</listitem>
155
</varlistentry>
156
157
<varlistentry>
158
<term><option>--keydir=<replaceable
159
>DIRECTORY</replaceable></option></term>
160
<term><option>-d
161
<replaceable>DIRECTORY</replaceable></option></term>
162
<listitem>
246
163
<para>
247
Normally, Zeroconf would be used to locate Mandos servers,
248
in which case this option would only be used when testing
249
and debugging.
164
Directory where the openpgp keyring is
250
165
</para>
251
166
</listitem>
252
167
</varlistentry>
253
168
254
169
<varlistentry>
255
<term><option>--interface=<replaceable
256
>NAME</replaceable><arg rep='repeat'>,<replaceable
257
>NAME</replaceable></arg></option></term>
170
<term><option>--interface=
171
<replaceable>NAME</replaceable></option></term>
258
172
<term><option>-i
259
<replaceable>NAME</replaceable><arg rep='repeat'>,<replaceable
260
>NAME</replaceable></arg></option></term>
173
<replaceable>NAME</replaceable></option></term>
261
174
<listitem>
262
175
<para>
263
Comma separated list of network interfaces that will be
264
brought up and scanned for Mandos servers to connect to.
265
The default is the empty string, which will automatically
266
use all appropriate interfaces.
267
</para>
268
<para>
269
If the <option>--connect</option> option is used, and
270
exactly one interface name is specified (except
271
<quote><literal>none</literal></quote>), this specifies
272
the interface to use to connect to the address given.
273
</para>
274
<para>
275
Note that since this program will normally run in the
276
initial RAM disk environment, the interface must be an
277
interface which exists at that stage. Thus, the interface
278
can normally not be a pseudo-interface such as
279
<quote>br0</quote> or <quote>tun0</quote>; such interfaces
280
will not exist until much later in the boot process, and
281
can not be used by this program, unless created by a
282
<quote>network hook</quote> — see <xref
283
linkend="network-hooks"/>.
284
</para>
285
<para>
286
<replaceable>NAME</replaceable> can be the string
287
<quote><literal>none</literal></quote>; this will make
288
<command>&COMMANDNAME;</command> only bring up interfaces
289
specified <emphasis>before</emphasis> this string. This
290
is not recommended, and only meant for advanced users.
176
Interface that Avahi will connect through
291
177
</para>
292
178
</listitem>
293
179
</varlistentry>
294
180
295
181
<varlistentry>
296
182
<term><option>--pubkey=<replaceable
297
183
>FILE</replaceable></option></term>
299
185
<replaceable>FILE</replaceable></option></term>
300
186
<listitem>
301
187
<para>
302
OpenPGP public key file name. The default name is
303
<quote><filename>/conf/conf.d/mandos/pubkey.txt</filename
304
></quote>.
188
Public openpgp key for gnutls authentication
305
189
</para>
306
190
</listitem>
307
191
</varlistentry>
308
192
309
193
<varlistentry>
310
194
<term><option>--seckey=<replaceable
311
195
>FILE</replaceable></option></term>
313
197
<replaceable>FILE</replaceable></option></term>
314
198
<listitem>
315
199
<para>
316
OpenPGP secret key file name. The default name is
317
<quote><filename>/conf/conf.d/mandos/seckey.txt</filename
318
></quote>.
200
Secret OpenPGP key for GnuTLS authentication
319
201
</para>
320
202
</listitem>
321
203
</varlistentry>
322
204
323
205
<varlistentry>
324
<term><option>--tls-pubkey=<replaceable
325
>FILE</replaceable></option></term>
326
<term><option>-T
327
<replaceable>FILE</replaceable></option></term>
328
<listitem>
329
<para>
330
TLS raw public key file name. The default name is
331
<quote><filename>/conf/conf.d/mandos/tls-pubkey.pem</filename
332
></quote>.
333
</para>
334
</listitem>
335
</varlistentry>
336
337
<varlistentry>
338
<term><option>--tls-privkey=<replaceable
339
>FILE</replaceable></option></term>
340
<term><option>-t
341
<replaceable>FILE</replaceable></option></term>
342
<listitem>
343
<para>
344
TLS secret key file name. The default name is
345
<quote><filename>/conf/conf.d/mandos/tls-privkey.pem</filename
346
></quote>.
347
</para>
348
</listitem>
349
</varlistentry>
350
351
<varlistentry>
352
206
<term><option>--priority=<replaceable
353
207
>STRING</replaceable></option></term>
354
208
<listitem>
355
<xi:include href="../mandos-options.xml"
356
xpointer="priority"/>
209
<para>
210
GnuTLS priority
211
</para>
357
212
</listitem>
358
213
</varlistentry>
359
214
360
215
<varlistentry>
361
216
<term><option>--dh-bits=<replaceable
362
217
>BITS</replaceable></option></term>
363
218
<listitem>
364
219
<para>
365
Sets the number of bits to use for the prime number in the
366
TLS Diffie-Hellman key exchange. The default value is
367
selected automatically based on the GnuTLS security
368
profile set in its priority string. Note that if the
369
<option>--dh-params</option> option is used, the values
370
from that file will be used instead.
371
</para>
372
</listitem>
373
</varlistentry>
374
375
<varlistentry>
376
<term><option>--dh-params=<replaceable
377
>FILE</replaceable></option></term>
378
<listitem>
379
<para>
380
Specifies a PEM-encoded PKCS#3 file to read the parameters
381
needed by the TLS Diffie-Hellman key exchange from. If
382
this option is not given, or if the file for some reason
383
could not be used, the parameters will be generated on
384
startup, which will take some time and processing power.
385
Those using servers running under time, power or processor
386
constraints may want to generate such a file in advance
387
and use this option.
388
</para>
389
</listitem>
390
</varlistentry>
391
392
<varlistentry>
393
<term><option>--delay=<replaceable
394
>SECONDS</replaceable></option></term>
395
<listitem>
396
<para>
397
After bringing a network interface up, the program waits
398
for the interface to arrive in a <quote>running</quote>
399
state before proceeding. During this time, the kernel log
400
level will be lowered to reduce clutter on the system
401
console, alleviating any other plugins which might be
402
using the system console. This option sets the upper
403
limit of seconds to wait. The default is 2.5 seconds.
404
</para>
405
</listitem>
406
</varlistentry>
407
408
<varlistentry>
409
<term><option>--retry=<replaceable
410
>SECONDS</replaceable></option></term>
411
<listitem>
412
<para>
413
All Mandos servers are tried repeatedly until a password
414
is received. This value specifies, in seconds, how long
415
between each successive try <emphasis>for the same
416
server</emphasis>. The default is 10 seconds.
417
</para>
418
</listitem>
419
</varlistentry>
420
421
<varlistentry>
422
<term><option>--network-hook-dir=<replaceable
423
>DIR</replaceable></option></term>
424
<listitem>
425
<para>
426
Network hook directory. The default directory is
427
<quote><filename class="directory"
428
>/lib/mandos/network-hooks.d</filename></quote>.
220
DH bits to use in gnutls communication
429
221
</para>
430
222
</listitem>
431
223
</varlistentry>
434
226
<term><option>--debug</option></term>
435
227
<listitem>
436
228
<para>
437
Enable debug mode. This will enable a lot of output to
438
standard error about what the program is doing. The
439
program will still perform all other functions normally.
440
</para>
441
<para>
442
It will also enable debug mode in the Avahi and GnuTLS
443
libraries, making them print large amounts of debugging
444
output.
229
Debug mode
445
230
</para>
446
231
</listitem>
447
232
</varlistentry>
451
236
<term><option>-?</option></term>
452
237
<listitem>
453
238
<para>
454
Gives a help message about options and their meanings.
239
Gives a help message
455
240
</para>
456
241
</listitem>
457
242
</varlistentry>
460
245
<term><option>--usage</option></term>
461
246
<listitem>
462
247
<para>
463
Gives a short usage message.
248
Gives a short usage message
464
249
</para>
465
250
</listitem>
466
251
</varlistentry>
467
252
468
253
<varlistentry>
469
254
<term><option>--version</option></term>
470
255
<term><option>-V</option></term>
471
256
<listitem>
472
257
<para>
473
Prints the program version.
258
Prints the program version
474
259
</para>
475
260
</listitem>
476
261
</varlistentry>
477
262
</variablelist>
478
263
</refsect1>
479
480
<refsect1 id="overview">
481
<title>OVERVIEW</title>
482
<xi:include href="../overview.xml"/>
483
<para>
484
This program is the client part. It is a plugin started by
485
<citerefentry><refentrytitle>plugin-runner</refentrytitle>
486
<manvolnum>8mandos</manvolnum></citerefentry> which will run in
487
an initial <acronym>RAM</acronym> disk environment.
488
</para>
489
<para>
490
This program could, theoretically, be used as a keyscript in
491
<filename>/etc/crypttab</filename>, but it would then be
492
impossible to enter a password for the encrypted root disk at
493
the console, since this program does not read from the console
494
at all. This is why a separate plugin runner (<citerefentry>
495
<refentrytitle>plugin-runner</refentrytitle>
496
<manvolnum>8mandos</manvolnum></citerefentry>) is used to run
497
both this program and others in in parallel,
498
<emphasis>one</emphasis> of which (<citerefentry>
499
<refentrytitle>password-prompt</refentrytitle>
500
<manvolnum>8mandos</manvolnum></citerefentry>) will prompt for
501
passwords on the system console.
502
</para>
503
</refsect1>
504
264
505
265
<refsect1 id="exit_status">
506
266
<title>EXIT STATUS</title>
507
267
<para>
508
This program will exit with a successful (zero) exit status if a
509
server could be found and the password received from it could be
510
successfully decrypted and output on standard output. The
511
program will exit with a non-zero exit status only if a critical
512
error occurs. Otherwise, it will forever connect to any
513
discovered <application>Mandos</application> servers, trying to
514
get a decryptable password and print it.
515
268
</para>
516
269
</refsect1>
517
270
518
271
<refsect1 id="environment">
519
272
<title>ENVIRONMENT</title>
520
<variablelist>
521
<varlistentry>
522
<term><envar>MANDOSPLUGINHELPERDIR</envar></term>
523
<listitem>
524
<para>
525
This environment variable will be assumed to contain the
526
directory containing any helper executables. The use and
527
nature of these helper executables, if any, is
528
purposefully not documented.
529
</para>
530
</listitem>
531
</varlistentry>
532
</variablelist>
533
<para>
534
This program does not use any other environment variables, not
535
even the ones provided by <citerefentry><refentrytitle
536
>cryptsetup</refentrytitle><manvolnum>8</manvolnum>
537
</citerefentry>.
538
</para>
539
</refsect1>
540
541
<refsect1 id="network-hooks">
542
<title>NETWORK HOOKS</title>
543
<para>
544
If a network interface like a bridge or tunnel is required to
545
find a Mandos server, this requires the interface to be up and
546
running before <command>&COMMANDNAME;</command> starts looking
547
for Mandos servers. This can be accomplished by creating a
548
<quote>network hook</quote> program, and placing it in a special
549
directory.
550
</para>
551
<para>
552
Before the network is used (and again before program exit), any
553
runnable programs found in the network hook directory are run
554
with the argument <quote><literal>start</literal></quote> or
555
<quote><literal>stop</literal></quote>. This should bring up or
556
down, respectively, any network interface which
557
<command>&COMMANDNAME;</command> should use.
558
</para>
559
<refsect2 id="hook-requirements">
560
<title>REQUIREMENTS</title>
561
<para>
562
A network hook must be an executable file, and its name must
563
consist entirely of upper and lower case letters, digits,
564
underscores, periods, and hyphens.
565
</para>
566
<para>
567
A network hook will receive one argument, which can be one of
568
the following:
569
</para>
570
<variablelist>
571
<varlistentry>
572
<term><literal>start</literal></term>
573
<listitem>
574
<para>
575
This should make the network hook create (if necessary)
576
and bring up a network interface.
577
</para>
578
</listitem>
579
</varlistentry>
580
<varlistentry>
581
<term><literal>stop</literal></term>
582
<listitem>
583
<para>
584
This should make the network hook take down a network
585
interface, and delete it if it did not exist previously.
586
</para>
587
</listitem>
588
</varlistentry>
589
<varlistentry>
590
<term><literal>files</literal></term>
591
<listitem>
592
<para>
593
This should make the network hook print, <emphasis>one
594
file per line</emphasis>, all the files needed for it to
595
run. (These files will be copied into the initial RAM
596
filesystem.) Typical use is for a network hook which is
597
a shell script to print its needed binaries.
598
</para>
599
<para>
600
It is not necessary to print any non-executable files
601
already in the network hook directory, these will be
602
copied implicitly if they otherwise satisfy the name
603
requirements.
604
</para>
605
</listitem>
606
</varlistentry>
607
<varlistentry>
608
<term><literal>modules</literal></term>
609
<listitem>
610
<para>
611
This should make the network hook print, <emphasis>on
612
separate lines</emphasis>, all the kernel modules needed
613
for it to run. (These modules will be copied into the
614
initial RAM filesystem.) For instance, a tunnel
615
interface needs the
616
<quote><literal>tun</literal></quote> module.
617
</para>
618
</listitem>
619
</varlistentry>
620
</variablelist>
621
<para>
622
The network hook will be provided with a number of environment
623
variables:
624
</para>
625
<variablelist>
626
<varlistentry>
627
<term><envar>MANDOSNETHOOKDIR</envar></term>
628
<listitem>
629
<para>
630
The network hook directory, specified to
631
<command>&COMMANDNAME;</command> by the
632
<option>--network-hook-dir</option> option. Note: this
633
should <emphasis>always</emphasis> be used by the
634
network hook to refer to itself or any files in the hook
635
directory it may require.
636
</para>
637
</listitem>
638
</varlistentry>
639
<varlistentry>
640
<term><envar>DEVICE</envar></term>
641
<listitem>
642
<para>
643
The network interfaces, as specified to
644
<command>&COMMANDNAME;</command> by the
645
<option>--interface</option> option, combined to one
646
string and separated by commas. If this is set, and
647
does not contain the interface a hook will bring up,
648
there is no reason for a hook to continue.
649
</para>
650
</listitem>
651
</varlistentry>
652
<varlistentry>
653
<term><envar>MODE</envar></term>
654
<listitem>
655
<para>
656
This will be the same as the first argument;
657
i.e. <quote><literal>start</literal></quote>,
658
<quote><literal>stop</literal></quote>,
659
<quote><literal>files</literal></quote>, or
660
<quote><literal>modules</literal></quote>.
661
</para>
662
</listitem>
663
</varlistentry>
664
<varlistentry>
665
<term><envar>VERBOSITY</envar></term>
666
<listitem>
667
<para>
668
This will be the <quote><literal>1</literal></quote> if
669
the <option>--debug</option> option is passed to
670
<command>&COMMANDNAME;</command>, otherwise
671
<quote><literal>0</literal></quote>.
672
</para>
673
</listitem>
674
</varlistentry>
675
<varlistentry>
676
<term><envar>DELAY</envar></term>
677
<listitem>
678
<para>
679
This will be the same as the <option>--delay</option>
680
option passed to <command>&COMMANDNAME;</command>. Is
681
only set if <envar>MODE</envar> is
682
<quote><literal>start</literal></quote> or
683
<quote><literal>stop</literal></quote>.
684
</para>
685
</listitem>
686
</varlistentry>
687
<varlistentry>
688
<term><envar>CONNECT</envar></term>
689
<listitem>
690
<para>
691
This will be the same as the <option>--connect</option>
692
option passed to <command>&COMMANDNAME;</command>. Is
693
only set if <option>--connect</option> is passed and
694
<envar>MODE</envar> is
695
<quote><literal>start</literal></quote> or
696
<quote><literal>stop</literal></quote>.
697
</para>
698
</listitem>
699
</varlistentry>
700
</variablelist>
701
<para>
702
A hook may not read from standard input, and should be
703
restrictive in printing to standard output or standard error
704
unless <varname>VERBOSITY</varname> is
705
<quote><literal>1</literal></quote>.
706
</para>
707
</refsect2>
708
</refsect1>
709
710
<refsect1 id="files">
273
<para>
274
</para>
275
</refsect1>
276
277
<refsect1 id="file">
711
278
<title>FILES</title>
712
<variablelist>
713
<varlistentry>
714
<term><filename>/conf/conf.d/mandos/pubkey.txt</filename
715
></term>
716
<term><filename>/conf/conf.d/mandos/seckey.txt</filename
717
></term>
718
<listitem>
719
<para>
720
OpenPGP public and private key files, in <quote>ASCII
721
Armor</quote> format. These are the default file names,
722
they can be changed with the <option>--pubkey</option> and
723
<option>--seckey</option> options.
724
</para>
725
</listitem>
726
</varlistentry>
727
<varlistentry>
728
<term><filename>/conf/conf.d/mandos/tls-pubkey.pem</filename
729
></term>
730
<term><filename>/conf/conf.d/mandos/tls-privkey.pem</filename
731
></term>
732
<listitem>
733
<para>
734
Public and private raw key files, in <quote>PEM</quote>
735
format. These are the default file names, they can be
736
changed with the <option>--tls-pubkey</option> and
737
<option>--tls-privkey</option> options.
738
</para>
739
</listitem>
740
</varlistentry>
741
<varlistentry>
742
<term><filename
743
class="directory">/lib/mandos/network-hooks.d</filename></term>
744
<listitem>
745
<para>
746
Directory where network hooks are located. Change this
747
with the <option>--network-hook-dir</option> option. See
748
<xref linkend="network-hooks"/>.
749
</para>
750
</listitem>
751
</varlistentry>
752
</variablelist>
279
<para>
280
</para>
753
281
</refsect1>
754
282
755
283
<refsect1 id="bugs">
756
284
<title>BUGS</title>
757
<xi:include href="../bugs.xml"/>
285
<para>
286
</para>
758
287
</refsect1>
759
288
760
289
<refsect1 id="example">
761
290
<title>EXAMPLE</title>
762
291
<para>
763
Note that normally, command line options will not be given
764
directly, but via options for the Mandos <citerefentry
765
><refentrytitle>plugin-runner</refentrytitle>
766
<manvolnum>8mandos</manvolnum></citerefentry>.
767
292
</para>
768
<informalexample>
769
<para>
770
Normal invocation needs no options, if the network interfaces
771
can be automatically determined:
772
</para>
773
<para>
774
<userinput>&COMMANDNAME;</userinput>
775
</para>
776
</informalexample>
777
<informalexample>
778
<para>
779
Search for Mandos servers (and connect to them) using one
780
specific interface:
781
</para>
782
<para>
783
<!-- do not wrap this line -->
784
<userinput>&COMMANDNAME; --interface eth1</userinput>
785
</para>
786
</informalexample>
787
<informalexample>
788
<para>
789
Run in debug mode, and use custom keys:
790
</para>
791
<para>
792
793
<!-- do not wrap this line -->
794
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --tls-pubkey keydir/tls-pubkey.pem --tls-privkey keydir/tls-privkey.pem</userinput>
795
796
</para>
797
</informalexample>
798
<informalexample>
799
<para>
800
Run in debug mode, with custom keys, and do not use Zeroconf
801
to locate a server; connect directly to the IPv6 link-local
802
address <quote><systemitem class="ipaddress"
803
>fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
804
using interface eth2:
805
</para>
806
<para>
807
808
<!-- do not wrap this line -->
809
<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>
810
811
</para>
812
</informalexample>
813
293
</refsect1>
814
294
815
295
<refsect1 id="security">
816
296
<title>SECURITY</title>
817
297
<para>
818
This program is set-uid to root, but will switch back to the
819
original (and presumably non-privileged) user and group after
820
bringing up the network interface.
821
</para>
822
<para>
823
To use this program for its intended purpose (see <xref
824
linkend="purpose"/>), the password for the root file system will
825
have to be given out to be stored in a server computer, after
826
having been encrypted using an OpenPGP key. This encrypted data
827
which will be stored in a server can only be decrypted by the
828
OpenPGP key, and the data will only be given out to those
829
clients who can prove they actually have that key. This key,
830
however, is stored unencrypted on the client side in its initial
831
<acronym>RAM</acronym> disk image file system. This is normally
832
readable by all, but this is normally fixed during installation
833
of this program; file permissions are set so that no-one is able
834
to read that file.
835
</para>
836
<para>
837
The only remaining weak point is that someone with physical
838
access to the client hard drive might turn off the client
839
computer, read the OpenPGP and TLS keys directly from the hard
840
drive, and communicate with the server. To safeguard against
841
this, the server is supposed to notice the client disappearing
842
and stop giving out the encrypted data. Therefore, it is
843
important to set the timeout and checker interval values tightly
844
on the server. See <citerefentry><refentrytitle
845
>mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
846
</para>
847
<para>
848
It will also help if the checker program on the server is
849
configured to request something from the client which can not be
850
spoofed by someone else on the network, like SSH server key
851
fingerprints, and unlike unencrypted <acronym>ICMP</acronym>
852
echo (<quote>ping</quote>) replies.
853
</para>
854
<para>
855
<emphasis>Note</emphasis>: This makes it completely insecure to
856
have <application >Mandos</application> clients which dual-boot
857
to another operating system which is <emphasis>not</emphasis>
858
trusted to keep the initial <acronym>RAM</acronym> disk image
859
confidential.
860
298
</para>
861
299
</refsect1>
862
300
863
301
<refsect1 id="see_also">
864
302
<title>SEE ALSO</title>
865
303
<para>
866
<citerefentry><refentrytitle>intro</refentrytitle>
867
<manvolnum>8mandos</manvolnum></citerefentry>,
868
<citerefentry><refentrytitle>cryptsetup</refentrytitle>
869
<manvolnum>8</manvolnum></citerefentry>,
870
<citerefentry><refentrytitle>crypttab</refentrytitle>
871
<manvolnum>5</manvolnum></citerefentry>,
872
304
<citerefentry><refentrytitle>mandos</refentrytitle>
873
305
<manvolnum>8</manvolnum></citerefentry>,
874
306
<citerefentry><refentrytitle>password-prompt</refentrytitle>
876
308
<citerefentry><refentrytitle>plugin-runner</refentrytitle>
877
309
<manvolnum>8mandos</manvolnum></citerefentry>
878
310
</para>
879
<variablelist>
880
<varlistentry>
881
<term>
882
<ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
883
</term>
884
<listitem>
885
<para>
886
Zeroconf is the network protocol standard used for finding
887
Mandos servers on the local network.
888
</para>
889
</listitem>
890
</varlistentry>
891
<varlistentry>
892
<term>
893
<ulink url="http://www.avahi.org/">Avahi</ulink>
894
</term>
895
<listitem>
896
<para>
897
Avahi is the library this program calls to find Zeroconf
898
services.
899
</para>
900
</listitem>
901
</varlistentry>
902
<varlistentry>
903
<term>
904
<ulink url="https://www.gnutls.org/">GnuTLS</ulink>
905
</term>
906
<listitem>
907
<para>
908
GnuTLS is the library this client uses to implement TLS for
909
communicating securely with the server, and at the same time
910
send the public key to the server.
911
</para>
912
</listitem>
913
</varlistentry>
914
<varlistentry>
915
<term>
916
<ulink url="https://www.gnupg.org/related_software/gpgme/"
917
>GPGME</ulink>
918
</term>
919
<listitem>
920
<para>
921
GPGME is the library used to decrypt the OpenPGP data sent
922
by the server.
923
</para>
924
</listitem>
925
</varlistentry>
926
<varlistentry>
927
<term>
928
RFC 4291: <citetitle>IP Version 6 Addressing
929
Architecture</citetitle>
930
</term>
931
<listitem>
932
<variablelist>
933
<varlistentry>
934
<term>Section 2.2: <citetitle>Text Representation of
935
Addresses</citetitle></term>
936
<listitem><para/></listitem>
937
</varlistentry>
938
<varlistentry>
939
<term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
940
Address</citetitle></term>
941
<listitem><para/></listitem>
942
</varlistentry>
943
<varlistentry>
944
<term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
945
Addresses</citetitle></term>
946
<listitem>
947
<para>
948
This client uses IPv6 link-local addresses, which are
949
immediately usable since a link-local addresses is
950
automatically assigned to a network interface when it
951
is brought up.
952
</para>
953
</listitem>
954
</varlistentry>
955
</variablelist>
956
</listitem>
957
</varlistentry>
958
<varlistentry>
959
<term>
960
RFC 5246: <citetitle>The Transport Layer Security (TLS)
961
Protocol Version 1.2</citetitle>
962
</term>
963
<listitem>
964
<para>
965
TLS 1.2 is the protocol implemented by GnuTLS.
966
</para>
967
</listitem>
968
</varlistentry>
969
<varlistentry>
970
<term>
971
RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
972
</term>
973
<listitem>
974
<para>
975
The data received from the server is binary encrypted
976
OpenPGP data.
977
</para>
978
</listitem>
979
</varlistentry>
980
<varlistentry>
981
<term>
982
RFC 7250: <citetitle>Using Raw Public Keys in Transport
983
Layer Security (TLS) and Datagram Transport Layer Security
984
(DTLS)</citetitle>
985
</term>
986
<listitem>
987
<para>
988
This is implemented by GnuTLS in version 3.6.6 and is, if
989
present, used by this program so that raw public keys can be
990
used.
991
</para>
992
</listitem>
993
</varlistentry>
994
<varlistentry>
995
<term>
996
RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
997
Security</citetitle>
998
</term>
999
<listitem>
1000
<para>
1001
This is implemented by GnuTLS before version 3.6.0 and is,
1002
if present, used by this program so that OpenPGP keys can be
1003
used.
1004
</para>
1005
</listitem>
1006
</varlistentry>
1007
</variablelist>
311
<itemizedlist>
312
<listitem><para>
313
<ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
314
</para></listitem>
315
316
<listitem><para>
317
<ulink url="http://www.avahi.org/">Avahi</ulink>
318
</para></listitem>
319
320
<listitem><para>
321
<ulink
322
url="http://www.gnu.org/software/gnutls/">GnuTLS</ulink>
323
</para></listitem>
324
325
<listitem><para>
326
<ulink
327
url="http://www.gnupg.org/related_software/gpgme/">
328
GPGME</ulink>
329
</para></listitem>
330
331
<listitem><para>
332
<citation>RFC 4880: <citetitle>OpenPGP Message
333
Format</citetitle></citation>
334
</para></listitem>
335
336
<listitem><para>
337
<citation>RFC 5081: <citetitle>Using OpenPGP Keys for
338
Transport Layer Security</citetitle></citation>
339
</para></listitem>
340
341
<listitem><para>
342
<citation>RFC 4291: <citetitle>IP Version 6 Addressing
343
Architecture</citetitle>, section 2.5.6, Link-Local IPv6
344
Unicast Addresses</citation>
345
</para></listitem>
346
</itemizedlist>
1008
347
</refsect1>
348
1009
349
</refentry>
1010
1011
350
<!-- Local Variables: -->
1012
351
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
1013
352
<!-- time-stamp-end: "[\"']>" -->
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0