1
<?xml version="1.0" encoding="UTF-8"?>
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
<!ENTITY COMMANDNAME "plymouth">
5
<!ENTITY TIMESTAMP "2012-01-01">
6
<!ENTITY % common SYSTEM "../common.ent">
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
12
<title>Mandos Manual</title>
13
<!-- NWalsh’s docbook scripts use this to generate the footer: -->
14
<productname>Mandos</productname>
15
<productnumber>&version;</productnumber>
16
<date>&TIMESTAMP;</date>
19
<firstname>Björn</firstname>
20
<surname>Påhlsson</surname>
22
<email>belorn@recompile.se</email>
26
<firstname>Teddy</firstname>
27
<surname>Hogeborn</surname>
29
<email>teddy@recompile.se</email>
37
<holder>Teddy Hogeborn</holder>
38
<holder>Björn Påhlsson</holder>
40
<xi:include href="../legalnotice.xml"/>
44
<refentrytitle>&COMMANDNAME;</refentrytitle>
45
<manvolnum>8mandos</manvolnum>
49
<refname><command>&COMMANDNAME;</command></refname>
50
<refpurpose>Mandos plugin to use plymouth to get a
51
password.</refpurpose>
56
<command>&COMMANDNAME;</command>
60
<refsect1 id="description">
61
<title>DESCRIPTION</title>
63
This program prompts for a password using <citerefentry>
64
<refentrytitle>plymouth</refentrytitle><manvolnum>8</manvolnum>
65
</citerefentry> and outputs any given password to standard
66
output. If no <citerefentry><refentrytitle
67
>plymouth</refentrytitle><manvolnum>8</manvolnum></citerefentry>
68
process can be found, this program will immediately exit with an
69
exit code indicating failure.
72
This program is not very useful on its own. This program is
73
really meant to run as a plugin in the <application
74
>Mandos</application> client-side system, where it is used as a
75
fallback and alternative to retrieving passwords from a
76
<application >Mandos</application> server.
79
If this program is killed (presumably by
80
<citerefentry><refentrytitle>plugin-runner</refentrytitle>
81
<manvolnum>8mandos</manvolnum></citerefentry> because some other
82
plugin provided the password), it cannot tell <citerefentry>
83
<refentrytitle>plymouth</refentrytitle><manvolnum>8</manvolnum>
84
</citerefentry> to abort requesting a password, because
85
<citerefentry><refentrytitle>plymouth</refentrytitle>
86
<manvolnum>8</manvolnum></citerefentry> does not support this.
87
Therefore, this program will then <emphasis>kill</emphasis> the
88
running <citerefentry><refentrytitle>plymouth</refentrytitle>
89
<manvolnum>8</manvolnum></citerefentry> process and start a
90
<emphasis>new</emphasis> one using the same command line
91
arguments as the old one was using.
95
<refsect1 id="options">
96
<title>OPTIONS</title>
98
This program takes no options.
102
<refsect1 id="exit_status">
103
<title>EXIT STATUS</title>
105
If exit status is 0, the output from the program is the password
106
as it was read. Otherwise, if exit status is other than 0, the
107
program was interrupted or encountered an error, and any output
108
so far could be corrupt and/or truncated, and should therefore
113
<refsect1 id="environment">
114
<title>ENVIRONMENT</title>
117
<term><envar>cryptsource</envar></term>
118
<term><envar>crypttarget</envar></term>
121
If set, these environment variables will be assumed to
122
contain the source device name and the target device
123
mapper name, respectively, and will be shown as part of
127
These variables will normally be inherited from
128
<citerefentry><refentrytitle>plugin-runner</refentrytitle>
129
<manvolnum>8mandos</manvolnum></citerefentry>, which will
130
normally have inherited them from
131
<filename>/scripts/local-top/cryptroot</filename> in the
132
initial <acronym>RAM</acronym> disk environment, which will
133
have set them from parsing kernel arguments and
134
<filename>/conf/conf.d/cryptroot</filename> (also in the
135
initial RAM disk environment), which in turn will have been
136
created when the initial RAM disk image was created by
138
>/usr/share/initramfs-tools/hooks/cryptroot</filename>, by
139
extracting the information of the root file system from
140
<filename >/etc/crypttab</filename>.
143
This behavior is meant to exactly mirror the behavior of
144
<command>askpass</command>, the default password prompter.
151
<refsect1 id="files">
155
<term><filename>/bin/plymouth</filename></term>
158
This is the command run to retrieve a password from
159
<citerefentry><refentrytitle>plymouth</refentrytitle>
160
<manvolnum>8</manvolnum></citerefentry>.
165
<term><filename class="directory">/proc</filename></term>
168
To find the running <citerefentry><refentrytitle
169
>plymouth</refentrytitle><manvolnum>8</manvolnum>
170
</citerefentry>, this directory will be searched for
171
numeric entries which will be assumed to be directories.
172
In all those directories, the <filename>exe</filename> and
173
<filename>cmdline</filename> entries will be used to
174
determine the name of the running binary, effective user
175
and group <abbrev>ID</abbrev>, and the command line
176
arguments. See <citerefentry><refentrytitle
177
>proc</refentrytitle><manvolnum>5</manvolnum>
183
<term><filename>/sbin/plymouthd</filename></term>
186
This is the name of the binary which will be searched for
187
in the process list. See <citerefentry><refentrytitle
188
>plymouth</refentrytitle><manvolnum>8</manvolnum>
199
Killing the <citerefentry><refentrytitle
200
>plymouth</refentrytitle><manvolnum>8</manvolnum></citerefentry>
201
daemon and starting a new one is ugly, but necessary as long as
202
it does not support aborting a password request.
206
<refsect1 id="example">
207
<title>EXAMPLE</title>
209
Note that normally, this program will not be invoked directly,
210
but instead started by the Mandos <citerefentry><refentrytitle
211
>plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum>
216
This program takes no options.
219
<userinput>&COMMANDNAME;</userinput>
224
<refsect1 id="security">
225
<title>SECURITY</title>
227
If this program is killed by a signal, it will kill the process
228
<abbrev>ID</abbrev> which at the start of this program was
229
determined to run <citerefentry><refentrytitle
230
>plymouth</refentrytitle><manvolnum>8</manvolnum></citerefentry>
231
as root (see also <xref linkend="files"/>). There is a very
232
slight risk that, in the time between those events, that process
233
<abbrev>ID</abbrev> was freed and then taken up by another
234
process; the wrong process would then be killed. Now, this
235
program can only be killed by the user who started it; see
236
<citerefentry><refentrytitle>plugin-runner</refentrytitle>
237
<manvolnum>8mandos</manvolnum></citerefentry>. This program
238
should therefore be started by a completely separate
239
non-privileged user, and no other programs should be allowed to
240
run as that special user. This means that it is not recommended
241
to use the user "nobody" to start this program, as other
242
possibly less trusted programs could be running as "nobody", and
243
they would then be able to kill this program, triggering the
244
killing of the process <abbrev>ID</abbrev> which may or may not
245
be <citerefentry><refentrytitle>plymouth</refentrytitle>
246
<manvolnum>8</manvolnum></citerefentry>.
249
The only other thing that could be considered worthy of note is
250
this: This program is meant to be run by <citerefentry>
251
<refentrytitle>plugin-runner</refentrytitle><manvolnum
252
>8mandos</manvolnum></citerefentry>, and will, when run
253
standalone, outside, in a normal environment, immediately output
254
on its standard output any presumably secret password it just
255
received. Therefore, when running this program standalone
256
(which should never normally be done), take care not to type in
257
any real secret password by force of habit, since it would then
258
immediately be shown as output.
262
<refsect1 id="see_also">
263
<title>SEE ALSO</title>
265
<citerefentry><refentrytitle>intro</refentrytitle>
266
<manvolnum>8mandos</manvolnum></citerefentry>,
267
<citerefentry><refentrytitle>crypttab</refentrytitle>
268
<manvolnum>5</manvolnum></citerefentry>,
269
<citerefentry><refentrytitle>plugin-runner</refentrytitle>
270
<manvolnum>8mandos</manvolnum></citerefentry>,
271
<citerefentry><refentrytitle>proc</refentrytitle>
272
<manvolnum>5</manvolnum></citerefentry>,
273
<citerefentry><refentrytitle>plymouth</refentrytitle>
274
<manvolnum>8</manvolnum></citerefentry>
278
<!-- Local Variables: -->
279
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
280
<!-- time-stamp-end: "[\"']>" -->
281
<!-- time-stamp-format: "%:y-%02m-%02d" -->
added
removed
plugins.d/plymouth.xml
