/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: 2018-02-22 18:34:39 UTC
  • mfrom: (237.7.490 trunk)
  • Revision ID: teddy@recompile.se-20180222183439-ardlmmsvs6jbkp8x
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-09-01">
 
5
<!ENTITY TIMESTAMP "2018-02-08">
 
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>
 
42
      <year>2016</year>
 
43
      <year>2017</year>
 
44
      <year>2018</year>
34
45
      <holder>Teddy Hogeborn</holder>
35
46
      <holder>Björn Påhlsson</holder>
36
47
    </copyright>
83
94
    <title>DESCRIPTION</title>
84
95
    <para>
85
96
      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.
 
97
      password and output any given password to standard output.
 
98
    </para>
 
99
    <para>
 
100
      This program is not very useful on its own.  This program is
 
101
      really meant to run as a plugin in the <application
 
102
      >Mandos</application> client-side system, where it is used as a
 
103
      fallback and alternative to retrieving passwords from a
 
104
      <application >Mandos</application> server.
92
105
    </para>
93
106
    <para>
94
107
      This program is little more than a <citerefentry><refentrytitle
179
192
    <title>ENVIRONMENT</title>
180
193
    <variablelist>
181
194
      <varlistentry>
182
 
        <term><envar>cryptsource</envar></term>
183
 
        <term><envar>crypttarget</envar></term>
 
195
        <term><envar>CRYPTTAB_SOURCE</envar></term>
 
196
        <term><envar>CRYPTTAB_NAME</envar></term>
184
197
        <listitem>
185
198
          <para>
186
199
            If set, these environment variables will be assumed to
215
228
  
216
229
  <refsect1 id="bugs">
217
230
    <title>BUGS</title>
218
 
    <para>
219
 
      None are known at this time.
220
 
    </para>
 
231
    <xi:include href="../bugs.xml"/>
221
232
  </refsect1>
222
233
  
223
234
  <refsect1 id="example">
240
251
      <para>
241
252
        Show a prefix before the prompt; in this case, a host name.
242
253
        It might be useful to be reminded of which host needs a
243
 
        password, in case of KVM switches, etc.
 
254
        password, in case of <acronym>KVM</acronym> switches, etc.
244
255
      </para>
245
256
      <para>
246
257
 
270
281
      >plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum>
271
282
      </citerefentry>, and will, when run standalone, outside, in a
272
283
      normal environment, immediately output on its standard output
273
 
      any presumably secret password it just recieved.  Therefore,
 
284
      any presumably secret password it just received.  Therefore,
274
285
      when running this program standalone (which should never
275
286
      normally be done), take care not to type in any real secret
276
287
      password by force of habit, since it would then immediately be
288
299
  <refsect1 id="see_also">
289
300
    <title>SEE ALSO</title>
290
301
    <para>
 
302
      <citerefentry><refentrytitle>intro</refentrytitle>
 
303
      <manvolnum>8mandos</manvolnum></citerefentry>
291
304
      <citerefentry><refentrytitle>crypttab</refentrytitle>
292
305
      <manvolnum>5</manvolnum></citerefentry>
293
 
      <citerefentry><refentrytitle>password-request</refentrytitle>
 
306
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
294
307
      <manvolnum>8mandos</manvolnum></citerefentry>
295
308
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
296
309
      <manvolnum>8mandos</manvolnum></citerefentry>,