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-08-31">
5
<!ENTITY TIMESTAMP "2019-07-27">
6
<!ENTITY % common SYSTEM "../common.ent">
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>
18
19
<firstname>Björn</firstname>
19
20
<surname>Påhlsson</surname>
21
<email>belorn@fukt.bsnet.se</email>
22
<email>belorn@recompile.se</email>
25
26
<firstname>Teddy</firstname>
26
27
<surname>Hogeborn</surname>
28
<email>teddy@fukt.bsnet.se</email>
29
<email>teddy@recompile.se</email>
34
46
<holder>Teddy Hogeborn</holder>
35
47
<holder>Björn Påhlsson</holder>
39
This manual page is free software: you can redistribute it
40
and/or modify it under the terms of the GNU General Public
41
License as published by the Free Software Foundation,
42
either version 3 of the License, or (at your option) any
47
This manual page is distributed in the hope that it will
48
be useful, but WITHOUT ANY WARRANTY; without even the
49
implied warranty of MERCHANTABILITY or FITNESS FOR A
50
PARTICULAR PURPOSE. See the GNU General Public License
55
You should have received a copy of the GNU General Public
56
License along with this program; If not, see
57
<ulink url="http://www.gnu.org/licenses/"/>.
49
<xi:include href="../legalnotice.xml"/>
105
98
<title>DESCRIPTION</title>
107
100
All <command>&COMMANDNAME;</command> does is prompt for a
108
password and output any given password to standard output. This
109
is not very useful on its own. This program is really meant to
110
run as a plugin in the <application>Mandos</application>
111
client-side system, where it is used as a fallback and
112
alternative to retriving passwords from a <application
113
>Mandos</application> server.
101
password and output any given password to standard output.
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.
116
111
This program is little more than a <citerefentry><refentrytitle
118
113
wrapper, although actual use of that function is not guaranteed
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.
123
127
<refsect1 id="options">
137
<term><option>-p</option> <replaceable>PREFIX</replaceable
139
<term><option>--prefix=</option><replaceable
140
>PREFIX</replaceable></term>
141
<term><option>--prefix=<replaceable
142
>PREFIX</replaceable></option></term>
144
<replaceable>PREFIX</replaceable></option></term>
143
147
Prefix string shown before the password prompt.
153
<term><option>--prompt=<replaceable
154
>PROMPT</replaceable></option></term>
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.
149
165
<term><option>--debug</option></term>
201
217
<title>ENVIRONMENT</title>
204
<term><envar>cryptsource</envar></term>
205
<term><envar>crypttarget</envar></term>
220
<term><envar>CRYPTTAB_SOURCE</envar></term>
221
<term><envar>CRYPTTAB_NAME</envar></term>
208
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
209
226
contain the source device name and the target device
210
227
mapper name, respectively, and will be shown as part of
214
231
These variables will normally be inherited from
215
232
<citerefentry><refentrytitle>plugin-runner</refentrytitle>
216
<manvolnum>8mandos</manvolnum></citerefentry>, which will
217
normally have inherited them from
218
<filename>/scripts/local-top/cryptroot</filename> in the
219
initial RAM disk environment, which will have set them from
220
parsing kernel arguments and
221
<filename>/conf/conf.d/cryptroot</filename> (also in the
222
initial RAM disk environment), which in turn will have been
223
created when the initial RAM disk image was created by
225
>/usr/share/initramfs-tools/hooks/cryptroot</filename>, by
226
extracting the information of the root file system from
227
<filename >/etc/crypttab</filename>.
233
<manvolnum>8mandos</manvolnum></citerefentry>, which might
234
have in turn inherited them from its calling process.
230
237
This behavior is meant to exactly mirror the behavior of
231
<command>askpass</command>, the default password prompter.
238
<command>askpass</command>, the default password prompter
239
from initramfs-tools.
263
269
Show a prefix before the prompt; in this case, a host name.
264
270
It might be useful to be reminded of which host needs a
265
password, in case of KVM switches, etc.
271
password, in case of <acronym>KVM</acronym> switches, etc.
292
298
>plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum>
293
299
</citerefentry>, and will, when run standalone, outside, in a
294
300
normal environment, immediately output on its standard output
295
any presumably secret password it just recieved. Therefore,
301
any presumably secret password it just received. Therefore,
296
302
when running this program standalone (which should never
297
303
normally be done), take care not to type in any real secret
298
304
password by force of habit, since it would then immediately be
310
316
<refsect1 id="see_also">
311
317
<title>SEE ALSO</title>
313
<citerefentry><refentrytitle>crypttab</refentrytitle>
314
<manvolnum>5</manvolnum></citerefentry>
315
<citerefentry><refentrytitle>password-request</refentrytitle>
316
<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>,
317
323
<citerefentry><refentrytitle>plugin-runner</refentrytitle>
318
324
<manvolnum>8mandos</manvolnum></citerefentry>,
325
<citerefentry><refentrytitle>plymouthd</refentrytitle>
326
<manvolnum>8</manvolnum></citerefentry>
added
removed
plugins.d/password-prompt.xml
