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 "2019-02-10">
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>
46
<holder>Teddy Hogeborn</holder>
47
<holder>Björn Påhlsson</holder>
49
<xi:include href="../legalnotice.xml"/>
53
<refentrytitle>&COMMANDNAME;</refentrytitle>
54
<manvolnum>8mandos</manvolnum>
58
<refname><command>&COMMANDNAME;</command></refname>
59
<refpurpose>Mandos plugin to use usplash to get a
60
password.</refpurpose>
65
<command>&COMMANDNAME;</command>
69
<refsect1 id="description">
70
<title>DESCRIPTION</title>
72
This program prompts for a password using <citerefentry>
73
<refentrytitle>usplash</refentrytitle><manvolnum>8</manvolnum>
74
</citerefentry> and outputs any given password to standard
75
output. If no <citerefentry><refentrytitle
76
>usplash</refentrytitle><manvolnum>8</manvolnum></citerefentry>
77
process can be found, this program will immediately exit with an
78
exit code indicating failure.
81
This program is not very useful on its own. This program is
82
really meant to run as a plugin in the <application
83
>Mandos</application> client-side system, where it is used as a
84
fallback and alternative to retrieving passwords from a
85
<application >Mandos</application> server.
88
If this program is killed (presumably by
89
<citerefentry><refentrytitle>plugin-runner</refentrytitle>
90
<manvolnum>8mandos</manvolnum></citerefentry> because some other
91
plugin provided the password), it cannot tell <citerefentry>
92
<refentrytitle>usplash</refentrytitle><manvolnum>8</manvolnum>
93
</citerefentry> to abort requesting a password, because
94
<citerefentry><refentrytitle>usplash</refentrytitle>
95
<manvolnum>8</manvolnum></citerefentry> does not support this.
96
Therefore, this program will then <emphasis>kill</emphasis> the
97
running <citerefentry><refentrytitle>usplash</refentrytitle>
98
<manvolnum>8</manvolnum></citerefentry> process and start a
99
<emphasis>new</emphasis> one using the same command line
100
arguments as the old one was using.
104
<refsect1 id="options">
105
<title>OPTIONS</title>
107
This program takes no options.
111
<refsect1 id="exit_status">
112
<title>EXIT STATUS</title>
114
If exit status is 0, the output from the program is the password
115
as it was read. Otherwise, if exit status is other than 0, the
116
program was interrupted or encountered an error, and any output
117
so far could be corrupt and/or truncated, and should therefore
122
<refsect1 id="environment">
123
<title>ENVIRONMENT</title>
126
<term><envar>cryptsource</envar></term>
127
<term><envar>crypttarget</envar></term>
130
If set, these environment variables will be assumed to
131
contain the source device name and the target device
132
mapper name, respectively, and will be shown as part of
136
These variables will normally be inherited from
137
<citerefentry><refentrytitle>plugin-runner</refentrytitle>
138
<manvolnum>8mandos</manvolnum></citerefentry>, which will
139
normally have inherited them from
140
<filename>/scripts/local-top/cryptroot</filename> in the
141
initial <acronym>RAM</acronym> disk environment, which will
142
have set them from parsing kernel arguments and
143
<filename>/conf/conf.d/cryptroot</filename> (also in the
144
initial RAM disk environment), which in turn will have been
145
created when the initial RAM disk image was created by
147
>/usr/share/initramfs-tools/hooks/cryptroot</filename>, by
148
extracting the information of the root file system from
149
<filename >/etc/crypttab</filename>.
152
This behavior is meant to exactly mirror the behavior of
153
<command>askpass</command>, the default password prompter.
160
<refsect1 id="files">
164
<term><filename>/dev/.initramfs/usplash_fifo</filename></term>
167
This is the <acronym>FIFO</acronym> to where this program
168
will write the commands for <citerefentry><refentrytitle
169
>usplash</refentrytitle><manvolnum>8</manvolnum>
170
</citerefentry>. See <citerefentry><refentrytitle
171
>fifo</refentrytitle><manvolnum>7</manvolnum>
177
<term><filename>/dev/.initramfs/usplash_outfifo</filename></term>
180
This is the <acronym>FIFO</acronym> where this program
181
will read the password from <citerefentry><refentrytitle
182
>usplash</refentrytitle><manvolnum>8</manvolnum>
183
</citerefentry>. See <citerefentry><refentrytitle
184
>fifo</refentrytitle><manvolnum>7</manvolnum>
190
<term><filename class="directory">/proc</filename></term>
193
To find the running <citerefentry><refentrytitle
194
>usplash</refentrytitle><manvolnum>8</manvolnum>
195
</citerefentry>, this directory will be searched for
196
numeric entries which will be assumed to be directories.
197
In all those directories, the <filename>exe</filename> and
198
<filename>cmdline</filename> entries will be used to
199
determine the name of the running binary, effective user
200
and group <abbrev>ID</abbrev>, and the command line
201
arguments. See <citerefentry><refentrytitle
202
>proc</refentrytitle><manvolnum>5</manvolnum>
208
<term><filename>/sbin/usplash</filename></term>
211
This is the name of the binary which will be searched for
212
in the process list. See <citerefentry><refentrytitle
213
>usplash</refentrytitle><manvolnum>8</manvolnum>
224
Killing <citerefentry><refentrytitle>usplash</refentrytitle>
225
<manvolnum>8</manvolnum></citerefentry> and starting a new one
226
is ugly, but necessary as long as it does not support aborting a
229
<xi:include href="../bugs.xml"/>
232
<refsect1 id="example">
233
<title>EXAMPLE</title>
235
Note that normally, this program will not be invoked directly,
236
but instead started by the Mandos <citerefentry><refentrytitle
237
>plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum>
242
This program takes no options.
245
<userinput>&COMMANDNAME;</userinput>
250
<refsect1 id="security">
251
<title>SECURITY</title>
253
If this program is killed by a signal, it will kill the process
254
<abbrev>ID</abbrev> which at the start of this program was
255
determined to run <citerefentry><refentrytitle
256
>usplash</refentrytitle><manvolnum>8</manvolnum></citerefentry>
257
as root (see also <xref linkend="files"/>). There is a very
258
slight risk that, in the time between those events, that process
259
<abbrev>ID</abbrev> was freed and then taken up by another
260
process; the wrong process would then be killed. Now, this
261
program can only be killed by the user who started it; see
262
<citerefentry><refentrytitle>plugin-runner</refentrytitle>
263
<manvolnum>8mandos</manvolnum></citerefentry>. This program
264
should therefore be started by a completely separate
265
non-privileged user, and no other programs should be allowed to
266
run as that special user. This means that it is not recommended
267
to use the user "nobody" to start this program, as other
268
possibly less trusted programs could be running as "nobody", and
269
they would then be able to kill this program, triggering the
270
killing of the process <abbrev>ID</abbrev> which may or may not
271
be <citerefentry><refentrytitle>usplash</refentrytitle>
272
<manvolnum>8</manvolnum></citerefentry>.
275
The only other thing that could be considered worthy of note is
276
this: This program is meant to be run by <citerefentry>
277
<refentrytitle>plugin-runner</refentrytitle><manvolnum
278
>8mandos</manvolnum></citerefentry>, and will, when run
279
standalone, outside, in a normal environment, immediately output
280
on its standard output any presumably secret password it just
281
received. Therefore, when running this program standalone
282
(which should never normally be done), take care not to type in
283
any real secret password by force of habit, since it would then
284
immediately be shown as output.
288
<refsect1 id="see_also">
289
<title>SEE ALSO</title>
291
<citerefentry><refentrytitle>intro</refentrytitle>
292
<manvolnum>8mandos</manvolnum></citerefentry>,
293
<citerefentry><refentrytitle>crypttab</refentrytitle>
294
<manvolnum>5</manvolnum></citerefentry>,
295
<citerefentry><refentrytitle>fifo</refentrytitle>
296
<manvolnum>7</manvolnum></citerefentry>,
297
<citerefentry><refentrytitle>plugin-runner</refentrytitle>
298
<manvolnum>8mandos</manvolnum></citerefentry>,
299
<citerefentry><refentrytitle>proc</refentrytitle>
300
<manvolnum>5</manvolnum></citerefentry>,
301
<citerefentry><refentrytitle>usplash</refentrytitle>
302
<manvolnum>8</manvolnum></citerefentry>
306
<!-- Local Variables: -->
307
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
308
<!-- time-stamp-end: "[\"']>" -->
309
<!-- time-stamp-format: "%:y-%02m-%02d" -->
added
removed
plugins.d/usplash.xml
