67
46
<refname><command>&COMMANDNAME;</command></refname>
69
get password for encrypted rootdisk
48
Run Mandos plugins. Pass data from first succesful one.
75
54
<command>&COMMANDNAME;</command>
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>
85
<command>&COMMANDNAME;</command>
86
<arg choice='plain'>--help</arg>
89
<command>&COMMANDNAME;</command>
90
<arg choice='plain'>--usage</arg>
93
<command>&COMMANDNAME;</command>
94
<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>
98
129
<refsect1 id="description">
99
130
<title>DESCRIPTION</title>
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
107
<citerefentry><refentrytitle>crypttab</refentrytitle>
108
<manvolnum>5</manvolnum></citerefentry> for more information on
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.
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.
118
159
<title>OPTIONS</title>
121
<term><literal>-g</literal>,<literal>--global-options
122
<replaceable>OPTIONS</replaceable></literal></term>
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.
133
<term><literal>-o</literal>,<literal> --options-for
134
<replaceable>PLUGIN</replaceable>:<replaceable>OPTION</replaceable>
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.
146
<term><literal>-d</literal>,<literal> --disable
147
<replaceable>PLUGIN</replaceable>
151
Disable a specific plugin
157
<term><literal>--groupid <replaceable>ID</replaceable>
161
Group ID the plugins will run as
167
<term><literal>--userid <replaceable>ID</replaceable>
171
User ID the plugins will run as
177
<term><literal>--plugin-dir <replaceable>DIRECTORY</replaceable>
181
Specify a different plugin directory
187
<term><literal>--debug</literal></term>
196
<term><literal>-?</literal>, <literal>--help</literal></term>
205
<term><literal>--usage</literal></term>
208
Gives a short usage message
214
<term><literal>-V</literal>, <literal>--version</literal></term>
217
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>
176
<term><option>--env-for
177
<replaceable>PLUGIN</replaceable><literal>:</literal
178
><replaceable>ENV</replaceable><literal>=</literal
179
><replaceable>value</replaceable></option></term>
181
<replaceable>PLUGIN</replaceable><literal>:</literal
182
><replaceable>ENV</replaceable><literal>=</literal
183
><replaceable>value</replaceable></option></term>
191
<term><option>--global-options
192
<replaceable>OPTIONS</replaceable></option></term>
194
<replaceable>OPTIONS</replaceable></option></term>
197
Pass some options to <emphasis>all</emphasis> plugins.
198
<replaceable>OPTIONS</replaceable> is a comma separated
199
list of options. This is not a very useful option, except
200
for specifying the <quote><option>--debug</option></quote>
207
<term><option>--options-for
208
<replaceable>PLUGIN</replaceable><literal>:</literal
209
><replaceable>OPTION</replaceable></option></term>
211
<replaceable>PLUGIN</replaceable><literal>:</literal
212
><replaceable>OPTION</replaceable></option></term>
215
Pass some options to a specific plugin. <replaceable
216
>PLUGIN</replaceable> is the name (file basename) of a
217
plugin, and <replaceable>OPTIONS</replaceable> is a comma
218
separated list of options.
221
Note that since options are not split on whitespace, the
222
way to pass, to the plugin
223
<quote><filename>foo</filename></quote>, the option
224
<option>--bar</option> with the option argument
225
<quote>baz</quote> is either
226
<userinput>--options-for=foo:--bar=baz</userinput> or
227
<userinput>--options-for=foo:--bar,baz</userinput>, but
228
<emphasis>not</emphasis>
229
<userinput>--options-for="foo:--bar baz"</userinput>.
235
<term><option> --disable
236
<replaceable>PLUGIN</replaceable></option></term>
238
<replaceable>PLUGIN</replaceable></option></term>
241
Disable the plugin named
242
<replaceable>PLUGIN</replaceable>. The plugin will not be
249
<term><option>--groupid
250
<replaceable>ID</replaceable></option></term>
253
Change to group ID <replaceable>ID</replaceable> on
254
startup. The default is 65534. All plugins will be
255
started using this group ID. <emphasis>Note:</emphasis>
256
This must be a number, not a name.
262
<term><option>--userid
263
<replaceable>ID</replaceable></option></term>
266
Change to user ID <replaceable>ID</replaceable> on
267
startup. The default is 65534. All plugins will be
268
started using this user ID. <emphasis>Note:</emphasis>
269
This must be a number, not a name.
275
<term><option>--plugin-dir
276
<replaceable>DIRECTORY</replaceable></option></term>
279
Specify a different plugin directory. The default is
280
<filename>/lib/mandos/plugins.d</filename>, which will
281
exist in the initial <acronym>RAM</acronym> disk
288
<term><option>--debug</option></term>
291
Enable debug mode. This will enable a lot of output to
292
standard error about what the program is doing. The
293
program will still perform all other functions normally.
294
The default is to <emphasis>not</emphasis> run in debug
298
The plugins will <emphasis>not</emphasis> be affected by
300
<userinput><option>--global-options=--debug</option></userinput>
301
if complete debugging eruption is desired.
307
<term><option>--help</option></term>
308
<term><option>-?</option></term>
311
Gives a help message about options and their meanings.
317
<term><option>--usage</option></term>
320
Gives a short usage message.
326
<term><option>--version</option></term>
327
<term><option>-V</option></term>
330
Prints the program version.
337
<refsect1 id="overview">
338
<title>OVERVIEW</title>
339
<xi:include href="overview.xml"/>
341
This program will run on the client side in the initial
342
<acronym>RAM</acronym> disk environment, and is responsible for
343
getting a password. It does this by running plugins, one of
344
which will normally be the actual client program communicating
348
<refsect1 id="plugins">
349
<title>PLUGINS</title>
351
This program will get a password by running a number of
352
<firstterm>plugins</firstterm>, which are simply executable
353
programs in a directory in the initial <acronym>RAM</acronym>
354
disk environment. The default directory is
355
<filename>/lib/mandos/plugins.d</filename>, but this can be
356
changed with the <option>--plugin-dir</option> option. The
357
plugins are started in parallel, and the first plugin to output
358
a password <emphasis>and</emphasis> exit with a successful exit
359
code will make this plugin-runner output the password from that
360
plugin, stop any other plugins, and exit.
364
<refsect1 id="fallback">
365
<title>FALLBACK</title>
367
If no plugins succeed, this program will, as a fallback, ask for
368
a password on the console using <citerefentry><refentrytitle
369
>getpass</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
370
and output it. This is not meant to be the normal mode of
371
operation, as there is a separate plugin for getting a password
224
376
<refsect1 id="exit_status">
225
377
<title>EXIT STATUS</title>
379
Exit status of this program is zero if no errors were
380
encountered, and otherwise not. The fallback (see <xref
381
linkend="fallback"/>) may or may not have succeeded in either
386
<refsect1 id="environment">
387
<title>ENVIRONMENT</title>
230
393
<refsect1 id="file">
231
394
<title>FILES</title>
236
<refsect1 id="notes">
399
>/conf/conf.d/mandos/plugin-runner.conf</filename></term>
402
Since this program will be run as a keyscript, there is
403
little to no opportunity to pass command line arguments
404
to it. Therefore, it will <emphasis>also</emphasis>
405
read this file and use its contents as
406
whitespace-separated command line options. Also,
407
everything from a <quote>#</quote> character to the end
408
of a line is ignored.