/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: 2019-08-04 12:42:49 UTC
  • Revision ID: teddy@recompile.se-20190804124249-69cq19d1bgbmm0gh
Describe role of password-agent(8mandos) in intro(8mandos)

Describe the role of password-agent(8mandos) in the intro(8mandos)
manual.

* intro.xml (SYSTEMD): New section.
  (SEE ALSO): Add reference to password-agent(8mandos).

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 "2016-02-28">
 
5
<!ENTITY TIMESTAMP "2019-07-27">
6
6
<!ENTITY % common SYSTEM "../common.ent">
7
7
%common;
8
8
]>
40
40
      <year>2014</year>
41
41
      <year>2015</year>
42
42
      <year>2016</year>
 
43
      <year>2017</year>
 
44
      <year>2018</year>
 
45
      <year>2019</year>
43
46
      <holder>Teddy Hogeborn</holder>
44
47
      <holder>Björn Påhlsson</holder>
45
48
    </copyright>
66
69
        >PREFIX</replaceable></arg>
67
70
      </group>
68
71
      <sbr/>
 
72
      <arg choice="opt">
 
73
        <option>--prompt <replaceable>PROMPT</replaceable></option>
 
74
      </arg>
69
75
      <arg choice="opt"><option>--debug</option></arg>
70
76
    </cmdsynopsis>
71
77
    <cmdsynopsis>
107
113
      wrapper, although actual use of that function is not guaranteed
108
114
      or implied.
109
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>
110
125
  </refsect1>
111
126
  
112
127
  <refsect1 id="options">
135
150
      </varlistentry>
136
151
      
137
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>
138
165
        <term><option>--debug</option></term>
139
166
        <listitem>
140
167
          <para>
194
221
        <term><envar>CRYPTTAB_NAME</envar></term>
195
222
        <listitem>
196
223
          <para>
197
 
            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
198
226
            contain the source device name and the target device
199
227
            mapper name, respectively, and will be shown as part of
200
228
            the prompt.
202
230
        <para>
203
231
          These variables will normally be inherited from
204
232
          <citerefentry><refentrytitle>plugin-runner</refentrytitle>
205
 
          <manvolnum>8mandos</manvolnum></citerefentry>, which will
206
 
          normally have inherited them from
207
 
          <filename>/scripts/local-top/cryptroot</filename> in the
208
 
          initial <acronym>RAM</acronym> disk environment, which will
209
 
          have set them from parsing kernel arguments and
210
 
          <filename>/conf/conf.d/cryptroot</filename> (also in the
211
 
          initial RAM disk environment), which in turn will have been
212
 
          created when the initial RAM disk image was created by
213
 
          <filename
214
 
          >/usr/share/initramfs-tools/hooks/cryptroot</filename>, by
215
 
          extracting the information of the root file system from
216
 
          <filename >/etc/crypttab</filename>.
 
233
          <manvolnum>8mandos</manvolnum></citerefentry>, which might
 
234
          have in turn inherited them from its calling process.
217
235
        </para>
218
236
        <para>
219
237
          This behavior is meant to exactly mirror the behavior of
220
 
          <command>askpass</command>, the default password prompter.
 
238
          <command>askpass</command>, the default password prompter
 
239
          from initramfs-tools.
221
240
        </para>
222
241
        </listitem>
223
242
      </varlistentry>
226
245
  
227
246
  <refsect1 id="bugs">
228
247
    <title>BUGS</title>
229
 
    <para>
230
 
      None are known at this time.
231
 
    </para>
 
248
    <xi:include href="../bugs.xml"/>
232
249
  </refsect1>
233
250
  
234
251
  <refsect1 id="example">
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>