/mandos/release

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

« back to all changes in this revision

Viewing changes to plugins.d/splashy.xml

  • Committer: Teddy Hogeborn
  • Date: 2008-09-07 01:44:44 UTC
  • mfrom: (24.1.93 mandos)
  • Revision ID: teddy@fukt.bsnet.se-20080907014444-cf4ilzndc0tbn8va
Merge & resolve.

Show diffs side-by-side

added added

removed removed

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