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>--plugin-helper-dir=<replaceable
118
>DIRECTORY</replaceable></option></arg>
120
<arg><option>--config-file=<replaceable
121
>FILE</replaceable></option></arg>
123
<arg><option>--debug</option></arg>
126
<command>&COMMANDNAME;</command>
128
<arg choice="plain"><option>--help</option></arg>
129
<arg choice="plain"><option>-?</option></arg>
133
<command>&COMMANDNAME;</command>
134
<arg choice="plain"><option>--usage</option></arg>
137
<command>&COMMANDNAME;</command>
139
<arg choice="plain"><option>--version</option></arg>
140
<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>
145
98
<refsect1 id="description">
146
99
<title>DESCRIPTION</title>
148
<command>&COMMANDNAME;</command> is a program which is meant to
149
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
150
107
<citerefentry><refentrytitle>crypttab</refentrytitle>
151
<manvolnum>5</manvolnum></citerefentry>. The aim of this
152
program is therefore to output a password, which then
153
<citerefentry><refentrytitle>cryptsetup</refentrytitle>
154
<manvolnum>8</manvolnum></citerefentry> will use to unlock the
158
This program is not meant to be invoked directly, but can be in
159
order to test it. Note that any password obtained will simply
160
be output on standard output.
164
<refsect1 id="purpose">
165
<title>PURPOSE</title>
167
The purpose of this is to enable <emphasis>remote and unattended
168
rebooting</emphasis> of client host computer with an
169
<emphasis>encrypted root file system</emphasis>. See <xref
170
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.
175
118
<title>OPTIONS</title>
178
<term><option>--global-env
179
<replaceable>ENV</replaceable><literal>=</literal><replaceable
180
>value</replaceable></option></term>
182
<replaceable>ENV</replaceable><literal>=</literal><replaceable
183
>value</replaceable></option></term>
186
This option will add an environment variable setting to
187
all plugins. This will override any inherited environment
194
<term><option>--env-for
195
<replaceable>PLUGIN</replaceable><literal>:</literal
196
><replaceable>ENV</replaceable><literal>=</literal
197
><replaceable>value</replaceable></option></term>
199
<replaceable>PLUGIN</replaceable><literal>:</literal
200
><replaceable>ENV</replaceable><literal>=</literal
201
><replaceable>value</replaceable></option></term>
204
This option will add an environment variable setting to
205
the <replaceable>PLUGIN</replaceable> plugin. This will
206
override any inherited environment variables or
207
environment variables specified using
208
<option>--global-env</option>.
214
<term><option>--global-options
215
<replaceable>OPTIONS</replaceable></option></term>
217
<replaceable>OPTIONS</replaceable></option></term>
220
Pass some options to <emphasis>all</emphasis> plugins.
221
<replaceable>OPTIONS</replaceable> is a comma separated
222
list of options. This is not a very useful option, except
223
for specifying the <quote><option>--debug</option></quote>
224
option to all plugins.
230
<term><option>--options-for
231
<replaceable>PLUGIN</replaceable><literal>:</literal
232
><replaceable>OPTION</replaceable></option></term>
234
<replaceable>PLUGIN</replaceable><literal>:</literal
235
><replaceable>OPTION</replaceable></option></term>
238
Pass some options to a specific plugin. <replaceable
239
>PLUGIN</replaceable> is the name (file basename) of a
240
plugin, and <replaceable>OPTIONS</replaceable> is a comma
241
separated list of options.
244
Note that since options are not split on whitespace, the
245
way to pass, to the plugin
246
<quote><filename>foo</filename></quote>, the option
247
<option>--bar</option> with the option argument
248
<quote>baz</quote> is either
249
<userinput>--options-for=foo:--bar=baz</userinput> or
250
<userinput>--options-for=foo:--bar,baz</userinput>. Using
251
<userinput>--options-for="foo:--bar baz"</userinput>. will
252
<emphasis>not</emphasis> work.
258
<term><option>--disable
259
<replaceable>PLUGIN</replaceable></option></term>
261
<replaceable>PLUGIN</replaceable></option></term>
264
Disable the plugin named
265
<replaceable>PLUGIN</replaceable>. The plugin will not be
272
<term><option>--enable
273
<replaceable>PLUGIN</replaceable></option></term>
275
<replaceable>PLUGIN</replaceable></option></term>
278
Re-enable the plugin named
279
<replaceable>PLUGIN</replaceable>. This is only useful to
280
undo a previous <option>--disable</option> option, maybe
281
from the configuration file.
287
<term><option>--groupid
288
<replaceable>ID</replaceable></option></term>
291
Change to group ID <replaceable>ID</replaceable> on
292
startup. The default is 65534. All plugins will be
293
started using this group ID. <emphasis>Note:</emphasis>
294
This must be a number, not a name.
300
<term><option>--userid
301
<replaceable>ID</replaceable></option></term>
304
Change to user ID <replaceable>ID</replaceable> on
305
startup. The default is 65534. All plugins will be
306
started using this user ID. <emphasis>Note:</emphasis>
307
This must be a number, not a name.
313
<term><option>--plugin-dir
314
<replaceable>DIRECTORY</replaceable></option></term>
317
Specify a different plugin directory. The default is
318
<filename>/lib/mandos/plugins.d</filename>, which will
319
exist in the initial <acronym>RAM</acronym> disk
326
<term><option>--plugin-helper-dir
327
<replaceable>DIRECTORY</replaceable></option></term>
330
Specify a different plugin helper directory. The default
331
is <filename>/lib/mandos/plugin-helpers</filename>, which
332
will exist in the initial <acronym>RAM</acronym> disk
333
environment. (This will simply be passed to all plugins
334
via the <envar>MANDOSPLUGINHELPERDIR</envar> environment
335
variable. See <xref linkend="writing_plugins"/>)
341
<term><option>--config-file
342
<replaceable>FILE</replaceable></option></term>
345
Specify a different file to read additional options from.
346
See <xref linkend="files"/>. Other command line options
347
will override options specified in the file.
353
<term><option>--debug</option></term>
356
Enable debug mode. This will enable a lot of output to
357
standard error about what the program is doing. The
358
program will still perform all other functions normally.
359
The default is to <emphasis>not</emphasis> run in debug
363
The plugins will <emphasis>not</emphasis> be affected by
365
<userinput><option>--global-options=--debug</option></userinput>
366
if complete debugging eruption is desired.
372
<term><option>--help</option></term>
373
<term><option>-?</option></term>
376
Gives a help message about options and their meanings.
382
<term><option>--usage</option></term>
385
Gives a short usage message.
391
<term><option>--version</option></term>
392
<term><option>-V</option></term>
395
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
402
<refsect1 id="overview">
403
<title>OVERVIEW</title>
404
<xi:include href="overview.xml"/>
406
This program will run on the client side in the initial
407
<acronym>RAM</acronym> disk environment, and is responsible for
408
getting a password. It does this by running plugins, one of
409
which will normally be the actual client program communicating
413
<refsect1 id="plugins">
414
<title>PLUGINS</title>
416
This program will get a password by running a number of
417
<firstterm>plugins</firstterm>, which are simply executable
418
programs in a directory in the initial <acronym>RAM</acronym>
419
disk environment. The default directory is
420
<filename>/lib/mandos/plugins.d</filename>, but this can be
421
changed with the <option>--plugin-dir</option> option. The
422
plugins are started in parallel, and the first plugin to output
423
a password <emphasis>and</emphasis> exit with a successful exit
424
code will make this plugin-runner output the password from that
425
plugin, stop any other plugins, and exit.
428
<refsect2 id="writing_plugins">
429
<title>WRITING PLUGINS</title>
431
A plugin is simply a program which prints a password to its
432
standard output and then exits with a successful (zero) exit
433
status. If the exit status is not zero, any output on
434
standard output will be ignored by the plugin runner. Any
435
output on its standard error channel will simply be passed to
436
the standard error of the plugin runner, usually the system
440
If the password is a single-line, manually entered passprase,
441
a final trailing newline character should
442
<emphasis>not</emphasis> be printed.
445
The plugin will run in the initial RAM disk environment, so
446
care must be taken not to depend on any files or running
447
services not available there. Any helper executables required
448
by the plugin (which are not in the <envar>PATH</envar>) can
449
be placed in the plugin helper directory, the name of which
450
will be made available to the plugin via the
451
<envar>MANDOSPLUGINHELPERDIR</envar> environment variable.
454
The plugin must exit cleanly and free all allocated resources
455
upon getting the TERM signal, since this is what the plugin
456
runner uses to stop all other plugins when one plugin has
457
output a password and exited cleanly.
460
The plugin must not use resources, like for instance reading
461
from the standard input, without knowing that no other plugin
465
It is useful, but not required, for the plugin to take the
466
<option>--debug</option> option.
471
<refsect1 id="fallback">
472
<title>FALLBACK</title>
474
If no plugins succeed, this program will, as a fallback, ask for
475
a password on the console using <citerefentry><refentrytitle
476
>getpass</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
477
and output it. This is not meant to be the normal mode of
478
operation, as there is a separate plugin for getting a password
483
<refsect1 id="exit_status">
484
<title>EXIT STATUS</title>
486
Exit status of this program is zero if no errors were
487
encountered, and otherwise not. The fallback (see <xref
488
linkend="fallback"/>) may or may not have succeeded in either
493
<refsect1 id="environment">
494
<title>ENVIRONMENT</title>
496
This program does not use any environment variables itself, it
497
only passes on its environment to all the plugins. The
498
environment passed to plugins can be modified using the
499
<option>--global-env</option> and <option>--env-for</option>
500
options. Also, the <option>--plugin-helper-dir</option> option
501
will affect the environment variable
502
<envar>MANDOSPLUGINHELPERDIR</envar> for the plugins.
506
<refsect1 id="files">
512
>/conf/conf.d/mandos/plugin-runner.conf</filename></term>
515
Since this program will be run as a keyscript, there is
516
little to no opportunity to pass command line arguments
517
to it. Therefore, it will <emphasis>also</emphasis>
518
read this file and use its contents as
519
whitespace-separated command line options. Also,
520
everything from a <quote>#</quote> character to the end
521
of a line is ignored.
524
This program is meant to run in the initial RAM disk
525
environment, so that is where this file is assumed to
526
exist. The file does not need to exist in the normal
530
This file will be processed <emphasis>before</emphasis>
531
the normal command line options, so the latter can
532
override the former, if need be.
535
This file name is the default; the file to read for
536
arguments can be changed using the
537
<option>--config-file</option> option.
548
The <option>--config-file</option> option is ignored when
549
specified from within a configuration file.
553
<refsect1 id="examples">
554
<title>EXAMPLE</title>
557
Normal invocation needs no options:
560
<userinput>&COMMANDNAME;</userinput>
565
Run the program, but not the plugins, in debug mode:
569
<!-- do not wrap this line -->
570
<userinput>&COMMANDNAME; --debug</userinput>
576
Run all plugins, but run the <quote>foo</quote> plugin in
581
<!-- do not wrap this line -->
582
<userinput>&COMMANDNAME; --options-for=foo:--debug</userinput>
588
Run all plugins, but not the program, in debug mode:
592
<!-- do not wrap this line -->
593
<userinput>&COMMANDNAME; --global-options=--debug</userinput>
599
Run plugins from a different directory, read a different
600
configuration file, and add two options to the
601
<citerefentry><refentrytitle >mandos-client</refentrytitle>
602
<manvolnum>8mandos</manvolnum></citerefentry> plugin:
606
<!-- do not wrap this line -->
607
<userinput>cd /etc/keys/mandos; &COMMANDNAME; --config-file=/etc/mandos/plugin-runner.conf --plugin-dir /usr/lib/mandos/plugins.d --options-for=mandos-client:--pubkey=pubkey.txt,--seckey=seckey.txt</userinput>
612
<refsect1 id="security">
613
<title>SECURITY</title>
615
This program will, when starting, try to switch to another user.
616
If it is started as root, it will succeed, and will by default
617
switch to user and group 65534, which are assumed to be
618
non-privileged. This user and group is then what all plugins
619
will be started as. Therefore, the only way to run a plugin as
620
a privileged user is to have the set-user-ID or set-group-ID bit
621
set on the plugin executable file (see <citerefentry>
622
<refentrytitle>execve</refentrytitle><manvolnum>2</manvolnum>
626
If this program is used as a keyscript in <citerefentry
627
><refentrytitle>crypttab</refentrytitle><manvolnum>5</manvolnum>
628
</citerefentry>, there is a slight risk that if this program
629
fails to work, there might be no way to boot the system except
630
for booting from another media and editing the initial RAM disk
631
image to not run this program. This is, however, unlikely,
632
since the <citerefentry><refentrytitle
633
>password-prompt</refentrytitle><manvolnum>8mandos</manvolnum>
634
</citerefentry> plugin will read a password from the console in
635
case of failure of the other plugins, and this plugin runner
636
will also, in case of catastrophic failure, itself fall back to
637
asking and outputting a password on the console (see <xref
638
linkend="fallback"/>).
642
<refsect1 id="see_also">
643
<title>SEE ALSO</title>
645
<citerefentry><refentrytitle>intro</refentrytitle>
646
<manvolnum>8mandos</manvolnum></citerefentry>,
647
<citerefentry><refentrytitle>cryptsetup</refentrytitle>
648
<manvolnum>8</manvolnum></citerefentry>,
649
<citerefentry><refentrytitle>crypttab</refentrytitle>
650
<manvolnum>5</manvolnum></citerefentry>,
651
<citerefentry><refentrytitle>execve</refentrytitle>
652
<manvolnum>2</manvolnum></citerefentry>,
653
<citerefentry><refentrytitle>mandos</refentrytitle>
654
<manvolnum>8</manvolnum></citerefentry>,
655
<citerefentry><refentrytitle>password-prompt</refentrytitle>
656
<manvolnum>8mandos</manvolnum></citerefentry>,
657
<citerefentry><refentrytitle>mandos-client</refentrytitle>
658
<manvolnum>8mandos</manvolnum></citerefentry>
663
<!-- Local Variables: -->
664
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
665
<!-- time-stamp-end: "[\"']>" -->
666
<!-- time-stamp-format: "%:y-%02m-%02d" -->