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 135
- compare with another revision
- download diff
- download tarball
- view history from revision 135
- Committer: Teddy Hogeborn
- Date: 2008-09-01 16:19:32 UTC
- Revision ID: teddy@fukt.bsnet.se-20080901161932-ostp7tulh9aijulh
* plugin-runner.c (add_environment): Never insert existing environment
variables.
(main): Rename "--global-envs" to "--global-env" and "--envs-for" to
"--env-for".
* plugin-runner.xml (SYNOPSIS): Rename "--global-envs" to
"--global-env" and "--envs-for" to
"--env-for".
(OPTIONS): Added "--global-env" and "--env-for".
(FALLBACK): Add id attribute.
(EXIT STATUS): Add text.
(ENVIRONMENT): New section.
(FILES): Document configuration file.
variables.
(main): Rename "--global-envs" to "--global-env" and "--envs-for" to
"--env-for".
* plugin-runner.xml (SYNOPSIS): Rename "--global-envs" to
"--global-env" and "--envs-for" to
"--env-for".
(OPTIONS): Added "--global-env" and "--env-for".
(FALLBACK): Add id attribute.
(EXIT STATUS): Add text.
(ENVIRONMENT): New section.
(FILES): Document configuration file.
- 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 "2015-07-20">
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
34
<holder>Teddy Hogeborn</holder>
43
35
<holder>Björn Påhlsson</holder>
44
36
</copyright>
45
37
<xi:include href="../legalnotice.xml"/>
46
38
</refentryinfo>
47
39
48
40
<refmeta>
49
41
<refentrytitle>&COMMANDNAME;</refentrytitle>
50
42
<manvolnum>8mandos</manvolnum>
53
45
<refnamediv>
54
46
<refname><command>&COMMANDNAME;</command></refname>
55
47
<refpurpose>
56
Client for <application>Mandos</application>
48
Client for mandos
57
49
</refpurpose>
58
50
</refnamediv>
59
51
60
52
<refsynopsisdiv>
61
53
<cmdsynopsis>
62
54
<command>&COMMANDNAME;</command>
63
55
<group>
64
56
<arg choice="plain"><option>--connect
65
<replaceable>ADDRESS</replaceable><literal>:</literal
57
<replaceable>IPADDR</replaceable><literal>:</literal
66
58
><replaceable>PORT</replaceable></option></arg>
67
59
<arg choice="plain"><option>-c
68
<replaceable>ADDRESS</replaceable><literal>:</literal
60
<replaceable>IPADDR</replaceable><literal>:</literal
69
61
><replaceable>PORT</replaceable></option></arg>
70
62
</group>
71
63
<sbr/>
72
<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>
73
72
<arg choice="plain"><option>--interface
74
<replaceable>NAME</replaceable><arg rep='repeat'
75
>,<replaceable>NAME</replaceable></arg></option></arg>
76
<arg choice="plain"><option>-i <replaceable>NAME</replaceable
77
><arg rep='repeat'>,<replaceable>NAME</replaceable></arg
78
></option></arg>
73
<replaceable>NAME</replaceable></option></arg>
74
<arg choice="plain"><option>-i
75
<replaceable>NAME</replaceable></option></arg>
79
76
</group>
80
77
<sbr/>
81
78
<group>
101
98
</arg>
102
99
<sbr/>
103
100
<arg>
104
<option>--dh-params <replaceable>FILE</replaceable></option>
105
</arg>
106
<sbr/>
107
<arg>
108
<option>--delay <replaceable>SECONDS</replaceable></option>
109
</arg>
110
<sbr/>
111
<arg>
112
<option>--retry <replaceable>SECONDS</replaceable></option>
113
</arg>
114
<sbr/>
115
<arg>
116
<option>--network-hook-dir
117
<replaceable>DIR</replaceable></option>
118
</arg>
119
<sbr/>
120
<arg>
121
101
<option>--debug</option>
122
102
</arg>
123
103
</cmdsynopsis>
140
120
</group>
141
121
</cmdsynopsis>
142
122
</refsynopsisdiv>
143
123
144
124
<refsect1 id="description">
145
125
<title>DESCRIPTION</title>
146
126
<para>
147
<command>&COMMANDNAME;</command> is a client program that
148
communicates with <citerefentry><refentrytitle
149
>mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>
150
to get a password. In slightly more detail, this client program
151
brings up network interfaces, uses the interfaces’ IPv6
152
link-local addresses to get network connectivity, uses Zeroconf
153
to find servers on the local network, and communicates with
154
servers using TLS with an OpenPGP key to ensure authenticity and
155
confidentiality. This client program keeps running, trying all
156
servers on the network, until it receives a satisfactory reply
157
or a TERM signal. After all servers have been tried, all
158
servers are periodically retried. If no servers are found it
159
will wait indefinitely for new servers to appear.
160
</para>
161
<para>
162
The network interfaces are selected like this: If any interfaces
163
are specified using the <option>--interface</option> option,
164
those interface are used. Otherwise,
165
<command>&COMMANDNAME;</command> will use all interfaces that
166
are not loopback interfaces, are not point-to-point interfaces,
167
are capable of broadcasting and do not have the NOARP flag (see
168
<citerefentry><refentrytitle>netdevice</refentrytitle>
169
<manvolnum>7</manvolnum></citerefentry>). (If the
170
<option>--connect</option> option is used, point-to-point
171
interfaces and non-broadcast interfaces are accepted.) If any
172
used interfaces are not up and running, they are first taken up
173
(and later taken down again on program exit).
174
</para>
175
<para>
176
Before network interfaces are selected, all <quote>network
177
hooks</quote> are run; see <xref linkend="network-hooks"/>.
178
</para>
179
<para>
180
This program is not meant to be run directly; it is really meant
181
to run as a plugin of the <application>Mandos</application>
182
<citerefentry><refentrytitle>plugin-runner</refentrytitle>
183
<manvolnum>8mandos</manvolnum></citerefentry>, which runs in the
184
initial <acronym>RAM</acronym> disk environment because it is
185
specified as a <quote>keyscript</quote> in the <citerefentry>
186
<refentrytitle>crypttab</refentrytitle><manvolnum>5</manvolnum>
187
</citerefentry> file.
188
</para>
189
</refsect1>
190
191
<refsect1 id="purpose">
192
<title>PURPOSE</title>
193
<para>
194
The purpose of this is to enable <emphasis>remote and unattended
195
rebooting</emphasis> of client host computer with an
196
<emphasis>encrypted root file system</emphasis>. See <xref
197
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.
198
132
</para>
199
133
</refsect1>
200
134
201
135
<refsect1 id="options">
202
136
<title>OPTIONS</title>
203
137
<para>
204
This program is commonly not invoked from the command line; it
205
is normally started by the <application>Mandos</application>
206
plugin runner, see <citerefentry><refentrytitle
207
>plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum>
208
</citerefentry>. Any command line options this program accepts
209
are therefore normally provided by the plugin runner, and not
210
directly.
138
Commonly not invoked as command lines but from configuration
139
file of plugin runner.
211
140
</para>
212
141
213
142
<variablelist>
214
143
<varlistentry>
215
144
<term><option>--connect=<replaceable
216
>ADDRESS</replaceable><literal>:</literal><replaceable
145
>IPADDR</replaceable><literal>:</literal><replaceable
217
146
>PORT</replaceable></option></term>
218
147
<term><option>-c
219
<replaceable>ADDRESS</replaceable><literal>:</literal
148
<replaceable>IPADDR</replaceable><literal>:</literal
220
149
><replaceable>PORT</replaceable></option></term>
221
150
<listitem>
222
151
<para>
223
Do not use Zeroconf to locate servers. Connect directly
224
to only one specified <application>Mandos</application>
225
server. Note that an IPv6 address has colon characters in
226
it, so the <emphasis>last</emphasis> colon character is
227
assumed to separate the address from the port number.
152
Connect directly to a specified mandos server
228
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>
229
163
<para>
230
Normally, Zeroconf would be used to locate Mandos servers,
231
in which case this option would only be used when testing
232
and debugging.
164
Directory where the openpgp keyring is
233
165
</para>
234
166
</listitem>
235
167
</varlistentry>
236
168
237
169
<varlistentry>
238
<term><option>--interface=<replaceable
239
>NAME</replaceable><arg rep='repeat'>,<replaceable
240
>NAME</replaceable></arg></option></term>
170
<term><option>--interface=
171
<replaceable>NAME</replaceable></option></term>
241
172
<term><option>-i
242
<replaceable>NAME</replaceable><arg rep='repeat'>,<replaceable
243
>NAME</replaceable></arg></option></term>
173
<replaceable>NAME</replaceable></option></term>
244
174
<listitem>
245
175
<para>
246
Comma separated list of network interfaces that will be
247
brought up and scanned for Mandos servers to connect to.
248
The default is the empty string, which will automatically
249
use all appropriate interfaces.
250
</para>
251
<para>
252
If the <option>--connect</option> option is used, and
253
exactly one interface name is specified (except
254
<quote><literal>none</literal></quote>), this specifies
255
the interface to use to connect to the address given.
256
</para>
257
<para>
258
Note that since this program will normally run in the
259
initial RAM disk environment, the interface must be an
260
interface which exists at that stage. Thus, the interface
261
can normally not be a pseudo-interface such as
262
<quote>br0</quote> or <quote>tun0</quote>; such interfaces
263
will not exist until much later in the boot process, and
264
can not be used by this program, unless created by a
265
<quote>network hook</quote> — see <xref
266
linkend="network-hooks"/>.
267
</para>
268
<para>
269
<replaceable>NAME</replaceable> can be the string
270
<quote><literal>none</literal></quote>; this will make
271
<command>&COMMANDNAME;</command> only bring up interfaces
272
specified <emphasis>before</emphasis> this string. This
273
is not recommended, and only meant for advanced users.
176
Interface that Avahi will connect through
274
177
</para>
275
178
</listitem>
276
179
</varlistentry>
277
180
278
181
<varlistentry>
279
182
<term><option>--pubkey=<replaceable
280
183
>FILE</replaceable></option></term>
282
185
<replaceable>FILE</replaceable></option></term>
283
186
<listitem>
284
187
<para>
285
OpenPGP public key file name. The default name is
286
<quote><filename>/conf/conf.d/mandos/pubkey.txt</filename
287
></quote>.
188
Public openpgp key for gnutls authentication
288
189
</para>
289
190
</listitem>
290
191
</varlistentry>
291
192
292
193
<varlistentry>
293
194
<term><option>--seckey=<replaceable
294
195
>FILE</replaceable></option></term>
296
197
<replaceable>FILE</replaceable></option></term>
297
198
<listitem>
298
199
<para>
299
OpenPGP secret key file name. The default name is
300
<quote><filename>/conf/conf.d/mandos/seckey.txt</filename
301
></quote>.
200
Secret OpenPGP key for GnuTLS authentication
302
201
</para>
303
202
</listitem>
304
203
</varlistentry>
307
206
<term><option>--priority=<replaceable
308
207
>STRING</replaceable></option></term>
309
208
<listitem>
310
<xi:include href="../mandos-options.xml"
311
xpointer="priority"/>
209
<para>
210
GnuTLS priority
211
</para>
312
212
</listitem>
313
213
</varlistentry>
314
214
315
215
<varlistentry>
316
216
<term><option>--dh-bits=<replaceable
317
217
>BITS</replaceable></option></term>
318
218
<listitem>
319
219
<para>
320
Sets the number of bits to use for the prime number in the
321
TLS Diffie-Hellman key exchange. The default value is
322
selected automatically based on the OpenPGP key. Note
323
that if the <option>--dh-params</option> option is used,
324
the values from that file will be used instead.
325
</para>
326
</listitem>
327
</varlistentry>
328
329
<varlistentry>
330
<term><option>--dh-params=<replaceable
331
>FILE</replaceable></option></term>
332
<listitem>
333
<para>
334
Specifies a PEM-encoded PKCS#3 file to read the parameters
335
needed by the TLS Diffie-Hellman key exchange from. If
336
this option is not given, or if the file for some reason
337
could not be used, the parameters will be generated on
338
startup, which will take some time and processing power.
339
Those using servers running under time, power or processor
340
constraints may want to generate such a file in advance
341
and use this option.
342
</para>
343
</listitem>
344
</varlistentry>
345
346
<varlistentry>
347
<term><option>--delay=<replaceable
348
>SECONDS</replaceable></option></term>
349
<listitem>
350
<para>
351
After bringing a network interface up, the program waits
352
for the interface to arrive in a <quote>running</quote>
353
state before proceeding. During this time, the kernel log
354
level will be lowered to reduce clutter on the system
355
console, alleviating any other plugins which might be
356
using the system console. This option sets the upper
357
limit of seconds to wait. The default is 2.5 seconds.
358
</para>
359
</listitem>
360
</varlistentry>
361
362
<varlistentry>
363
<term><option>--retry=<replaceable
364
>SECONDS</replaceable></option></term>
365
<listitem>
366
<para>
367
All Mandos servers are tried repeatedly until a password
368
is received. This value specifies, in seconds, how long
369
between each successive try <emphasis>for the same
370
server</emphasis>. The default is 10 seconds.
371
</para>
372
</listitem>
373
</varlistentry>
374
375
<varlistentry>
376
<term><option>--network-hook-dir=<replaceable
377
>DIR</replaceable></option></term>
378
<listitem>
379
<para>
380
Network hook directory. The default directory is
381
<quote><filename class="directory"
382
>/lib/mandos/network-hooks.d</filename></quote>.
220
DH bits to use in gnutls communication
383
221
</para>
384
222
</listitem>
385
223
</varlistentry>
388
226
<term><option>--debug</option></term>
389
227
<listitem>
390
228
<para>
391
Enable debug mode. This will enable a lot of output to
392
standard error about what the program is doing. The
393
program will still perform all other functions normally.
394
</para>
395
<para>
396
It will also enable debug mode in the Avahi and GnuTLS
397
libraries, making them print large amounts of debugging
398
output.
229
Debug mode
399
230
</para>
400
231
</listitem>
401
232
</varlistentry>
405
236
<term><option>-?</option></term>
406
237
<listitem>
407
238
<para>
408
Gives a help message about options and their meanings.
239
Gives a help message
409
240
</para>
410
241
</listitem>
411
242
</varlistentry>
414
245
<term><option>--usage</option></term>
415
246
<listitem>
416
247
<para>
417
Gives a short usage message.
248
Gives a short usage message
418
249
</para>
419
250
</listitem>
420
251
</varlistentry>
421
252
422
253
<varlistentry>
423
254
<term><option>--version</option></term>
424
255
<term><option>-V</option></term>
425
256
<listitem>
426
257
<para>
427
Prints the program version.
258
Prints the program version
428
259
</para>
429
260
</listitem>
430
261
</varlistentry>
431
262
</variablelist>
432
263
</refsect1>
433
434
<refsect1 id="overview">
435
<title>OVERVIEW</title>
436
<xi:include href="../overview.xml"/>
437
<para>
438
This program is the client part. It is a plugin started by
439
<citerefentry><refentrytitle>plugin-runner</refentrytitle>
440
<manvolnum>8mandos</manvolnum></citerefentry> which will run in
441
an initial <acronym>RAM</acronym> disk environment.
442
</para>
443
<para>
444
This program could, theoretically, be used as a keyscript in
445
<filename>/etc/crypttab</filename>, but it would then be
446
impossible to enter a password for the encrypted root disk at
447
the console, since this program does not read from the console
448
at all. This is why a separate plugin runner (<citerefentry>
449
<refentrytitle>plugin-runner</refentrytitle>
450
<manvolnum>8mandos</manvolnum></citerefentry>) is used to run
451
both this program and others in in parallel,
452
<emphasis>one</emphasis> of which (<citerefentry>
453
<refentrytitle>password-prompt</refentrytitle>
454
<manvolnum>8mandos</manvolnum></citerefentry>) will prompt for
455
passwords on the system console.
456
</para>
457
</refsect1>
458
264
459
265
<refsect1 id="exit_status">
460
266
<title>EXIT STATUS</title>
461
267
<para>
462
This program will exit with a successful (zero) exit status if a
463
server could be found and the password received from it could be
464
successfully decrypted and output on standard output. The
465
program will exit with a non-zero exit status only if a critical
466
error occurs. Otherwise, it will forever connect to any
467
discovered <application>Mandos</application> servers, trying to
468
get a decryptable password and print it.
469
268
</para>
470
269
</refsect1>
471
270
472
271
<refsect1 id="environment">
473
272
<title>ENVIRONMENT</title>
474
<variablelist>
475
<varlistentry>
476
<term><envar>MANDOSPLUGINHELPERDIR</envar></term>
477
<listitem>
478
<para>
479
This environment variable will be assumed to contain the
480
directory containing any helper executables. The use and
481
nature of these helper executables, if any, is
482
purposefully not documented.
483
</para>
484
</listitem>
485
</varlistentry>
486
</variablelist>
487
<para>
488
This program does not use any other environment variables, not
489
even the ones provided by <citerefentry><refentrytitle
490
>cryptsetup</refentrytitle><manvolnum>8</manvolnum>
491
</citerefentry>.
492
</para>
493
</refsect1>
494
495
<refsect1 id="network-hooks">
496
<title>NETWORK HOOKS</title>
497
<para>
498
If a network interface like a bridge or tunnel is required to
499
find a Mandos server, this requires the interface to be up and
500
running before <command>&COMMANDNAME;</command> starts looking
501
for Mandos servers. This can be accomplished by creating a
502
<quote>network hook</quote> program, and placing it in a special
503
directory.
504
</para>
505
<para>
506
Before the network is used (and again before program exit), any
507
runnable programs found in the network hook directory are run
508
with the argument <quote><literal>start</literal></quote> or
509
<quote><literal>stop</literal></quote>. This should bring up or
510
down, respectively, any network interface which
511
<command>&COMMANDNAME;</command> should use.
512
</para>
513
<refsect2 id="hook-requirements">
514
<title>REQUIREMENTS</title>
515
<para>
516
A network hook must be an executable file, and its name must
517
consist entirely of upper and lower case letters, digits,
518
underscores, periods, and hyphens.
519
</para>
520
<para>
521
A network hook will receive one argument, which can be one of
522
the following:
523
</para>
524
<variablelist>
525
<varlistentry>
526
<term><literal>start</literal></term>
527
<listitem>
528
<para>
529
This should make the network hook create (if necessary)
530
and bring up a network interface.
531
</para>
532
</listitem>
533
</varlistentry>
534
<varlistentry>
535
<term><literal>stop</literal></term>
536
<listitem>
537
<para>
538
This should make the network hook take down a network
539
interface, and delete it if it did not exist previously.
540
</para>
541
</listitem>
542
</varlistentry>
543
<varlistentry>
544
<term><literal>files</literal></term>
545
<listitem>
546
<para>
547
This should make the network hook print, <emphasis>one
548
file per line</emphasis>, all the files needed for it to
549
run. (These files will be copied into the initial RAM
550
filesystem.) Typical use is for a network hook which is
551
a shell script to print its needed binaries.
552
</para>
553
<para>
554
It is not necessary to print any non-executable files
555
already in the network hook directory, these will be
556
copied implicitly if they otherwise satisfy the name
557
requirements.
558
</para>
559
</listitem>
560
</varlistentry>
561
<varlistentry>
562
<term><literal>modules</literal></term>
563
<listitem>
564
<para>
565
This should make the network hook print, <emphasis>on
566
separate lines</emphasis>, all the kernel modules needed
567
for it to run. (These modules will be copied into the
568
initial RAM filesystem.) For instance, a tunnel
569
interface needs the
570
<quote><literal>tun</literal></quote> module.
571
</para>
572
</listitem>
573
</varlistentry>
574
</variablelist>
575
<para>
576
The network hook will be provided with a number of environment
577
variables:
578
</para>
579
<variablelist>
580
<varlistentry>
581
<term><envar>MANDOSNETHOOKDIR</envar></term>
582
<listitem>
583
<para>
584
The network hook directory, specified to
585
<command>&COMMANDNAME;</command> by the
586
<option>--network-hook-dir</option> option. Note: this
587
should <emphasis>always</emphasis> be used by the
588
network hook to refer to itself or any files in the hook
589
directory it may require.
590
</para>
591
</listitem>
592
</varlistentry>
593
<varlistentry>
594
<term><envar>DEVICE</envar></term>
595
<listitem>
596
<para>
597
The network interfaces, as specified to
598
<command>&COMMANDNAME;</command> by the
599
<option>--interface</option> option, combined to one
600
string and separated by commas. If this is set, and
601
does not contain the interface a hook will bring up,
602
there is no reason for a hook to continue.
603
</para>
604
</listitem>
605
</varlistentry>
606
<varlistentry>
607
<term><envar>MODE</envar></term>
608
<listitem>
609
<para>
610
This will be the same as the first argument;
611
i.e. <quote><literal>start</literal></quote>,
612
<quote><literal>stop</literal></quote>,
613
<quote><literal>files</literal></quote>, or
614
<quote><literal>modules</literal></quote>.
615
</para>
616
</listitem>
617
</varlistentry>
618
<varlistentry>
619
<term><envar>VERBOSITY</envar></term>
620
<listitem>
621
<para>
622
This will be the <quote><literal>1</literal></quote> if
623
the <option>--debug</option> option is passed to
624
<command>&COMMANDNAME;</command>, otherwise
625
<quote><literal>0</literal></quote>.
626
</para>
627
</listitem>
628
</varlistentry>
629
<varlistentry>
630
<term><envar>DELAY</envar></term>
631
<listitem>
632
<para>
633
This will be the same as the <option>--delay</option>
634
option passed to <command>&COMMANDNAME;</command>. Is
635
only set if <envar>MODE</envar> is
636
<quote><literal>start</literal></quote> or
637
<quote><literal>stop</literal></quote>.
638
</para>
639
</listitem>
640
</varlistentry>
641
<varlistentry>
642
<term><envar>CONNECT</envar></term>
643
<listitem>
644
<para>
645
This will be the same as the <option>--connect</option>
646
option passed to <command>&COMMANDNAME;</command>. Is
647
only set if <option>--connect</option> is passed and
648
<envar>MODE</envar> is
649
<quote><literal>start</literal></quote> or
650
<quote><literal>stop</literal></quote>.
651
</para>
652
</listitem>
653
</varlistentry>
654
</variablelist>
655
<para>
656
A hook may not read from standard input, and should be
657
restrictive in printing to standard output or standard error
658
unless <varname>VERBOSITY</varname> is
659
<quote><literal>1</literal></quote>.
660
</para>
661
</refsect2>
662
</refsect1>
663
664
<refsect1 id="files">
273
<para>
274
</para>
275
</refsect1>
276
277
<refsect1 id="file">
665
278
<title>FILES</title>
666
<variablelist>
667
<varlistentry>
668
<term><filename>/conf/conf.d/mandos/pubkey.txt</filename
669
></term>
670
<term><filename>/conf/conf.d/mandos/seckey.txt</filename
671
></term>
672
<listitem>
673
<para>
674
OpenPGP public and private key files, in <quote>ASCII
675
Armor</quote> format. These are the default file names,
676
they can be changed with the <option>--pubkey</option> and
677
<option>--seckey</option> options.
678
</para>
679
</listitem>
680
</varlistentry>
681
<varlistentry>
682
<term><filename
683
class="directory">/lib/mandos/network-hooks.d</filename></term>
684
<listitem>
685
<para>
686
Directory where network hooks are located. Change this
687
with the <option>--network-hook-dir</option> option. See
688
<xref linkend="network-hooks"/>.
689
</para>
690
</listitem>
691
</varlistentry>
692
</variablelist>
693
</refsect1>
694
695
<!-- <refsect1 id="bugs"> -->
696
<!-- <title>BUGS</title> -->
697
<!-- <para> -->
698
<!-- </para> -->
699
<!-- </refsect1> -->
700
279
<para>
280
</para>
281
</refsect1>
282
283
<refsect1 id="bugs">
284
<title>BUGS</title>
285
<para>
286
</para>
287
</refsect1>
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