/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: 2008-08-17 06:01:58 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080817060158-o5xakkih6t3br9yq
* Makefile (GNUTLS_CFLAGS, GNUTLS_LIBS, AVAHI_CFLAGS, AVAHI_LIBS,
            GPGME_CFLAGS, GPGME_LIBS): New; use libgnutls-config,
                                       pkg-config, and gpgme-config to
                                       get the correct compiler and
                                       linker flags.
  (MANPOST): New post-processing stage to man pages to fix a bug with
             having "\n" in the DocBook pages.
  (objects): Use $(addsuffix) instead of a for loop in a subshell.
  (plugin-runner, plugins.d/password-prompt): Removed; targets no
                                              longer necessary.
  (.PHONY): Added "doc".

* mandos.xml: Much improved.

* plugins.d/password-request.xml: Improved SEE ALSO section.

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 "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>2010</year>
35
 
      <year>2011</year>
36
 
      <year>2012</year>
37
 
      <year>2013</year>
38
 
      <year>2014</year>
39
 
      <year>2015</year>
40
 
      <year>2016</year>
41
 
      <year>2017</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 plymouth 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>plymouth</refentrytitle><manvolnum>8</manvolnum>
70
 
      </citerefentry> and outputs any given password to standard
71
 
      output.  If no <citerefentry><refentrytitle
72
 
      >plymouth</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>plymouth</refentrytitle><manvolnum>8</manvolnum>
89
 
      </citerefentry> to abort requesting a password, because
90
 
      <citerefentry><refentrytitle>plymouth</refentrytitle>
91
 
      <manvolnum>8</manvolnum></citerefentry> does not support this.
92
 
      Therefore, this program will then <emphasis>kill</emphasis> the
93
 
      running <citerefentry><refentrytitle>plymouth</refentrytitle>
94
 
      <manvolnum>8</manvolnum></citerefentry> process and start a
95
 
      <emphasis>new</emphasis> one using the same command line
96
 
      arguments as the old one was using.
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>/bin/plymouth</filename></term>
161
 
        <listitem>
162
 
          <para>
163
 
            This is the command run to retrieve a password from
164
 
            <citerefentry><refentrytitle>plymouth</refentrytitle>
165
 
            <manvolnum>8</manvolnum></citerefentry>.
166
 
          </para>
167
 
        </listitem>
168
 
      </varlistentry>
169
 
      <varlistentry>
170
 
        <term><filename class="directory">/proc</filename></term>
171
 
        <listitem>
172
 
          <para>
173
 
            To find the running <citerefentry><refentrytitle
174
 
            >plymouth</refentrytitle><manvolnum>8</manvolnum>
175
 
            </citerefentry>, this directory will be searched for
176
 
            numeric entries which will be assumed to be directories.
177
 
            In all those directories, the <filename>exe</filename> and
178
 
            <filename>cmdline</filename> entries will be used to
179
 
            determine the name of the running binary, effective user
180
 
            and group <abbrev>ID</abbrev>, and the command line
181
 
            arguments.  See <citerefentry><refentrytitle
182
 
            >proc</refentrytitle><manvolnum>5</manvolnum>
183
 
            </citerefentry>.
184
 
          </para>
185
 
        </listitem>
186
 
      </varlistentry>
187
 
      <varlistentry>
188
 
        <term><filename>/sbin/plymouthd</filename></term>
189
 
        <listitem>
190
 
          <para>
191
 
            This is the name of the binary which will be searched for
192
 
            in the process list.  See <citerefentry><refentrytitle
193
 
            >plymouth</refentrytitle><manvolnum>8</manvolnum>
194
 
            </citerefentry>.
195
 
          </para>
196
 
        </listitem>
197
 
      </varlistentry>
198
 
    </variablelist>
199
 
  </refsect1>
200
 
  
201
 
  <refsect1 id="bugs">
202
 
    <title>BUGS</title>
203
 
    <para>
204
 
      Killing the <citerefentry><refentrytitle
