/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: 2008-08-31 08:47:38 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080831084738-uu70kayyt876982d
* mandos-keygen: Minor help text change.

* mandos-keygen.xml: Changed plural "keys" to singular "key"
                     throughout.
  (NAME): Improved wording.
  (DESCRIPTION): Improved wording.
  (OPTIONS): Split options in <term> tags into separate <term> tags.
             Use <option> tags.  Move long options before short
             options.  Uppercase replaceables.
  (OVERVIEW): Improved wording.
  (EXIT STATUS): Also cover --password option.
  (EXAMPLE): Add two examples using the --password option.
  (SECURITY): Improved wording.

* overview.xml: Improved wording.

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugins.d/password-prompt.xml
1
1
<?xml version="1.0" encoding="UTF-8"?>
2
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
3
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
 
4
<!ENTITY VERSION "1.0">
4
5
<!ENTITY COMMANDNAME "password-prompt">
5
 
<!ENTITY TIMESTAMP "2019-07-27">
6
 
<!ENTITY % common SYSTEM "../common.ent">
7
 
%common;
 
6
<!ENTITY TIMESTAMP "2008-08-31">
8
7
]>
9
8
 
10
 
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
 
9
<refentry>
11
10
  <refentryinfo>
12
11
    <title>Mandos Manual</title>
13
12
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
14
13
    <productname>Mandos</productname>
15
 
    <productnumber>&version;</productnumber>
 
14
    <productnumber>&VERSION;</productnumber>
16
15
    <date>&TIMESTAMP;</date>
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
34
      <holder>Teddy Hogeborn</holder>
47
35
      <holder>Björn Påhlsson</holder>
48
36
    </copyright>
49
 
    <xi:include href="../legalnotice.xml"/>
 
37
    <legalnotice>
 
38
      <para>
 
39
        This manual page is free software: you can redistribute it
 
40
        and/or modify it under the terms of the GNU General Public
 
41
        License as published by the Free Software Foundation,
 
42
        either version 3 of the License, or (at your option) any
 
43
        later version.
 
44
      </para>
 
45
      
 
46
      <para>
 
47
        This manual page is distributed in the hope that it will
 
48
        be useful, but WITHOUT ANY WARRANTY; without even the
 
49
        implied warranty of MERCHANTABILITY or FITNESS FOR A
 
50
        PARTICULAR PURPOSE.  See the GNU General Public License
 
51
        for more details.
 
52
      </para>
 
53
      
 
54
      <para>
 
55
        You should have received a copy of the GNU General Public
 
56
        License along with this program; If not, see
 
57
        <ulink url="http://www.gnu.org/licenses/"/>.
 
58
      </para>
 
59
    </legalnotice>
50
60
  </refentryinfo>
51
61
  
52
62
  <refmeta>
69
79
        >PREFIX</replaceable></arg>
70
80
      </group>
71
81
      <sbr/>
72
 
      <arg choice="opt">
73
 
        <option>--prompt <replaceable>PROMPT</replaceable></option>
74
 
      </arg>
75
82
      <arg choice="opt"><option>--debug</option></arg>
76
83
    </cmdsynopsis>
77
84
    <cmdsynopsis>
98
105
    <title>DESCRIPTION</title>
99
106
    <para>
100
107
      All <command>&COMMANDNAME;</command> does is prompt for a
101
 
      password and output any given password to standard output.
102
 
    </para>
103
 
    <para>
104
 
      This program is not very useful on its own.  This program is
105
 
      really meant to run as a plugin in the <application
106
 
      >Mandos</application> client-side system, where it is used as a
107
 
      fallback and alternative to retrieving passwords from a
108
 
      <application >Mandos</application> server.
 
108
      password and output any given password to standard output.  This
 
109
      is not very useful on its own.  This program is really meant to
 
110
      run as a plugin in the <application>Mandos</application>
 
111
      client-side system, where it is used as a fallback and
 
112
      alternative to retriving passwords from a <application
 
113
      >Mandos</application> server.
109
114
    </para>
110
115
    <para>
111
116
      This program is little more than a <citerefentry><refentrytitle
113
118
      wrapper, although actual use of that function is not guaranteed
114
119
      or implied.
115
120
    </para>
116
 
    <para>
117
 
      This program tries to detect if a Plymouth daemon
118
 
      (<citerefentry><refentrytitle
119
 
      >plymouthd</refentrytitle><manvolnum>8</manvolnum></citerefentry>)
120
 
      is running, by looking for a
121
 
      <filename>/run/plymouth/pid</filename> file or a process named
122
 
      <quote><literal>plymouthd</literal></quote>.  If it is detected,
123
 
      this process will immediately exit without doing anything.
124
 
    </para>
125
121
  </refsect1>
126
122
  
127
123
  <refsect1 id="options">
138
134
    
139
135
    <variablelist>
140
136
      <varlistentry>
141
 
        <term><option>--prefix=<replaceable
142
 
        >PREFIX</replaceable></option></term>
143
 
        <term><option>-p
144
 
        <replaceable>PREFIX</replaceable></option></term>
 
137
        <term><option>-p</option> <replaceable>PREFIX</replaceable
 
138
        ></term>
 
139
        <term><option>--prefix=</option><replaceable
 
140
        >PREFIX</replaceable></term>
145
141
        <listitem>
