11
12
<title>Mandos Manual</title>
12
13
<!-- Nwalsh’s docbook scripts use this to generate the footer: -->
13
14
<productname>Mandos</productname>
14
<productnumber>&VERSION;</productnumber>
15
<productnumber>&version;</productnumber>
15
16
<date>&TIMESTAMP;</date>
18
19
<firstname>Björn</firstname>
19
20
<surname>Påhlsson</surname>
21
<email>belorn@fukt.bsnet.se</email>
22
<email>belorn@recompile.se</email>
25
26
<firstname>Teddy</firstname>
26
27
<surname>Hogeborn</surname>
28
<email>teddy@fukt.bsnet.se</email>
29
<email>teddy@recompile.se</email>
34
37
<holder>Teddy Hogeborn</holder>
35
38
<holder>Björn Påhlsson</holder>
37
40
<xi:include href="legalnotice.xml"/>
41
44
<refentrytitle>&COMMANDNAME;</refentrytitle>
42
45
<manvolnum>8mandos</manvolnum>
46
49
<refname><command>&COMMANDNAME;</command></refname>
48
Run Mandos plugins. Pass data from first succesful one.
51
Run Mandos plugins, pass data from first to succeed.
54
57
<command>&COMMANDNAME;</command>
55
58
<group rep="repeat">
56
59
<arg choice="plain"><option>--global-env=<replaceable
57
>VAR</replaceable><literal>=</literal><replaceable
60
>ENV</replaceable><literal>=</literal><replaceable
58
61
>value</replaceable></option></arg>
59
<arg choice="plain"><option>-e
60
<replaceable>VAR</replaceable><literal>=</literal><replaceable
62
<arg choice="plain"><option>-G
63
<replaceable>ENV</replaceable><literal>=</literal><replaceable
61
64
>value</replaceable> </option></arg>
130
146
<title>DESCRIPTION</title>
132
148
<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.
149
be specified as a <quote>keyscript</quote> for the root disk in
150
<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
142
158
This program is not meant to be invoked directly, but can be in
177
195
<replaceable>PLUGIN</replaceable><literal>:</literal
178
196
><replaceable>ENV</replaceable><literal>=</literal
179
197
><replaceable>value</replaceable></option></term>
181
199
<replaceable>PLUGIN</replaceable><literal>:</literal
182
200
><replaceable>ENV</replaceable><literal>=</literal
183
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>.
224
247
<option>--bar</option> with the option argument
225
248
<quote>baz</quote> is either
226
249
<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>.
250
<userinput>--options-for=foo:--bar,baz</userinput>. Using
251
<userinput>--options-for="foo:--bar baz"</userinput>. will
252
<emphasis>not</emphasis> work.
235
<term><option> --disable
258
<term><option>--disable
236
259
<replaceable>PLUGIN</replaceable></option></term>
238
261
<replaceable>PLUGIN</replaceable></option></term>
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.
288
353
<term><option>--debug</option></term>
359
424
code will make this plugin-runner output the password from that
360
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.
364
471
<refsect1 id="fallback">
407
520
everything from a <quote>#</quote> character to the end
408
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.
416
545
<refsect1 id="bugs">
417
546
<title>BUGS</title>
548
The <option>--config-file</option> option is ignored when
549
specified from within a configuration file.
422
553
<refsect1 id="examples">
423
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>
428
612
<refsect1 id="security">
429
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"/>).
434
642
<refsect1 id="see_also">
435
643
<title>SEE ALSO</title>
645
<citerefentry><refentrytitle>intro</refentrytitle>
646
<manvolnum>8mandos</manvolnum></citerefentry>,
437
647
<citerefentry><refentrytitle>cryptsetup</refentrytitle>
438
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>,
439
653
<citerefentry><refentrytitle>mandos</refentrytitle>
440
654
<manvolnum>8</manvolnum></citerefentry>,
441
655
<citerefentry><refentrytitle>password-prompt</refentrytitle>
442
656
<manvolnum>8mandos</manvolnum></citerefentry>,
443
<citerefentry><refentrytitle>password-request</refentrytitle>
657
<citerefentry><refentrytitle>mandos-client</refentrytitle>
444
658
<manvolnum>8mandos</manvolnum></citerefentry>
added
removed
plugin-runner.xml
