/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: Björn Påhlsson
  • Date: 2008-07-20 02:52:20 UTC
  • Revision ID: belorn@braxen-20080720025220-r5u0388uy9iu23h6
Added following support:
Pluginbased client handler
rewritten Mandos client
       Avahi instead of udp server discovery
       openpgp encrypted key support
Passprompt stand alone application for direct console input
Added logging for Mandos server

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 "2017-02-23">
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
 
      <holder>Teddy Hogeborn</holder>
45
 
      <holder>Björn Påhlsson</holder>
46
 
    </copyright>
47
 
    <xi:include href="../legalnotice.xml"/>
48
 
  </refentryinfo>
49
 
  
50
 
  <refmeta>
51
 
    <refentrytitle>&COMMANDNAME;</refentrytitle>
52
 
    <manvolnum>8mandos</manvolnum>
53
 
  </refmeta>
54
 
  
55
 
  <refnamediv>
56
 
    <refname><command>&COMMANDNAME;</command></refname>
57
 
    <refpurpose>Prompt for a password and output it.</refpurpose>
58
 
  </refnamediv>
59
 
  
60
 
  <refsynopsisdiv>
61
 
    <cmdsynopsis>
62
 
      <command>&COMMANDNAME;</command>
63
 
      <group choice="opt">
64
 
        <arg choice="plain"><option>--prefix <replaceable
65
 
        >PREFIX</replaceable></option></arg>
66
 
        <arg choice="plain"><option>-p </option><replaceable
67
 
        >PREFIX</replaceable></arg>
68
 
      </group>
69
 
      <sbr/>
70
 
      <arg choice="opt"><option>--debug</option></arg>
71
 
    </cmdsynopsis>
72
 
    <cmdsynopsis>
73
 
      <command>&COMMANDNAME;</command>
74
 
      <group choice="req">
75
 
        <arg choice="plain"><option>--help</option></arg>
76
 
        <arg choice="plain"><option>-?</option></arg>
77
 
      </group>
78
 
    </cmdsynopsis>
79
 
    <cmdsynopsis>
80
 
      <command>&COMMANDNAME;</command>
81
 
      <arg choice="plain"><option>--usage</option></arg>
82
 
    </cmdsynopsis>
83
 
    <cmdsynopsis>
84
 
      <command>&COMMANDNAME;</command>
85
 
      <group choice="req">
86
 
        <arg choice="plain"><option>--version</option></arg>
87
 
        <arg choice="plain"><option>-V</option></arg>
88
 
      </group>
89
 
    </cmdsynopsis>
90
 
  </refsynopsisdiv>
91
 
  
92
 
  <refsect1 id="description">
93
 
    <title>DESCRIPTION</title>
94
 
    <para>
95
 
      All <command>&COMMANDNAME;</command> does is prompt for a
96
 
      password and output any given password to standard output.
97
 
    </para>
98
 
    <para>
99
 
      This program is not very useful on its own.  This program is
100
 
      really meant to run as a plugin in the <application
101
 
      >Mandos</application> client-side system, where it is used as a
102
 
      fallback and alternative to retrieving passwords from a
103
 
      <application >Mandos</application> server.
104
 
    </para>
105
 
    <para>
106
 
      This program is little more than a <citerefentry><refentrytitle
107
 
      >getpass</refentrytitle><manvolnum>3</manvolnum></citerefentry>
108
 
      wrapper, although actual use of that function is not guaranteed
109
 
      or implied.
110
 
    </para>
111
 
  </refsect1>
112
 
  
113
 
  <refsect1 id="options">
114
 
    <title>OPTIONS</title>
115
 
    <para>
116
 
      This program is commonly not invoked from the command line; it
117
 
      is normally started by the <application>Mandos</application>
118
 
      plugin runner, see <citerefentry><refentrytitle
119
 
      >plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum>
120
 
      </citerefentry>.  Any command line options this program accepts
