/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.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 splashy 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>splashy_update</refentrytitle>
64
      <manvolnum>8</manvolnum></citerefentry> and outputs any given
65
      password to standard output.  If no <citerefentry><refentrytitle
66
      >splashy</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>splashy</refentrytitle><manvolnum>8</manvolnum>
83
      </citerefentry> to abort requesting a password, because
84
      <citerefentry><refentrytitle>splashy</refentrytitle>
85
      <manvolnum>8</manvolnum></citerefentry> does not support this.
86
      Therefore, this program will then <emphasis>kill</emphasis> the
87
      running <citerefentry><refentrytitle>splashy</refentrytitle>
88
      <manvolnum>8</manvolnum></citerefentry> process and start a
89
      <emphasis>new</emphasis> one, using <quote><literal
90
      >boot</literal></quote> as the only argument.
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>/sbin/splashy_update</filename></term>
155
	<listitem>
156
	  <para>
157
	    This is the command run to retrieve a password from
158
	    <citerefentry><refentrytitle>splashy</refentrytitle>
159
	    <manvolnum>8</manvolnum></citerefentry>.  See
160
	    <citerefentry><refentrytitle
161
	    >splashy_update</refentrytitle><manvolnum>8</manvolnum>
162
	    </citerefentry>.
163
	  </para>
164
	</listitem>
165
      </varlistentry>
166
      <varlistentry>
167
	<term><filename>/proc</filename></term>
168
	<listitem>
169
	  <para>
170
	    To find the running <citerefentry><refentrytitle
171
	    >splashy</refentrytitle><manvolnum>8</manvolnum>
172
	    </citerefentry>, this directory will be searched for
173
	    numeric entries which will be assumed to be directories.
174
	    In all those directories, the <filename>exe</filename>
175
	    entry will be used to determine the name of the running
176
	    binary and the effective user and group
177
	    <abbrev>ID</abbrev> of the process.  See <citerefentry>
178
	    <refentrytitle>proc</refentrytitle><manvolnum
179
	    >5</manvolnum></citerefentry>.
180
	  </para>
181
	</listitem>
182
      </varlistentry>
183
      <varlistentry>
184
	<term><filename>/sbin/splashy</filename></term>
185
	<listitem>
186
	  <para>
187
	    This is the name of the binary which will be searched for
188
	    in the process list.  See <citerefentry><refentrytitle
189
	    >splashy</refentrytitle><manvolnum>8</manvolnum>
190
	  </citerefentry>.
191
	  </para>
192
	</listitem>
193
      </varlistentry>
194
    </variablelist>
195
  </refsect1>
196
  
197
  <refsect1 id="bugs">
198
    <title>BUGS</title>
199
    <para>
200
      Killing <citerefentry><refentrytitle>splashy</refentrytitle>
201
      <manvolnum>8</manvolnum></citerefentry> and starting a new one
202
      is ugly, but necessary as long as it does not support aborting a
203
      password request.
204
    </para>
205
  </refsect1>
206
  
207
  <refsect1 id="example">
208
    <title>EXAMPLE</title>
209
    <para>
210
      Note that normally, this program will not be invoked directly,
211
      but instead started by the Mandos <citerefentry><refentrytitle
212
      >plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum>
213
      </citerefentry>.
214
    </para>
215
    <informalexample>
216
      <para>
217
	This program takes no options.
218
      </para>
219
      <para>
220
	<userinput>&COMMANDNAME;</userinput>
221
      </para>
222
    </informalexample>
223
  </refsect1>
224
  
225
  <refsect1 id="security">
226
    <title>SECURITY</title>
227
    <para>
228
      If this program is killed by a signal, it will kill the process
229
      <abbrev>ID</abbrev> which at the start of this program was
230
      determined to run <citerefentry><refentrytitle
231
      >splashy</refentrytitle><manvolnum>8</manvolnum></citerefentry>
232
      as root (see also <xref linkend="files"/>).  There is a very
233
      slight risk that, in the time between those events, that process
234
      <abbrev>ID</abbrev> was freed and then taken up by another
235
      process; the wrong process would then be killed.  Now, this
236
      program can only be killed by the user who started it; see
237
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
238
      <manvolnum>8mandos</manvolnum></citerefentry>.  This program
239
      should therefore be started by a completely separate
240
      non-privileged user, and no other programs should be allowed to
241
      run as that special user.  This means that it is not recommended
242
      to use the user "nobody" to start this program, as other
243
      possibly less trusted programs could be running as "nobody", and
244
      they would then be able to kill this program, triggering the
245
      killing of the process <abbrev>ID</abbrev> which may or may not
246
      be <citerefentry><refentrytitle>splashy</refentrytitle>
247
      <manvolnum>8</manvolnum></citerefentry>.
248
    </para>
249
    <para>
250
      The only other thing that could be considered worthy of note is
251
      this:  This program is meant to be run by <citerefentry>
252
      <refentrytitle>plugin-runner</refentrytitle><manvolnum
253
      >8mandos</manvolnum></citerefentry>, and will, when run
254
      standalone, outside, in a normal environment, immediately output
255
      on its standard output any presumably secret password it just
256
      received.  Therefore, when running this program standalone
257
      (which should never normally be done), take care not to type in
258
      any real secret password by force of habit, since it would then
259
      immediately be shown as output.
260
    </para>
261
  </refsect1>
262
  
263
  <refsect1 id="see_also">
264
    <title>SEE ALSO</title>
265
    <para>
266
      <citerefentry><refentrytitle>crypttab</refentrytitle>
267
      <manvolnum>5</manvolnum></citerefentry>,
268
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
269
      <manvolnum>8mandos</manvolnum></citerefentry>,
270
      <citerefentry><refentrytitle>proc</refentrytitle>
271
      <manvolnum>5</manvolnum></citerefentry>,
272
      <citerefentry><refentrytitle>splashy</refentrytitle>
273
      <manvolnum>8</manvolnum></citerefentry>,
274
      <citerefentry><refentrytitle>splashy_update</refentrytitle>
275
      <manvolnum>8</manvolnum></citerefentry>
276
    </para>
277
  </refsect1>
278
</refentry>
279
<!-- Local Variables: -->
280
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
281
<!-- time-stamp-end: "[\"']>" -->
282
<!-- time-stamp-format: "%:y-%02m-%02d" -->
283
<!-- End: -->