/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

merge

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-02-10">
6
 
<!ENTITY % common SYSTEM "../common.ent">
7
 
%common;
 
6
<!ENTITY TIMESTAMP "2008-08-31">
8
7
]>
9
8
 
10
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
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>
95
83
    <title>DESCRIPTION</title>
96
84
    <para>
97
85
      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.
 
86
      password and output any given password to standard output.  This
 
87
      is not very useful on its own.  This program is really meant to
 
88
      run as a plugin in the <application>Mandos</application>
 
89
      client-side system, where it is used as a fallback and
 
90
      alternative to retriving passwords from a <application
 
91
      >Mandos</application> server.
106
92
    </para>
107
93
    <para>
108
94
      This program is little more than a <citerefentry><refentrytitle
193
179
    <title>ENVIRONMENT</title>
194
180
    <variablelist>
195
181
      <varlistentry>
196
 
        <term><envar>CRYPTTAB_SOURCE</envar></term>
197
 
        <term><envar>CRYPTTAB_NAME</envar></term>
 
182
        <term><envar>cryptsource</envar></term>
 
183
        <term><envar>crypttarget</envar></term>
198
184
        <listitem>
199
185
          <para>
200
186
            If set, these environment variables will be assumed to
208
194
          <manvolnum>8mandos</manvolnum></citerefentry>, which will
209
195
          normally have inherited them from
210
196
          <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
 
197
          initial RAM disk environment, which will have set them from
 
198
          parsing kernel arguments and
213
199
          <filename>/conf/conf.d/cryptroot</filename> (also in the
214
200
          initial RAM disk environment), which in turn will have been
215
201
          created when the initial RAM disk image was created by
229
215
  
230
216
  <refsect1 id="bugs">
231
217
    <title>BUGS</title>
232
 
    <xi:include href="../bugs.xml"/>
 
218
    <para>
 
219
      None are known at this time.
 
220
    </para>
233
221
  </refsect1>
234
222
  
235
223
  <refsect1 id="example">
252
240
      <para>
253
241
        Show a prefix before the prompt; in this case, a host name.
254
242
        It might be useful to be reminded of which host needs a
255
 
        password, in case of <acronym>KVM</acronym> switches, etc.
 
243
        password, in case of KVM switches, etc.
256
244
      </para>
257
245
      <para>
258
246
 
282
270
      >plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum>
283
271
      </citerefentry>, and will, when run standalone, outside, in a
284
272
      normal environment, immediately output on its standard output
285
 
      any presumably secret password it just received.  Therefore,
 
273
      any presumably secret password it just recieved.  Therefore,
286
274
      when running this program standalone (which should never
287
275
      normally be done), take care not to type in any real secret
288
276
      password by force of habit, since it would then immediately be
300
288
  <refsect1 id="see_also">
301
289
    <title>SEE ALSO</title>
302
290
    <para>
303
 
      <citerefentry><refentrytitle>intro</refentrytitle>
304
 
      <manvolnum>8mandos</manvolnum></citerefentry>
305
291
      <citerefentry><refentrytitle>crypttab</refentrytitle>
306
292
      <manvolnum>5</manvolnum></citerefentry>
307
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
293
      <citerefentry><refentrytitle>password-request</refentrytitle>
308
294
      <manvolnum>8mandos</manvolnum></citerefentry>
309
295
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
310
296
      <manvolnum>8mandos</manvolnum></citerefentry>,