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