/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: Björn Påhlsson
  • Date: 2007-10-20 21:38:25 UTC
  • Revision ID: belorn@tower-20071020213825-abf6f0d1c33ee961
First working version with: IPv6, GnuTLS, X.509 certificates, DN
retrieval.

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugins.d/password-prompt.xml
1
 
<?xml version="1.0" encoding="UTF-8"?>
2
 
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
 
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
 
<!ENTITY COMMANDNAME "password-prompt">
5
 
<!ENTITY TIMESTAMP "2019-07-27">
6
 
<!ENTITY % common SYSTEM "../common.ent">
7
 
%common;
8
 
]>
9
 
 
10
 
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
11
 
  <refentryinfo>
12
 
    <title>Mandos Manual</title>
13
 
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
14
 
    <productname>Mandos</productname>
15
 
    <productnumber>&version;</productnumber>
16
 
    <date>&TIMESTAMP;</date>
17
 
    <authorgroup>
18
 
      <author>
19
 
        <firstname>Björn</firstname>
20
 
        <surname>Påhlsson</surname>
21
 
        <address>
22
 
          <email>belorn@recompile.se</email>
23
 
        </address>
24
 
      </author>
25
 
      <author>
26
 
        <firstname>Teddy</firstname>
27
 
        <surname>Hogeborn</surname>
28
 
        <address>
29
 
          <email>teddy@recompile.se</email>
30
 
        </address>
31
 
      </author>
32
 
    </authorgroup>
33
 
    <copyright>
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>
46
 
      <holder>Teddy Hogeborn</holder>
47
 
      <holder>Björn Påhlsson</holder>
48
 
    </copyright>
49
 
    <xi:include href="../legalnotice.xml"/>
50
 
  </refentryinfo>
51
 
  
52
 
  <refmeta>
53
 
    <refentrytitle>&COMMANDNAME;</refentrytitle>
54
 
    <manvolnum>8mandos</manvolnum>
55
 
  </refmeta>
56
 
  
57
 
  <refnamediv>
58
 
    <refname><command>&COMMANDNAME;</command></refname>
59
 
    <refpurpose>Prompt for a password and output it.</refpurpose>
60
 
  </refnamediv>
61
 
  
62
 
  <refsynopsisdiv>
63
 
    <cmdsynopsis>
64
 
      <command>&COMMANDNAME;</command>
65
 
      <group choice="opt">
66
 
        <arg choice="plain"><option>--prefix <replaceable
67
 
        >PREFIX</replaceable></option></arg>
68
 
        <arg choice="plain"><option>-p </option><replaceable
69
 
        >PREFIX</replaceable></arg>
70
 
      </group>
71
 
      <sbr/>
72
 
      <arg choice="opt">
73
 
        <option>--prompt <replaceable>PROMPT</replaceable></option>
74
 
      </arg>
75
 
      <arg choice="opt"><option>--debug</option></arg>
76
 
    </cmdsynopsis>
77
 
    <cmdsynopsis>
78
 
      <command>&COMMANDNAME;</command>
79
 
      <group choice="req">
80
 
        <arg choice="plain"><option>--help</option></arg>
81
 
        <arg choice="plain"><option>-?</option></arg>
82
 
      </group>
83
 
    </cmdsynopsis>
84
 
    <cmdsynopsis>
85
 
      <command>&COMMANDNAME;</command>
86
 
      <arg choice="plain"><option>--usage</option></arg>
87
 
    </cmdsynopsis>
88
 
    <cmdsynopsis>
89
 
      <command>&COMMANDNAME;</command>
90
 
      <group choice="req">
91
 
        <arg choice="plain"><option>--version</option></arg>
92
 
        <arg choice="plain"><option>-V</option></arg>
93
 
      </group>
94
 
    </cmdsynopsis>
95
 
  </refsynopsisdiv>
96
 
  
97
 
  <refsect1 id="description">
98
 
    <title>DESCRIPTION</title>
99
 
    <para>
