1
1
<?xml version="1.0" encoding="UTF-8"?>
2
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
3
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
<!ENTITY VERSION "1.0">
5
4
<!ENTITY COMMANDNAME "plugin-runner">
6
<!ENTITY TIMESTAMP "2008-09-02">
5
<!ENTITY TIMESTAMP "2009-01-04">
6
<!ENTITY % common SYSTEM "common.ent">
9
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
46
48
<refname><command>&COMMANDNAME;</command></refname>
48
Run Mandos plugins. Pass data from first succesful one.
50
Run Mandos plugins, pass data from first to succeed.
54
56
<command>&COMMANDNAME;</command>
55
57
<group rep="repeat">
56
58
<arg choice="plain"><option>--global-env=<replaceable
57
>VAR</replaceable><literal>=</literal><replaceable
59
>ENV</replaceable><literal>=</literal><replaceable
58
60
>value</replaceable></option></arg>
59
61
<arg choice="plain"><option>-G
60
<replaceable>VAR</replaceable><literal>=</literal><replaceable
62
<replaceable>ENV</replaceable><literal>=</literal><replaceable
61
63
>value</replaceable> </option></arg>
140
142
<title>DESCRIPTION</title>
142
144
<command>&COMMANDNAME;</command> is a program which is meant to
143
be specified as <quote>keyscript</quote> in <citerefentry>
144
<refentrytitle>crypttab</refentrytitle>
145
<manvolnum>5</manvolnum></citerefentry> for the root disk. The
146
aim of this program is therefore to output a password, which
147
then <citerefentry><refentrytitle>cryptsetup</refentrytitle>
148
<manvolnum>8</manvolnum></citerefentry> will use to try and
149
unlock the root disk.
145
be specified as a <quote>keyscript</quote> for the root disk in
146
<citerefentry><refentrytitle>crypttab</refentrytitle>
147
<manvolnum>5</manvolnum></citerefentry>. The aim of this
148
program is therefore to output a password, which then
149
<citerefentry><refentrytitle>cryptsetup</refentrytitle>
150
<manvolnum>8</manvolnum></citerefentry> will use to unlock the
152
154
This program is not meant to be invoked directly, but can be in
172
174
<term><option>--global-env
173
<replaceable>VAR</replaceable><literal>=</literal><replaceable
175
<replaceable>ENV</replaceable><literal>=</literal><replaceable
174
176
>value</replaceable></option></term>
176
<replaceable>VAR</replaceable><literal>=</literal><replaceable
178
<replaceable>ENV</replaceable><literal>=</literal><replaceable
177
179
>value</replaceable></option></term>
241
243
<option>--bar</option> with the option argument
242
244
<quote>baz</quote> is either
243
245
<userinput>--options-for=foo:--bar=baz</userinput> or
244
<userinput>--options-for=foo:--bar,baz</userinput>, but
245
<emphasis>not</emphasis>
246
<userinput>--options-for="foo:--bar baz"</userinput>.
246
<userinput>--options-for=foo:--bar,baz</userinput>. Using
247
<userinput>--options-for="foo:--bar baz"</userinput>. will
248
<emphasis>not</emphasis> work.
252
254
<term><option>--disable
253
255
<replaceable>PLUGIN</replaceable></option></term>
403
405
code will make this plugin-runner output the password from that
404
406
plugin, stop any other plugins, and exit.
409
<refsect2 id="writing_plugins">
410
<title>WRITING PLUGINS</title>
412
A plugin is simply a program which prints a password to its
413
standard output and then exits with a successful (zero) exit
414
status. If the exit status is not zero, any output on
415
standard output will be ignored by the plugin runner. Any
416
output on its standard error channel will simply be passed to
417
the standard error of the plugin runner, usually the system
421
If the password is a single-line, manually entered passprase,
422
a final trailing newline character should
423
<emphasis>not</emphasis> be printed.
426
The plugin will run in the initial RAM disk environment, so
427
care must be taken not to depend on any files or running
428
services not available there.
431
The plugin must exit cleanly and free all allocated resources
432
upon getting the TERM signal, since this is what the plugin
433
runner uses to stop all other plugins when one plugin has
434
output a password and exited cleanly.
437
The plugin must not use resources, like for instance reading
438
from the standard input, without knowing that no other plugin
442
It is useful, but not required, for the plugin to take the
443
<option>--debug</option> option.
408
448
<refsect1 id="fallback">
480
520
<refsect1 id="bugs">
481
521
<title>BUGS</title>
523
The <option>--config-file</option> option is ignored when
524
specified from within a configuration file.
486
528
<refsect1 id="examples">
487
529
<title>EXAMPLE</title>
532
Normal invocation needs no options:
535
<userinput>&COMMANDNAME;</userinput>
540
Run the program, but not the plugins, in debug mode:
544
<!-- do not wrap this line -->
545
<userinput>&COMMANDNAME; --debug</userinput>
551
Run all plugins, but run the <quote>foo</quote> plugin in
556
<!-- do not wrap this line -->
557
<userinput>&COMMANDNAME; --options-for=foo:--debug</userinput>
563
Run all plugins, but not the program, in debug mode:
567
<!-- do not wrap this line -->
568
<userinput>&COMMANDNAME; --global-options=--debug</userinput>
574
Run plugins from a different directory, read a different
575
configuration file, and add two options to the
576
<citerefentry><refentrytitle >mandos-client</refentrytitle>
577
<manvolnum>8mandos</manvolnum></citerefentry> plugin:
581
<!-- do not wrap this line -->
582
<userinput>&COMMANDNAME; --config-file=/etc/mandos/plugin-runner.conf --plugin-dir /usr/lib/mandos/plugins.d --options-for=mandos-client:--pubkey=/etc/keys/mandos/pubkey.txt,--seckey=/etc/keys/mandos/seckey.txt</userinput>
492
587
<refsect1 id="security">
493
588
<title>SECURITY</title>
590
This program will, when starting, try to switch to another user.
591
If it is started as root, it will succeed, and will by default
592
switch to user and group 65534, which are assumed to be
593
non-privileged. This user and group is then what all plugins
594
will be started as. Therefore, the only way to run a plugin as
595
a privileged user is to have the set-user-ID or set-group-ID bit
596
set on the plugin executable file (see <citerefentry>
597
<refentrytitle>execve</refentrytitle><manvolnum>2</manvolnum>
601
If this program is used as a keyscript in <citerefentry
602
><refentrytitle>crypttab</refentrytitle><manvolnum>5</manvolnum>
603
</citerefentry>, there is a slight risk that if this program
604
fails to work, there might be no way to boot the system except
605
for booting from another media and editing the initial RAM disk
606
image to not run this program. This is, however, unlikely,
607
since the <citerefentry><refentrytitle
608
>password-prompt</refentrytitle><manvolnum>8mandos</manvolnum>
609
</citerefentry> plugin will read a password from the console in
610
case of failure of the other plugins, and this plugin runner
611
will also, in case of catastrophic failure, itself fall back to
612
asking and outputting a password on the console (see <xref
613
linkend="fallback"/>).
501
620
<citerefentry><refentrytitle>cryptsetup</refentrytitle>
502
621
<manvolnum>8</manvolnum></citerefentry>,
622
<citerefentry><refentrytitle>crypttab</refentrytitle>
623
<manvolnum>5</manvolnum></citerefentry>,
624
<citerefentry><refentrytitle>execve</refentrytitle>
625
<manvolnum>2</manvolnum></citerefentry>,
503
626
<citerefentry><refentrytitle>mandos</refentrytitle>
504
627
<manvolnum>8</manvolnum></citerefentry>,
505
628
<citerefentry><refentrytitle>password-prompt</refentrytitle>
506
629
<manvolnum>8mandos</manvolnum></citerefentry>,
507
<citerefentry><refentrytitle>password-request</refentrytitle>
630
<citerefentry><refentrytitle>mandos-client</refentrytitle>
508
631
<manvolnum>8mandos</manvolnum></citerefentry>
added
removed
plugin-runner.xml
