/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/password-prompt.xml

  • Committer: teddy at recompile
  • Date: 2020-04-08 19:15:13 UTC
  • mfrom: (237.4.130 release)
  • Revision ID: teddy@recompile.se-20200408191513-n0ke303478rw1g0b
Merge from release branch

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugins.d/password-prompt.xml
2
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
3
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
4
<!ENTITY COMMANDNAME "password-prompt">
5
 
<!ENTITY TIMESTAMP "2008-10-04">
 
5
<!ENTITY TIMESTAMP "2019-07-27">
6
6
<!ENTITY % common SYSTEM "../common.ent">
7
7
%common;
8
8
]>
19
19
        <firstname>Björn</firstname>
20
20
        <surname>Påhlsson</surname>
21
21
        <address>
22
 
          <email>belorn@fukt.bsnet.se</email>
 
22
          <email>belorn@recompile.se</email>
23
23
        </address>
24
24
      </author>
25
25
      <author>
26
26
        <firstname>Teddy</firstname>
27
27
        <surname>Hogeborn</surname>
28
28
        <address>
29
 
          <email>teddy@fukt.bsnet.se</email>
 
29
          <email>teddy@recompile.se</email>
30
30
        </address>
31
31
      </author>
32
32
    </authorgroup>
33
33
    <copyright>
34
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
      <year>2018</year>
 
45
      <year>2019</year>
35
46
      <holder>Teddy Hogeborn</holder>
36
47
      <holder>Björn Påhlsson</holder>
37
48
    </copyright>
58
69
        >PREFIX</replaceable></arg>
59
70
      </group>
60
71
      <sbr/>
 
72
      <arg choice="opt">
 
73
        <option>--prompt <replaceable>PROMPT</replaceable></option>
 
74
      </arg>
61
75
      <arg choice="opt"><option>--debug</option></arg>
62
76
    </cmdsynopsis>
63
77
    <cmdsynopsis>
99
113
      wrapper, although actual use of that function is not guaranteed
100
114
      or implied.
101
115
    </para>
 
116
    <para>
 
117
      This program tries to detect if a Plymouth daemon
 
118
      (<citerefentry><refentrytitle
 
119
      >plymouthd</refentrytitle><manvolnum>8</manvolnum></citerefentry>)
 
120
      is running, by looking for a
 
121
      <filename>/run/plymouth/pid</filename> file or a process named
 
122
      <quote><literal>plymouthd</literal></quote>.  If it is detected,
 
123
      this process will immediately exit without doing anything.
 
124
    </para>
102
125
  </refsect1>
103
126
  
104
127
  <refsect1 id="options">
127
150
      </varlistentry>
128
151
      
129
152
      <varlistentry>
 
153
        <term><option>--prompt=<replaceable
 
154
        >PROMPT</replaceable></option></term>
 
155
        <listitem>
 
156
          <para>
 
157
            The password prompt.  Using this option will make this
 
158
            program ignore the <envar>CRYPTTAB_SOURCE</envar> and
 
159
            <envar>CRYPTTAB_NAME</envar> environment variables.
 
160
          </para>
 
161
        </listitem>
 
162
      </varlistentry>
 
163
      
 
164
      <varlistentry>
130
165
        <term><option>--debug</option></term>
131
166
        <listitem>
132
167
          <para>
182
217
    <title>ENVIRONMENT</title>
183
218
    <variablelist>
184
219
      <varlistentry>
185
 
        <term><envar>cryptsource</envar></term>
186
 
        <term><envar>crypttarget</envar></term>
 
220
        <term><envar>CRYPTTAB_SOURCE</envar></term>
 
221
        <term><envar>CRYPTTAB_NAME</envar></term>
187
222
        <listitem>
188
223
          <para>
189
 
            If set, these environment variables will be assumed to
 
224
            If set, and if the <option>--prompt</option> option is not
 
225
            used, these environment variables will be assumed to
190
226
            contain the source device name and the target device
191
227
            mapper name, respectively, and will be shown as part of
192
228
            the prompt.
194
230
        <para>
195
231
          These variables will normally be inherited from
196
232
          <citerefentry><refentrytitle>plugin-runner</refentrytitle>
197
 
          <manvolnum>8mandos</manvolnum></citerefentry>, which will
198
 
          normally have inherited them from
199
 
          <filename>/scripts/local-top/cryptroot</filename> in the
200
 
          initial <acronym>RAM</acronym> disk environment, which will
201
 
          have set them from parsing kernel arguments and
202
 
          <filename>/conf/conf.d/cryptroot</filename> (also in the
203
 
          initial RAM disk environment), which in turn will have been
204
 
          created when the initial RAM disk image was created by
205
 
          <filename
206
 
          >/usr/share/initramfs-tools/hooks/cryptroot</filename>, by
207
 
          extracting the information of the root file system from
208
 
          <filename >/etc/crypttab</filename>.
 
233
          <manvolnum>8mandos</manvolnum></citerefentry>, which might
 
234
          have in turn inherited them from its calling process.
209
235
        </para>
210
236
        <para>
211
237
          This behavior is meant to exactly mirror the behavior of
212
 
          <command>askpass</command>, the default password prompter.
 
238
          <command>askpass</command>, the default password prompter
 
239
          from initramfs-tools.
213
240
        </para>
214
241
        </listitem>
215
242
      </varlistentry>
218
245
  
219
246
  <refsect1 id="bugs">
220
247
    <title>BUGS</title>
221
 
    <para>
222
 
      None are known at this time.
223
 
    </para>
 
248
    <xi:include href="../bugs.xml"/>
224
249
  </refsect1>
225
250
  
226
251
  <refsect1 id="example">
291
316
  <refsect1 id="see_also">
292
317
    <title>SEE ALSO</title>
293
318
    <para>
294
 
      <citerefentry><refentrytitle>crypttab</refentrytitle>
295
 
      <manvolnum>5</manvolnum></citerefentry>
 
319
      <citerefentry><refentrytitle>intro</refentrytitle>
 
320
      <manvolnum>8mandos</manvolnum></citerefentry>,
296
321
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
297
 
      <manvolnum>8mandos</manvolnum></citerefentry>
 
322
      <manvolnum>8mandos</manvolnum></citerefentry>,
298
323
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
299
324
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
325
      <citerefentry><refentrytitle>plymouthd</refentrytitle>
 
326
      <manvolnum>8</manvolnum></citerefentry>
300
327
    </para>
301
328
  </refsect1>
302
329
</refentry>