100
 
      All <command>&COMMANDNAME;</command> does is prompt for a
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.
109
 
    </para>
110
 
    <para>
111
 
      This program is little more than a <citerefentry><refentrytitle
112
 
      >getpass</refentrytitle><manvolnum>3</manvolnum></citerefentry>
113
 
      wrapper, although actual use of that function is not guaranteed
114
 
      or implied.
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>
125
 
  </refsect1>
126
 
  
127
 
  <refsect1 id="options">
128
 
    <title>OPTIONS</title>
129
 
    <para>
130
 
      This program is commonly not invoked from the command line; it
131
 
      is normally started by the <application>Mandos</application>
132
 
      plugin runner, see <citerefentry><refentrytitle
133
 
      >plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum>
134
 
      </citerefentry>.  Any command line options this program accepts
135
 
      are therefore normally provided by the plugin runner, and not
136
 
      directly.
137
 
    </para>
138
 
    
139
 
    <variablelist>
140
 
      <varlistentry>
141
 
        <term><option>--prefix=<replaceable
142
 
        >PREFIX</replaceable></option></term>
143
 
        <term><option>-p
144
 
        <replaceable>PREFIX</replaceable></option></term>
145
 
        <listitem>
146
 
          <para>
147
 
            Prefix string shown before the password prompt.
148
 
          </para>
149
 
        </listitem>
150
 
      </varlistentry>
151
 
      
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>
165
 
        <term><option>--debug</option></term>
166
 
        <listitem>
167
 
          <para>
168
 
            Enable debug mode.  This will enable a lot of output to
169
 
            standard error about what the program is doing.  The
170
 
            program will still perform all other functions normally.
171
 
          </para>
172
 
        </listitem>
173
 
      </varlistentry>
174
 
      
175
 
      <varlistentry>
176
 
        <term><option>--help</option></term>
177
 
        <term><option>-?</option></term>
178
 
        <listitem>
179
 
          <para>
180
 
            Gives a help message about options and their meanings.
181
 
          </para>
182
 
        </listitem>
183
 
      </varlistentry>
184
 
      
185
 
      <varlistentry>
186
 
        <term><option>--usage</option></term>
187
 
        <listitem>
188
 
          <para>
189
 
            Gives a short usage message.
190
 
          </para>
191
 
        </listitem>
192
 
      </varlistentry>
193
 
      
194
 
      <varlistentry>
195
 
        <term><option>--version</option></term>
196
 
        <term><option>-V</option></term>
197
 
        <listitem>
198
 
          <para>
199
 
            Prints the program version.
200
 
          </para>
201
 
        </listitem>
202
 
      </varlistentry>
203
 
    </variablelist>
204
 
  </refsect1>
205
 
  
206
 
  <refsect1 id="exit_status">
207
 
    <title>EXIT STATUS</title>
208
 
    <para>
209
 
      If exit status is 0, the output from the program is the password
210
 
      as it was read.  Otherwise, if exit status is other than 0, the
211
 
      program has encountered an error, and any output so far could be
212
 
      corrupt and/or truncated, and should therefore be ignored.
213
 
    </para>
214
 
  </refsect1>
215
 
  
216
 
  <refsect1 id="environment">
217
 
    <title>ENVIRONMENT</title>
218
 
    <variablelist>
219
 
      <varlistentry>
220
 
        <term><envar>CRYPTTAB_SOURCE</envar></term>
221
 
        <term><envar>CRYPTTAB_NAME</envar></term>
222
 
        <listitem>
223
 
          <para>
224
 
            If set, and if the <option>--prompt</option> option is not
225
 
            used, these environment variables will be assumed to
226
 
            contain the source device name and the target device
227
 
            mapper name, respectively, and will be shown as part of
228
 
            the prompt.
229
 
        </para>
230
 
        <para>
231
 
          These variables will normally be inherited from
232
 
          <citerefentry><refentrytitle>plugin-runner</refentrytitle>
