/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: 2019-07-25 22:44:36 UTC
  • Revision ID: teddy@recompile.se-20190725224436-19eyd06r7qmtowo6
Allow line breaks on long lines in plugin-runner manual

* debian/mandos-client.lintian-overrides
  (manpage-has-errors-from-man): Remove.
* plugin-runner.xml (EXAMPLE): Allow line breaks by adding ZERO WIDTH
                               SPACE characters.  Also correct
                               description of example command line.

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 "2019-02-10">
 
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
      <year>2017</year>
 
44
      <year>2018</year>
 
45
      <year>2019</year>
 
46
      <holder>Teddy Hogeborn</holder>
 
47
      <holder>Björn Påhlsson</holder>
35
48
    </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>
 
49
    <xi:include href="../legalnotice.xml"/>
59
50
  </refentryinfo>
60
 
 
 
51
  
61
52
  <refmeta>
62
53
    <refentrytitle>&COMMANDNAME;</refentrytitle>
63
54
    <manvolnum>8mandos</manvolnum>
65
56
  
66
57
  <refnamediv>
67
58
    <refname><command>&COMMANDNAME;</command></refname>
68
 
    <refpurpose>
69
 
      Passprompt for luks during boot sequence
70
 
    </refpurpose>
 
59
    <refpurpose>Prompt for a password and output it.</refpurpose>
71
60
  </refnamediv>
72
61
  
73
62
  <refsynopsisdiv>
74
63
    <cmdsynopsis>
75
64
      <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>    
 
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>
91
92
  </refsynopsisdiv>
92
 
 
 
93
  
93
94
  <refsect1 id="description">
94
95
    <title>DESCRIPTION</title>
95
96
    <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>.
 
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.
103
112
    </para>
104
113
  </refsect1>
105
114
  
106
115
  <refsect1 id="options">
107
116
    <title>OPTIONS</title>
108
117
    <para>
109
 
      Commonly not invoked as command lines but from configuration
110
 
      file of plugin runner.
 
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.
111
125
    </para>
112
 
 
 
126
    
113
127
    <variablelist>
114
128
      <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>            
 
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>
159
179
    </variablelist>
160
180
  </refsect1>
161
 
 
 
181
  
162
182
  <refsect1 id="exit_status">
163
183
    <title>EXIT STATUS</title>
164
184
    <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.
165
189
    </para>
166
190
  </refsect1>
167
 
 
 
191
  
168
192
  <refsect1 id="environment">
169
193
    <title>ENVIRONMENT</title>
170
 
    <para>
171
 
    </para>
172
 
  </refsect1>
173
 
 
174
 
  <refsect1 id="files">
175
 
    <title>FILES</title>
176
 
    <para>
177
 
    </para>
 
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>
178
228
  </refsect1>
179
229
  
180
230
  <refsect1 id="bugs">
181
231
    <title>BUGS</title>
182
 
    <para>
183
 
    </para>
184
 
  </refsect1>  
185
 
 
 
232
    <xi:include href="../bugs.xml"/>
 
233
  </refsect1>
 
234
  
186
235
  <refsect1 id="example">
187
236
    <title>EXAMPLE</title>
188
237
    <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>.
189
242
    </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>
190
273
  </refsect1>
191
 
 
 
274
  
192
275
  <refsect1 id="security">
193
276
    <title>SECURITY</title>
194
277
    <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.
195
297
    </para>
196
298
  </refsect1>
197
 
 
 
299
  
198
300
  <refsect1 id="see_also">
199
301
    <title>SEE ALSO</title>
200
302
    <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>
 
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>,
207
311
    </para>
208
 
  </refsect1>  
209
 
  
 
312
  </refsect1>
210
313
</refentry>
 
314
<!-- Local Variables: -->
 
315
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
316
<!-- time-stamp-end: "[\"']>" -->
 
317
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
318
<!-- End: -->