/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: 2015-12-05 01:20:26 UTC
  • mfrom: (237.7.341 trunk)
  • Revision ID: teddy@recompile.se-20151205012026-l4honhk310e34s2e
Merge from trunk.

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 "2015-07-20">
 
6
<!ENTITY % common SYSTEM "../common.ent">
 
7
%common;
7
8
]>
8
9
 
9
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
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>
34
42
      <holder>Teddy Hogeborn</holder>
35
43
      <holder>Björn Påhlsson</holder>
36
44
    </copyright>
83
91
    <title>DESCRIPTION</title>
84
92
    <para>
85
93
      All <command>&COMMANDNAME;</command> does is prompt for a
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.
 
94
      password and output any given password to standard output.
 
95
    </para>
 
96
    <para>
 
97
      This program is not very useful on its own.  This program is
 
98
      really meant to run as a plugin in the <application
 
99
      >Mandos</application> client-side system, where it is used as a
 
100
      fallback and alternative to retrieving passwords from a
 
101
      <application >Mandos</application> server.
92
102
    </para>
93
103
    <para>
94
104
      This program is little more than a <citerefentry><refentrytitle
179
189
    <title>ENVIRONMENT</title>
180
190
    <variablelist>
181
191
      <varlistentry>
182
 
        <term><envar>cryptsource</envar></term>
183
 
        <term><envar>crypttarget</envar></term>
 
192
        <term><envar>CRYPTTAB_SOURCE</envar></term>
 
193
        <term><envar>CRYPTTAB_NAME</envar></term>
184
194
        <listitem>
185
195
          <para>
186
196
            If set, these environment variables will be assumed to
194
204
          <manvolnum>8mandos</manvolnum></citerefentry>, which will
195
205
          normally have inherited them from
196
206
          <filename>/scripts/local-top/cryptroot</filename> in the
197
 
          initial RAM disk environment, which will have set them from
198
 
          parsing kernel arguments and
 
207
          initial <acronym>RAM</acronym> disk environment, which will
 
208
          have set them from parsing kernel arguments and
199
209
          <filename>/conf/conf.d/cryptroot</filename> (also in the
200
210
          initial RAM disk environment), which in turn will have been
201
211
          created when the initial RAM disk image was created by
240
250
      <para>
241
251
        Show a prefix before the prompt; in this case, a host name.
242
252
        It might be useful to be reminded of which host needs a
243
 
        password, in case of KVM switches, etc.
 
253
        password, in case of <acronym>KVM</acronym> switches, etc.
244
254
      </para>
245
255
      <para>
246
256
 
270
280
      >plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum>
271
281
      </citerefentry>, and will, when run standalone, outside, in a
272
282
      normal environment, immediately output on its standard output
273
 
      any presumably secret password it just recieved.  Therefore,
 
283
      any presumably secret password it just received.  Therefore,
274
284
      when running this program standalone (which should never
275
285
      normally be done), take care not to type in any real secret
276
286
      password by force of habit, since it would then immediately be
288
298
  <refsect1 id="see_also">
289
299
    <title>SEE ALSO</title>
290
300
    <para>
 
301
      <citerefentry><refentrytitle>intro</refentrytitle>
 
302
      <manvolnum>8mandos</manvolnum></citerefentry>
291
303
      <citerefentry><refentrytitle>crypttab</refentrytitle>
292
304
      <manvolnum>5</manvolnum></citerefentry>
293
 
      <citerefentry><refentrytitle>password-request</refentrytitle>
 
305
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
294
306
      <manvolnum>8mandos</manvolnum></citerefentry>
295
307
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
296
308
      <manvolnum>8mandos</manvolnum></citerefentry>,