/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-09-13 15:36:18 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080913153618-atp386q2bqj0ku99
* Makefile (install-client-nokey): Do "&&" instead of ";" to catch
                                   errors.

* README: Kill the straight quotes.  Add copyright notice.

* overview.xml: Improved wording.

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