/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-08-31 09:26:12 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080831092612-atz9uzia38h1ijy5
* mandos.xml (OPTIONS): Moved long options before short.  Use <option>
                        tags instead of <literal>.

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-31">
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>
90
 
    </cmdsynopsis>    
 
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>
 
101
    </cmdsynopsis>
91
102
  </refsynopsisdiv>
92
 
 
 
103
  
93
104
  <refsect1 id="description">
94
105
    <title>DESCRIPTION</title>
95
106
    <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>.
 
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.
103
120
    </para>
104
121
  </refsect1>
105
122
  
106
123
  <refsect1 id="options">
107
124
    <title>OPTIONS</title>
108
125
    <para>
109
 
      Commonly not invoked as command lines but from configuration
110
 
      file of plugin runner.
 
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.
111
133
    </para>
112
 
 
 
134
    
113
135
    <variablelist>
114
136
      <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>            
 
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>
159
187
    </variablelist>
160
188
  </refsect1>
161
 
 
 
189
  
162
190
  <refsect1 id="exit_status">
163
191
    <title>EXIT STATUS</title>
164
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.
165
197
    </para>
166
198
  </refsect1>
167
 
 
 
199
  
168
200
  <refsect1 id="environment">
169
201
    <title>ENVIRONMENT</title>
170
 
    <para>
171
 
    </para>
172
 
  </refsect1>
173
 
 
174
 
  <refsect1 id="files">
175
 
    <title>FILES</title>
176
 
    <para>
177
 
    </para>
 
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>
178
236
  </refsect1>
179
237
  
180
238
  <refsect1 id="bugs">
181
239
    <title>BUGS</title>
182
240
    <para>
 
241
      None are known at this time.
183
242
    </para>
184
 
  </refsect1>  
185
 
 
 
243
  </refsect1>
 
244
  
186
245
  <refsect1 id="example">
187
246
    <title>EXAMPLE</title>
188
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>.
189
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>
190
283
  </refsect1>
191
 
 
 
284
  
192
285
  <refsect1 id="security">
193
286
    <title>SECURITY</title>
194
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.
195
307
    </para>
196
308
  </refsect1>
197
 
 
 
309
  
198
310
  <refsect1 id="see_also">
199
311
    <title>SEE ALSO</title>
200
312
    <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>
 
313
      <citerefentry><refentrytitle>crypttab</refentrytitle>
 
314
      <manvolnum>5</manvolnum></citerefentry>
 
315
      <citerefentry><refentrytitle>password-request</refentrytitle>
206
316
      <manvolnum>8mandos</manvolnum></citerefentry>
 
317
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
 
318
      <manvolnum>8mandos</manvolnum></citerefentry>,
207
319
    </para>
208
 
  </refsect1>  
209
 
  
 
320
  </refsect1>
210
321
</refentry>
 
322
<!-- Local Variables: -->
 
323
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
324
<!-- time-stamp-end: "[\"']>" -->
 
325
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
326
<!-- End: -->