233
 
          <manvolnum>8mandos</manvolnum></citerefentry>, which might
234
 
          have in turn inherited them from its calling process.
235
 
        </para>
236
 
        <para>
237
 
          This behavior is meant to exactly mirror the behavior of
238
 
          <command>askpass</command>, the default password prompter
239
 
          from initramfs-tools.
240
 
        </para>
241
 
        </listitem>
242
 
      </varlistentry>
243
 
    </variablelist>
244
 
  </refsect1>
245
 
  
246
 
  <refsect1 id="bugs">
247
 
    <title>BUGS</title>
248
 
    <xi:include href="../bugs.xml"/>
249
 
  </refsect1>
250
 
  
251
 
  <refsect1 id="example">
252
 
    <title>EXAMPLE</title>
253
 
    <para>
254
 
      Note that normally, command line options will not be given
255
 
      directly, but via options for the Mandos <citerefentry
256
 
      ><refentrytitle>plugin-runner</refentrytitle>
257
 
      <manvolnum>8mandos</manvolnum></citerefentry>.
258
 
    </para>
259
 
    <informalexample>
260
 
      <para>
261
 
        Normal invocation needs no options:
262
 
      </para>
263
 
      <para>
264
 
        <userinput>&COMMANDNAME;</userinput>
265
 
      </para>
266
 
    </informalexample>
267
 
    <informalexample>
268
 
      <para>
269
 
        Show a prefix before the prompt; in this case, a host name.
270
 
        It might be useful to be reminded of which host needs a
271
 
        password, in case of <acronym>KVM</acronym> switches, etc.
272
 
      </para>
273
 
      <para>
274
 
 
275
 
<!-- do not wrap this line -->
276
 
<userinput>&COMMANDNAME; --prefix=host.example.org:</userinput>
277
 
 
278
 
      </para>
279
 
    </informalexample>
280
 
    <informalexample>
281
 
      <para>
282
 
        Run in debug mode.
283
 
      </para>
284
 
      <para>
285
 
        <!-- do not wrap this line -->
286
 
        <userinput>&COMMANDNAME; --debug</userinput>
287
 
      </para>
288
 
    </informalexample>
289
 
  </refsect1>
290
 
  
291
 
  <refsect1 id="security">
292
 
    <title>SECURITY</title>
293
 
    <para>
294
 
      On its own, this program is very simple, and does not exactly
295
 
      present any security risks.  The one thing that could be
296
 
      considered worthy of note is this: This program is meant to be
297
 
      run by <citerefentry><refentrytitle
298
 
      >plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum>
299
 
      </citerefentry>, and will, when run standalone, outside, in a
300
 
      normal environment, immediately output on its standard output
301
 
      any presumably secret password it just received.  Therefore,
302
 
      when running this program standalone (which should never
303
 
      normally be done), take care not to type in any real secret
304
 
      password by force of habit, since it would then immediately be
305
 
      shown as output.
306
 
    </para>
307
 
    <para>
308
 
      To further alleviate any risk of being locked out of a system,
309
 
      the <citerefentry><refentrytitle>plugin-runner</refentrytitle>
310
 
      <manvolnum>8mandos</manvolnum></citerefentry> has a fallback
311
 
      mode which does the same thing as this program, only with less
312
 
      features.
313
 
    </para>
314
 
  </refsect1>
315
 
  
316
 
  <refsect1 id="see_also">
317
 
    <title>SEE ALSO</title>
318
 
    <para>
319
 
      <citerefentry><refentrytitle>intro</refentrytitle>
320
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
321
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
322
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
323
 
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
324
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
325
 
      <citerefentry><refentrytitle>plymouthd</refentrytitle>
326
 
      <manvolnum>8</manvolnum></citerefentry>
327
 
    </para>
328
 
  </refsect1>
329
 
</refentry>
330
 
<!-- Local Variables: -->
331
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
332
 
<!-- time-stamp-end: "[\"']>" -->
333
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
334
 
<!-- End: -->