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 "usplash">
5
<!ENTITY TIMESTAMP "2016-03-05">
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 usplash 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>usplash</refentrytitle><manvolnum>8</manvolnum>
71
</citerefentry> and outputs any given password to standard
72
output. If no <citerefentry><refentrytitle
73
>usplash</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>usplash</refentrytitle><manvolnum>8</manvolnum>
90
</citerefentry> to abort requesting a password, because
91
<citerefentry><refentrytitle>usplash</refentrytitle>
92
<manvolnum>8</manvolnum></citerefentry> does not support this.
93
Therefore, this program will then <emphasis>kill</emphasis> the
94
running <citerefentry><refentrytitle>usplash</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>/dev/.initramfs/usplash_fifo</filename></term>
164
This is the <acronym>FIFO</acronym> to where this program
165
will write the commands for <citerefentry><refentrytitle
166
>usplash</refentrytitle><manvolnum>8</manvolnum>
167
</citerefentry>. See <citerefentry><refentrytitle
168
>fifo</refentrytitle><manvolnum>7</manvolnum>
174
<term><filename>/dev/.initramfs/usplash_outfifo</filename></term>
177
This is the <acronym>FIFO</acronym> where this program
178
will read the password from <citerefentry><refentrytitle
179
>usplash</refentrytitle><manvolnum>8</manvolnum>
180
</citerefentry>. See <citerefentry><refentrytitle
181
>fifo</refentrytitle><manvolnum>7</manvolnum>
187
<term><filename class="directory">/proc</filename></term>
190
To find the running <citerefentry><refentrytitle
191
>usplash</refentrytitle><manvolnum>8</manvolnum>
192
</citerefentry>, this directory will be searched for
193
numeric entries which will be assumed to be directories.
194
In all those directories, the <filename>exe</filename> and
195
<filename>cmdline</filename> entries will be used to
196
determine the name of the running binary, effective user
197
and group <abbrev>ID</abbrev>, and the command line
198
arguments. See <citerefentry><refentrytitle
199
>proc</refentrytitle><manvolnum>5</manvolnum>
205
<term><filename>/sbin/usplash</filename></term>
208
This is the name of the binary which will be searched for
209
in the process list. See <citerefentry><refentrytitle
210
>usplash</refentrytitle><manvolnum>8</manvolnum>
221
Killing <citerefentry><refentrytitle>usplash</refentrytitle>
222
<manvolnum>8</manvolnum></citerefentry> and starting a new one
223
is ugly, but necessary as long as it does not support aborting a
226
<xi:include href="../bugs.xml"/>
229
<refsect1 id="example">
230
<title>EXAMPLE</title>
232
Note that normally, this program will not be invoked directly,
233
but instead started by the Mandos <citerefentry><refentrytitle
234
>plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum>
239
This program takes no options.
242
<userinput>&COMMANDNAME;</userinput>
247
<refsect1 id="security">
248
<title>SECURITY</title>
250
If this program is killed by a signal, it will kill the process
251
<abbrev>ID</abbrev> which at the start of this program was
252
determined to run <citerefentry><refentrytitle
253
>usplash</refentrytitle><manvolnum>8</manvolnum></citerefentry>
254
as root (see also <xref linkend="files"/>). There is a very
255
slight risk that, in the time between those events, that process
256
<abbrev>ID</abbrev> was freed and then taken up by another
257
process; the wrong process would then be killed. Now, this
258
program can only be killed by the user who started it; see
259
<citerefentry><refentrytitle>plugin-runner</refentrytitle>
260
<manvolnum>8mandos</manvolnum></citerefentry>. This program
261
should therefore be started by a completely separate
262
non-privileged user, and no other programs should be allowed to
263
run as that special user. This means that it is not recommended
264
to use the user "nobody" to start this program, as other
265
possibly less trusted programs could be running as "nobody", and
266
they would then be able to kill this program, triggering the
267
killing of the process <abbrev>ID</abbrev> which may or may not
268
be <citerefentry><refentrytitle>usplash</refentrytitle>
269
<manvolnum>8</manvolnum></citerefentry>.
272
The only other thing that could be considered worthy of note is
273
this: This program is meant to be run by <citerefentry>
274
<refentrytitle>plugin-runner</refentrytitle><manvolnum
275
>8mandos</manvolnum></citerefentry>, and will, when run
276
standalone, outside, in a normal environment, immediately output
277
on its standard output any presumably secret password it just
278
received. Therefore, when running this program standalone
279
(which should never normally be done), take care not to type in
280
any real secret password by force of habit, since it would then
281
immediately be shown as output.
285
<refsect1 id="see_also">
286
<title>SEE ALSO</title>
288
<citerefentry><refentrytitle>intro</refentrytitle>
289
<manvolnum>8mandos</manvolnum></citerefentry>,
290
<citerefentry><refentrytitle>crypttab</refentrytitle>
291
<manvolnum>5</manvolnum></citerefentry>,
292
<citerefentry><refentrytitle>fifo</refentrytitle>
293
<manvolnum>7</manvolnum></citerefentry>,
294
<citerefentry><refentrytitle>plugin-runner</refentrytitle>
295
<manvolnum>8mandos</manvolnum></citerefentry>,
296
<citerefentry><refentrytitle>proc</refentrytitle>
297
<manvolnum>5</manvolnum></citerefentry>,
298
<citerefentry><refentrytitle>usplash</refentrytitle>
299
<manvolnum>8</manvolnum></citerefentry>
303
<!-- Local Variables: -->
304
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
305
<!-- time-stamp-end: "[\"']>" -->
306
<!-- time-stamp-format: "%:y-%02m-%02d" -->
added
removed
plugins.d/usplash.xml
