/mandos/trunk

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/trunk

« back to all changes in this revision

Viewing changes to plugins.d/usplash.xml

  • Committer: Teddy Hogeborn
  • Date: 2008-09-03 05:08:24 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080903050824-x38ghzu01vkfrpb4
* plugins.d/password-request.xml (OVERVIEW): Improved wording.
  (EXIT STATUS): Fixed typos.

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugins.d/usplash.xml
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">
5
 
<!ENTITY TIMESTAMP "2019-02-10">
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@recompile.se</email>
23
 
        </address>
24
 
      </author>
25
 
      <author>
26
 
        <firstname>Teddy</firstname>
27
 
        <surname>Hogeborn</surname>
28
 
        <address>
29
 
          <email>teddy@recompile.se</email>
30
 
        </address>
31
 
      </author>
32
 
    </authorgroup>
33
 
    <copyright>
34
 
      <year>2008</year>
35
 
      <year>2009</year>
36
 
      <year>2010</year>
37
 
      <year>2011</year>
38
 
      <year>2012</year>
39
 
      <year>2013</year>
40
 
      <year>2014</year>
41
 
      <year>2015</year>
42
 
      <year>2016</year>
43
 
      <year>2017</year>
44
 
      <year>2018</year>
45
 
      <year>2019</year>
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 usplash 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>usplash</refentrytitle><manvolnum>8</manvolnum>
74
 
      </citerefentry> and outputs any given password to standard
75
 
      output.  If no <citerefentry><refentrytitle
76
 
      >usplash</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>usplash</refentrytitle><manvolnum>8</manvolnum>
93
 
      </citerefentry> to abort requesting a password, because
94
 
      <citerefentry><refentrytitle>usplash</refentrytitle>
95
 
      <manvolnum>8</manvolnum></citerefentry> does not support this.
96
 
      Therefore, this program will then <emphasis>kill</emphasis> the
97
 
      running <citerefentry><refentrytitle>usplash</refentrytitle>
98
 
      <manvolnum>8</manvolnum></citerefentry> process and start a
99
 
      <emphasis>new</emphasis> one using the same command line
100
 
      arguments as the old one was using.
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 might
139
 
          have in turn inherited them from its calling process.
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 class="directory">/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
 
    <xi:include href="../bugs.xml"/>
220
 
  </refsect1>
221
 
  
222
 
  <refsect1 id="example">
223
 
    <title>EXAMPLE</title>
224
 
    <para>
225
 
      Note that normally, this program will not be invoked directly,
226
 
      but instead started by the Mandos <citerefentry><refentrytitle
227
 
      >plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum>
228
 
      </citerefentry>.
229
 
    </para>
230
 
    <informalexample>
231
 
      <para>
232
 
        This program takes no options.
233
 
      </para>
234
 
      <para>
235
 
        <userinput>&COMMANDNAME;</userinput>
236
 
      </para>
237
 
    </informalexample>
238
 
  </refsect1>
239
 
  
240
 
  <refsect1 id="security">
241
 
    <title>SECURITY</title>
242
 
    <para>
243
 
      If this program is killed by a signal, it will kill the process
244
 
      <abbrev>ID</abbrev> which at the start of this program was
245
 
      determined to run <citerefentry><refentrytitle
246
 
      >usplash</refentrytitle><manvolnum>8</manvolnum></citerefentry>
247
 
      as root (see also <xref linkend="files"/>).  There is a very
248
 
      slight risk that, in the time between those events, that process
249
 
      <abbrev>ID</abbrev> was freed and then taken up by another
250
 
      process; the wrong process would then be killed.  Now, this
251
 
      program can only be killed by the user who started it; see
252
 
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
253
 
      <manvolnum>8mandos</manvolnum></citerefentry>.  This program
254
 
      should therefore be started by a completely separate
255
 
      non-privileged user, and no other programs should be allowed to
256
 
      run as that special user.  This means that it is not recommended
257
 
      to use the user "nobody" to start this program, as other
258
 
      possibly less trusted programs could be running as "nobody", and
259
 
      they would then be able to kill this program, triggering the
260
 
      killing of the process <abbrev>ID</abbrev> which may or may not
261
 
      be <citerefentry><refentrytitle>usplash</refentrytitle>
262
 
      <manvolnum>8</manvolnum></citerefentry>.
263
 
    </para>
264
 
    <para>
265
 
      The only other thing that could be considered worthy of note is
266
 
      this:  This program is meant to be run by <citerefentry>
267
 
      <refentrytitle>plugin-runner</refentrytitle><manvolnum
268
 
      >8mandos</manvolnum></citerefentry>, and will, when run
269
 
      standalone, outside, in a normal environment, immediately output
270
 
      on its standard output any presumably secret password it just
271
 
      received.  Therefore, when running this program standalone
272
 
      (which should never normally be done), take care not to type in
273
 
      any real secret password by force of habit, since it would then
274
 
      immediately be shown as output.
275
 
    </para>
276
 
  </refsect1>
277
 
  
278
 
  <refsect1 id="see_also">
279
 
    <title>SEE ALSO</title>
280
 
    <para>
281
 
      <citerefentry><refentrytitle>intro</refentrytitle>
282
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
283
 
      <citerefentry><refentrytitle>fifo</refentrytitle>
284
 
      <manvolnum>7</manvolnum></citerefentry>,
285
 
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
286
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
287
 
      <citerefentry><refentrytitle>proc</refentrytitle>
288
 
      <manvolnum>5</manvolnum></citerefentry>,
289
 
      <citerefentry><refentrytitle>usplash</refentrytitle>
290
 
      <manvolnum>8</manvolnum></citerefentry>
291
 
    </para>
292
 
  </refsect1>
293
 
</refentry>
294
 
<!-- Local Variables: -->
295
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
296
 
<!-- time-stamp-end: "[\"']>" -->
297
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
298
 
<!-- End: -->