/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 Hogeborn
  • Date: 2018-02-12 14:54:58 UTC
  • Revision ID: teddy@recompile.se-20180212145458-mkcjkw4cd9s18izm
Client bug fix: Revert change to plugin-runner

* plugin-runner.c (free_plugin): Bug fix: Don't free() plugin name.

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 "2019-07-27">
 
5
<!ENTITY TIMESTAMP "2018-02-08">
6
6
<!ENTITY % common SYSTEM "../common.ent">
7
7
%common;
8
8
]>
42
42
      <year>2016</year>
43
43
      <year>2017</year>
44
44
      <year>2018</year>
45
 
      <year>2019</year>
46
45
      <holder>Teddy Hogeborn</holder>
47
46
      <holder>Björn Påhlsson</holder>
48
47
    </copyright>
69
68
        >PREFIX</replaceable></arg>
70
69
      </group>
71
70
      <sbr/>
72
 
      <arg choice="opt">
73
 
        <option>--prompt <replaceable>PROMPT</replaceable></option>
74
 
      </arg>
75
71
      <arg choice="opt"><option>--debug</option></arg>
76
72
    </cmdsynopsis>
77
73
    <cmdsynopsis>
113
109
      wrapper, although actual use of that function is not guaranteed
114
110
      or implied.
115
111
    </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>
125
112
  </refsect1>
126
113
  
127
114
  <refsect1 id="options">
150
137
      </varlistentry>
151
138
      
152
139
      <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>
165
140
        <term><option>--debug</option></term>
166
141
        <listitem>
167
142
          <para>
221
196
        <term><envar>CRYPTTAB_NAME</envar></term>
222
197
        <listitem>
223
198
          <para>
224
 
            If set, and if the <option>--prompt</option> option is not
225
 
            used, these environment variables will be assumed to
 
199
            If set, these environment variables will be assumed to
226
200
            contain the source device name and the target device
227
201
            mapper name, respectively, and will be shown as part of
228
202
            the prompt.
230
204
        <para>
231
205
          These variables will normally be inherited from
232
206
          <citerefentry><refentrytitle>plugin-runner</refentrytitle>
233
 
          <manvolnum>8mandos</manvolnum></citerefentry>, which might
234
 
          have in turn inherited them from its calling process.
 
207
          <manvolnum>8mandos</manvolnum></citerefentry>, which will
 
208
          normally have inherited them from
 
209
          <filename>/scripts/local-top/cryptroot</filename> in the
 
210
          initial <acronym>RAM</acronym> disk environment, which will
 
211
          have set them from parsing kernel arguments and
 
212
          <filename>/conf/conf.d/cryptroot</filename> (also in the
 
213
          initial RAM disk environment), which in turn will have been
 
214
          created when the initial RAM disk image was created by
 
215
          <filename
 
216
          >/usr/share/initramfs-tools/hooks/cryptroot</filename>, by
 
217
          extracting the information of the root file system from
 
218
          <filename >/etc/crypttab</filename>.
235
219
        </para>
236
220
        <para>
237
221
          This behavior is meant to exactly mirror the behavior of
238
 
          <command>askpass</command>, the default password prompter
239
 
          from initramfs-tools.
 
222
          <command>askpass</command>, the default password prompter.
240
223
        </para>
241
224
        </listitem>
242
225
      </varlistentry>
317
300
    <title>SEE ALSO</title>
318
301
    <para>
319
302
      <citerefentry><refentrytitle>intro</refentrytitle>
320
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
303
      <manvolnum>8mandos</manvolnum></citerefentry>
 
304
      <citerefentry><refentrytitle>crypttab</refentrytitle>
 
305
      <manvolnum>5</manvolnum></citerefentry>
321
306
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
322
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
307
      <manvolnum>8mandos</manvolnum></citerefentry>
323
308
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
324
309
      <manvolnum>8mandos</manvolnum></citerefentry>,
325
 
      <citerefentry><refentrytitle>plymouthd</refentrytitle>
326
 
      <manvolnum>8</manvolnum></citerefentry>
327
310
    </para>
328
311
  </refsect1>
329
312
</refentry>