146
142
          <para>
147
143
            Prefix string shown before the password prompt.
150
146
      </varlistentry>
151
147
      
152
148
      <varlistentry>
153
 
        <term><option>--prompt=<replaceable
154
 
        >PROMPT</replaceable></option></term>
155
 
        <listitem>
156
 
          <para>
157
 
            The password prompt.  Using this option will make this
158
 
            program ignore the <envar>CRYPTTAB_SOURCE</envar> and
159
 
            <envar>CRYPTTAB_NAME</envar> environment variables.
160
 
          </para>
161
 
        </listitem>
162
 
      </varlistentry>
163
 
      
164
 
      <varlistentry>
165
149
        <term><option>--debug</option></term>
166
150
        <listitem>
167
151
          <para>
173
157
      </varlistentry>
174
158
      
175
159
      <varlistentry>
 
160
        <term><option>-?</option></term>
176
161
        <term><option>--help</option></term>
177
 
        <term><option>-?</option></term>
178
162
        <listitem>
179
163
          <para>
180
164
            Gives a help message about options and their meanings.
192
176
      </varlistentry>
193
177
      
194
178
      <varlistentry>
 
179
        <term><option>-V</option></term>
195
180
        <term><option>--version</option></term>
196
 
        <term><option>-V</option></term>
197
181
        <listitem>
198
182
          <para>
199
183
            Prints the program version.
217
201
    <title>ENVIRONMENT</title>
218
202
    <variablelist>
219
203
      <varlistentry>
220
 
        <term><envar>CRYPTTAB_SOURCE</envar></term>
221
 
        <term><envar>CRYPTTAB_NAME</envar></term>
 
204
        <term><envar>cryptsource</envar></term>
 
205
        <term><envar>crypttarget</envar></term>
222
206
        <listitem>
223
207
          <para>
224
 
            If set, and if the <option>--prompt</option> option is not
225
 
            used, these environment variables will be assumed to
 
208
            If set, these environment variables will be assumed to
226
209
            contain the source device name and the target device
227
210
            mapper name, respectively, and will be shown as part of
228
211
            the prompt.
230
213
        <para>
231
214
          These variables will normally be inherited from
232
215
          <citerefentry><refentrytitle>plugin-runner</refentrytitle>
233
 
          <manvolnum>8mandos</manvolnum></citerefentry>, which might
234
 
          have in turn inherited them from its calling process.
 
216
          <manvolnum>8mandos</manvolnum></citerefentry>, which will
 
217
          normally have inherited them from
 
218
          <filename>/scripts/local-top/cryptroot</filename> in the
 
219
          initial RAM disk environment, which will have set them from
 
220
          parsing kernel arguments and
 
221
          <filename>/conf/conf.d/cryptroot</filename> (also in the
 
222
          initial RAM disk environment), which in turn will have been
 
223
          created when the initial RAM disk image was created by
 
224
          <filename
 
225
          >/usr/share/initramfs-tools/hooks/cryptroot</filename>, by
 
226
          extracting the information of the root file system from
 
227
          <filename >/etc/crypttab</filename>.
235
228
        </para>
236
229
        <para>
237
230
          This behavior is meant to exactly mirror the behavior of
238
 
          <command>askpass</command>, the default password prompter
239
 
          from initramfs-tools.
 
231
          <command>askpass</command>, the default password prompter.
240
232
        </para>
241
233
        </listitem>
242
234
      </varlistentry>
245
237
  
246
238
  <refsect1 id="bugs">
247
239
    <title>BUGS</title>
248
 
    <xi:include href="../bugs.xml"/>
 
240
    <para>
 
241
      None are known at this time.
 
242
    </para>
249
243
  </refsect1>
250
244
  
251
245
  <refsect1 id="example">
268
262
      <para>
269
263
        Show a prefix before the prompt; in this case, a host name.
270
264
        It might be useful to be reminded of which host needs a
271
 
        password, in case of <acronym>KVM</acronym> switches, etc.
 
265
        password, in case of KVM switches, etc.
272
266
      </para>
273
267
      <para>
274
268
 
298
292
      >plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum>
299
293
      </citerefentry>, and will, when run standalone, outside, in a
300
294
      normal environment, immediately output on its standard output
301
 
      any presumably secret password it just received.  Therefore,
 
295
      any presumably secret password it just recieved.  Therefore,
302
296
      when running this program standalone (which should never
303
297
      normally be done), take care not to type in any real secret
304
298
      password by force of habit, since it would then immediately be
316
310
  <refsect1 id="see_also">
317
311
    <title>SEE ALSO</title>
318
312
    <para>
319
 
      <citerefentry><refentrytitle>intro</refentrytitle>
320
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
321
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
322
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
313
      <citerefentry><refentrytitle>crypttab</refentrytitle>
 
314
      <manvolnum>5</manvolnum></citerefentry>
 
315
      <citerefentry><refentrytitle>password-request</refentrytitle>
 
316
      <manvolnum>8mandos</manvolnum></citerefentry>
323
317
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
324
318
      <manvolnum>8mandos</manvolnum></citerefentry>,
325
 
      <citerefentry><refentrytitle>plymouthd</refentrytitle>
326
 
      <manvolnum>8</manvolnum></citerefentry>
327
319
    </para>
328
320
  </refsect1>
329
321
</refentry>