121
 
      are therefore normally provided by the plugin runner, and not
122
 
      directly.
123
 
    </para>
124
 
    
125
 
    <variablelist>
126
 
      <varlistentry>
127
 
        <term><option>--prefix=<replaceable
128
 
        >PREFIX</replaceable></option></term>
129
 
        <term><option>-p
130
 
        <replaceable>PREFIX</replaceable></option></term>
131
 
        <listitem>
132
 
          <para>
133
 
            Prefix string shown before the password prompt.
134
 
          </para>
135
 
        </listitem>
136
 
      </varlistentry>
137
 
      
138
 
      <varlistentry>
139
 
        <term><option>--debug</option></term>
140
 
        <listitem>
141
 
          <para>
142
 
            Enable debug mode.  This will enable a lot of output to
143
 
            standard error about what the program is doing.  The
144
 
            program will still perform all other functions normally.
145
 
          </para>
146
 
        </listitem>
147
 
      </varlistentry>
148
 
      
149
 
      <varlistentry>
150
 
        <term><option>--help</option></term>
151
 
        <term><option>-?</option></term>
152
 
        <listitem>
153
 
          <para>
154
 
            Gives a help message about options and their meanings.
155
 
          </para>
156
 
        </listitem>
157
 
      </varlistentry>
158
 
      
159
 
      <varlistentry>
160
 
        <term><option>--usage</option></term>
161
 
        <listitem>
162
 
          <para>
163
 
            Gives a short usage message.
164
 
          </para>
165
 
        </listitem>
166
 
      </varlistentry>
167
 
      
168
 
      <varlistentry>
169
 
        <term><option>--version</option></term>
170
 
        <term><option>-V</option></term>
171
 
        <listitem>
172
 
          <para>
173
 
            Prints the program version.
174
 
          </para>
175
 
        </listitem>
176
 
      </varlistentry>
177
 
    </variablelist>
178
 
  </refsect1>
179
 
  
180
 
  <refsect1 id="exit_status">
181
 
    <title>EXIT STATUS</title>
182
 
    <para>
183
 
      If exit status is 0, the output from the program is the password
184
 
      as it was read.  Otherwise, if exit status is other than 0, the
185
 
      program has encountered an error, and any output so far could be
186
 
      corrupt and/or truncated, and should therefore be ignored.
187
 
    </para>
188
 
  </refsect1>
189
 
  
190
 
  <refsect1 id="environment">
191
 
    <title>ENVIRONMENT</title>
192
 
    <variablelist>
193
 
      <varlistentry>
194
 
        <term><envar>CRYPTTAB_SOURCE</envar></term>
195
 
        <term><envar>CRYPTTAB_NAME</envar></term>
196
 
        <listitem>
197
 
          <para>
198
 
            If set, these environment variables will be assumed to
199
 
            contain the source device name and the target device
200
 
            mapper name, respectively, and will be shown as part of
201
 
            the prompt.
202
 
        </para>
203
 
        <para>
204
 
          These variables will normally be inherited from
205
 
          <citerefentry><refentrytitle>plugin-runner</refentrytitle>
206
 
          <manvolnum>8mandos</manvolnum></citerefentry>, which will
207
 
          normally have inherited them from
208
 
          <filename>/scripts/local-top/cryptroot</filename> in the
209
 
          initial <acronym>RAM</acronym> disk environment, which will
210
 
          have set them from parsing kernel arguments and
211
 
          <filename>/conf/conf.d/cryptroot</filename> (also in the
212
 
          initial RAM disk environment), which in turn will have been
213
 
          created when the initial RAM disk image was created by
214
 
          <filename
215
 
          >/usr/share/initramfs-tools/hooks/cryptroot</filename>, by
216
 
          extracting the information of the root file system from
217
 
          <filename >/etc/crypttab</filename>.
218
 
        </para>
219
 
        <para>
