/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release
225 by Teddy Hogeborn
* Makefile (DOCS): Added "plugins.d/usplash.8mandos" and
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">
237.7.517 by Teddy Hogeborn
Update copyright year to 2019
5
<!ENTITY TIMESTAMP "2019-02-10">
225 by Teddy Hogeborn
* Makefile (DOCS): Added "plugins.d/usplash.8mandos" and
6
<!ENTITY % common SYSTEM "../common.ent">
7
%common;
8
]>
9
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
11
  <refentryinfo>
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>
17
    <authorgroup>
18
      <author>
19
	<firstname>Björn</firstname>
20
	<surname>Påhlsson</surname>
21
	<address>
237.11.2 by Teddy Hogeborn
Change "fukt.bsnet.se" to "recompile.se" throughout.
22
	  <email>belorn@recompile.se</email>
225 by Teddy Hogeborn
* Makefile (DOCS): Added "plugins.d/usplash.8mandos" and
23
	</address>
24
      </author>
25
      <author>
26
	<firstname>Teddy</firstname>
27
	<surname>Hogeborn</surname>
28
	<address>
237.11.2 by Teddy Hogeborn
Change "fukt.bsnet.se" to "recompile.se" throughout.
29
	  <email>teddy@recompile.se</email>
225 by Teddy Hogeborn
* Makefile (DOCS): Added "plugins.d/usplash.8mandos" and
30
	</address>
31
      </author>
32
    </authorgroup>
33
    <copyright>
34
      <year>2008</year>
237.2.9 by Teddy Hogeborn
* README: Update copyright year; add "2009".
35
      <year>2009</year>
237.7.326 by Teddy Hogeborn
Update copyright year.
36
      <year>2010</year>
37
      <year>2011</year>
237.7.92 by Teddy Hogeborn
Updated year in copyright notices.
38
      <year>2012</year>
237.7.326 by Teddy Hogeborn
Update copyright year.
39
      <year>2013</year>
40
      <year>2014</year>
41
      <year>2015</year>
237.7.355 by Teddy Hogeborn
Update copyright year.
42
      <year>2016</year>
237.7.447 by Teddy Hogeborn
Update copyright year to 2017
43
      <year>2017</year>
237.7.471 by Teddy Hogeborn
Update copyright year to 2018
44
      <year>2018</year>
237.7.517 by Teddy Hogeborn
Update copyright year to 2019
45
      <year>2019</year>
225 by Teddy Hogeborn
* Makefile (DOCS): Added "plugins.d/usplash.8mandos" and
46
      <holder>Teddy Hogeborn</holder>
47
      <holder>Björn Påhlsson</holder>
48
    </copyright>
49
    <xi:include href="../legalnotice.xml"/>
50
  </refentryinfo>
51
  
52
  <refmeta>
53
    <refentrytitle>&COMMANDNAME;</refentrytitle>
54
    <manvolnum>8mandos</manvolnum>
55
  </refmeta>
56
  
57
  <refnamediv>
58
    <refname><command>&COMMANDNAME;</command></refname>
59
    <refpurpose>Mandos plugin to use splashy to get a
60
    password.</refpurpose>
61
  </refnamediv>
62
  
63
  <refsynopsisdiv>
64
    <cmdsynopsis>
65
      <command>&COMMANDNAME;</command>
66
    </cmdsynopsis>
67
  </refsynopsisdiv>
68
  
69
  <refsect1 id="description">
70
    <title>DESCRIPTION</title>
71
    <para>
72
      This program prompts for a password using <citerefentry>
73
      <refentrytitle>splashy_update</refentrytitle>
74
      <manvolnum>8</manvolnum></citerefentry> and outputs any given
75
      password to standard output.  If no <citerefentry><refentrytitle
76
      >splashy</refentrytitle><manvolnum>8</manvolnum></citerefentry>
77
      process can be found, this program will immediately exit with an
78
      exit code indicating failure.
79
    </para>
80
    <para>
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.
86
    </para>
87
    <para>
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>splashy</refentrytitle><manvolnum>8</manvolnum>
93
      </citerefentry> to abort requesting a password, because
