/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/splashy.xml

  • Committer: Teddy Hogeborn
  • Date: 2017-08-20 16:20:54 UTC
  • Revision ID: teddy@recompile.se-20170820162054-jwig602syxx2k4l0
Alter copyright notices slightly.  Actual license is unchanged!

This alters all copyright notices to use the Free Software
Foundation's recommendations for license notices; from
<https://www.gnu.org/licenses/gpl-howto.html>:

  For programs that are more than one file, it is better to replace
  “this program” with the name of the program, and begin the statement
  with a line saying “This file is part of NAME”.

* DBUS-API: Use program name "Mandos" explicitly in license notice.
* debian/copyright: - '' -
* initramfs-unpack: - '' -
* legalnotice.xml: - '' -
* mandos: - '' -
* mandos-ctl: - '' -
* mandos-keygen: - '' -
* mandos-monitor: - '' -
* plugin-helpers/mandos-client-iprouteadddel.c: - '' -
* plugin-runner.c: - '' -
* plugins.d/askpass-fifo.c: - '' -
* plugins.d/mandos-client.c: - '' -
* plugins.d/password-prompt.c: - '' -
* plugins.d/plymouth.c: - '' -
* plugins.d/splashy.c: - '' -
* plugins.d/usplash.c: - '' -

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