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
143
<title>DESCRIPTION</title>
132
145
<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.
146
be specified as a <quote>keyscript</quote> for the root disk in
147
<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
142
155
This program is not meant to be invoked directly, but can be in
231
244
<option>--bar</option> with the option argument
232
245
<quote>baz</quote> is either
233
246
<userinput>--options-for=foo:--bar=baz</userinput> or
234
<userinput>--options-for=foo:--bar,baz</userinput>, but
235
<emphasis>not</emphasis>
236
<userinput>--options-for="foo:--bar baz"</userinput>.
247
<userinput>--options-for=foo:--bar,baz</userinput>. Using
248
<userinput>--options-for="foo:--bar baz"</userinput>. will
249
<emphasis>not</emphasis> work.
242
<term><option> --disable
255
<term><option>--disable
243
256
<replaceable>PLUGIN</replaceable></option></term>
245
258
<replaceable>PLUGIN</replaceable></option></term>
366
406
code will make this plugin-runner output the password from that
367
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.
371
449
<refsect1 id="fallback">
428
521
<refsect1 id="bugs">
429
522
<title>BUGS</title>
431
There is no <option>--enable</option> option to enable disabled
524
The <option>--config-file</option> option is ignored when
525
specified from within a configuration file.
436
529
<refsect1 id="examples">
437
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
Run plugins from a different directory, read a different
576
configuration file, and add two options to the
577
<citerefentry><refentrytitle >mandos-client</refentrytitle>
578
<manvolnum>8mandos</manvolnum></citerefentry> plugin:
582
<!-- do not wrap this line -->
583
<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>
442
588
<refsect1 id="security">
443
589
<title>SECURITY</title>
591
This program will, when starting, try to switch to another user.
592
If it is started as root, it will succeed, and will by default
593
switch to user and group 65534, which are assumed to be
594
non-privileged. This user and group is then what all plugins
595
will be started as. Therefore, the only way to run a plugin as
596
a privileged user is to have the set-user-ID or set-group-ID bit
597
set on the plugin executable file (see <citerefentry>
598
<refentrytitle>execve</refentrytitle><manvolnum>2</manvolnum>
602
If this program is used as a keyscript in <citerefentry
603
><refentrytitle>crypttab</refentrytitle><manvolnum>5</manvolnum>
604
</citerefentry>, there is a slight risk that if this program
605
fails to work, there might be no way to boot the system except
606
for booting from another media and editing the initial RAM disk
607
image to not run this program. This is, however, unlikely,
608
since the <citerefentry><refentrytitle
609
>password-prompt</refentrytitle><manvolnum>8mandos</manvolnum>
610
</citerefentry> plugin will read a password from the console in
611
case of failure of the other plugins, and this plugin runner
612
will also, in case of catastrophic failure, itself fall back to
613
asking and outputting a password on the console (see <xref
614
linkend="fallback"/>).
448
618
<refsect1 id="see_also">
449
619
<title>SEE ALSO</title>
621
<citerefentry><refentrytitle>intro</refentrytitle>
622
<manvolnum>8mandos</manvolnum></citerefentry>,
451
623
<citerefentry><refentrytitle>cryptsetup</refentrytitle>
452
624
<manvolnum>8</manvolnum></citerefentry>,
625
<citerefentry><refentrytitle>crypttab</refentrytitle>
626
<manvolnum>5</manvolnum></citerefentry>,
627
<citerefentry><refentrytitle>execve</refentrytitle>
628
<manvolnum>2</manvolnum></citerefentry>,
453
629
<citerefentry><refentrytitle>mandos</refentrytitle>
454
630
<manvolnum>8</manvolnum></citerefentry>,
455
631
<citerefentry><refentrytitle>password-prompt</refentrytitle>
456
632
<manvolnum>8mandos</manvolnum></citerefentry>,
457
<citerefentry><refentrytitle>password-request</refentrytitle>
633
<citerefentry><refentrytitle>mandos-client</refentrytitle>
458
634
<manvolnum>8mandos</manvolnum></citerefentry>
added
removed
plugin-runner.xml
