/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: 2015-08-10 07:34:37 UTC
  • Revision ID: teddy@recompile.se-20150810073437-3m8jgt13nqric6vf
Revert change to D-Bus API.

The D-Bus API signal CheckerCompleted is documented to provide a
wait(2) status value.  Since the server switched to using subprocess
to run checkers, it no longer has access to a wait(2) status value.  A
previous change to work around this made the D-Bus API incompatible.
Revert this change by constructing a fake wait(2) status value; this
keeps the D-Bus API stable.

* DBUS-API (CheckerCompleted): Revert incompatible change.
* mandos (ClientDBus.checker_callback): Construct fake wait(2) status.
* mandos-monitor (MandosClientWidget.checker_completed): Revert to
                                                         using
                                                         original API
                                                         with wait(2)
                                                         condition
                                                         value.

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