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 "2018-02-08">
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>
43
<holder>Teddy Hogeborn</holder>
44
<holder>Björn Påhlsson</holder>
46
<xi:include href="../legalnotice.xml"/>
50
<refentrytitle>&COMMANDNAME;</refentrytitle>
51
<manvolnum>8mandos</manvolnum>
55
<refname><command>&COMMANDNAME;</command></refname>
56
<refpurpose>Mandos plugin to use plymouth to get a
57
password.</refpurpose>
62
<command>&COMMANDNAME;</command>
66
<refsect1 id="description">
67
<title>DESCRIPTION</title>
69
This program prompts for a password using <citerefentry>
70
<refentrytitle>plymouth</refentrytitle><manvolnum>8</manvolnum>
71
</citerefentry> and outputs any given password to standard
72
output. If no <citerefentry><refentrytitle
73
>plymouth</refentrytitle><manvolnum>8</manvolnum></citerefentry>
74
process can be found, this program will immediately exit with an
75
exit code indicating failure.
78
This program is not very useful on its own. This program is
79
really meant to run as a plugin in the <application
80
>Mandos</application> client-side system, where it is used as a
81
fallback and alternative to retrieving passwords from a
82
<application >Mandos</application> server.
85
If this program is killed (presumably by
86
<citerefentry><refentrytitle>plugin-runner</refentrytitle>
87
<manvolnum>8mandos</manvolnum></citerefentry> because some other
88
plugin provided the password), it cannot tell <citerefentry>
89
<refentrytitle>plymouth</refentrytitle><manvolnum>8</manvolnum>
90
</citerefentry> to abort requesting a password, because
91
<citerefentry><refentrytitle>plymouth</refentrytitle>
92
<manvolnum>8</manvolnum></citerefentry> does not support this.
93
Therefore, this program will then <emphasis>kill</emphasis> the
94
running <citerefentry><refentrytitle>plymouth</refentrytitle>
95
<manvolnum>8</manvolnum></citerefentry> process and start a
96
<emphasis>new</emphasis> one using the same command line
97
arguments as the old one was using.
101
<refsect1 id="options">
102
<title>OPTIONS</title>
104
This program takes no options.
108
<refsect1 id="exit_status">
109
<title>EXIT STATUS</title>
111
If exit status is 0, the output from the program is the password
112
as it was read. Otherwise, if exit status is other than 0, the
113
program was interrupted or encountered an error, and any output
114
so far could be corrupt and/or truncated, and should therefore
119
<refsect1 id="environment">
120
<title>ENVIRONMENT</title>
123
<term><envar>cryptsource</envar></term>
124
<term><envar>crypttarget</envar></term>
127
If set, these environment variables will be assumed to
128
contain the source device name and the target device
129
mapper name, respectively, and will be shown as part of
133
These variables will normally be inherited from
134
<citerefentry><refentrytitle>plugin-runner</refentrytitle>
135
<manvolnum>8mandos</manvolnum></citerefentry>, which will
136
normally have inherited them from
137
<filename>/scripts/local-top/cryptroot</filename> in the
138
initial <acronym>RAM</acronym> disk environment, which will
139
have set them from parsing kernel arguments and
140
<filename>/conf/conf.d/cryptroot</filename> (also in the
141
initial RAM disk environment), which in turn will have been
142
created when the initial RAM disk image was created by
144
>/usr/share/initramfs-tools/hooks/cryptroot</filename>, by
145
extracting the information of the root file system from
146
<filename >/etc/crypttab</filename>.
149
This behavior is meant to exactly mirror the behavior of
150
<command>askpass</command>, the default password prompter.
157
<refsect1 id="files">
161
<term><filename>/bin/plymouth</filename></term>
164
This is the command run to retrieve a password from
165
<citerefentry><refentrytitle>plymouth</refentrytitle>
166
<manvolnum>8</manvolnum></citerefentry>.
171
<term><filename class="directory">/proc</filename></term>
174
To find the running <citerefentry><refentrytitle
175
>plymouth</refentrytitle><manvolnum>8</manvolnum>
176
</citerefentry>, this directory will be searched for
177
numeric entries which will be assumed to be directories.
178
In all those directories, the <filename>exe</filename> and
179
<filename>cmdline</filename> entries will be used to
180
determine the name of the running binary, effective user
181
and group <abbrev>ID</abbrev>, and the command line
182
arguments. See <citerefentry><refentrytitle
183
>proc</refentrytitle><manvolnum>5</manvolnum>
189
<term><filename>/sbin/plymouthd</filename></term>
192
This is the name of the binary which will be searched for
193
in the process list. See <citerefentry><refentrytitle
194
>plymouth</refentrytitle><manvolnum>8</manvolnum>
205
Killing the <citerefentry><refentrytitle
206
>plymouth</refentrytitle><manvolnum>8</manvolnum></citerefentry>
207
daemon and starting a new one is ugly, but necessary as long as
208
it does not support aborting a password request.
210
<xi:include href="../bugs.xml"/>
213
<refsect1 id="example">
214
<title>EXAMPLE</title>
216
Note that normally, this program will not be invoked directly,
217
but instead started by the Mandos <citerefentry><refentrytitle
218
>plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum>
223
This program takes no options.
226
<userinput>&COMMANDNAME;</userinput>
231
<refsect1 id="security">
232
<title>SECURITY</title>
234
If this program is killed by a signal, it will kill the process
235
<abbrev>ID</abbrev> which at the start of this program was
236
determined to run <citerefentry><refentrytitle
237
>plymouth</refentrytitle><manvolnum>8</manvolnum></citerefentry>
238
as root (see also <xref linkend="files"/>). There is a very
239
slight risk that, in the time between those events, that process
240
<abbrev>ID</abbrev> was freed and then taken up by another
241
process; the wrong process would then be killed. Now, this
242
program can only be killed by the user who started it; see
243
<citerefentry><refentrytitle>plugin-runner</refentrytitle>
244
<manvolnum>8mandos</manvolnum></citerefentry>. This program
245
should therefore be started by a completely separate
246
non-privileged user, and no other programs should be allowed to
247
run as that special user. This means that it is not recommended
248
to use the user "nobody" to start this program, as other
249
possibly less trusted programs could be running as "nobody", and
250
they would then be able to kill this program, triggering the
251
killing of the process <abbrev>ID</abbrev> which may or may not
252
be <citerefentry><refentrytitle>plymouth</refentrytitle>
253
<manvolnum>8</manvolnum></citerefentry>.
256
The only other thing that could be considered worthy of note is
257
this: This program is meant to be run by <citerefentry>
258
<refentrytitle>plugin-runner</refentrytitle><manvolnum
259
>8mandos</manvolnum></citerefentry>, and will, when run
260
standalone, outside, in a normal environment, immediately output
261
on its standard output any presumably secret password it just
262
received. Therefore, when running this program standalone
263
(which should never normally be done), take care not to type in
264
any real secret password by force of habit, since it would then
265
immediately be shown as output.
269
<refsect1 id="see_also">
270
<title>SEE ALSO</title>
272
<citerefentry><refentrytitle>intro</refentrytitle>
273
<manvolnum>8mandos</manvolnum></citerefentry>,
274
<citerefentry><refentrytitle>crypttab</refentrytitle>
275
<manvolnum>5</manvolnum></citerefentry>,
276
<citerefentry><refentrytitle>plugin-runner</refentrytitle>
277
<manvolnum>8mandos</manvolnum></citerefentry>,
278
<citerefentry><refentrytitle>proc</refentrytitle>
279
<manvolnum>5</manvolnum></citerefentry>,
280
<citerefentry><refentrytitle>plymouth</refentrytitle>
281
<manvolnum>8</manvolnum></citerefentry>
285
<!-- Local Variables: -->
286
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
287
<!-- time-stamp-end: "[\"']>" -->
288
<!-- time-stamp-format: "%:y-%02m-%02d" -->
added
removed
plugins.d/plymouth.xml
