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