/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

Added configuration files support for mandos-client
Removed plus argument support for mandos-client

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"?>
 
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"?>
2
4
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
5
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
 
6
<!ENTITY VERSION "1.0">
4
7
<!ENTITY COMMANDNAME "password-prompt">
5
 
<!ENTITY TIMESTAMP "2016-02-28">
6
 
<!ENTITY % common SYSTEM "../common.ent">
7
 
%common;
8
8
]>
9
9
 
10
 
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
 
10
<refentry>
11
11
  <refentryinfo>
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>
 
12
    <title>&COMMANDNAME;</title>
 
13
    <!-- NWalsh's docbook scripts use this to generate the footer: -->
 
14
    <productname>&COMMANDNAME;</productname>
 
15
    <productnumber>&VERSION;</productnumber>
17
16
    <authorgroup>
18
17
      <author>
19
18
        <firstname>Björn</firstname>
20
19
        <surname>Påhlsson</surname>
21
20
        <address>
22
 
          <email>belorn@recompile.se</email>
 
21
          <email>belorn@fukt.bsnet.se</email>
23
22
        </address>
24
23
      </author>
25
24
      <author>
26
25
        <firstname>Teddy</firstname>
27
26
        <surname>Hogeborn</surname>
28
27
        <address>
29
 
          <email>teddy@recompile.se</email>
 
28
          <email>teddy@fukt.bsnet.se</email>
30
29
        </address>
31
30
      </author>
32
31
    </authorgroup>
33
32
    <copyright>
34
33
      <year>2008</year>
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>
 
34
      <holder>Teddy Hogeborn &amp; Björn Påhlsson</holder>
45
35
    </copyright>
46
 
    <xi:include href="../legalnotice.xml"/>
 
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>
47
59
  </refentryinfo>
48
 
  
 
60
 
49
61
  <refmeta>
50
62
    <refentrytitle>&COMMANDNAME;</refentrytitle>
51
63
    <manvolnum>8mandos</manvolnum>
53
65
  
54
66
  <refnamediv>
55
67
    <refname><command>&COMMANDNAME;</command></refname>
56
 
    <refpurpose>Prompt for a password and output it.</refpurpose>
 
68
    <refpurpose>
 
69
      Passprompt for luks during boot sequence
 
70
    </refpurpose>
57
71
  </refnamediv>
58
72
  
59
73
  <refsynopsisdiv>
60
74
    <cmdsynopsis>
61
75
      <command>&COMMANDNAME;</command>
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>
 
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>    
89
91
  </refsynopsisdiv>
90
 
  
 
92
 
91
93
  <refsect1 id="description">
92
94
    <title>DESCRIPTION</title>
93
95
    <para>
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.
109
 
    </para>
110
 
  </refsect1>
111
 
  
112
 
  <refsect1 id="options">
113
 
    <title>OPTIONS</title>
114
 
    <para>
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.
122
 
    </para>
123
 
    
124
 
    <variablelist>
125
 
      <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>
176
 
    </variablelist>
177
 
  </refsect1>
178
 
  
179
 
  <refsect1 id="exit_status">
180
 
    <title>EXIT STATUS</title>
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.
186
 
    </para>
187
 
  </refsect1>
188
 
  
189
 
  <refsect1 id="environment">
190
 
    <title>ENVIRONMENT</title>
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>
225
 
  </refsect1>
226
 
  
227
 
  <refsect1 id="bugs">
228
 
    <title>BUGS</title>
229
 
    <para>
230
 
      None are known at this time.
231
 
    </para>
232
 
  </refsect1>
233
 
  
234
 
  <refsect1 id="example">
235
 
    <title>EXAMPLE</title>
236
 
    <para>
237
 
      Note that normally, command line options will not be given
238
 
      directly, but via options for the Mandos <citerefentry
239
 
      ><refentrytitle>plugin-runner</refentrytitle>
240
 
      <manvolnum>8mandos</manvolnum></citerefentry>.
241
 
    </para>
242
 
    <informalexample>
243
 
      <para>
244
 
        Normal invocation needs no options:
245
 
      </para>
246
 
      <para>
247
 
        <userinput>&COMMANDNAME;</userinput>
248
 
      </para>
249
 
    </informalexample>
250
 
    <informalexample>
251
 
      <para>
