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

  • Committer: Teddy Hogeborn
  • Date: 2009-01-06 22:43:19 UTC
  • Revision ID: teddy@fukt.bsnet.se-20090106224319-zpussai0zoy77ho3
Merge release from release branch.

Show diffs side-by-side

added added

removed removed

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