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 might
139
have in turn inherited them from its calling process.
142
This behavior is meant to exactly mirror the behavior of
143
<command>askpass</command>, the default password prompter.
150
<refsect1 id="files">
154
<term><filename>/dev/.initramfs/usplash_fifo</filename></term>
157
This is the <acronym>FIFO</acronym> to where this program
158
will write the commands for <citerefentry><refentrytitle
159
>usplash</refentrytitle><manvolnum>8</manvolnum>
160
</citerefentry>. See <citerefentry><refentrytitle
161
>fifo</refentrytitle><manvolnum>7</manvolnum>
167
<term><filename>/dev/.initramfs/usplash_outfifo</filename></term>
170
This is the <acronym>FIFO</acronym> where this program
171
will read the password from <citerefentry><refentrytitle
172
>usplash</refentrytitle><manvolnum>8</manvolnum>
173
</citerefentry>. See <citerefentry><refentrytitle
174
>fifo</refentrytitle><manvolnum>7</manvolnum>
180
<term><filename class="directory">/proc</filename></term>
183
To find the running <citerefentry><refentrytitle
184
>usplash</refentrytitle><manvolnum>8</manvolnum>
185
</citerefentry>, this directory will be searched for
186
numeric entries which will be assumed to be directories.
187
In all those directories, the <filename>exe</filename> and
188
<filename>cmdline</filename> entries will be used to
189
determine the name of the running binary, effective user
190
and group <abbrev>ID</abbrev>, and the command line
191
arguments. See <citerefentry><refentrytitle
192
>proc</refentrytitle><manvolnum>5</manvolnum>
198
<term><filename>/sbin/usplash</filename></term>
201
This is the name of the binary which will be searched for
202
in the process list. See <citerefentry><refentrytitle
203
>usplash</refentrytitle><manvolnum>8</manvolnum>
214
Killing <citerefentry><refentrytitle>usplash</refentrytitle>
215
<manvolnum>8</manvolnum></citerefentry> and starting a new one
216
is ugly, but necessary as long as it does not support aborting a
219
<xi:include href="../bugs.xml"/>
222
<refsect1 id="example">
223
<title>EXAMPLE</title>
225
Note that normally, this program will not be invoked directly,
226
but instead started by the Mandos <citerefentry><refentrytitle
227
>plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum>
232
This program takes no options.
235
<userinput>&COMMANDNAME;</userinput>
240
<refsect1 id="security">
241
<title>SECURITY</title>
243
If this program is killed by a signal, it will kill the process
244
<abbrev>ID</abbrev> which at the start of this program was
245
determined to run <citerefentry><refentrytitle
246
>usplash</refentrytitle><manvolnum>8</manvolnum></citerefentry>
247
as root (see also <xref linkend="files"/>). There is a very
248
slight risk that, in the time between those events, that process
249
<abbrev>ID</abbrev> was freed and then taken up by another
250
process; the wrong process would then be killed. Now, this
251
program can only be killed by the user who started it; see
252
<citerefentry><refentrytitle>plugin-runner</refentrytitle>
253
<manvolnum>8mandos</manvolnum></citerefentry>. This program
254
should therefore be started by a completely separate
255
non-privileged user, and no other programs should be allowed to
256
run as that special user. This means that it is not recommended
257
to use the user "nobody" to start this program, as other
258
possibly less trusted programs could be running as "nobody", and
259
they would then be able to kill this program, triggering the
260
killing of the process <abbrev>ID</abbrev> which may or may not
261
be <citerefentry><refentrytitle>usplash</refentrytitle>
262
<manvolnum>8</manvolnum></citerefentry>.
265
The only other thing that could be considered worthy of note is
266
this: This program is meant to be run by <citerefentry>
267
<refentrytitle>plugin-runner</refentrytitle><manvolnum
268
>8mandos</manvolnum></citerefentry>, and will, when run
269
standalone, outside, in a normal environment, immediately output
270
on its standard output any presumably secret password it just
271
received. Therefore, when running this program standalone
272
(which should never normally be done), take care not to type in
273
any real secret password by force of habit, since it would then
274
immediately be shown as output.
278
<refsect1 id="see_also">
279
<title>SEE ALSO</title>
281
<citerefentry><refentrytitle>intro</refentrytitle>
282
<manvolnum>8mandos</manvolnum></citerefentry>,
283
<citerefentry><refentrytitle>fifo</refentrytitle>
284
<manvolnum>7</manvolnum></citerefentry>,
285
<citerefentry><refentrytitle>plugin-runner</refentrytitle>
286
<manvolnum>8mandos</manvolnum></citerefentry>,
287
<citerefentry><refentrytitle>proc</refentrytitle>
288
<manvolnum>5</manvolnum></citerefentry>,
289
<citerefentry><refentrytitle>usplash</refentrytitle>
290
<manvolnum>8</manvolnum></citerefentry>
294
<!-- Local Variables: -->
295
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
296
<!-- time-stamp-end: "[\"']>" -->
297
<!-- time-stamp-format: "%:y-%02m-%02d" -->
added
removed
plugins.d/usplash.xml