205
 
      >plymouth</refentrytitle><manvolnum>8</manvolnum></citerefentry>
206
 
      daemon and starting a new one is ugly, but necessary as long as
207
 
      it does not support aborting a password request.
208
 
    </para>
209
 
    <xi:include href="../bugs.xml"/>
210
 
  </refsect1>
211
 
  
212
 
  <refsect1 id="example">
213
 
    <title>EXAMPLE</title>
214
 
    <para>
215
 
      Note that normally, this program will not be invoked directly,
216
 
      but instead started by the Mandos <citerefentry><refentrytitle
217
 
      >plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum>
218
 
      </citerefentry>.
219
 
    </para>
220
 
    <informalexample>
221
 
      <para>
222
 
        This program takes no options.
223
 
      </para>
224
 
      <para>
225
 
        <userinput>&COMMANDNAME;</userinput>
226
 
      </para>
227
 
    </informalexample>
228
 
  </refsect1>
229
 
  
230
 
  <refsect1 id="security">
231
 
    <title>SECURITY</title>
232
 
    <para>
233
 
      If this program is killed by a signal, it will kill the process
234
 
      <abbrev>ID</abbrev> which at the start of this program was
235
 
      determined to run <citerefentry><refentrytitle
236
 
      >plymouth</refentrytitle><manvolnum>8</manvolnum></citerefentry>
237
 
      as root (see also <xref linkend="files"/>).  There is a very
238
 
      slight risk that, in the time between those events, that process
239
 
      <abbrev>ID</abbrev> was freed and then taken up by another
240
 
      process; the wrong process would then be killed.  Now, this
241
 
      program can only be killed by the user who started it; see
242
 
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
243
 
      <manvolnum>8mandos</manvolnum></citerefentry>.  This program
244
 
      should therefore be started by a completely separate
245
 
      non-privileged user, and no other programs should be allowed to
246
 
      run as that special user.  This means that it is not recommended
247
 
      to use the user "nobody" to start this program, as other
248
 
      possibly less trusted programs could be running as "nobody", and
249
 
      they would then be able to kill this program, triggering the
250
 
      killing of the process <abbrev>ID</abbrev> which may or may not
251
 
      be <citerefentry><refentrytitle>plymouth</refentrytitle>
252
 
      <manvolnum>8</manvolnum></citerefentry>.
253
 
    </para>
254
 
    <para>
255
 
      The only other thing that could be considered worthy of note is
256
 
      this:  This program is meant to be run by <citerefentry>
257
 
      <refentrytitle>plugin-runner</refentrytitle><manvolnum
258
 
      >8mandos</manvolnum></citerefentry>, and will, when run
259
 
      standalone, outside, in a normal environment, immediately output
260
 
      on its standard output any presumably secret password it just
261
 
      received.  Therefore, when running this program standalone
262
 
      (which should never normally be done), take care not to type in
263
 
      any real secret password by force of habit, since it would then
264
 
      immediately be shown as output.
265
 
    </para>
266
 
  </refsect1>
267
 
  
268
 
  <refsect1 id="see_also">
269
 
    <title>SEE ALSO</title>
270
 
    <para>
271
 
      <citerefentry><refentrytitle>intro</refentrytitle>
272
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
273
 
      <citerefentry><refentrytitle>crypttab</refentrytitle>
274
 
      <manvolnum>5</manvolnum></citerefentry>,
275
 
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
276
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
277
 
      <citerefentry><refentrytitle>proc</refentrytitle>
278
 
      <manvolnum>5</manvolnum></citerefentry>,
279
 
      <citerefentry><refentrytitle>plymouth</refentrytitle>
280
 
      <manvolnum>8</manvolnum></citerefentry>
281
 
    </para>
282
 
  </refsect1>
283
 
</refentry>
284
 
<!-- Local Variables: -->
285
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
286
 
<!-- time-stamp-end: "[\"']>" -->
287
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
288
 
<!-- End: -->