94
      <citerefentry><refentrytitle>splashy</refentrytitle>
95
      <manvolnum>8</manvolnum></citerefentry> does not support this.
96
      Therefore, this program will then <emphasis>kill</emphasis> the
97
      running <citerefentry><refentrytitle>splashy</refentrytitle>
98
      <manvolnum>8</manvolnum></citerefentry> process and start a
99
      <emphasis>new</emphasis> one, using <quote><literal
100
      >boot</literal></quote> as the only argument.
101
    </para>
102
  </refsect1>
103
  
104
  <refsect1 id="options">
105
    <title>OPTIONS</title>
106
    <para>
107
      This program takes no options.
108
    </para>
109
  </refsect1>
110
  
111
  <refsect1 id="exit_status">
112
    <title>EXIT STATUS</title>
113
    <para>
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
118
      be ignored.
119
    </para>
120
  </refsect1>
121
  
122
  <refsect1 id="environment">
123
    <title>ENVIRONMENT</title>
124
    <variablelist>
125
      <varlistentry>
126
	<term><envar>cryptsource</envar></term>
127
	<term><envar>crypttarget</envar></term>
128
	<listitem>
129
	  <para>
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
133
	    the prompt.
134
	</para>
135
	<para>
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
146
	  <filename
147
	  >/usr/share/initramfs-tools/hooks/cryptroot</filename>, by
148
	  extracting the information of the root file system from
149
	  <filename >/etc/crypttab</filename>.
150
	</para>
151
	<para>
152
	  This behavior is meant to exactly mirror the behavior of
153
	  <command>askpass</command>, the default password prompter.
154
	</para>
155
	</listitem>
156
      </varlistentry>
157
    </variablelist>
158
  </refsect1>
159
  
160
  <refsect1 id="files">
161
    <title>FILES</title>
162
    <variablelist>
163
      <varlistentry>
164
	<term><filename>/sbin/splashy_update</filename></term>
165
	<listitem>
166
	  <para>
167
	    This is the command run to retrieve a password from
168
	    <citerefentry><refentrytitle>splashy</refentrytitle>
169
	    <manvolnum>8</manvolnum></citerefentry>.  See
170
	    <citerefentry><refentrytitle
171
	    >splashy_update</refentrytitle><manvolnum>8</manvolnum>
172
	    </citerefentry>.
173
	  </para>
174
	</listitem>
175
      </varlistentry>
176
      <varlistentry>
177
	<term><filename>/proc</filename></term>
178
	<listitem>
179
	  <para>
180
	    To find the running <citerefentry><refentrytitle
181
	    >splashy</refentrytitle><manvolnum>8</manvolnum>
182
	    </citerefentry>, this directory will be searched for
183
	    numeric entries which will be assumed to be directories.
184
	    In all those directories, the <filename>exe</filename>
185
	    entry will be used to determine the name of the running
186
	    binary and the effective user and group
187
	    <abbrev>ID</abbrev> of the process.  See <citerefentry>
188
	    <refentrytitle>proc</refentrytitle><manvolnum
189
	    >5</manvolnum></citerefentry>.
190
	  </para>
191
	</listitem>
192
      </varlistentry>
193
      <varlistentry>
194
	<term><filename>/sbin/splashy</filename></term>
195
	<listitem>
196
	  <para>
197
	    This is the name of the binary which will be searched for
198
	    in the process list.  See <citerefentry><refentrytitle
199
	    >splashy</refentrytitle><manvolnum>8</manvolnum>
200
	  </citerefentry>.
201
	  </para>
202
	</listitem>
203
      </varlistentry>
204
    </variablelist>
205
  </refsect1>
206
  
207
  <refsect1 id="bugs">
208
    <title>BUGS</title>
209
    <para>
210
      Killing <citerefentry><refentrytitle>splashy</refentrytitle>
211
      <manvolnum>8</manvolnum></citerefentry> and starting a new one
212
      is ugly, but necessary as long as it does not support aborting a
213
      password request.
214
    </para>
