/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to plugins.d/password-prompt.xml

  • Committer: Teddy Hogeborn
  • Date: 2024-09-12 02:53:43 UTC
  • mto: This revision was merged to the branch mainline in revision 410.
  • Revision ID: teddy@recompile.se-20240912025343-05elzcldczplvk89
Ignore some more files

* .bzrignore: Ignore "cl", which is used to temporarily save the
  commit message.  Ignore the .mypy_cache directories.  Ignore
  *.c.local files which are used by the tools to sort #include
  directives and associated comments.

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 "2018-02-08">
 
5
<!ENTITY TIMESTAMP "2019-07-27">
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>
45
46
      <holder>Teddy Hogeborn</holder>
46
47
      <holder>Björn Påhlsson</holder>
47
48
    </copyright>
68
69
        >PREFIX</replaceable></arg>
69
70
      </group>
70
71
      <sbr/>
 
72
      <arg choice="opt">
 
73
        <option>--prompt <replaceable>PROMPT</replaceable></option>
 
74
      </arg>
71
75
      <arg choice="opt"><option>--debug</option></arg>
72
76
    </cmdsynopsis>
73
77
    <cmdsynopsis>
109
113
      wrapper, although actual use of that function is not guaranteed
110
114
      or implied.
111
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>
112
125
  </refsect1>
113
126
  
114
127
  <refsect1 id="options">
137
150
      </varlistentry>
138
151
      
139
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>
140
165
        <term><option>--debug</option></term>
141
166
        <listitem>
142
167
          <para>
196
221
        <term><envar>CRYPTTAB_NAME</envar></term>
197
222
        <listitem>
198
223
          <para>
199
 
            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
200
226
            contain the source device name and the target device
201
227
            mapper name, respectively, and will be shown as part of
202
228
            the prompt.
204
230
        <para>
205
231
          These variables will normally be inherited from
206
232
          <citerefentry><refentrytitle>plugin-runner</refentrytitle>
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>.
 
233
          <manvolnum>8mandos</manvolnum></citerefentry>, which might
 
234
          have in turn inherited them from its calling process.
219
235
        </para>
220
236
        <para>
221
237
          This behavior is meant to exactly mirror the behavior of
222
 
          <command>askpass</command>, the default password prompter.
 
238
          <command>askpass</command>, the default password prompter
 
239
          from initramfs-tools.
223
240
        </para>
224
241
        </listitem>
225
242
      </varlistentry>
300
317
    <title>SEE ALSO</title>
301
318
    <para>
302
319
      <citerefentry><refentrytitle>intro</refentrytitle>
303
 
      <manvolnum>8mandos</manvolnum></citerefentry>
304
 
      <citerefentry><refentrytitle>crypttab</refentrytitle>
305
 
      <manvolnum>5</manvolnum></citerefentry>
 
320
      <manvolnum>8mandos</manvolnum></citerefentry>,
306
321
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
307
 
      <manvolnum>8mandos</manvolnum></citerefentry>
 
322
      <manvolnum>8mandos</manvolnum></citerefentry>,
308
323
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
309
324
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
325
      <citerefentry><refentrytitle>plymouthd</refentrytitle>
 
326
      <manvolnum>8</manvolnum></citerefentry>
310
327
    </para>
311
328
  </refsect1>
312
329
</refentry>