/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

merge

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-08-29">
8
7
]>
9
8
 
10
9
<refentry>
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
37
    <legalnotice>
37
38
      <para>
41
42
        either version 3 of the License, or (at your option) any
42
43
        later version.
43
44
      </para>
44
 
 
 
45
      
45
46
      <para>
46
47
        This manual page is distributed in the hope that it will
47
48
        be useful, but WITHOUT ANY WARRANTY; without even the
49
50
        PARTICULAR PURPOSE.  See the GNU General Public License
50
51
        for more details.
51
52
      </para>
52
 
 
 
53
      
53
54
      <para>
54
55
        You should have received a copy of the GNU General Public
55
56
        License along with this program; If not, see
57
58
      </para>
58
59
    </legalnotice>
59
60
  </refentryinfo>
60
 
 
 
61
  
61
62
  <refmeta>
62
63
    <refentrytitle>&COMMANDNAME;</refentrytitle>
63
64
    <manvolnum>8mandos</manvolnum>
65
66
  
66
67
  <refnamediv>
67
68
    <refname><command>&COMMANDNAME;</command></refname>
68
 
    <refpurpose>
69
 
      Passprompt for luks during boot sequence
70
 
    </refpurpose>
 
69
    <refpurpose>Prompt for a password and output it.</refpurpose>
71
70
  </refnamediv>
72
71
  
73
72
  <refsynopsisdiv>
74
73
    <cmdsynopsis>
75
74
      <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>
 
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>
90
100
    </cmdsynopsis>    
91
101
  </refsynopsisdiv>
92
 
 
 
102
  
93
103
  <refsect1 id="description">
94
104
    <title>DESCRIPTION</title>
95
105
    <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>.
 
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.
103
119
    </para>
104
120
  </refsect1>
105
121
  
106
122
  <refsect1 id="options">
107
123
    <title>OPTIONS</title>
108
124
    <para>
109
 
      Commonly not invoked as command lines but from configuration
110
 
      file of plugin runner.
 
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.
111
132
    </para>
112
 
 
 
133
    
113
134
    <variablelist>
114
135
      <varlistentry>
115
 
        <term><literal>-p</literal>, <literal>--prefix=<replaceable>PREFIX
116
 
        </replaceable></literal></term>
117
 
        <listitem>
118
 
          <para>
119
 
            Prefix used before the passprompt
120
 
          </para>
121
 
        </listitem>
122
 
      </varlistentry>
123
 
      
124
 
      <varlistentry>
125
 
        <term><literal>--debug</literal></term>
126
 
        <listitem>
127
 
          <para>
128
 
            Debug mode
129
 
          </para>
130
 
        </listitem>
131
 
      </varlistentry>
132
 
      
133
 
      <varlistentry>
134
 
        <term><literal>-?</literal>, <literal>--help</literal></term>
135
 
        <listitem>
136
 
          <para>
137
 
            Gives a help message
138
 
          </para>
139
 
        </listitem>
140
 
      </varlistentry>
141
 
      
142
 
      <varlistentry>
143
 
        <term><literal>--usage</literal></term>
144
 
        <listitem>
145
 
          <para>
146
 
            Gives a short usage message
147
 
          </para>
148
 
        </listitem>
149
 
      </varlistentry>
150
 
 
151
 
      <varlistentry>
152
 
        <term><literal>-V</literal>, <literal>--version</literal></term>
153
 
        <listitem>
154
 
          <para>
155
 
            Prints the program version
 
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.
156
183
          </para>
157
184
        </listitem>
158
185
      </varlistentry>            
159
186
    </variablelist>
160
187
  </refsect1>
161
 
 
 
188
  
162
189
  <refsect1 id="exit_status">
163
190
    <title>EXIT STATUS</title>
164
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.
165
196
    </para>
166
197
  </refsect1>
167
 
 
 
198
  
168
199
  <refsect1 id="environment">
169
200
    <title>ENVIRONMENT</title>
170
 
    <para>
171
 
    </para>
172
 
  </refsect1>
173
 
 
174
 
  <refsect1 id="files">
175
 
    <title>FILES</title>
176
 
    <para>
177
 
    </para>
 
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>
178
235
  </refsect1>
179
236
  
180
237
  <refsect1 id="bugs">
181
238
    <title>BUGS</title>
182
239
    <para>
 
240
      None are known at this time.
183
241
    </para>
184
242
  </refsect1>  
185
 
 
 
243
  
186
244
  <refsect1 id="example">
187
245
    <title>EXAMPLE</title>
188
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>.
189
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>
190
282
  </refsect1>
191
 
 
 
283
  
192
284
  <refsect1 id="security">
193
285
    <title>SECURITY</title>
194
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.
195
306
    </para>
196
307
  </refsect1>
197
 
 
 
308
  
198
309
  <refsect1 id="see_also">
199
310
    <title>SEE ALSO</title>
200
311
    <para>
201
 
      <citerefentry><refentrytitle>mandos</refentrytitle>
202
 
      <manvolnum>8</manvolnum></citerefentry>, <citerefentry>
203
 
      <refentrytitle>plugin-runner</refentrytitle>
204
 
      <manvolnum>8mandos</manvolnum></citerefentry> and <citerefentry>
205
 
      <refentrytitle>password-request</refentrytitle>
 
312
      <citerefentry><refentrytitle>crypttab</refentrytitle>
 
313
      <manvolnum>5</manvolnum></citerefentry>
 
314
      <citerefentry><refentrytitle>password-request</refentrytitle>
206
315
      <manvolnum>8mandos</manvolnum></citerefentry>
 
316
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
 
317
      <manvolnum>8mandos</manvolnum></citerefentry>,
207
318
    </para>
208
 
  </refsect1>  
209
 
  
 
319
  </refsect1>
210
320
</refentry>
 
321
<!-- Local Variables: -->
 
322
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
323
<!-- time-stamp-end: "[\"']>" -->
 
324
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
325
<!-- End: -->