/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 at recompile
  • Date: 2019-12-04 23:35:08 UTC
  • Revision ID: teddy@recompile.se-20191204233508-npy5ss0cd3q23x9v
Minor refactor of Python code: Move "str = unicode" to top

* mandos: Move "str = unicode" to top of file.
* mandos-ctl: - '' -

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-08-31">
 
5
<!ENTITY TIMESTAMP "2019-07-27">
 
6
<!ENTITY % common SYSTEM "../common.ent">
 
7
%common;
7
8
]>
8
9
 
9
 
<refentry>
 
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
10
11
  <refentryinfo>
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>
37
 
    <legalnotice>
38
 
      <para>
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
43
 
        later version.
44
 
      </para>
45
 
      
46
 
      <para>
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
51
 
        for more details.
52
 
      </para>
53
 
      
54
 
      <para>
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/"/>.
58
 
      </para>
59
 
    </legalnotice>
 
49
    <xi:include href="../legalnotice.xml"/>
60
50
  </refentryinfo>
61
51
  
62
52
  <refmeta>
79
69
        >PREFIX</replaceable></arg>
80
70
      </group>
81
71
      <sbr/>
 
72
      <arg choice="opt">
 
73
        <option>--prompt <replaceable>PROMPT</replaceable></option>
 
74
      </arg>
82
75
      <arg choice="opt"><option>--debug</option></arg>
83
76
    </cmdsynopsis>
84
77
    <cmdsynopsis>
105
98
    <title>DESCRIPTION</title>
106
99
    <para>
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.
 
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.
114
109
    </para>
115
110
    <para>
116
111
      This program is little more than a <citerefentry><refentrytitle
118
113
      wrapper, although actual use of that function is not guaranteed
119
114
      or implied.
120
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>
121
125
  </refsect1>
122
126
  
123
127
  <refsect1 id="options">
134
138
    
135
139
    <variablelist>
136
140
      <varlistentry>
137
 
        <term><option>-p</option> <replaceable>PREFIX</replaceable
138
 
        ></term>
139
 
        <term><option>--prefix=</option><replaceable
140
 
        >PREFIX</replaceable></term>
 
141
        <term><option>--prefix=<replaceable
 
142
        >PREFIX</replaceable></option></term>
 
143
        <term><option>-p
 
144
        <replaceable>PREFIX</replaceable></option></term>
141
145
        <listitem>
142
146
          <para>
143
147
            Prefix string shown before the password prompt.
146
150
      </varlistentry>
147
151
      
148
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>
149
165
        <term><option>--debug</option></term>
150
166
        <listitem>
151
167
          <para>
157
173
      </varlistentry>
158
174
      
159
175
      <varlistentry>
 
176
        <term><option>--help</option></term>
160
177
        <term><option>-?</option></term>
161
 
        <term><option>--help</option></term>
162
178
        <listitem>
163
179
          <para>
164
180
            Gives a help message about options and their meanings.
176
192
      </varlistentry>
177
193
      
178
194
      <varlistentry>
 
195
        <term><option>--version</option></term>
179
196
        <term><option>-V</option></term>
180
 
        <term><option>--version</option></term>
181
197
        <listitem>
182
198
          <para>
183
199
            Prints the program version.
201
217
    <title>ENVIRONMENT</title>
202
218
    <variablelist>
203
219
      <varlistentry>
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>
206
222
        <listitem>
207
223
          <para>
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
211
228
            the prompt.
213
230
        <para>
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
224
 
          <filename
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.
228
235
        </para>
229
236
        <para>
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.
232
240
        </para>
233
241
        </listitem>
234
242
      </varlistentry>
237
245
  
238
246
  <refsect1 id="bugs">
239
247
    <title>BUGS</title>
240
 
    <para>
241
 
      None are known at this time.
242
 
    </para>
 
248
    <xi:include href="../bugs.xml"/>
243
249
  </refsect1>
244
250
  
245
251
  <refsect1 id="example">
262
268
      <para>
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.
266
272
      </para>
267
273
      <para>
268
274
 
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>
312
318
    <para>
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>
319
327
    </para>
320
328
  </refsect1>
321
329
</refentry>