220
 
          This behavior is meant to exactly mirror the behavior of
221
 
          <command>askpass</command>, the default password prompter.
222
 
        </para>
223
 
        </listitem>
224
 
      </varlistentry>
225
 
    </variablelist>
226
 
  </refsect1>
227
 
  
228
 
  <refsect1 id="bugs">
229
 
    <title>BUGS</title>
230
 
    <xi:include href="../bugs.xml"/>
231
 
  </refsect1>
232
 
  
233
 
  <refsect1 id="example">
234
 
    <title>EXAMPLE</title>
235
 
    <para>
236
 
      Note that normally, command line options will not be given
237
 
      directly, but via options for the Mandos <citerefentry
238
 
      ><refentrytitle>plugin-runner</refentrytitle>
239
 
      <manvolnum>8mandos</manvolnum></citerefentry>.
240
 
    </para>
241
 
    <informalexample>
242
 
      <para>
243
 
        Normal invocation needs no options:
244
 
      </para>
245
 
      <para>
246
 
        <userinput>&COMMANDNAME;</userinput>
247
 
      </para>
248
 
    </informalexample>
249
 
    <informalexample>
250
 
      <para>
251
 
        Show a prefix before the prompt; in this case, a host name.
252
 
        It might be useful to be reminded of which host needs a
253
 
        password, in case of <acronym>KVM</acronym> switches, etc.
254
 
      </para>
255
 
      <para>
256
 
 
257
 
<!-- do not wrap this line -->
258
 
<userinput>&COMMANDNAME; --prefix=host.example.org:</userinput>
259
 
 
260
 
      </para>
261
 
    </informalexample>
262
 
    <informalexample>
263
 
      <para>
264
 
        Run in debug mode.
265
 
      </para>
266
 
      <para>
267
 
        <!-- do not wrap this line -->
268
 
        <userinput>&COMMANDNAME; --debug</userinput>
269
 
      </para>
270
 
    </informalexample>
271
 
  </refsect1>
272
 
  
273
 
  <refsect1 id="security">
274
 
    <title>SECURITY</title>
275
 
    <para>
276
 
      On its own, this program is very simple, and does not exactly
277
 
      present any security risks.  The one thing that could be
278
 
      considered worthy of note is this: This program is meant to be
279
 
      run by <citerefentry><refentrytitle
280
 
      >plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum>
281
 
      </citerefentry>, and will, when run standalone, outside, in a
282
 
      normal environment, immediately output on its standard output
283
 
      any presumably secret password it just received.  Therefore,
284
 
      when running this program standalone (which should never
285
 
      normally be done), take care not to type in any real secret
286
 
      password by force of habit, since it would then immediately be
287
 
      shown as output.
288
 
    </para>
289
 
    <para>
290
 
      To further alleviate any risk of being locked out of a system,
291
 
      the <citerefentry><refentrytitle>plugin-runner</refentrytitle>
292
 
      <manvolnum>8mandos</manvolnum></citerefentry> has a fallback
293
 
      mode which does the same thing as this program, only with less
294
 
      features.
295
 
    </para>
296
 
  </refsect1>
297
 
  
298
 
  <refsect1 id="see_also">
299
 
    <title>SEE ALSO</title>
300
 
    <para>
301
 
      <citerefentry><refentrytitle>intro</refentrytitle>
302
 
      <manvolnum>8mandos</manvolnum></citerefentry>
303
 
      <citerefentry><refentrytitle>crypttab</refentrytitle>
304
 
      <manvolnum>5</manvolnum></citerefentry>
305
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
306
 
      <manvolnum>8mandos</manvolnum></citerefentry>
307
 
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
308
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
309
 
    </para>
310
 
  </refsect1>
311
 
</refentry>
312
 
<!-- Local Variables: -->
313
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
314
 
<!-- time-stamp-end: "[\"']>" -->
315
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
316
 
<!-- End: -->