To get this branch, use:
bzr branch
http://bzr.recompile.se/loggerhead/mandos/trunk
« back to all changes in this revision
Viewing changes to plugin-runner.xml
- browse files at revision 78
- compare with another revision
- download diff
- download tarball
- view history from revision 78
- Committer: Teddy Hogeborn
- Date: 2008-08-16 03:29:08 UTC
- Revision ID: teddy@fukt.bsnet.se-20080816032908-ihw7c05r2mnyk389
Add feature to specify custom environment variables for plugins.
* plugin-runner.c (plugin): New members "environ" and "envc" to
contain possible custom environment.
(getplugin): Return NULL on failure instead of doing exit(); all
callers changed.
(add_to_char_array): New helper function for "add_argument" and
"add_environment".
(addargument): Renamed to "add_argument". Return bool. Call
"add_to_char_array" to actually do things.
(add_environment): New; analogous to "add_argument".
(addcustomargument): Renamed to "add_to_argv" to avoid confusion
with "add_argument".
(main): New options "--global-envs" and "--envs-for" to specify
custom environment for plugins. Print environment for
plugins in debug mode. Use asprintf instead of strcpy and
strcat. Use execve() for plugins with custom environments.
Free environment for plugin when freeing plugin list.
* plugin-runner.c (plugin): New members "environ" and "envc" to
contain possible custom environment.
(getplugin): Return NULL on failure instead of doing exit(); all
callers changed.
(add_to_char_array): New helper function for "add_argument" and
"add_environment".
(addargument): Renamed to "add_argument". Return bool. Call
"add_to_char_array" to actually do things.
(add_environment): New; analogous to "add_argument".
(addcustomargument): Renamed to "add_to_argv" to avoid confusion
with "add_argument".
(main): New options "--global-envs" and "--envs-for" to specify
custom environment for plugins. Print environment for
plugins in debug mode. Use asprintf instead of strcpy and
strcat. Use execve() for plugins with custom environments.
Free environment for plugin when freeing plugin list.
- files added:
- network-protocol.txt
- 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:
- Makefile
added
removed
plugin-runner.xml
1
<?xml version="1.0" encoding="UTF-8"?>
1
<?xml version='1.0' encoding='UTF-8'?>
2
<?xml-stylesheet type="text/xsl"
3
href="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl"?>
2
4
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
5
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
6
<!ENTITY VERSION "1.0">
4
7
<!ENTITY COMMANDNAME "plugin-runner">
5
<!ENTITY TIMESTAMP "2015-07-20">
6
<!ENTITY % common SYSTEM "common.ent">
7
%common;
8
8
]>
9
9
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
10
<refentry>
11
11
<refentryinfo>
12
<title>Mandos Manual</title>
13
<!-- Nwalsh’s docbook scripts use this to generate the footer: -->
14
<productname>Mandos</productname>
15
<productnumber>&version;</productnumber>
16
<date>&TIMESTAMP;</date>
12
<title>&COMMANDNAME;</title>
13
<!-- NWalsh's docbook scripts use this to generate the footer: -->
14
<productname>&COMMANDNAME;</productname>
15
<productnumber>&VERSION;</productnumber>
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
<holder>Teddy Hogeborn</holder>
43
<holder>Björn Påhlsson</holder>
34
<holder>Teddy Hogeborn & Björn Påhlsson</holder>
44
35
</copyright>
45
<xi:include href="legalnotice.xml"/>
36
<legalnotice>
37
<para>
38
This manual page is free software: you can redistribute it
39
and/or modify it under the terms of the GNU General Public
40
License as published by the Free Software Foundation,
41
either version 3 of the License, or (at your option) any
42
later version.
43
</para>
44
45
<para>
46
This manual page is distributed in the hope that it will
47
be useful, but WITHOUT ANY WARRANTY; without even the
48
implied warranty of MERCHANTABILITY or FITNESS FOR A
49
PARTICULAR PURPOSE. See the GNU General Public License
50
for more details.
51
</para>
52
53
<para>
54
You should have received a copy of the GNU General Public
55
License along with this program; If not, see
56
<ulink url="http://www.gnu.org/licenses/"/>.
57
</para>
58
</legalnotice>
46
59
</refentryinfo>
47
60
48
61
<refmeta>
49
62
<refentrytitle>&COMMANDNAME;</refentrytitle>
50
63
<manvolnum>8mandos</manvolnum>
53
66
<refnamediv>
54
67
<refname><command>&COMMANDNAME;</command></refname>
55
68
<refpurpose>
56
Run Mandos plugins, pass data from first to succeed.
69
get password for encrypted rootdisk
57
70
</refpurpose>
58
71
</refnamediv>
59
72
60
73
<refsynopsisdiv>
61
74
<cmdsynopsis>
62
75
<command>&COMMANDNAME;</command>
63
<group rep="repeat">
64
<arg choice="plain"><option>--global-env=<replaceable
65
>ENV</replaceable><literal>=</literal><replaceable
66
>value</replaceable></option></arg>
67
<arg choice="plain"><option>-G
68
<replaceable>ENV</replaceable><literal>=</literal><replaceable
69
>value</replaceable> </option></arg>
70
</group>
71
<sbr/>
72
<group rep="repeat">
73
<arg choice="plain"><option>--env-for=<replaceable
74
>PLUGIN</replaceable><literal>:</literal><replaceable
75
>ENV</replaceable><literal>=</literal><replaceable
76
>value</replaceable></option></arg>
77
<arg choice="plain"><option>-E<replaceable>
78
PLUGIN</replaceable><literal>:</literal><replaceable
79
>ENV</replaceable><literal>=</literal><replaceable
80
>value</replaceable> </option></arg>
81
</group>
82
<sbr/>
83
<group rep="repeat">
84
<arg choice="plain"><option>--global-options=<replaceable
85
>OPTIONS</replaceable></option></arg>
86
<arg choice="plain"><option>-g<replaceable>
87
OPTIONS</replaceable> </option></arg>
88
</group>
89
<sbr/>
90
<group rep="repeat">
91
<arg choice="plain"><option>--options-for=<replaceable
92
>PLUGIN</replaceable><literal>:</literal><replaceable
93
>OPTIONS</replaceable></option></arg>
94
<arg choice="plain"><option>-o<replaceable>
95
PLUGIN</replaceable><literal>:</literal><replaceable
96
>OPTIONS</replaceable> </option></arg>
97
</group>
98
<sbr/>
99
<group rep="repeat">
100
<arg choice="plain"><option>--disable=<replaceable
101
>PLUGIN</replaceable></option></arg>
102
<arg choice="plain"><option>-d
103
<replaceable>PLUGIN</replaceable> </option></arg>
104
</group>
105
<sbr/>
106
<group rep="repeat">
107
<arg choice="plain"><option>--enable=<replaceable
108
>PLUGIN</replaceable></option></arg>
109
<arg choice="plain"><option>-e
110
<replaceable>PLUGIN</replaceable> </option></arg>
111
</group>
112
<sbr/>
113
<arg><option>--groupid=<replaceable
114
>ID</replaceable></option></arg>
115
<sbr/>
116
<arg><option>--userid=<replaceable
117
>ID</replaceable></option></arg>
118
<sbr/>
119
<arg><option>--plugin-dir=<replaceable
120
>DIRECTORY</replaceable></option></arg>
121
<sbr/>
122
<arg><option>--plugin-helper-dir=<replaceable
123
>DIRECTORY</replaceable></option></arg>
124
<sbr/>
125
<arg><option>--config-file=<replaceable
126
>FILE</replaceable></option></arg>
127
<sbr/>
128
<arg><option>--debug</option></arg>
129
</cmdsynopsis>
130
<cmdsynopsis>
131
<command>&COMMANDNAME;</command>
132
<group choice="req">
133
<arg choice="plain"><option>--help</option></arg>
134
<arg choice="plain"><option>-?</option></arg>
135
</group>
136
</cmdsynopsis>
137
<cmdsynopsis>
138
<command>&COMMANDNAME;</command>
139
<arg choice="plain"><option>--usage</option></arg>
140
</cmdsynopsis>
141
<cmdsynopsis>
142
<command>&COMMANDNAME;</command>
143
<group choice="req">
144
<arg choice="plain"><option>--version</option></arg>
145
<arg choice="plain"><option>-V</option></arg>
146
</group>
147
</cmdsynopsis>
76
<arg choice='opt'>--global-options<arg choice='plain'>OPTIONS</arg></arg>
77
<arg choice='opt'>--options-for<arg choice='plain'>PLUGIN:OPTIONS</arg></arg>
78
<arg choice='opt'>--disable<arg choice='plain'>PLUGIN</arg></arg>
79
<arg choice='opt'>--groupid<arg choice='plain'>ID</arg></arg>
80
<arg choice='opt'>--userid<arg choice='plain'>ID</arg></arg>
81
<arg choice='opt'>--plugin-dir<arg choice='plain'>DIRECTORY</arg></arg>
82
<arg choice='opt'>--debug</arg>
83
</cmdsynopsis>
84
<cmdsynopsis>
85
<command>&COMMANDNAME;</command>
86
<arg choice='plain'>--help</arg>
87
</cmdsynopsis>
88
<cmdsynopsis>
89
<command>&COMMANDNAME;</command>
90
<arg choice='plain'>--usage</arg>
91
</cmdsynopsis>
92
<cmdsynopsis>
93
<command>&COMMANDNAME;</command>
94
<arg choice='plain'>--version</arg>
95
</cmdsynopsis>
148
96
</refsynopsisdiv>
149
97
150
98
<refsect1 id="description">
151
99
<title>DESCRIPTION</title>
152
100
<para>
153
<command>&COMMANDNAME;</command> is a program which is meant to
154
be specified as a <quote>keyscript</quote> for the root disk in
101
<command>&COMMANDNAME;</command> is a plugin runner that waits
102
for any of its plugins to return sucessfull with a password, and
103
passes it to cryptsetup as stdout message. This command is not
104
meant to be invoked directly, but is instead meant to be run by
105
cryptsetup by being specified in /etc/crypttab as a keyscript
106
and subsequlently started in the initrd environment. See
155
107
<citerefentry><refentrytitle>crypttab</refentrytitle>
156
<manvolnum>5</manvolnum></citerefentry>. The aim of this
157
program is therefore to output a password, which then
158
<citerefentry><refentrytitle>cryptsetup</refentrytitle>
159
<manvolnum>8</manvolnum></citerefentry> will use to unlock the
160
root disk.
161
</para>
162
<para>
163
This program is not meant to be invoked directly, but can be in
164
order to test it. Note that any password obtained will simply
165
be output on standard output.
166
</para>
167
</refsect1>
168
169
<refsect1 id="purpose">
170
<title>PURPOSE</title>
171
<para>
172
The purpose of this is to enable <emphasis>remote and unattended
173
rebooting</emphasis> of client host computer with an
174
<emphasis>encrypted root file system</emphasis>. See <xref
175
linkend="overview"/> for details.
176
</para>
177
</refsect1>
178
108
<manvolnum>5</manvolnum></citerefentry> for more information on
109
keyscripts.
110
</para>
111
112
<para>
113
plugins is looked for in the plugins directory which by default will be
114
/conf/conf.d/mandos/plugins.d if not changed by option --plugin-dir.
115
</para>
116
</refsect1>
179
117
<refsect1>
180
118
<title>OPTIONS</title>
181
119
<variablelist>
182
120
<varlistentry>
183
<term><option>--global-env
184
<replaceable>ENV</replaceable><literal>=</literal><replaceable
185
>value</replaceable></option></term>
186
<term><option>-G
187
<replaceable>ENV</replaceable><literal>=</literal><replaceable
188
>value</replaceable></option></term>
189
<listitem>
190
<para>
191
This option will add an environment variable setting to
192
all plugins. This will override any inherited environment
193
variable.
194
</para>
195
</listitem>
196
</varlistentry>
197
198
<varlistentry>
199
<term><option>--env-for
200
<replaceable>PLUGIN</replaceable><literal>:</literal
201
><replaceable>ENV</replaceable><literal>=</literal
202
><replaceable>value</replaceable></option></term>
203
<term><option>-E
204
<replaceable>PLUGIN</replaceable><literal>:</literal
205
><replaceable>ENV</replaceable><literal>=</literal
206
><replaceable>value</replaceable></option></term>
207
<listitem>
208
<para>
209
This option will add an environment variable setting to
210
the <replaceable>PLUGIN</replaceable> plugin. This will
211
override any inherited environment variables or
212
environment variables specified using
213
<option>--global-env</option>.
214
</para>
215
</listitem>
216
</varlistentry>
217
218
<varlistentry>
219
<term><option>--global-options
220
<replaceable>OPTIONS</replaceable></option></term>
221
<term><option>-g
222
<replaceable>OPTIONS</replaceable></option></term>
223
<listitem>
224
<para>
225
Pass some options to <emphasis>all</emphasis> plugins.
226
<replaceable>OPTIONS</replaceable> is a comma separated
227
list of options. This is not a very useful option, except
228
for specifying the <quote><option>--debug</option></quote>
229
option to all plugins.
230
</para>
231
</listitem>
232
</varlistentry>
233
234
<varlistentry>
235
<term><option>--options-for
236
<replaceable>PLUGIN</replaceable><literal>:</literal
237
><replaceable>OPTION</replaceable></option></term>
238
<term><option>-o
239
<replaceable>PLUGIN</replaceable><literal>:</literal
240
><replaceable>OPTION</replaceable></option></term>
241
<listitem>
242
<para>
243
Pass some options to a specific plugin. <replaceable
244
>PLUGIN</replaceable> is the name (file basename) of a
245
plugin, and <replaceable>OPTIONS</replaceable> is a comma
246
separated list of options.
247
</para>
248
<para>
249
Note that since options are not split on whitespace, the
250
way to pass, to the plugin
251
<quote><filename>foo</filename></quote>, the option
252
<option>--bar</option> with the option argument
253
<quote>baz</quote> is either
254
<userinput>--options-for=foo:--bar=baz</userinput> or
255
<userinput>--options-for=foo:--bar,baz</userinput>. Using
256
<userinput>--options-for="foo:--bar baz"</userinput>. will
257
<emphasis>not</emphasis> work.
258
</para>
259
</listitem>
260
</varlistentry>
261
262
<varlistentry>
263
<term><option>--disable
264
<replaceable>PLUGIN</replaceable></option></term>
265
<term><option>-d
266
<replaceable>PLUGIN</replaceable></option></term>
267
<listitem>
268
<para>
269
Disable the plugin named
270
<replaceable>PLUGIN</replaceable>. The plugin will not be
271
started.
272
</para>
273
</listitem>
274
</varlistentry>
275
276
<varlistentry>
277
<term><option>--enable
278
<replaceable>PLUGIN</replaceable></option></term>
279
<term><option>-e
280
<replaceable>PLUGIN</replaceable></option></term>
281
<listitem>
282
<para>
283
Re-enable the plugin named
284
<replaceable>PLUGIN</replaceable>. This is only useful to
285
undo a previous <option>--disable</option> option, maybe
286
from the configuration file.
287
</para>
288
</listitem>
289
</varlistentry>
290
291
<varlistentry>
292
<term><option>--groupid
293
<replaceable>ID</replaceable></option></term>
294
<listitem>
295
<para>
296
Change to group ID <replaceable>ID</replaceable> on
297
startup. The default is 65534. All plugins will be
298
started using this group ID. <emphasis>Note:</emphasis>
299
This must be a number, not a name.
300
</para>
301
</listitem>
302
</varlistentry>
303
304
<varlistentry>
305
<term><option>--userid
306
<replaceable>ID</replaceable></option></term>
307
<listitem>
308
<para>
309
Change to user ID <replaceable>ID</replaceable> on
310
startup. The default is 65534. All plugins will be
311
started using this user ID. <emphasis>Note:</emphasis>
312
This must be a number, not a name.
313
</para>
314
</listitem>
315
</varlistentry>
316
317
<varlistentry>
318
<term><option>--plugin-dir
319
<replaceable>DIRECTORY</replaceable></option></term>
320
<listitem>
321
<para>
322
Specify a different plugin directory. The default is
323
<filename>/lib/mandos/plugins.d</filename>, which will
324
exist in the initial <acronym>RAM</acronym> disk
325
environment.
326
</para>
327
</listitem>
328
</varlistentry>
329
330
<varlistentry>
331
<term><option>--plugin-helper-dir
332
<replaceable>DIRECTORY</replaceable></option></term>
333
<listitem>
334
<para>
335
Specify a different plugin helper directory. The default
336
is <filename>/lib/mandos/plugin-helpers</filename>, which
337
will exist in the initial <acronym>RAM</acronym> disk
338
environment. (This will simply be passed to all plugins
339
via the <envar>MANDOSPLUGINHELPERDIR</envar> environment
340
variable. See <xref linkend="writing_plugins"/>)
341
</para>
342
</listitem>
343
</varlistentry>
344
345
<varlistentry>
346
<term><option>--config-file
347
<replaceable>FILE</replaceable></option></term>
348
<listitem>
349
<para>
350
Specify a different file to read additional options from.
351
See <xref linkend="files"/>. Other command line options
352
will override options specified in the file.
353
</para>
354
</listitem>
355
</varlistentry>
356
357
<varlistentry>
358
<term><option>--debug</option></term>
359
<listitem>
360
<para>
361
Enable debug mode. This will enable a lot of output to
362
standard error about what the program is doing. The
363
program will still perform all other functions normally.
364
The default is to <emphasis>not</emphasis> run in debug
365
mode.
366
</para>
367
<para>
368
The plugins will <emphasis>not</emphasis> be affected by
369
this option. Use
370
<userinput><option>--global-options=--debug</option></userinput>
371
if complete debugging eruption is desired.
372
</para>
373
</listitem>
374
</varlistentry>
375
376
<varlistentry>
377
<term><option>--help</option></term>
378
<term><option>-?</option></term>
379
<listitem>
380
<para>
381
Gives a help message about options and their meanings.
382
</para>
383
</listitem>
384
</varlistentry>
385
386
<varlistentry>
387
<term><option>--usage</option></term>
388
<listitem>
389
<para>
390
Gives a short usage message.
391
</para>
392
</listitem>
393
</varlistentry>
394
395
<varlistentry>
396
<term><option>--version</option></term>
397
<term><option>-V</option></term>
398
<listitem>
399
<para>
400
Prints the program version.
401
</para>
402
</listitem>
403
</varlistentry>
121
<term><literal>-g</literal>,<literal>--global-options
122
<replaceable>OPTIONS</replaceable></literal></term>
123
<listitem>
124
<para>
125
Global options given to all plugins as additional start
126
arguments. Options are specified with a -o flag followed
127
by a comma separated string of options.
128
</para>
129
</listitem>
130
</varlistentry>
131
132
<varlistentry>
133
<term><literal>-o</literal>,<literal> --options-for
134
<replaceable>PLUGIN</replaceable>:<replaceable>OPTION</replaceable>
135
</literal></term>
136
<listitem>
137
<para>
138
Plugin specific options given to the plugin as additional
139
start arguments. Options are specified with a -o flag
140
followed by a comma separated string of options.
141
</para>
142
</listitem>
143
</varlistentry>
144
145
<varlistentry>
146
<term><literal>-d</literal>,<literal> --disable
147
<replaceable>PLUGIN</replaceable>
148
</literal></term>
149
<listitem>
150
<para>
151
Disable a specific plugin
152
</para>
153
</listitem>
154
</varlistentry>
155
156
<varlistentry>
157
<term><literal>--groupid <replaceable>ID</replaceable>
158
</literal></term>
159
<listitem>
160
<para>
161
Group ID the plugins will run as
162
</para>
163
</listitem>
164
</varlistentry>
165
166
<varlistentry>
167
<term><literal>--userid <replaceable>ID</replaceable>
168
</literal></term>
169
<listitem>
170
<para>
171
User ID the plugins will run as
172
</para>
173
</listitem>
174
</varlistentry>
175
176
<varlistentry>
177
<term><literal>--plugin-dir <replaceable>DIRECTORY</replaceable>
178
</literal></term>
179
<listitem>
180
<para>
181
Specify a different plugin directory
182
</para>
183
</listitem>
184
</varlistentry>
185
186
<varlistentry>
187
<term><literal>--debug</literal></term>
188
<listitem>
189
<para>
190
Debug mode
191
</para>
192
</listitem>
193
</varlistentry>
194
195
<varlistentry>
196
<term><literal>-?</literal>, <literal>--help</literal></term>
197
<listitem>
198
<para>
199
Gives a help message
200
</para>
201
</listitem>
202
</varlistentry>
203
204
<varlistentry>
205
<term><literal>--usage</literal></term>
206
<listitem>
207
<para>
208
Gives a short usage message
209
</para>
210
</listitem>
211
</varlistentry>
212
213
<varlistentry>
214
<term><literal>-V</literal>, <literal>--version</literal></term>
215
<listitem>
216
<para>
217
Prints the program version
218
</para>
219
</listitem>
220
</varlistentry>
404
221
</variablelist>
405
222
</refsect1>
406
407
<refsect1 id="overview">
408
<title>OVERVIEW</title>
409
<xi:include href="overview.xml"/>
410
<para>
411
This program will run on the client side in the initial
412
<acronym>RAM</acronym> disk environment, and is responsible for
413
getting a password. It does this by running plugins, one of
414
which will normally be the actual client program communicating
415
with the server.
416
</para>
417
</refsect1>
418
<refsect1 id="plugins">
419
<title>PLUGINS</title>
420
<para>
421
This program will get a password by running a number of
422
<firstterm>plugins</firstterm>, which are simply executable
423
programs in a directory in the initial <acronym>RAM</acronym>
424
disk environment. The default directory is
425
<filename>/lib/mandos/plugins.d</filename>, but this can be
426
changed with the <option>--plugin-dir</option> option. The
427
plugins are started in parallel, and the first plugin to output
428
a password <emphasis>and</emphasis> exit with a successful exit
429
code will make this plugin-runner output the password from that
430
plugin, stop any other plugins, and exit.
431
</para>
432
433
<refsect2 id="writing_plugins">
434
<title>WRITING PLUGINS</title>
435
<para>
436
A plugin is simply a program which prints a password to its
437
standard output and then exits with a successful (zero) exit
438
status. If the exit status is not zero, any output on
439
standard output will be ignored by the plugin runner. Any
440
output on its standard error channel will simply be passed to
441
the standard error of the plugin runner, usually the system
442
console.
443
</para>
444
<para>
445
If the password is a single-line, manually entered passprase,
446
a final trailing newline character should
447
<emphasis>not</emphasis> be printed.
448
</para>
449
<para>
450
The plugin will run in the initial RAM disk environment, so
451
care must be taken not to depend on any files or running
452
services not available there. Any helper executables required
453
by the plugin (which are not in the <envar>PATH</envar>) can
454
be placed in the plugin helper directory, the name of which
455
will be made available to the plugin via the
456
<envar>MANDOSPLUGINHELPERDIR</envar> environment variable.
457
</para>
458
<para>
459
The plugin must exit cleanly and free all allocated resources
460
upon getting the TERM signal, since this is what the plugin
461
runner uses to stop all other plugins when one plugin has
462
output a password and exited cleanly.
463
</para>
464
<para>
465
The plugin must not use resources, like for instance reading
466
from the standard input, without knowing that no other plugin
467
is also using it.
468
</para>
469
<para>
470
It is useful, but not required, for the plugin to take the
471
<option>--debug</option> option.
472
</para>
473
</refsect2>
474
</refsect1>
475
476
<refsect1 id="fallback">
477
<title>FALLBACK</title>
478
<para>
479
If no plugins succeed, this program will, as a fallback, ask for
480
a password on the console using <citerefentry><refentrytitle
481
>getpass</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
482
and output it. This is not meant to be the normal mode of
483
operation, as there is a separate plugin for getting a password
484
from the console.
485
</para>
486
</refsect1>
487
223
488
224
<refsect1 id="exit_status">
489
225
<title>EXIT STATUS</title>
490
226
<para>
491
Exit status of this program is zero if no errors were
492
encountered, and otherwise not. The fallback (see <xref
493
linkend="fallback"/>) may or may not have succeeded in either
494
case.
495
</para>
496
</refsect1>
497
498
<refsect1 id="environment">
499
<title>ENVIRONMENT</title>
500
<para>
501
This program does not use any environment variables itself, it
502
only passes on its environment to all the plugins. The
503
environment passed to plugins can be modified using the
504
<option>--global-env</option> and <option>--env-for</option>
505
options. Also, the <option>--plugin-helper-dir</option> option
506
will affect the environment variable
507
<envar>MANDOSPLUGINHELPERDIR</envar> for the plugins.
508
</para>
509
</refsect1>
510
511
<refsect1 id="files">
227
</para>
228
</refsect1>
229
230
<refsect1 id="file">
512
231
<title>FILES</title>
513
232
<para>
514
<variablelist>
515
<varlistentry>
516
<term><filename
517
>/conf/conf.d/mandos/plugin-runner.conf</filename></term>
518
<listitem>
519
<para>
520
Since this program will be run as a keyscript, there is
521
little to no opportunity to pass command line arguments
522
to it. Therefore, it will <emphasis>also</emphasis>
523
read this file and use its contents as
524
whitespace-separated command line options. Also,
525
everything from a <quote>#</quote> character to the end
526
of a line is ignored.
527
</para>
528
<para>
529
This program is meant to run in the initial RAM disk
530
environment, so that is where this file is assumed to
531
exist. The file does not need to exist in the normal
532
file system.
533
</para>
534
<para>
535
This file will be processed <emphasis>before</emphasis>
536
the normal command line options, so the latter can
537
override the former, if need be.
538
</para>
539
<para>
540
This file name is the default; the file to read for
541
arguments can be changed using the
542
<option>--config-file</option> option.
543
</para>
544
</listitem>
545
</varlistentry>
546
</variablelist>
547
</para>
233
</para>
234
</refsect1>
235
236
<refsect1 id="notes">
237
<title>NOTES</title>
238
<para>
239
</para>
548
240
</refsect1>
549
241
550
242
<refsect1 id="bugs">
551
243
<title>BUGS</title>
552
244
<para>
553
The <option>--config-file</option> option is ignored when
554
specified from within a configuration file.
555
</para>
556
</refsect1>
557
245
</para>
246
</refsect1>
247
558
248
<refsect1 id="examples">
559
<title>EXAMPLE</title>
560
<informalexample>
561
<para>
562
Normal invocation needs no options:
563
</para>
564
<para>
565
<userinput>&COMMANDNAME;</userinput>
566
</para>
567
</informalexample>
568
<informalexample>
569
<para>
570
Run the program, but not the plugins, in debug mode:
571
</para>
572
<para>
573
574
<!-- do not wrap this line -->
575
<userinput>&COMMANDNAME; --debug</userinput>
576
577
</para>
578
</informalexample>
579
<informalexample>
580
<para>
581
Run all plugins, but run the <quote>foo</quote> plugin in
582
debug mode:
583
</para>
584
<para>
585
586
<!-- do not wrap this line -->
587
<userinput>&COMMANDNAME; --options-for=foo:--debug</userinput>
588
589
</para>
590
</informalexample>
591
<informalexample>
592
<para>
593
Run all plugins, but not the program, in debug mode:
594
</para>
595
<para>
596
597
<!-- do not wrap this line -->
598
<userinput>&COMMANDNAME; --global-options=--debug</userinput>
599
600
</para>
601
</informalexample>
602
<informalexample>
603
<para>
604
Read a different configuration file, run plugins from a
605
different directory, specify an alternate plugin helper
606
directory and add two options to the
607
<citerefentry><refentrytitle >mandos-client</refentrytitle>
608
<manvolnum>8mandos</manvolnum></citerefentry> plugin:
609
</para>
610
<para>
611
612
<!-- do not wrap this line -->
613
<userinput>cd /etc/keys/mandos; &COMMANDNAME; --config-file=/etc/mandos/plugin-runner.conf --plugin-dir /usr/lib/x86_64-linux-gnu/mandos/plugins.d --plugin-helper-dir /usr/lib/x86_64-linux-gnu/mandos/plugin-helpers --options-for=mandos-client:--pubkey=pubkey.txt,--seckey=seckey.txt</userinput>
614
615
</para>
616
</informalexample>
249
<title>EXAMPLES</title>
250
<para>
251
</para>
617
252
</refsect1>
253
618
254
<refsect1 id="security">
619
255
<title>SECURITY</title>
620
256
<para>
621
This program will, when starting, try to switch to another user.
622
If it is started as root, it will succeed, and will by default
623
switch to user and group 65534, which are assumed to be
624
non-privileged. This user and group is then what all plugins
625
will be started as. Therefore, the only way to run a plugin as
626
a privileged user is to have the set-user-ID or set-group-ID bit
627
set on the plugin executable file (see <citerefentry>
628
<refentrytitle>execve</refentrytitle><manvolnum>2</manvolnum>
629
</citerefentry>).
630
</para>
631
<para>
632
If this program is used as a keyscript in <citerefentry
633
><refentrytitle>crypttab</refentrytitle><manvolnum>5</manvolnum>
634
</citerefentry>, there is a slight risk that if this program
635
fails to work, there might be no way to boot the system except
636
for booting from another media and editing the initial RAM disk
637
image to not run this program. This is, however, unlikely,
638
since the <citerefentry><refentrytitle
639
>password-prompt</refentrytitle><manvolnum>8mandos</manvolnum>
640
</citerefentry> plugin will read a password from the console in
641
case of failure of the other plugins, and this plugin runner
642
will also, in case of catastrophic failure, itself fall back to
643
asking and outputting a password on the console (see <xref
644
linkend="fallback"/>).
645
</para>
257
</para>
646
258
</refsect1>
647
259
648
260
<refsect1 id="see_also">
649
261
<title>SEE ALSO</title>
650
262
<para>
651
<citerefentry><refentrytitle>intro</refentrytitle>
652
<manvolnum>8mandos</manvolnum></citerefentry>,
653
<citerefentry><refentrytitle>cryptsetup</refentrytitle>
654
<manvolnum>8</manvolnum></citerefentry>,
655
<citerefentry><refentrytitle>crypttab</refentrytitle>
656
<manvolnum>5</manvolnum></citerefentry>,
657
<citerefentry><refentrytitle>execve</refentrytitle>
658
<manvolnum>2</manvolnum></citerefentry>,
659
263
<citerefentry><refentrytitle>mandos</refentrytitle>
660
<manvolnum>8</manvolnum></citerefentry>,
661
<citerefentry><refentrytitle>password-prompt</refentrytitle>
662
<manvolnum>8mandos</manvolnum></citerefentry>,
663
<citerefentry><refentrytitle>mandos-client</refentrytitle>
264
<manvolnum>8</manvolnum></citerefentry>, <citerefentry>
265
<refentrytitle>password-request</refentrytitle>
266
<manvolnum>8mandos</manvolnum></citerefentry> and <citerefentry>
267
<refentrytitle>password-prompt</refentrytitle>
664
268
<manvolnum>8mandos</manvolnum></citerefentry>
665
269
</para>
666
270
</refsect1>
667
271
668
272
</refentry>
669
<!-- Local Variables: -->
670
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
671
<!-- time-stamp-end: "[\"']>" -->
672
<!-- time-stamp-format: "%:y-%02m-%02d" -->
673
<!-- End: -->
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0