49
67
<refname><command>&COMMANDNAME;</command></refname>
51
Run Mandos plugins, pass data from first to succeed.
69
get password for encrypted rootdisk
57
75
<command>&COMMANDNAME;</command>
59
<arg choice="plain"><option>--global-env=<replaceable
60
>ENV</replaceable><literal>=</literal><replaceable
61
>value</replaceable></option></arg>
62
<arg choice="plain"><option>-G
63
<replaceable>ENV</replaceable><literal>=</literal><replaceable
64
>value</replaceable> </option></arg>
68
<arg choice="plain"><option>--env-for=<replaceable
69
>PLUGIN</replaceable><literal>:</literal><replaceable
70
>ENV</replaceable><literal>=</literal><replaceable
71
>value</replaceable></option></arg>
72
<arg choice="plain"><option>-E<replaceable>
73
PLUGIN</replaceable><literal>:</literal><replaceable
74
>ENV</replaceable><literal>=</literal><replaceable
75
>value</replaceable> </option></arg>
79
<arg choice="plain"><option>--global-options=<replaceable
80
>OPTIONS</replaceable></option></arg>
81
<arg choice="plain"><option>-g<replaceable>
82
OPTIONS</replaceable> </option></arg>
86
<arg choice="plain"><option>--options-for=<replaceable
87
>PLUGIN</replaceable><literal>:</literal><replaceable
88
>OPTIONS</replaceable></option></arg>
89
<arg choice="plain"><option>-o<replaceable>
90
PLUGIN</replaceable><literal>:</literal><replaceable
91
>OPTIONS</replaceable> </option></arg>
95
<arg choice="plain"><option>--disable=<replaceable
96
>PLUGIN</replaceable></option></arg>
97
<arg choice="plain"><option>-d
98
<replaceable>PLUGIN</replaceable> </option></arg>
102
<arg choice="plain"><option>--enable=<replaceable
103
>PLUGIN</replaceable></option></arg>
104
<arg choice="plain"><option>-e
105
<replaceable>PLUGIN</replaceable> </option></arg>
108
<arg><option>--groupid=<replaceable
109
>ID</replaceable></option></arg>
111
<arg><option>--userid=<replaceable
112
>ID</replaceable></option></arg>
114
<arg><option>--plugin-dir=<replaceable
115
>DIRECTORY</replaceable></option></arg>
117
<arg><option>--config-file=<replaceable
118
>FILE</replaceable></option></arg>
120
<arg><option>--debug</option></arg>
123
<command>&COMMANDNAME;</command>
125
<arg choice="plain"><option>--help</option></arg>
126
<arg choice="plain"><option>-?</option></arg>
130
<command>&COMMANDNAME;</command>
131
<arg choice="plain"><option>--usage</option></arg>
134
<command>&COMMANDNAME;</command>
136
<arg choice="plain"><option>--version</option></arg>
137
<arg choice="plain"><option>-V</option></arg>
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>
142
98
<refsect1 id="description">
143
99
<title>DESCRIPTION</title>
145
<command>&COMMANDNAME;</command> is a program which is meant to
146
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
147
107
<citerefentry><refentrytitle>crypttab</refentrytitle>
148
<manvolnum>5</manvolnum></citerefentry>. The aim of this
149
program is therefore to output a password, which then
150
<citerefentry><refentrytitle>cryptsetup</refentrytitle>
151
<manvolnum>8</manvolnum></citerefentry> will use to unlock the
155
This program is not meant to be invoked directly, but can be in
156
order to test it. Note that any password obtained will simply
157
be output on standard output.
161
<refsect1 id="purpose">
162
<title>PURPOSE</title>
164
The purpose of this is to enable <emphasis>remote and unattended
165
rebooting</emphasis> of client host computer with an
166
<emphasis>encrypted root file system</emphasis>. See <xref
167
linkend="overview"/> for details.
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.
172
118
<title>OPTIONS</title>
175
<term><option>--global-env
176
<replaceable>ENV</replaceable><literal>=</literal><replaceable
177
>value</replaceable></option></term>
179
<replaceable>ENV</replaceable><literal>=</literal><replaceable
180
>value</replaceable></option></term>
183
This option will add an environment variable setting to
184
all plugins. This will override any inherited environment
191
<term><option>--env-for
192
<replaceable>PLUGIN</replaceable><literal>:</literal
193
><replaceable>ENV</replaceable><literal>=</literal
194
><replaceable>value</replaceable></option></term>
196
<replaceable>PLUGIN</replaceable><literal>:</literal
197
><replaceable>ENV</replaceable><literal>=</literal
198
><replaceable>value</replaceable></option></term>
201
This option will add an environment variable setting to
202
the <replaceable>PLUGIN</replaceable> plugin. This will
203
override any inherited environment variables or
204
environment variables specified using
205
<option>--global-env</option>.
211
<term><option>--global-options
212
<replaceable>OPTIONS</replaceable></option></term>
214
<replaceable>OPTIONS</replaceable></option></term>
217
Pass some options to <emphasis>all</emphasis> plugins.
218
<replaceable>OPTIONS</replaceable> is a comma separated
219
list of options. This is not a very useful option, except
220
for specifying the <quote><option>--debug</option></quote>
221
option to all plugins.
227
<term><option>--options-for
228
<replaceable>PLUGIN</replaceable><literal>:</literal
229
><replaceable>OPTION</replaceable></option></term>
231
<replaceable>PLUGIN</replaceable><literal>:</literal
232
><replaceable>OPTION</replaceable></option></term>
235
Pass some options to a specific plugin. <replaceable
236
>PLUGIN</replaceable> is the name (file basename) of a
237
plugin, and <replaceable>OPTIONS</replaceable> is a comma
238
separated list of options.
241
Note that since options are not split on whitespace, the
242
way to pass, to the plugin
243
<quote><filename>foo</filename></quote>, the option
244
<option>--bar</option> with the option argument
245
<quote>baz</quote> is either
246
<userinput>--options-for=foo:--bar=baz</userinput> or
247
<userinput>--options-for=foo:--bar,baz</userinput>. Using
248
<userinput>--options-for="foo:--bar baz"</userinput>. will
249
<emphasis>not</emphasis> work.
255
<term><option>--disable
256
<replaceable>PLUGIN</replaceable></option></term>
258
<replaceable>PLUGIN</replaceable></option></term>
261
Disable the plugin named
262
<replaceable>PLUGIN</replaceable>. The plugin will not be
269
<term><option>--enable
270
<replaceable>PLUGIN</replaceable></option></term>
272
<replaceable>PLUGIN</replaceable></option></term>
275
Re-enable the plugin named
276
<replaceable>PLUGIN</replaceable>. This is only useful to
277
undo a previous <option>--disable</option> option, maybe
278
from the configuration file.
284
<term><option>--groupid
285
<replaceable>ID</replaceable></option></term>
288
Change to group ID <replaceable>ID</replaceable> on
289
startup. The default is 65534. All plugins will be
290
started using this group ID. <emphasis>Note:</emphasis>
291
This must be a number, not a name.
297
<term><option>--userid
298
<replaceable>ID</replaceable></option></term>
301
Change to user ID <replaceable>ID</replaceable> on
302
startup. The default is 65534. All plugins will be
303
started using this user ID. <emphasis>Note:</emphasis>
304
This must be a number, not a name.
310
<term><option>--plugin-dir
311
<replaceable>DIRECTORY</replaceable></option></term>
314
Specify a different plugin directory. The default is
315
<filename>/lib/mandos/plugins.d</filename>, which will
316
exist in the initial <acronym>RAM</acronym> disk
323
<term><option>--config-file
324
<replaceable>FILE</replaceable></option></term>
327
Specify a different file to read additional options from.
328
See <xref linkend="files"/>. Other command line options
329
will override options specified in the file.
335
<term><option>--debug</option></term>
338
Enable debug mode. This will enable a lot of output to
339
standard error about what the program is doing. The
340
program will still perform all other functions normally.
341
The default is to <emphasis>not</emphasis> run in debug
345
The plugins will <emphasis>not</emphasis> be affected by
347
<userinput><option>--global-options=--debug</option></userinput>
348
if complete debugging eruption is desired.
354
<term><option>--help</option></term>
355
<term><option>-?</option></term>
358
Gives a help message about options and their meanings.
364
<term><option>--usage</option></term>
367
Gives a short usage message.
373
<term><option>--version</option></term>
374
<term><option>-V</option></term>
377
Prints the program version.
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
384
<refsect1 id="overview">
385
<title>OVERVIEW</title>
386
<xi:include href="overview.xml"/>
388
This program will run on the client side in the initial
389
<acronym>RAM</acronym> disk environment, and is responsible for
390
getting a password. It does this by running plugins, one of
391
which will normally be the actual client program communicating
395
<refsect1 id="plugins">
396
<title>PLUGINS</title>
398
This program will get a password by running a number of
399
<firstterm>plugins</firstterm>, which are simply executable
400
programs in a directory in the initial <acronym>RAM</acronym>
401
disk environment. The default directory is
402
<filename>/lib/mandos/plugins.d</filename>, but this can be
403
changed with the <option>--plugin-dir</option> option. The
404
plugins are started in parallel, and the first plugin to output
405
a password <emphasis>and</emphasis> exit with a successful exit
406
code will make this plugin-runner output the password from that
407
plugin, stop any other plugins, and exit.
410
<refsect2 id="writing_plugins">
411
<title>WRITING PLUGINS</title>
413
A plugin is simply a program which prints a password to its
414
standard output and then exits with a successful (zero) exit
415
status. If the exit status is not zero, any output on
416
standard output will be ignored by the plugin runner. Any
417
output on its standard error channel will simply be passed to
418
the standard error of the plugin runner, usually the system
422
If the password is a single-line, manually entered passprase,
423
a final trailing newline character should
424
<emphasis>not</emphasis> be printed.
427
The plugin will run in the initial RAM disk environment, so
428
care must be taken not to depend on any files or running
429
services not available there.
432
The plugin must exit cleanly and free all allocated resources
433
upon getting the TERM signal, since this is what the plugin
434
runner uses to stop all other plugins when one plugin has
435
output a password and exited cleanly.
438
The plugin must not use resources, like for instance reading
439
from the standard input, without knowing that no other plugin
443
It is useful, but not required, for the plugin to take the
444
<option>--debug</option> option.
449
<refsect1 id="fallback">
450
<title>FALLBACK</title>
452
If no plugins succeed, this program will, as a fallback, ask for
453
a password on the console using <citerefentry><refentrytitle
454
>getpass</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
455
and output it. This is not meant to be the normal mode of
456
operation, as there is a separate plugin for getting a password
461
224
<refsect1 id="exit_status">
462
225
<title>EXIT STATUS</title>
464
Exit status of this program is zero if no errors were
465
encountered, and otherwise not. The fallback (see <xref
466
linkend="fallback"/>) may or may not have succeeded in either
471
<refsect1 id="environment">
472
<title>ENVIRONMENT</title>
474
This program does not use any environment variables itself, it
475
only passes on its environment to all the plugins. The
476
environment passed to plugins can be modified using the
477
<option>--global-env</option> and <option>--env-for</option>
482
<refsect1 id="files">
483
231
<title>FILES</title>
488
>/conf/conf.d/mandos/plugin-runner.conf</filename></term>
491
Since this program will be run as a keyscript, there is
492
little to no opportunity to pass command line arguments
493
to it. Therefore, it will <emphasis>also</emphasis>
494
read this file and use its contents as
495
whitespace-separated command line options. Also,
496
everything from a <quote>#</quote> character to the end
497
of a line is ignored.
500
This program is meant to run in the initial RAM disk
501
environment, so that is where this file is assumed to
502
exist. The file does not need to exist in the normal
506
This file will be processed <emphasis>before</emphasis>
507
the normal command line options, so the latter can
508
override the former, if need be.
511
This file name is the default; the file to read for
512
arguments can be changed using the
513
<option>--config-file</option> option.
236
<refsect1 id="notes">
521
242
<refsect1 id="bugs">
522
243
<title>BUGS</title>
524
The <option>--config-file</option> option is ignored when
525
specified from within a configuration file.
529
248
<refsect1 id="examples">
530
<title>EXAMPLE</title>
533
Normal invocation needs no options:
536
<userinput>&COMMANDNAME;</userinput>
541
Run the program, but not the plugins, in debug mode:
545
<!-- do not wrap this line -->
546
<userinput>&COMMANDNAME; --debug</userinput>
552
Run all plugins, but run the <quote>foo</quote> plugin in
557
<!-- do not wrap this line -->
558
<userinput>&COMMANDNAME; --options-for=foo:--debug</userinput>
564
Run all plugins, but not the program, in debug mode:
568
<!-- do not wrap this line -->
569
<userinput>&COMMANDNAME; --global-options=--debug</userinput>
575
Read a different configuration file, run plugins from a
576
different directory, specify an alternate plugin helper
577
directory and add two options to the
578
<citerefentry><refentrytitle >mandos-client</refentrytitle>
579
<manvolnum>8mandos</manvolnum></citerefentry> plugin:
583
<!-- do not wrap this line -->
584
<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>
249
<title>EXAMPLES</title>
589
254
<refsect1 id="security">
590
255
<title>SECURITY</title>
592
This program will, when starting, try to switch to another user.
593
If it is started as root, it will succeed, and will by default
594
switch to user and group 65534, which are assumed to be
595
non-privileged. This user and group is then what all plugins
596
will be started as. Therefore, the only way to run a plugin as
597
a privileged user is to have the set-user-ID or set-group-ID bit
598
set on the plugin executable file (see <citerefentry>
599
<refentrytitle>execve</refentrytitle><manvolnum>2</manvolnum>
603
If this program is used as a keyscript in <citerefentry
604
><refentrytitle>crypttab</refentrytitle><manvolnum>5</manvolnum>
605
</citerefentry>, there is a slight risk that if this program
606
fails to work, there might be no way to boot the system except
607
for booting from another media and editing the initial RAM disk
608
image to not run this program. This is, however, unlikely,
609
since the <citerefentry><refentrytitle
610
>password-prompt</refentrytitle><manvolnum>8mandos</manvolnum>
611
</citerefentry> plugin will read a password from the console in
612
case of failure of the other plugins, and this plugin runner
613
will also, in case of catastrophic failure, itself fall back to
614
asking and outputting a password on the console (see <xref
615
linkend="fallback"/>).
619
260
<refsect1 id="see_also">
620
261
<title>SEE ALSO</title>
622
<citerefentry><refentrytitle>intro</refentrytitle>
623
<manvolnum>8mandos</manvolnum></citerefentry>,
624
<citerefentry><refentrytitle>cryptsetup</refentrytitle>
625
<manvolnum>8</manvolnum></citerefentry>,
626
<citerefentry><refentrytitle>crypttab</refentrytitle>
627
<manvolnum>5</manvolnum></citerefentry>,
628
<citerefentry><refentrytitle>execve</refentrytitle>
629
<manvolnum>2</manvolnum></citerefentry>,
630
<citerefentry><refentrytitle>mandos</refentrytitle>
631
<manvolnum>8</manvolnum></citerefentry>,
632
<citerefentry><refentrytitle>password-prompt</refentrytitle>
633
<manvolnum>8mandos</manvolnum></citerefentry>,
634
<citerefentry><refentrytitle>mandos-client</refentrytitle>
635
<manvolnum>8mandos</manvolnum></citerefentry>
640
<!-- Local Variables: -->
641
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
642
<!-- time-stamp-end: "[\"']>" -->
643
<!-- time-stamp-format: "%:y-%02m-%02d" -->