/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: Teddy Hogeborn
  • Date: 2008-10-15 19:54:11 UTC
  • Revision ID: teddy@fukt.bsnet.se-20081015195411-y5rr8hh3u7koihgi
* debian/copyright: Removed non-standard headers.

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