/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: 2018-08-19 16:10:20 UTC
  • Revision ID: teddy@recompile.se-20180819161020-mmtrdp553n9y7ilo
Use new header "Rules-Requires-Root" in debian/control

* debian/control (Source: mandos/Rules-Requires-Root): New; set to
  "binary-targets".

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">
5
4
<!ENTITY COMMANDNAME "password-prompt">
6
 
<!ENTITY TIMESTAMP "2008-08-31">
 
5
<!ENTITY TIMESTAMP "2018-02-08">
 
6
<!ENTITY % common SYSTEM "../common.ent">
 
7
%common;
7
8
]>
8
9
 
9
 
<refentry>
 
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
10
11
  <refentryinfo>
11
12
    <title>Mandos Manual</title>
12
13
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
13
14
    <productname>Mandos</productname>
14
 
    <productnumber>&VERSION;</productnumber>
 
15
    <productnumber>&version;</productnumber>
15
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>
 
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>
34
45
      <holder>Teddy Hogeborn</holder>
35
46
      <holder>Björn Påhlsson</holder>
36
47
    </copyright>
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>
 
48
    <xi:include href="../legalnotice.xml"/>
60
49
  </refentryinfo>
61
50
  
62
51
  <refmeta>
105
94
    <title>DESCRIPTION</title>
106
95
    <para>
107
96
      All <command>&COMMANDNAME;</command> does is prompt for a
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.
 
97
      password and output any given password to standard output.
 
98
    </para>
 
99
    <para>
 
100
      This program is not very useful on its own.  This program is
 
101
      really meant to run as a plugin in the <application
 
102
      >Mandos</application> client-side system, where it is used as a
 
103
      fallback and alternative to retrieving passwords from a
 
104
      <application >Mandos</application> server.
114
105
    </para>
115
106
    <para>
116
107
      This program is little more than a <citerefentry><refentrytitle
134
125
    
135
126
    <variablelist>
136
127
      <varlistentry>
137
 
        <term><option>-p</option> <replaceable>PREFIX</replaceable
138
 
        ></term>
139
 
        <term><option>--prefix=</option><replaceable
140
 
        >PREFIX</replaceable></term>
 
128
        <term><option>--prefix=<replaceable
 
129
        >PREFIX</replaceable></option></term>
 
130
        <term><option>-p
 
131
        <replaceable>PREFIX</replaceable></option></term>
141
132
        <listitem>
142
133
          <para>
143
134
            Prefix string shown before the password prompt.
157
148
      </varlistentry>
158
149
      
159
150
      <varlistentry>
 
151
        <term><option>--help</option></term>
160
152
        <term><option>-?</option></term>
161
 
        <term><option>--help</option></term>
162
153
        <listitem>
163
154
          <para>
164
155
            Gives a help message about options and their meanings.
176
167
      </varlistentry>
177
168
      
178
169
      <varlistentry>
 
170
        <term><option>--version</option></term>
179
171
        <term><option>-V</option></term>
180
 
        <term><option>--version</option></term>
181
172
        <listitem>
182
173
          <para>
183
174
            Prints the program version.
201
192
    <title>ENVIRONMENT</title>
202
193
    <variablelist>
203
194
      <varlistentry>
204
 
        <term><envar>cryptsource</envar></term>
205
 
        <term><envar>crypttarget</envar></term>
 
195
        <term><envar>CRYPTTAB_SOURCE</envar></term>
 
196
        <term><envar>CRYPTTAB_NAME</envar></term>
206
197
        <listitem>
207
198
          <para>
208
199
            If set, these environment variables will be assumed to
216
207
          <manvolnum>8mandos</manvolnum></citerefentry>, which will
217
208
          normally have inherited them from
218
209
          <filename>/scripts/local-top/cryptroot</filename> in the
219
 
          initial RAM disk environment, which will have set them from
220
 
          parsing kernel arguments and
 
210
          initial <acronym>RAM</acronym> disk environment, which will
 
211
          have set them from parsing kernel arguments and
221
212
          <filename>/conf/conf.d/cryptroot</filename> (also in the
222
213
          initial RAM disk environment), which in turn will have been
223
214
          created when the initial RAM disk image was created by
237
228
  
238
229
  <refsect1 id="bugs">
239
230
    <title>BUGS</title>
240
 
    <para>
241
 
      None are known at this time.
242
 
    </para>
 
231
    <xi:include href="../bugs.xml"/>
243
232
  </refsect1>
244
233
  
245
234
  <refsect1 id="example">
262
251
      <para>
263
252
        Show a prefix before the prompt; in this case, a host name.
264
253
        It might be useful to be reminded of which host needs a
265
 
        password, in case of KVM switches, etc.
 
254
        password, in case of <acronym>KVM</acronym> switches, etc.
266
255
      </para>
267
256
      <para>
268
257
 
292
281
      >plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum>
293
282
      </citerefentry>, and will, when run standalone, outside, in a
294
283
      normal environment, immediately output on its standard output
295
 
      any presumably secret password it just recieved.  Therefore,
 
284
      any presumably secret password it just received.  Therefore,
296
285
      when running this program standalone (which should never
297
286
      normally be done), take care not to type in any real secret
298
287
      password by force of habit, since it would then immediately be
310
299
  <refsect1 id="see_also">
311
300
    <title>SEE ALSO</title>
312
301
    <para>
 
302
      <citerefentry><refentrytitle>intro</refentrytitle>
 
303
      <manvolnum>8mandos</manvolnum></citerefentry>
313
304
      <citerefentry><refentrytitle>crypttab</refentrytitle>
314
305
      <manvolnum>5</manvolnum></citerefentry>
315
 
      <citerefentry><refentrytitle>password-request</refentrytitle>
 
306
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
316
307
      <manvolnum>8mandos</manvolnum></citerefentry>
317
308
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
318
309
      <manvolnum>8mandos</manvolnum></citerefentry>,