/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: 2016-03-19 22:27:06 UTC
  • mfrom: (342 release)
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 343.
  • Revision ID: teddy@recompile.se-20160319222706-n61m90vqve42k1vc
Merge from release branch

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