/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

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 "2011-10-03">
6
 
<!ENTITY % common SYSTEM "../common.ent">
7
 
%common;
 
6
<!ENTITY TIMESTAMP "2008-09-01">
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>2011</year>
37
34
      <holder>Teddy Hogeborn</holder>
38
35
      <holder>Björn Påhlsson</holder>
39
36
    </copyright>
86
83
    <title>DESCRIPTION</title>
87
84
    <para>
88
85
      All <command>&COMMANDNAME;</command> does is prompt for a
89
 
      password and output any given password to standard output.
90
 
    </para>
91
 
    <para>
92
 
      This program is not very useful on its own.  This program is
93
 
      really meant to run as a plugin in the <application
94
 
      >Mandos</application> client-side system, where it is used as a
95
 
      fallback and alternative to retrieving passwords from a
96
 
      <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.
97
92
    </para>
98
93
    <para>
99
94
      This program is little more than a <citerefentry><refentrytitle
184
179
    <title>ENVIRONMENT</title>
185
180
    <variablelist>
186
181
      <varlistentry>
187
 
        <term><envar>CRYPTTAB_SOURCE</envar></term>
188
 
        <term><envar>CRYPTTAB_NAME</envar></term>
 
182
        <term><envar>cryptsource</envar></term>
 
183
        <term><envar>crypttarget</envar></term>
189
184
        <listitem>
190
185
          <para>
191
186
            If set, these environment variables will be assumed to
245
240
      <para>
246
241
        Show a prefix before the prompt; in this case, a host name.
247
242
        It might be useful to be reminded of which host needs a
248
 
        password, in case of <acronym>KVM</acronym> switches, etc.
 
243
        password, in case of KVM switches, etc.
249
244
      </para>
250
245
      <para>
251
246
 
275
270
      >plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum>
276
271
      </citerefentry>, and will, when run standalone, outside, in a
277
272
      normal environment, immediately output on its standard output
278
 
      any presumably secret password it just received.  Therefore,
 
273
      any presumably secret password it just recieved.  Therefore,
279
274
      when running this program standalone (which should never
280
275
      normally be done), take care not to type in any real secret
281
276
      password by force of habit, since it would then immediately be
293
288
  <refsect1 id="see_also">
294
289
    <title>SEE ALSO</title>
295
290
    <para>
296
 
      <citerefentry><refentrytitle>intro</refentrytitle>
297
 
      <manvolnum>8mandos</manvolnum></citerefentry>
298
291
      <citerefentry><refentrytitle>crypttab</refentrytitle>
299
292
      <manvolnum>5</manvolnum></citerefentry>
300
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
293
      <citerefentry><refentrytitle>password-request</refentrytitle>
301
294
      <manvolnum>8mandos</manvolnum></citerefentry>
302
295
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
303
296
      <manvolnum>8mandos</manvolnum></citerefentry>,