12
11
<title>Mandos Manual</title>
13
12
<!-- Nwalsh’s docbook scripts use this to generate the footer: -->
14
13
<productname>Mandos</productname>
15
<productnumber>&version;</productnumber>
14
<productnumber>&VERSION;</productnumber>
16
15
<date>&TIMESTAMP;</date>
19
18
<firstname>Björn</firstname>
20
19
<surname>Påhlsson</surname>
22
<email>belorn@recompile.se</email>
21
<email>belorn@fukt.bsnet.se</email>
26
25
<firstname>Teddy</firstname>
27
26
<surname>Hogeborn</surname>
29
<email>teddy@recompile.se</email>
28
<email>teddy@fukt.bsnet.se</email>
45
34
<holder>Teddy Hogeborn</holder>
46
35
<holder>Björn Påhlsson</holder>
48
37
<xi:include href="legalnotice.xml"/>
52
41
<refentrytitle>&COMMANDNAME;</refentrytitle>
53
42
<manvolnum>8mandos</manvolnum>
57
46
<refname><command>&COMMANDNAME;</command></refname>
59
Run Mandos plugins, pass data from first to succeed.
48
Run Mandos plugins. Pass data from first succesful one.
65
54
<command>&COMMANDNAME;</command>
66
55
<group rep="repeat">
67
56
<arg choice="plain"><option>--global-env=<replaceable
68
>ENV</replaceable><literal>=</literal><replaceable
57
>VAR</replaceable><literal>=</literal><replaceable
69
58
>value</replaceable></option></arg>
70
59
<arg choice="plain"><option>-G
71
<replaceable>ENV</replaceable><literal>=</literal><replaceable
60
<replaceable>VAR</replaceable><literal>=</literal><replaceable
72
61
>value</replaceable> </option></arg>
154
140
<title>DESCRIPTION</title>
156
142
<command>&COMMANDNAME;</command> is a program which is meant to
157
be specified as a <quote>keyscript</quote> for the root disk in
158
<citerefentry><refentrytitle>crypttab</refentrytitle>
159
<manvolnum>5</manvolnum></citerefentry>. The aim of this
160
program is therefore to output a password, which then
161
<citerefentry><refentrytitle>cryptsetup</refentrytitle>
162
<manvolnum>8</manvolnum></citerefentry> will use to unlock the
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.
166
152
This program is not meant to be invoked directly, but can be in
432
403
code will make this plugin-runner output the password from that
433
404
plugin, stop any other plugins, and exit.
436
<refsect2 id="writing_plugins">
437
<title>WRITING PLUGINS</title>
439
A plugin is simply a program which prints a password to its
440
standard output and then exits with a successful (zero) exit
441
status. If the exit status is not zero, any output on
442
standard output will be ignored by the plugin runner. Any
443
output on its standard error channel will simply be passed to
444
the standard error of the plugin runner, usually the system
448
If the password is a single-line, manually entered passprase,
449
a final trailing newline character should
450
<emphasis>not</emphasis> be printed.
453
The plugin will run in the initial RAM disk environment, so
454
care must be taken not to depend on any files or running
455
services not available there. Any helper executables required
456
by the plugin (which are not in the <envar>PATH</envar>) can
457
be placed in the plugin helper directory, the name of which
458
will be made available to the plugin via the
459
<envar>MANDOSPLUGINHELPERDIR</envar> environment variable.
462
The plugin must exit cleanly and free all allocated resources
463
upon getting the TERM signal, since this is what the plugin
464
runner uses to stop all other plugins when one plugin has
465
output a password and exited cleanly.
468
The plugin must not use resources, like for instance reading
469
from the standard input, without knowing that no other plugin
473
It is useful, but not required, for the plugin to take the
474
<option>--debug</option> option.
479
408
<refsect1 id="fallback">
573
480
<refsect1 id="bugs">
574
481
<title>BUGS</title>
576
The <option>--config-file</option> option is ignored when
577
specified from within a configuration file.
579
<xi:include href="bugs.xml"/>
582
486
<refsect1 id="examples">
583
487
<title>EXAMPLE</title>
586
Normal invocation needs no options:
589
<userinput>&COMMANDNAME;</userinput>
594
Run the program, but not the plugins, in debug mode:
598
<!-- do not wrap this line -->
599
<userinput>&COMMANDNAME; --debug</userinput>
605
Run all plugins, but run the <quote>foo</quote> plugin in
610
<!-- do not wrap this line -->
611
<userinput>&COMMANDNAME; --options-for=foo:--debug</userinput>
617
Run all plugins, but not the program, in debug mode:
621
<!-- do not wrap this line -->
622
<userinput>&COMMANDNAME; --global-options=--debug</userinput>
628
Read a different configuration file, run plugins from a
629
different directory, specify an alternate plugin helper
630
directory and add two options to the
631
<citerefentry><refentrytitle >mandos-client</refentrytitle>
632
<manvolnum>8mandos</manvolnum></citerefentry> plugin:
636
<!-- do not wrap this line -->
637
<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,--tls-pubkey=tls-pubkey.pem,--tls-privkey=tls-privkey.pem</userinput>
642
492
<refsect1 id="security">
643
493
<title>SECURITY</title>
645
This program will, when starting, try to switch to another user.
646
If it is started as root, it will succeed, and will by default
647
switch to user and group 65534, which are assumed to be
648
non-privileged. This user and group is then what all plugins
649
will be started as. Therefore, the only way to run a plugin as
650
a privileged user is to have the set-user-ID or set-group-ID bit
651
set on the plugin executable file (see <citerefentry>
652
<refentrytitle>execve</refentrytitle><manvolnum>2</manvolnum>
656
If this program is used as a keyscript in <citerefentry
657
><refentrytitle>crypttab</refentrytitle><manvolnum>5</manvolnum>
658
</citerefentry>, there is a slight risk that if this program
659
fails to work, there might be no way to boot the system except
660
for booting from another media and editing the initial RAM disk
661
image to not run this program. This is, however, unlikely,
662
since the <citerefentry><refentrytitle
663
>password-prompt</refentrytitle><manvolnum>8mandos</manvolnum>
664
</citerefentry> plugin will read a password from the console in
665
case of failure of the other plugins, and this plugin runner
666
will also, in case of catastrophic failure, itself fall back to
667
asking and outputting a password on the console (see <xref
668
linkend="fallback"/>).
672
498
<refsect1 id="see_also">
673
499
<title>SEE ALSO</title>
675
<citerefentry><refentrytitle>intro</refentrytitle>
676
<manvolnum>8mandos</manvolnum></citerefentry>,
677
501
<citerefentry><refentrytitle>cryptsetup</refentrytitle>
678
502
<manvolnum>8</manvolnum></citerefentry>,
679
<citerefentry><refentrytitle>crypttab</refentrytitle>
680
<manvolnum>5</manvolnum></citerefentry>,
681
<citerefentry><refentrytitle>execve</refentrytitle>
682
<manvolnum>2</manvolnum></citerefentry>,
683
503
<citerefentry><refentrytitle>mandos</refentrytitle>
684
504
<manvolnum>8</manvolnum></citerefentry>,
685
505
<citerefentry><refentrytitle>password-prompt</refentrytitle>
686
506
<manvolnum>8mandos</manvolnum></citerefentry>,
687
<citerefentry><refentrytitle>mandos-client</refentrytitle>
507
<citerefentry><refentrytitle>password-request</refentrytitle>
688
508
<manvolnum>8mandos</manvolnum></citerefentry>