/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 "usplash">
237.2.9 by Teddy Hogeborn
* README: Update copyright year; add "2009".
5
<!ENTITY TIMESTAMP "2009-01-04">
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>
22
	  <email>belorn@fukt.bsnet.se</email>
23
	</address>
24
      </author>
25
      <author>
26
	<firstname>Teddy</firstname>
27
	<surname>Hogeborn</surname>
28
	<address>
29
	  <email>teddy@fukt.bsnet.se</email>
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>
225 by Teddy Hogeborn
* Makefile (DOCS): Added "plugins.d/usplash.8mandos" and
36
      <holder>Teddy Hogeborn</holder>
37
      <holder>Björn Påhlsson</holder>
38
    </copyright>
39
    <xi:include href="../legalnotice.xml"/>
40
  </refentryinfo>
41
  
42
  <refmeta>
43
    <refentrytitle>&COMMANDNAME;</refentrytitle>
44
    <manvolnum>8mandos</manvolnum>
45
  </refmeta>
46
  
47
  <refnamediv>
48
    <refname><command>&COMMANDNAME;</command></refname>
49
    <refpurpose>Mandos plugin to use usplash to get a
50
    password.</refpurpose>
51
  </refnamediv>
52
  
53
  <refsynopsisdiv>
54
    <cmdsynopsis>
55
      <command>&COMMANDNAME;</command>
56
    </cmdsynopsis>
57
  </refsynopsisdiv>
58
  
59
  <refsect1 id="description">
60
    <title>DESCRIPTION</title>
61
    <para>
62
      This program prompts for a password using <citerefentry>
63
      <refentrytitle>usplash</refentrytitle><manvolnum>8</manvolnum>
64
      </citerefentry> and outputs any given password to standard
65
      output.  If no <citerefentry><refentrytitle
66
      >usplash</refentrytitle><manvolnum>8</manvolnum></citerefentry>
67
      process can be found, this program will immediately exit with an
68
      exit code indicating failure.
69
    </para>
70
    <para>
71
      This program is not very useful on its own.  This program is
72
      really meant to run as a plugin in the <application
73
      >Mandos</application> client-side system, where it is used as a
74
      fallback and alternative to retrieving passwords from a
75
      <application >Mandos</application> server.
76
    </para>
77
    <para>
78
      If this program is killed (presumably by
79
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
80
      <manvolnum>8mandos</manvolnum></citerefentry> because some other
81
      plugin provided the password), it cannot tell <citerefentry>
82
      <refentrytitle>usplash</refentrytitle><manvolnum>8</manvolnum>
83
      </citerefentry> to abort requesting a password, because
84
      <citerefentry><refentrytitle>usplash</refentrytitle>
85
      <manvolnum>8</manvolnum></citerefentry> does not support this.
86
      Therefore, this program will then <emphasis>kill</emphasis> the
87
      running <citerefentry><refentrytitle>usplash</refentrytitle>
88
      <manvolnum>8</manvolnum></citerefentry> process and start a
89
      <emphasis>new</emphasis> one using the same command line
90
      arguments as the old one was using.
91
    </para>
92
  </refsect1>
93
  
94
  <refsect1 id="options">
95
    <title>OPTIONS</title>
96
    <para>
97
      This program takes no options.
98
    </para>
99
  </refsect1>
100
  
101
  <refsect1 id="exit_status">
102
    <title>EXIT STATUS</title>
103
    <para>
104
      If exit status is 0, the output from the program is the password
105
      as it was read.  Otherwise, if exit status is other than 0, the
106
      program was interrupted or encountered an error, and any output
107
      so far could be corrupt and/or truncated, and should therefore
108
      be ignored.
109
    </para>
110
  </refsect1>
111
  
112
  <refsect1 id="environment">
113
    <title>ENVIRONMENT</title>
114
    <variablelist>
115
      <varlistentry>
116
	<term><envar>cryptsource</envar></term>
117
	<term><envar>crypttarget</envar></term>
118
	<listitem>
119
	  <para>
120
	    If set, these environment variables will be assumed to
121
	    contain the source device name and the target device
122
	    mapper name, respectively, and will be shown as part of
123
	    the prompt.
124
	</para>
125
	<para>
126
	  These variables will normally be inherited from
127
	  <citerefentry><refentrytitle>plugin-runner</refentrytitle>
128
	  <manvolnum>8mandos</manvolnum></citerefentry>, which will
129
	  normally have inherited them from
130
	  <filename>/scripts/local-top/cryptroot</filename> in the
131
	  initial <acronym>RAM</acronym> disk environment, which will
132
	  have set them from parsing kernel arguments and
133
	  <filename>/conf/conf.d/cryptroot</filename> (also in the
134
	  initial RAM disk environment), which in turn will have been
135
	  created when the initial RAM disk image was created by
136
	  <filename
137
	  >/usr/share/initramfs-tools/hooks/cryptroot</filename>, by
138
	  extracting the information of the root file system from
139
	  <filename >/etc/crypttab</filename>.
