/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: 2011-02-27 17:26:35 UTC
  • Revision ID: teddy@fukt.bsnet.se-20110227172635-hw1sire7k3vuo1co
Update copyright year to "2011" wherever appropriate.

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 "2009-10-30">
 
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>
31
32
    </authorgroup>
32
33
    <copyright>
33
34
      <year>2008</year>
 
35
      <year>2009</year>
34
36
      <holder>Teddy Hogeborn</holder>
35
37
      <holder>Björn Påhlsson</holder>
36
38
    </copyright>
83
85
    <title>DESCRIPTION</title>
84
86
    <para>
85
87
      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.
 
88
      password and output any given password to standard output.
 
89
    </para>
 
90
    <para>
 
91
      This program is not very useful on its own.  This program is
 
92
      really meant to run as a plugin in the <application
 
93
      >Mandos</application> client-side system, where it is used as a
 
94
      fallback and alternative to retrieving passwords from a
 
95
      <application >Mandos</application> server.
92
96
    </para>
93
97
    <para>
94
98
      This program is little more than a <citerefentry><refentrytitle
179
183
    <title>ENVIRONMENT</title>
180
184
    <variablelist>
181
185
      <varlistentry>
182
 
        <term><envar>cryptsource</envar></term>
183
 
        <term><envar>crypttarget</envar></term>
 
186
        <term><envar>CRYPTTAB_SOURCE</envar></term>
 
187
        <term><envar>CRYPTTAB_NAME</envar></term>
184
188
        <listitem>
185
189
          <para>
186
190
            If set, these environment variables will be assumed to
194
198
          <manvolnum>8mandos</manvolnum></citerefentry>, which will
195
199
          normally have inherited them from
196
200
          <filename>/scripts/local-top/cryptroot</filename> in the
197
 
          initial RAM disk environment, which will have set them from
198
 
          parsing kernel arguments and
 
201
          initial <acronym>RAM</acronym> disk environment, which will
 
202
          have set them from parsing kernel arguments and
199
203
          <filename>/conf/conf.d/cryptroot</filename> (also in the
200
204
          initial RAM disk environment), which in turn will have been
201
205
          created when the initial RAM disk image was created by
240
244
      <para>
241
245
        Show a prefix before the prompt; in this case, a host name.
242
246
        It might be useful to be reminded of which host needs a
243
 
        password, in case of KVM switches, etc.
 
247
        password, in case of <acronym>KVM</acronym> switches, etc.
244
248
      </para>
245
249
      <para>
246
250
 
270
274
      >plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum>
271
275
      </citerefentry>, and will, when run standalone, outside, in a
272
276
      normal environment, immediately output on its standard output
273
 
      any presumably secret password it just recieved.  Therefore,
 
277
      any presumably secret password it just received.  Therefore,
274
278
      when running this program standalone (which should never
275
279
      normally be done), take care not to type in any real secret
276
280
      password by force of habit, since it would then immediately be
290
294
    <para>
291
295
      <citerefentry><refentrytitle>crypttab</refentrytitle>
292
296
      <manvolnum>5</manvolnum></citerefentry>
293
 
      <citerefentry><refentrytitle>password-request</refentrytitle>
 
297
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
294
298
      <manvolnum>8mandos</manvolnum></citerefentry>
295
299
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
296
300
      <manvolnum>8mandos</manvolnum></citerefentry>,