/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

removed old/unspecified todo's

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