/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: 2008-08-09 20:07:23 UTC
  • mto: (237.7.1 mandos) (24.1.154 mandos)
  • mto: This revision was merged to the branch mainline in revision 56.
  • Revision ID: belorn@braxen-20080809200723-4w313fa7w0w912yl
Added more stuff to do

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-31">
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>--prefix <replaceable
77
 
        >PREFIX</replaceable></option></arg>
78
 
        <arg choice="plain"><option>-p </option><replaceable
79
 
        >PREFIX</replaceable></arg>
80
 
      </group>
81
 
      <sbr/>
82
 
      <arg choice="opt"><option>--debug</option></arg>
83
 
    </cmdsynopsis>
84
 
    <cmdsynopsis>
85
 
      <command>&COMMANDNAME;</command>
86
 
      <group choice="req">
87
 
        <arg choice="plain"><option>--help</option></arg>
88
 
        <arg choice="plain"><option>-?</option></arg>
89
 
      </group>
90
 
    </cmdsynopsis>
91
 
    <cmdsynopsis>
92
 
      <command>&COMMANDNAME;</command>
93
 
      <arg choice="plain"><option>--usage</option></arg>
94
 
    </cmdsynopsis>
95
 
    <cmdsynopsis>
96
 
      <command>&COMMANDNAME;</command>
97
 
      <group choice="req">
98
 
        <arg choice="plain"><option>--version</option></arg>
99
 
        <arg choice="plain"><option>-V</option></arg>
100
 
      </group>
 
76
      <arg choice='opt' rep='repeat'>OPTION</arg>
101
77
    </cmdsynopsis>
102
78
  </refsynopsisdiv>
103
 
  
 
79
 
104
80
  <refsect1 id="description">
105
81
    <title>DESCRIPTION</title>
106
82
    <para>
107
 
      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.
114
 
    </para>
115
 
    <para>
116
 
      This program is little more than a <citerefentry><refentrytitle
117
 
      >getpass</refentrytitle><manvolnum>3</manvolnum></citerefentry>
118
 
      wrapper, although actual use of that function is not guaranteed
119
 
      or implied.
120
 
    </para>
121
 
  </refsect1>
122
 
  
123
 
  <refsect1 id="options">
124
 
    <title>OPTIONS</title>
125
 
    <para>
126
 
      This program is commonly not invoked from the command line; it
127
 
      is normally started by the <application>Mandos</application>
128
 
      plugin runner, see <citerefentry><refentrytitle
129
 
      >plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum>
130
 
      </citerefentry>.  Any command line options this program accepts
131
 
      are therefore normally provided by the plugin runner, and not
132
 
      directly.
133
 
    </para>
134
 
    
135
 
    <variablelist>
136
 
      <varlistentry>
137
 
        <term><option>-p</option> <replaceable>PREFIX</replaceable
138
 
        ></term>
139
 
        <term><option>--prefix=</option><replaceable
140
 
        >PREFIX</replaceable></term>
141
 
        <listitem>
142
 
          <para>
143
 
            Prefix string shown before the password prompt.
144
 
          </para>
145
 
        </listitem>
146
 
      </varlistentry>
147
 
      
148
 
      <varlistentry>
149
 
        <term><option>--debug</option></term>
150
 
        <listitem>
151
 
          <para>
152
 
            Enable debug mode.  This will enable a lot of output to
153
 
            standard error about what the program is doing.  The
154
 
            program will still perform all other functions normally.
155
 
          </para>
156
 
        </listitem>
157
 
      </varlistentry>
158
 
      
159
 
      <varlistentry>
160
 
        <term><option>-?</option></term>
161
 
        <term><option>--help</option></term>
162
 
        <listitem>
163
 
          <para>
164
 
            Gives a help message about options and their meanings.
165
 
          </para>
166
 
        </listitem>
167
 
      </varlistentry>
168
 
      
169
 
      <varlistentry>
170
 
        <term><option>--usage</option></term>
171
 
        <listitem>
172
 
          <para>
173
 
            Gives a short usage message.
174
 
          </para>
175
 
        </listitem>
176
 
      </varlistentry>
177
 
      
178
 
      <varlistentry>
179
 
        <term><option>-V</option></term>
180
 
        <term><option>--version</option></term>
181
 
        <listitem>
182
 
          <para>
183
 
            Prints the program version.
184
 
          </para>
185
 
        </listitem>
186
 
      </varlistentry>
187
 
    </variablelist>
188
 
  </refsect1>
189
 
  
190
 
  <refsect1 id="exit_status">
191
 
    <title>EXIT STATUS</title>
192
 
    <para>
193
 
      If exit status is 0, the output from the program is the password
194
 
      as it was read.  Otherwise, if exit status is other than 0, the
195
 
      program has encountered an error, and any output so far could be
196
 
      corrupt and/or truncated, and should therefore be ignored.
197
 
    </para>
198
 
  </refsect1>
199
 
  
200
 
  <refsect1 id="environment">
201
 
    <title>ENVIRONMENT</title>
202
 
    <variablelist>
203
 
      <varlistentry>
204
 
        <term><envar>cryptsource</envar></term>
205
 
        <term><envar>crypttarget</envar></term>
206
 
        <listitem>
207
 
          <para>
208
 
            If set, these environment variables will be assumed to
209
 
            contain the source device name and the target device
210
 
            mapper name, respectively, and will be shown as part of
211
 
            the prompt.
212
 
        </para>
213
 
        <para>
214
 
          These variables will normally be inherited from
215
 
          <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>.
228
 
        </para>
229
 
        <para>
230
 
          This behavior is meant to exactly mirror the behavior of
231
 
          <command>askpass</command>, the default password prompter.