140
	</para>
141
	<para>
142
	  This behavior is meant to exactly mirror the behavior of
143
	  <command>askpass</command>, the default password prompter.
144
	</para>
145
	</listitem>
146
      </varlistentry>
147
    </variablelist>
148
  </refsect1>
149
  
150
  <refsect1 id="files">
151
    <title>FILES</title>
152
    <variablelist>
153
      <varlistentry>
154
	<term><filename>/dev/.initramfs/usplash_fifo</filename></term>
155
	<listitem>
156
	  <para>
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>
162
	    </citerefentry>.
163
	  </para>
164
	</listitem>
165
      </varlistentry>
166
      <varlistentry>
167
	<term><filename>/dev/.initramfs/usplash_outfifo</filename></term>
168
	<listitem>
169
	  <para>
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>
175
	    </citerefentry>.
176
	  </para>
177
	</listitem>
178
      </varlistentry>
179
      <varlistentry>
180
	<term><filename>/proc</filename></term>
181
	<listitem>
182
	  <para>
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>
193
	    </citerefentry>.
194
	  </para>
195
	</listitem>
196
      </varlistentry>
197
      <varlistentry>
198
	<term><filename>/sbin/usplash</filename></term>
199
	<listitem>
200
	  <para>
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>
204
	    </citerefentry>.
205
	  </para>
206
	</listitem>
207
      </varlistentry>
208
    </variablelist>
209
  </refsect1>
210
  
211
  <refsect1 id="bugs">
212
    <title>BUGS</title>
213
    <para>
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
217
      password request.
218
    </para>
219
  </refsect1>
220
  
221
  <refsect1 id="example">
222
    <title>EXAMPLE</title>
223
    <para>
224
      Note that normally, this program will not be invoked directly,
225
      but instead started by the Mandos <citerefentry><refentrytitle
226
      >plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum>
227
      </citerefentry>.
228
    </para>
229
    <informalexample>
230
      <para>
231
	This program takes no options.
232
      </para>
233
      <para>
234
	<userinput>&COMMANDNAME;</userinput>
235
      </para>
236
    </informalexample>
237
  </refsect1>
238
  
239
  <refsect1 id="security">
240
    <title>SECURITY</title>
241
    <para>
242
      If this program is killed by a signal, it will kill the process
243
      <abbrev>ID</abbrev> which at the start of this program was
244
      determined to run <citerefentry><refentrytitle
245
      >usplash</refentrytitle><manvolnum>8</manvolnum></citerefentry>
246
      as root (see also <xref linkend="files"/>).  There is a very
247
      slight risk that, in the time between those events, that process
248
      <abbrev>ID</abbrev> was freed and then taken up by another
249
      process; the wrong process would then be killed.  Now, this
250
      program can only be killed by the user who started it; see
251
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
252
      <manvolnum>8mandos</manvolnum></citerefentry>.  This program
253
      should therefore be started by a completely separate
254
      non-privileged user, and no other programs should be allowed to
255
      run as that special user.  This means that it is not recommended
256
      to use the user "nobody" to start this program, as other
257
      possibly less trusted programs could be running as "nobody", and
258
      they would then be able to kill this program, triggering the
259
      killing of the process <abbrev>ID</abbrev> which may or may not
260
      be <citerefentry><refentrytitle>usplash</refentrytitle>
261
      <manvolnum>8</manvolnum></citerefentry>.
262
    </para>
263
    <para>
264
      The only other thing that could be considered worthy of note is
265
      this:  This program is meant to be run by <citerefentry>
266
      <refentrytitle>plugin-runner</refentrytitle><manvolnum
267
      >8mandos</manvolnum></citerefentry>, and will, when run
268
      standalone, outside, in a normal environment, immediately output
269
      on its standard output any presumably secret password it just
270
      received.  Therefore, when running this program standalone
271
      (which should never normally be done), take care not to type in
272
      any real secret password by force of habit, since it would then
273
      immediately be shown as output.
274
    </para>
275
  </refsect1>
276
  
277
  <refsect1 id="see_also">
278
    <title>SEE ALSO</title>
279
    <para>
280
      <citerefentry><refentrytitle>crypttab</refentrytitle>
281
      <manvolnum>5</manvolnum></citerefentry>,
282
      <citerefentry><refentrytitle>fifo</refentrytitle>
283
      <manvolnum>7</manvolnum></citerefentry>,
284
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
285
      <manvolnum>8mandos</manvolnum></citerefentry>,
286
      <citerefentry><refentrytitle>proc</refentrytitle>
287
      <manvolnum>5</manvolnum></citerefentry>,
288
      <citerefentry><refentrytitle>usplash</refentrytitle>
289
      <manvolnum>8</manvolnum></citerefentry>
290
    </para>
291
  </refsect1>
292
</refentry>
293
<!-- Local Variables: -->
294
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
295
<!-- time-stamp-end: "[\"']>" -->
296
<!-- time-stamp-format: "%:y-%02m-%02d" -->
297
<!-- End: -->