/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: 2008-08-10 17:52:54 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080810175254-pxjzwws523ji49n7
* Makefile (DOCBOOKTOMAN): Do not generate AUTHORS section.

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