69
46
<refname><command>&COMMANDNAME;</command></refname>
71
get password for encrypted rootdisk
48
Run Mandos plugins. Pass data from first succesful one.
77
54
<command>&COMMANDNAME;</command>
78
<arg choice='opt'>--global-options<arg choice='plain'>OPTIONS</arg></arg>
79
<arg choice='opt'>--options-for<arg choice='plain'>PLUGIN:OPTIONS</arg></arg>
80
<arg choice='opt'>--disable<arg choice='plain'>PLUGIN</arg></arg>
81
<arg choice='opt'>--groupid<arg choice='plain'>ID</arg></arg>
82
<arg choice='opt'>--userid<arg choice='plain'>ID</arg></arg>
83
<arg choice='opt'>--plugin-dir<arg choice='plain'>DIRECTORY</arg></arg>
84
<arg choice='opt'>--debug</arg>
87
<command>&COMMANDNAME;</command>
88
<arg choice='plain'>--help</arg>
91
<command>&COMMANDNAME;</command>
92
<arg choice='plain'>--usage</arg>
95
<command>&COMMANDNAME;</command>
96
<arg choice='plain'>--version</arg>
56
<arg choice="plain"><option>--global-env=<replaceable
57
>VAR</replaceable><literal>=</literal><replaceable
58
>value</replaceable></option></arg>
59
<arg choice="plain"><option>-e
60
<replaceable>VAR</replaceable><literal>=</literal><replaceable
61
>value</replaceable> </option></arg>
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>-f<replaceable>
70
PLUGIN</replaceable><literal>:</literal><replaceable
71
>ENV</replaceable><literal>=</literal><replaceable
72
>value</replaceable> </option></arg>
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>
83
<arg choice="plain"><option>--options-for=<replaceable
84
>PLUGIN</replaceable><literal>:</literal><replaceable
85
>OPTIONS</replaceable></option></arg>
86
<arg choice="plain"><option>-f<replaceable>
87
PLUGIN</replaceable><literal>:</literal><replaceable
88
>OPTIONS</replaceable> </option></arg>
92
<arg choice="plain"><option>--disable=<replaceable
93
>PLUGIN</replaceable></option></arg>
94
<arg choice="plain"><option>-d
95
<replaceable>PLUGIN</replaceable> </option></arg>
98
<arg><option>--groupid=<replaceable
99
>ID</replaceable></option></arg>
101
<arg><option>--userid=<replaceable
102
>ID</replaceable></option></arg>
104
<arg><option>--plugin-dir=<replaceable
105
>DIRECTORY</replaceable></option></arg>
107
<arg><option>--debug</option></arg>
110
<command>&COMMANDNAME;</command>
112
<arg choice="plain"><option>--help</option></arg>
113
<arg choice="plain"><option>-?</option></arg>
117
<command>&COMMANDNAME;</command>
118
<arg choice="plain"><option>--usage</option></arg>
121
<command>&COMMANDNAME;</command>
123
<arg choice="plain"><option>--version</option></arg>
124
<arg choice="plain"><option>-V</option></arg>
100
129
<refsect1 id="description">
101
130
<title>DESCRIPTION</title>
103
<command>&COMMANDNAME;</command> is a plugin runner that waits
104
for any of its plugins to return sucessfull with a password, and
105
passes it to cryptsetup as stdout message. This command is not
106
meant to be invoked directly, but is instead meant to be run by
107
cryptsetup by being specified in /etc/crypttab as a keyscript
108
and subsequlently started in the initrd environment. See
109
<citerefentry><refentrytitle>crypttab</refentrytitle>
110
<manvolnum>5</manvolnum></citerefentry> for more information on
115
plugins is looked for in the plugins directory which by default will be
116
/conf/conf.d/mandos/plugins.d if not changed by option --plugin-dir.
132
<command>&COMMANDNAME;</command> is a program which is meant to
133
be specified as <quote>keyscript</quote> in <citerefentry>
134
<refentrytitle>crypttab</refentrytitle>
135
<manvolnum>5</manvolnum></citerefentry> for the root disk. The
136
aim of this program is therefore to output a password, which
137
then <citerefentry><refentrytitle>cryptsetup</refentrytitle>
138
<manvolnum>8</manvolnum></citerefentry> will use to try and
139
unlock the root disk.
142
This program is not meant to be invoked directly, but can be in
143
order to test it. Note that any password obtained will simply
144
be output on standard output.
148
<refsect1 id="purpose">
149
<title>PURPOSE</title>
151
The purpose of this is to enable <emphasis>remote and unattended
152
rebooting</emphasis> of client host computer with an
153
<emphasis>encrypted root file system</emphasis>. See <xref
154
linkend="overview"/> for details.
120
159
<title>OPTIONS</title>
123
<term><literal>-g</literal>,<literal>--global-options
124
<replaceable>OPTIONS</replaceable></literal></term>
127
Global options given to all plugins as additional start
128
arguments. Options are specified with a -o flag followed
129
by a comma separated string of options.
135
<term><literal>-o</literal>,<literal> --options-for
136
<replaceable>PLUGIN</replaceable>:<replaceable>OPTION</replaceable>
140
Plugin specific options given to the plugin as additional
141
start arguments. Options are specified with a -o flag
142
followed by a comma separated string of options.
148
<term><literal>-d</literal>,<literal> --disable
149
<replaceable>PLUGIN</replaceable>
153
Disable a specific plugin
159
<term><literal>--groupid <replaceable>ID</replaceable>
163
Group ID the plugins will run as
169
<term><literal>--userid <replaceable>ID</replaceable>
173
User ID the plugins will run as
179
<term><literal>--plugin-dir <replaceable>DIRECTORY</replaceable>
183
Specify a different plugin directory
189
<term><literal>--debug</literal></term>
198
<term><literal>-?</literal>, <literal>--help</literal></term>
207
<term><literal>--usage</literal></term>
210
Gives a short usage message
216
<term><literal>-V</literal>, <literal>--version</literal></term>
219
Prints the program version
162
<term><option>--global-env
163
<replaceable>VAR</replaceable><literal>=</literal><replaceable
164
>value</replaceable></option></term>
166
<replaceable>VAR</replaceable><literal>=</literal><replaceable
167
>value</replaceable></option></term>
170
This option will add an environment variable setting to
171
all plugins. This will override any inherited environment
178
<term><option>--env-for
179
<replaceable>PLUGIN</replaceable><literal>:</literal
180
><replaceable>ENV</replaceable><literal>=</literal
181
><replaceable>value</replaceable></option></term>
183
<replaceable>PLUGIN</replaceable><literal>:</literal
184
><replaceable>ENV</replaceable><literal>=</literal
185
><replaceable>value</replaceable></option></term>
188
This option will add an environment variable setting to
189
the <replaceable>PLUGIN</replaceable> plugin. This will
190
override any inherited environment variables or
191
environment variables specified using
192
<option>--global-env</option>.
198
<term><option>--global-options
199
<replaceable>OPTIONS</replaceable></option></term>
201
<replaceable>OPTIONS</replaceable></option></term>
204
Pass some options to <emphasis>all</emphasis> plugins.
205
<replaceable>OPTIONS</replaceable> is a comma separated
206
list of options. This is not a very useful option, except
207
for specifying the <quote><option>--debug</option></quote>
214
<term><option>--options-for
215
<replaceable>PLUGIN</replaceable><literal>:</literal
216
><replaceable>OPTION</replaceable></option></term>
218
<replaceable>PLUGIN</replaceable><literal>:</literal
219
><replaceable>OPTION</replaceable></option></term>
222
Pass some options to a specific plugin. <replaceable
223
>PLUGIN</replaceable> is the name (file basename) of a
224
plugin, and <replaceable>OPTIONS</replaceable> is a comma
225
separated list of options.
228
Note that since options are not split on whitespace, the
229
way to pass, to the plugin
230
<quote><filename>foo</filename></quote>, the option
231
<option>--bar</option> with the option argument
232
<quote>baz</quote> is either
233
<userinput>--options-for=foo:--bar=baz</userinput> or
234
<userinput>--options-for=foo:--bar,baz</userinput>, but
235
<emphasis>not</emphasis>
236
<userinput>--options-for="foo:--bar baz"</userinput>.
242
<term><option> --disable
243
<replaceable>PLUGIN</replaceable></option></term>
245
<replaceable>PLUGIN</replaceable></option></term>
248
Disable the plugin named
249
<replaceable>PLUGIN</replaceable>. The plugin will not be
256
<term><option>--groupid
257
<replaceable>ID</replaceable></option></term>
260
Change to group ID <replaceable>ID</replaceable> on
261
startup. The default is 65534. All plugins will be
262
started using this group ID. <emphasis>Note:</emphasis>
263
This must be a number, not a name.
269
<term><option>--userid
270
<replaceable>ID</replaceable></option></term>
273
Change to user ID <replaceable>ID</replaceable> on
274
startup. The default is 65534. All plugins will be
275
started using this user ID. <emphasis>Note:</emphasis>
276
This must be a number, not a name.
282
<term><option>--plugin-dir
283
<replaceable>DIRECTORY</replaceable></option></term>
286
Specify a different plugin directory. The default is
287
<filename>/lib/mandos/plugins.d</filename>, which will
288
exist in the initial <acronym>RAM</acronym> disk
295
<term><option>--debug</option></term>
298
Enable debug mode. This will enable a lot of output to
299
standard error about what the program is doing. The
300
program will still perform all other functions normally.
301
The default is to <emphasis>not</emphasis> run in debug
305
The plugins will <emphasis>not</emphasis> be affected by
307
<userinput><option>--global-options=--debug</option></userinput>
308
if complete debugging eruption is desired.
314
<term><option>--help</option></term>
315
<term><option>-?</option></term>
318
Gives a help message about options and their meanings.
324
<term><option>--usage</option></term>
327
Gives a short usage message.
333
<term><option>--version</option></term>
334
<term><option>-V</option></term>
337
Prints the program version.
344
<refsect1 id="overview">
345
<title>OVERVIEW</title>
346
<xi:include href="overview.xml"/>
348
This program will run on the client side in the initial
349
<acronym>RAM</acronym> disk environment, and is responsible for
350
getting a password. It does this by running plugins, one of
351
which will normally be the actual client program communicating
355
<refsect1 id="plugins">
356
<title>PLUGINS</title>
358
This program will get a password by running a number of
359
<firstterm>plugins</firstterm>, which are simply executable
360
programs in a directory in the initial <acronym>RAM</acronym>
361
disk environment. The default directory is
362
<filename>/lib/mandos/plugins.d</filename>, but this can be
363
changed with the <option>--plugin-dir</option> option. The
364
plugins are started in parallel, and the first plugin to output
365
a password <emphasis>and</emphasis> exit with a successful exit
366
code will make this plugin-runner output the password from that
367
plugin, stop any other plugins, and exit.
371
<refsect1 id="fallback">
372
<title>FALLBACK</title>
374
If no plugins succeed, this program will, as a fallback, ask for
375
a password on the console using <citerefentry><refentrytitle
376
>getpass</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
377
and output it. This is not meant to be the normal mode of
378
operation, as there is a separate plugin for getting a password
226
383
<refsect1 id="exit_status">
227
384
<title>EXIT STATUS</title>
386
Exit status of this program is zero if no errors were
387
encountered, and otherwise not. The fallback (see <xref
388
linkend="fallback"/>) may or may not have succeeded in either
393
<refsect1 id="environment">
394
<title>ENVIRONMENT</title>
232
400
<refsect1 id="file">
233
401
<title>FILES</title>
238
<refsect1 id="notes">
406
>/conf/conf.d/mandos/plugin-runner.conf</filename></term>
409
Since this program will be run as a keyscript, there is
410
little to no opportunity to pass command line arguments
411
to it. Therefore, it will <emphasis>also</emphasis>
412
read this file and use its contents as
413
whitespace-separated command line options. Also,
414
everything from a <quote>#</quote> character to the end
415
of a line is ignored.
418
This file will be processed <emphasis>before</emphasis>
419
the normal command line options, so the latter can
420
override the former, if need be.
244
428
<refsect1 id="bugs">
245
429
<title>BUGS</title>
431
There is no <option>--enable</option> option to enable disabled
250
436
<refsect1 id="examples">
251
437
<title>EXAMPLE</title>
256
442
<refsect1 id="security">
257
443
<title>SECURITY</title>
262
448
<refsect1 id="see_also">
263
449
<title>SEE ALSO</title>