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