/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-08-19 23:44:17 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080819234417-8dz5prw19ihrklx6
* Makefile (DOCBOOKTOMAN): Include all DocBook-to-manpage-related
                           commands here, and use it everywhere.
  (mandos.8, mandos.conf.5): New; also depend on "mandos-options.xml".

* mandos-keygen.xml: Removed OVERVIEW entity.  Add XInclude namespace.
  (OVERVIEW): Changed to do <xi:include/>.

* mandos-options.xml (<simplesect>): Changed to a <section>.
  ([@id="address"]): Reordered sentences.

* mandos.conf.xml (OPTIONS): Removed illegal <arg> tags.
  (EXAMPLE): Added empty example.

* mandos.xml (NETWORK PROTOCOL): Bug fix: Changed "1\r\en" back to
                                 "1\r\n".
  (CHECKING): Do not refer to the non-relevant mandos.conf(5) manual.

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