/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-05 21:00:35 UTC
  • Revision ID: teddy@recompile.se-20190805210035-15cra82gas0yf7ok
Create a debconf translation file

* debian/mandos-client.templates (mandos-client/key_id): Line which
  should not be wrapped should be prefixed by a space.
* debian/mandos.templates (mandos/key_id): - '' -
* debian/po/en_US.po: New "translation" from ASCII to UTF-8.
* debian/po/templates.pot: Updated.

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugins.d/password-prompt.xml
1
1
<?xml version="1.0" encoding="UTF-8"?>
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
 
<!ENTITY VERSION "1.0">
5
4
<!ENTITY COMMANDNAME "password-prompt">
6
 
<!ENTITY TIMESTAMP "2008-09-04">
 
5
<!ENTITY TIMESTAMP "2019-07-27">
 
6
<!ENTITY % common SYSTEM "../common.ent">
 
7
%common;
7
8
]>
8
9
 
9
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
11
12
    <title>Mandos Manual</title>
12
13
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
13
14
    <productname>Mandos</productname>
14
 
    <productnumber>&VERSION;</productnumber>
 
15
    <productnumber>&version;</productnumber>
15
16
    <date>&TIMESTAMP;</date>
16
17
    <authorgroup>
17
18
      <author>
18
19
        <firstname>Björn</firstname>
19
20
        <surname>Påhlsson</surname>
20
21
        <address>
21
 
          <email>belorn@fukt.bsnet.se</email>
 
22
          <email>belorn@recompile.se</email>
22
23
        </address>
23
24
      </author>
24
25
      <author>
25
26
        <firstname>Teddy</firstname>
26
27
        <surname>Hogeborn</surname>
27
28
        <address>
28
 
          <email>teddy@fukt.bsnet.se</email>
 
29
          <email>teddy@recompile.se</email>
29
30
        </address>
30
31
      </author>
31
32
    </authorgroup>
32
33
    <copyright>
33
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>
34
46
      <holder>Teddy Hogeborn</holder>
35
47
      <holder>Björn Påhlsson</holder>
36
48
    </copyright>
57
69
        >PREFIX</replaceable></arg>
58
70
      </group>
59
71
      <sbr/>
 
72
      <arg choice="opt">
 
73
        <option>--prompt <replaceable>PROMPT</replaceable></option>
 
74
      </arg>
60
75
      <arg choice="opt"><option>--debug</option></arg>
61
76
    </cmdsynopsis>
62
77
    <cmdsynopsis>
83
98
    <title>DESCRIPTION</title>
84
99
    <para>
85
100
      All <command>&COMMANDNAME;</command> does is prompt for a
86
 
      password and output any given password to standard output.  This
87
 
      is not very useful on its own.  This program is really meant to
88
 
      run as a plugin in the <application>Mandos</application>
89
 
      client-side system, where it is used as a fallback and
90
 
      alternative to retrieving passwords from a <application
91
 
      >Mandos</application> server.
 
101
      password and output any given password to standard output.
 
102
    </para>
 
103
    <para>
 
104
      This program is not very useful on its own.  This program is
 
105
      really meant to run as a plugin in the <application
 
106
      >Mandos</application> client-side system, where it is used as a
 
107
      fallback and alternative to retrieving passwords from a
 
108
      <application >Mandos</application> server.
92
109
    </para>
93
110
    <para>
94
111
      This program is little more than a <citerefentry><refentrytitle
96
113
      wrapper, although actual use of that function is not guaranteed
97
114
      or implied.
98
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>
99
125
  </refsect1>
100
126
  
101
127
  <refsect1 id="options">
124
150
      </varlistentry>
125
151
      
126
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>
127
165
        <term><option>--debug</option></term>
128
166
        <listitem>
129
167
          <para>
179
217
    <title>ENVIRONMENT</title>
180
218
    <variablelist>
181
219
      <varlistentry>
182
 
        <term><envar>cryptsource</envar></term>
183
 
        <term><envar>crypttarget</envar></term>
 
220
        <term><envar>CRYPTTAB_SOURCE</envar></term>
 
221
        <term><envar>CRYPTTAB_NAME</envar></term>
184
222
        <listitem>
185
223
          <para>
186
 
            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
187
226
            contain the source device name and the target device
188
227
            mapper name, respectively, and will be shown as part of
189
228
            the prompt.
191
230
        <para>
192
231
          These variables will normally be inherited from
193
232
          <citerefentry><refentrytitle>plugin-runner</refentrytitle>
194
 
          <manvolnum>8mandos</manvolnum></citerefentry>, which will
195
 
          normally have inherited them from
196
 
          <filename>/scripts/local-top/cryptroot</filename> in the
197
 
          initial <acronym>RAM</acronym> disk environment, which will
198
 
          have set them from parsing kernel arguments and
199
 
          <filename>/conf/conf.d/cryptroot</filename> (also in the
200
 
          initial RAM disk environment), which in turn will have been
201
 
          created when the initial RAM disk image was created by
202
 
          <filename
203
 
          >/usr/share/initramfs-tools/hooks/cryptroot</filename>, by
204
 
          extracting the information of the root file system from
205
 
          <filename >/etc/crypttab</filename>.
 
233
          <manvolnum>8mandos</manvolnum></citerefentry>, which might
 
234
          have in turn inherited them from its calling process.
206
235
        </para>
207
236
        <para>
208
237
          This behavior is meant to exactly mirror the behavior of
209
 
          <command>askpass</command>, the default password prompter.
 
238
          <command>askpass</command>, the default password prompter
 
239
          from initramfs-tools.
210
240
        </para>
211
241
        </listitem>
212
242
      </varlistentry>
215
245
  
216
246
  <refsect1 id="bugs">
217
247
    <title>BUGS</title>
218
 
    <para>
219
 
      None are known at this time.
220
 
    </para>
 
248
    <xi:include href="../bugs.xml"/>
221
249
  </refsect1>
222
250
  
223
251
  <refsect1 id="example">
288
316
  <refsect1 id="see_also">
289
317
    <title>SEE ALSO</title>
290
318
    <para>
291
 
      <citerefentry><refentrytitle>crypttab</refentrytitle>
292
 
      <manvolnum>5</manvolnum></citerefentry>
293
 
      <citerefentry><refentrytitle>password-request</refentrytitle>
294
 
      <manvolnum>8mandos</manvolnum></citerefentry>
 
319
      <citerefentry><refentrytitle>intro</refentrytitle>
 
320
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
321
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
322
      <manvolnum>8mandos</manvolnum></citerefentry>,
295
323
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
296
324
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
325
      <citerefentry><refentrytitle>plymouthd</refentrytitle>
 
326
      <manvolnum>8</manvolnum></citerefentry>
297
327
    </para>
298
328
  </refsect1>
299
329
</refentry>