252
 
        Show a prefix before the prompt; in this case, a host name.
253
 
        It might be useful to be reminded of which host needs a
254
 
        password, in case of <acronym>KVM</acronym> switches, etc.
255
 
      </para>
256
 
      <para>
257
 
 
258
 
<!-- do not wrap this line -->
259
 
<userinput>&COMMANDNAME; --prefix=host.example.org:</userinput>
260
 
 
261
 
      </para>
262
 
    </informalexample>
263
 
    <informalexample>
264
 
      <para>
265
 
        Run in debug mode.
266
 
      </para>
267
 
      <para>
268
 
        <!-- do not wrap this line -->
269
 
        <userinput>&COMMANDNAME; --debug</userinput>
270
 
      </para>
271
 
    </informalexample>
272
 
  </refsect1>
273
 
  
274
 
  <refsect1 id="security">
275
 
    <title>SECURITY</title>
276
 
    <para>
277
 
      On its own, this program is very simple, and does not exactly
278
 
      present any security risks.  The one thing that could be
279
 
      considered worthy of note is this: This program is meant to be
280
 
      run by <citerefentry><refentrytitle
281
 
      >plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum>
282
 
      </citerefentry>, and will, when run standalone, outside, in a
283
 
      normal environment, immediately output on its standard output
284
 
      any presumably secret password it just received.  Therefore,
285
 
      when running this program standalone (which should never
286
 
      normally be done), take care not to type in any real secret
287
 
      password by force of habit, since it would then immediately be
288
 
      shown as output.
289
 
    </para>
290
 
    <para>
291
 
      To further alleviate any risk of being locked out of a system,
292
 
      the <citerefentry><refentrytitle>plugin-runner</refentrytitle>
293
 
      <manvolnum>8mandos</manvolnum></citerefentry> has a fallback
294
 
      mode which does the same thing as this program, only with less
295
 
      features.
296
 
    </para>
297
 
  </refsect1>
298
 
  
299
 
  <refsect1 id="see_also">
300
 
    <title>SEE ALSO</title>
301
 
    <para>
302
 
      <citerefentry><refentrytitle>intro</refentrytitle>
303
 
      <manvolnum>8mandos</manvolnum></citerefentry>
304
 
      <citerefentry><refentrytitle>crypttab</refentrytitle>
305
 
      <manvolnum>5</manvolnum></citerefentry>
306
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
307
 
      <manvolnum>8mandos</manvolnum></citerefentry>
308
 
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
309
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
310
 
    </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>.
 
103
    </para>
 
104
 
 
105
    <variablelist>
 
106
      <varlistentry>
 
107
        <term><literal>-p</literal>, <literal>--prefix=<replaceable>PREFIX
 
108
        </replaceable></literal></term>
 
109
        <listitem>
 
110
          <para>
 
111
            Prefix used before the passprompt
 
112
          </para>
 
113
        </listitem>
 
114
      </varlistentry>
 
115
      
 
116
      <varlistentry>
 
117
        <term><literal>--debug</literal></term>
 
118
        <listitem>
 
119
          <para>
 
120
            Debug mode
 
121
          </para>
 
122
        </listitem>
 
123
      </varlistentry>
 
124
      
 
125
      <varlistentry>
 
126
        <term><literal>-?</literal>, <literal>--help</literal></term>
 
127
        <listitem>
 
128
          <para>
 
129
            Gives a help message
 
130
          </para>
 
131
        </listitem>
 
132
      </varlistentry>
 
133
      
 
134
      <varlistentry>
 
135
        <term><literal>--usage</literal></term>
 
136
        <listitem>
 
137
          <para>
 
138
            Gives a short usage message
 
139
          </para>
 
140
        </listitem>
 
141
      </varlistentry>
 
142
 
 
143
      <varlistentry>
 
144
        <term><literal>-V</literal>, <literal>--version</literal></term>
 
145
        <listitem>
 
146
          <para>
 
147
            Prints the program version
 
148
          </para>
 
149
        </listitem>
 
150
      </varlistentry>            
 
151
    </variablelist>
311
152
  </refsect1>
312
153
</refentry>
313
 
<!-- Local Variables: -->
314
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
315
 
<!-- time-stamp-end: "[\"']>" -->
316
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
317
 
<!-- End: -->