232
 
        </para>
233
 
        </listitem>
234
 
      </varlistentry>
235
 
    </variablelist>
236
 
  </refsect1>
237
 
  
238
 
  <refsect1 id="bugs">
239
 
    <title>BUGS</title>
240
 
    <para>
241
 
      None are known at this time.
242
 
    </para>
243
 
  </refsect1>
244
 
  
245
 
  <refsect1 id="example">
246
 
    <title>EXAMPLE</title>
247
 
    <para>
248
 
      Note that normally, command line options will not be given
249
 
      directly, but via options for the Mandos <citerefentry
250
 
      ><refentrytitle>plugin-runner</refentrytitle>
251
 
      <manvolnum>8mandos</manvolnum></citerefentry>.
252
 
    </para>
253
 
    <informalexample>
254
 
      <para>
255
 
        Normal invocation needs no options:
256
 
      </para>
257
 
      <para>
258
 
        <userinput>&COMMANDNAME;</userinput>
259
 
      </para>
260
 
    </informalexample>
261
 
    <informalexample>
262
 
      <para>
263
 
        Show a prefix before the prompt; in this case, a host name.
264
 
        It might be useful to be reminded of which host needs a
265
 
        password, in case of KVM switches, etc.
266
 
      </para>
267
 
      <para>
268
 
 
269
 
<!-- do not wrap this line -->
270
 
<userinput>&COMMANDNAME; --prefix=host.example.org:</userinput>
271
 
 
272
 
      </para>
273
 
    </informalexample>
274
 
    <informalexample>
275
 
      <para>
276
 
        Run in debug mode.
277
 
      </para>
278
 
      <para>
279
 
        <!-- do not wrap this line -->
280
 
        <userinput>&COMMANDNAME; --debug</userinput>
281
 
      </para>
282
 
    </informalexample>
283
 
  </refsect1>
284
 
  
285
 
  <refsect1 id="security">
286
 
    <title>SECURITY</title>
287
 
    <para>
288
 
      On its own, this program is very simple, and does not exactly
289
 
      present any security risks.  The one thing that could be
290
 
      considered worthy of note is this: This program is meant to be
291
 
      run by <citerefentry><refentrytitle
292
 
      >plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum>
293
 
      </citerefentry>, and will, when run standalone, outside, in a
294
 
      normal environment, immediately output on its standard output
295
 
      any presumably secret password it just recieved.  Therefore,
296
 
      when running this program standalone (which should never
297
 
      normally be done), take care not to type in any real secret
298
 
      password by force of habit, since it would then immediately be
299
 
      shown as output.
300
 
    </para>
301
 
    <para>
302
 
      To further alleviate any risk of being locked out of a system,
303
 
      the <citerefentry><refentrytitle>plugin-runner</refentrytitle>
304
 
      <manvolnum>8mandos</manvolnum></citerefentry> has a fallback
305
 
      mode which does the same thing as this program, only with less
306
 
      features.
307
 
    </para>
308
 
  </refsect1>
309
 
  
310
 
  <refsect1 id="see_also">
311
 
    <title>SEE ALSO</title>
312
 
    <para>
313
 
      <citerefentry><refentrytitle>crypttab</refentrytitle>
314
 
      <manvolnum>5</manvolnum></citerefentry>
315
 
      <citerefentry><refentrytitle>password-request</refentrytitle>
316
 
      <manvolnum>8mandos</manvolnum></citerefentry>
317
 
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
318
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
319
 
    </para>
 
83
      <command>&COMMANDNAME;</command> is a terminal program that ask for
 
84
      passwords during boot sequence. It is a plugin to
 
85
      <firstterm>mandos</firstterm>, and is used as a fallback and
 
86
      alternative to retriving passwords from a mandos server. During
 
87
      boot sequence the user is prompted for the disk password, and
 
88
      when a password is given it then gets forwarded to
 
89
      <acronym>LUKS</acronym>.
 
90
    </para>
 
91
 
 
92
    <variablelist>
 
93
      <varlistentry>
 
94
        <term><literal>-p</literal>, <literal>--prefix=<replaceable>PREFIX
 
95
        </replaceable></literal></term>
 
96
        <listitem>
 
97
          <para>
 
98
            Prefix used before the passprompt
 
99
          </para>
 
100
        </listitem>
 
101
      </varlistentry>
 
102
      
 
103
      <varlistentry>
 
104
        <term><literal>--debug</literal></term>
 
105
        <listitem>
 
106
          <para>
 
107
            Debug mode
 
108
          </para>
 
109
        </listitem>
 
110
      </varlistentry>
 
111
      
 
112
      <varlistentry>
 
113
        <term><literal>-?</literal>, <literal>--help</literal></term>
 
114
        <listitem>
 
115
          <para>
 
116
            Gives a help message
 
117
          </para>
 
118
        </listitem>
 
119
      </varlistentry>
 
120
      
 
121
      <varlistentry>
 
122
        <term><literal>--usage</literal></term>
 
123
        <listitem>
 
124
          <para>
 
125
            Gives a short usage message
 
126
          </para>
 
127
        </listitem>
 
128
      </varlistentry>
 
129
 
 
130
      <varlistentry>
 
131
        <term><literal>-V</literal>, <literal>--version</literal></term>
 
132
        <listitem>
 
133
          <para>
 
134
            Prints the program version
 
135
          </para>
 
136
        </listitem>
 
137
      </varlistentry>            
 
138
    </variablelist>
320
139
  </refsect1>
321
140
</refentry>
322
 
<!-- Local Variables: -->
323
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
324
 
<!-- time-stamp-end: "[\"']>" -->
325
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
326
 
<!-- End: -->