237.7.369 by Teddy Hogeborn
Add bug reporting information to manual pages
215
    <xi:include href="../bugs.xml"/>
225 by Teddy Hogeborn
* Makefile (DOCS): Added "plugins.d/usplash.8mandos" and
216
  </refsect1>
217
  
218
  <refsect1 id="example">
219
    <title>EXAMPLE</title>
220
    <para>
221
      Note that normally, this program will not be invoked directly,
222
      but instead started by the Mandos <citerefentry><refentrytitle
223
      >plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum>
224
      </citerefentry>.
225
    </para>
226
    <informalexample>
227
      <para>
228
	This program takes no options.
229
      </para>
230
      <para>
231
	<userinput>&COMMANDNAME;</userinput>
232
      </para>
233
    </informalexample>
234
  </refsect1>
235
  
236
  <refsect1 id="security">
237
    <title>SECURITY</title>
238
    <para>
239
      If this program is killed by a signal, it will kill the process
240
      <abbrev>ID</abbrev> which at the start of this program was
241
      determined to run <citerefentry><refentrytitle
242
      >splashy</refentrytitle><manvolnum>8</manvolnum></citerefentry>
243
      as root (see also <xref linkend="files"/>).  There is a very
244
      slight risk that, in the time between those events, that process
245
      <abbrev>ID</abbrev> was freed and then taken up by another
246
      process; the wrong process would then be killed.  Now, this
247
      program can only be killed by the user who started it; see
248
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
249
      <manvolnum>8mandos</manvolnum></citerefentry>.  This program
250
      should therefore be started by a completely separate
251
      non-privileged user, and no other programs should be allowed to
252
      run as that special user.  This means that it is not recommended
253
      to use the user "nobody" to start this program, as other
254
      possibly less trusted programs could be running as "nobody", and
255
      they would then be able to kill this program, triggering the
256
      killing of the process <abbrev>ID</abbrev> which may or may not
257
      be <citerefentry><refentrytitle>splashy</refentrytitle>
258
      <manvolnum>8</manvolnum></citerefentry>.
259
    </para>
260
    <para>
261
      The only other thing that could be considered worthy of note is
262
      this:  This program is meant to be run by <citerefentry>
263
      <refentrytitle>plugin-runner</refentrytitle><manvolnum
264
      >8mandos</manvolnum></citerefentry>, and will, when run
265
      standalone, outside, in a normal environment, immediately output
266
      on its standard output any presumably secret password it just
267
      received.  Therefore, when running this program standalone
268
      (which should never normally be done), take care not to type in
269
      any real secret password by force of habit, since it would then
270
      immediately be shown as output.
271
    </para>
272
  </refsect1>
273
  
274
  <refsect1 id="see_also">
275
    <title>SEE ALSO</title>
276
    <para>
237.7.41 by Teddy Hogeborn
* Makefile (DOCS): Added "intro.8mandos".
277
      <citerefentry><refentrytitle>intro</refentrytitle>
278
      <manvolnum>8mandos</manvolnum></citerefentry>,
225 by Teddy Hogeborn
* Makefile (DOCS): Added "plugins.d/usplash.8mandos" and
279
      <citerefentry><refentrytitle>crypttab</refentrytitle>
280
      <manvolnum>5</manvolnum></citerefentry>,
281
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
282
      <manvolnum>8mandos</manvolnum></citerefentry>,
283
      <citerefentry><refentrytitle>proc</refentrytitle>
284
      <manvolnum>5</manvolnum></citerefentry>,
285
      <citerefentry><refentrytitle>splashy</refentrytitle>
286
      <manvolnum>8</manvolnum></citerefentry>,
287
      <citerefentry><refentrytitle>splashy_update</refentrytitle>
288
      <manvolnum>8</manvolnum></citerefentry>
289
    </para>
290
  </refsect1>
291
</refentry>
292
<!-- Local Variables: -->
293
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
294
<!-- time-stamp-end: "[\"']>" -->
295
<!-- time-stamp-format: "%:y-%02m-%02d" -->
296
<!-- End: -->