/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-30 18:59:44 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080930185944-zjw2s8bsw4gmww7d
* Makefile (uninstall-client): Do not remove obsolete README file.

* debian/rules: Do not change permissions on "/etc/mandos/plugins.d".

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