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