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 "splashy">
5
<!ENTITY TIMESTAMP "2016-02-28">
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 splashy 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>splashy_update</refentrytitle>
71
<manvolnum>8</manvolnum></citerefentry> and outputs any given
72
password to standard output. If no <citerefentry><refentrytitle
73
>splashy</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>splashy</refentrytitle><manvolnum>8</manvolnum>
90
</citerefentry> to abort requesting a password, because
91
<citerefentry><refentrytitle>splashy</refentrytitle>
92
<manvolnum>8</manvolnum></citerefentry> does not support this.
93
Therefore, this program will then <emphasis>kill</emphasis> the
94
running <citerefentry><refentrytitle>splashy</refentrytitle>
95
<manvolnum>8</manvolnum></citerefentry> process and start a
96
<emphasis>new</emphasis> one, using <quote><literal
97
>boot</literal></quote> as the only argument.
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>/sbin/splashy_update</filename></term>
164
This is the command run to retrieve a password from
165
<citerefentry><refentrytitle>splashy</refentrytitle>
166
<manvolnum>8</manvolnum></citerefentry>. See
167
<citerefentry><refentrytitle
168
>splashy_update</refentrytitle><manvolnum>8</manvolnum>
174
<term><filename>/proc</filename></term>
177
To find the running <citerefentry><refentrytitle
178
>splashy</refentrytitle><manvolnum>8</manvolnum>
179
</citerefentry>, this directory will be searched for
180
numeric entries which will be assumed to be directories.
181
In all those directories, the <filename>exe</filename>
182
entry will be used to determine the name of the running
183
binary and the effective user and group
184
<abbrev>ID</abbrev> of the process. See <citerefentry>
185
<refentrytitle>proc</refentrytitle><manvolnum
186
>5</manvolnum></citerefentry>.
191
<term><filename>/sbin/splashy</filename></term>
194
This is the name of the binary which will be searched for
195
in the process list. See <citerefentry><refentrytitle
196
>splashy</refentrytitle><manvolnum>8</manvolnum>
207
Killing <citerefentry><refentrytitle>splashy</refentrytitle>
208
<manvolnum>8</manvolnum></citerefentry> and starting a new one
209
is ugly, but necessary as long as it does not support aborting a
214
<refsect1 id="example">
215
<title>EXAMPLE</title>
217
Note that normally, this program will not be invoked directly,
218
but instead started by the Mandos <citerefentry><refentrytitle
219
>plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum>
224
This program takes no options.
227
<userinput>&COMMANDNAME;</userinput>
232
<refsect1 id="security">
233
<title>SECURITY</title>
235
If this program is killed by a signal, it will kill the process
236
<abbrev>ID</abbrev> which at the start of this program was
237
determined to run <citerefentry><refentrytitle
238
>splashy</refentrytitle><manvolnum>8</manvolnum></citerefentry>
239
as root (see also <xref linkend="files"/>). There is a very
240
slight risk that, in the time between those events, that process
241
<abbrev>ID</abbrev> was freed and then taken up by another
242
process; the wrong process would then be killed. Now, this
243
program can only be killed by the user who started it; see
244
<citerefentry><refentrytitle>plugin-runner</refentrytitle>
245
<manvolnum>8mandos</manvolnum></citerefentry>. This program
246
should therefore be started by a completely separate
247
non-privileged user, and no other programs should be allowed to
248
run as that special user. This means that it is not recommended
249
to use the user "nobody" to start this program, as other
250
possibly less trusted programs could be running as "nobody", and
251
they would then be able to kill this program, triggering the
252
killing of the process <abbrev>ID</abbrev> which may or may not
253
be <citerefentry><refentrytitle>splashy</refentrytitle>
254
<manvolnum>8</manvolnum></citerefentry>.
257
The only other thing that could be considered worthy of note is
258
this: This program is meant to be run by <citerefentry>
259
<refentrytitle>plugin-runner</refentrytitle><manvolnum
260
>8mandos</manvolnum></citerefentry>, and will, when run
261
standalone, outside, in a normal environment, immediately output
262
on its standard output any presumably secret password it just
263
received. Therefore, when running this program standalone
264
(which should never normally be done), take care not to type in
265
any real secret password by force of habit, since it would then
266
immediately be shown as output.
270
<refsect1 id="see_also">
271
<title>SEE ALSO</title>
273
<citerefentry><refentrytitle>intro</refentrytitle>
274
<manvolnum>8mandos</manvolnum></citerefentry>,
275
<citerefentry><refentrytitle>crypttab</refentrytitle>
276
<manvolnum>5</manvolnum></citerefentry>,
277
<citerefentry><refentrytitle>plugin-runner</refentrytitle>
278
<manvolnum>8mandos</manvolnum></citerefentry>,
279
<citerefentry><refentrytitle>proc</refentrytitle>
280
<manvolnum>5</manvolnum></citerefentry>,
281
<citerefentry><refentrytitle>splashy</refentrytitle>
282
<manvolnum>8</manvolnum></citerefentry>,
283
<citerefentry><refentrytitle>splashy_update</refentrytitle>
284
<manvolnum>8</manvolnum></citerefentry>
288
<!-- Local Variables: -->
289
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
290
<!-- time-stamp-end: "[\"']>" -->
291
<!-- time-stamp-format: "%:y-%02m-%02d" -->
added
removed
plugins.d/splashy.xml
