/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: 2012-06-22 23:33:56 UTC
  • Revision ID: teddy@recompile.se-20120622233356-odoqqt2ki2gssn37
* Makefile (check): Also check mandos-ctl.
* mandos-ctl: All options taking a time interval argument can now take
              an RFC 3339 duration.
  (rfc3339_duration_to_delta): New function.
  (string_to_delta): Try rfc3339_duration_to_delta first.
  (main): New "--check" option.
* mandos-ctl.xml (SYNOPSIS, OPTIONS): Document new "--check" option.

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-29">
 
5
<!ENTITY TIMESTAMP "2012-01-01">
 
6
<!ENTITY % common SYSTEM "../common.ent">
 
7
%common;
7
8
]>
8
9
 
9
 
<refentry>
 
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
10
11
  <refentryinfo>
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>2011</year>
 
37
      <year>2012</year>
34
38
      <holder>Teddy Hogeborn</holder>
35
39
      <holder>Björn Påhlsson</holder>
36
40
    </copyright>
37
 
    <legalnotice>
38
 
      <para>
39
 
        This manual page is free software: you can redistribute it
40
 
        and/or modify it under the terms of the GNU General Public
41
 
        License as published by the Free Software Foundation,
42
 
        either version 3 of the License, or (at your option) any
43
 
        later version.
44
 
      </para>
45
 
      
46
 
      <para>
47
 
        This manual page is distributed in the hope that it will
48
 
        be useful, but WITHOUT ANY WARRANTY; without even the
49
 
        implied warranty of MERCHANTABILITY or FITNESS FOR A
50
 
        PARTICULAR PURPOSE.  See the GNU General Public License
51
 
        for more details.
52
 
      </para>
53
 
      
54
 
      <para>
55
 
        You should have received a copy of the GNU General Public
56
 
        License along with this program; If not, see
57
 
        <ulink url="http://www.gnu.org/licenses/"/>.
58
 
      </para>
59
 
    </legalnotice>
 
41
    <xi:include href="../legalnotice.xml"/>
60
42
  </refentryinfo>
61
43
  
62
44
  <refmeta>
73
55
    <cmdsynopsis>
74
56
      <command>&COMMANDNAME;</command>
75
57
      <group choice="opt">
76
 
        <arg choice="plain"><option>-p <replaceable
 
58
        <arg choice="plain"><option>--prefix <replaceable
77
59
        >PREFIX</replaceable></option></arg>
78
 
        <arg choice="plain"><option>--prefix </option><replaceable
 
60
        <arg choice="plain"><option>-p </option><replaceable
79
61
        >PREFIX</replaceable></arg>
80
62
      </group>
 
63
      <sbr/>
81
64
      <arg choice="opt"><option>--debug</option></arg>
82
65
    </cmdsynopsis>
83
66
    <cmdsynopsis>
84
67
      <command>&COMMANDNAME;</command>
85
68
      <group choice="req">
 
69
        <arg choice="plain"><option>--help</option></arg>
86
70
        <arg choice="plain"><option>-?</option></arg>
87
 
        <arg choice="plain"><option>--help</option></arg>
88
71
      </group>
89
72
    </cmdsynopsis>
90
73
    <cmdsynopsis>
94
77
    <cmdsynopsis>
95
78
      <command>&COMMANDNAME;</command>
96
79
      <group choice="req">
 
80
        <arg choice="plain"><option>--version</option></arg>
97
81
        <arg choice="plain"><option>-V</option></arg>
98
 
        <arg choice="plain"><option>--version</option></arg>
99
82
      </group>
100
 
    </cmdsynopsis>    
 
83
    </cmdsynopsis>
101
84
  </refsynopsisdiv>
102
85
  
103
86
  <refsect1 id="description">
104
87
    <title>DESCRIPTION</title>
105
88
    <para>
106
89
      All <command>&COMMANDNAME;</command> does is prompt for a
107
 
      password and output any given password to standard output.  This
108
 
      is not very useful on its own.  This program is really meant to
109
 
      run as a plugin in the <application>Mandos</application>
110
 
      client-side system, where it is used as a fallback and
111
 
      alternative to retriving passwords from a <application
112
 
      >Mandos</application> server.
 
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.
113
98
    </para>
114
99
    <para>
115
100
      This program is little more than a <citerefentry><refentrytitle
133
118
    
134
119
    <variablelist>
135
120
      <varlistentry>
136
 
        <term><option>-p</option> <replaceable>PREFIX</replaceable
137
 
        ></term>
138
 
        <term><option>--prefix=</option><replaceable
139
 
        >PREFIX</replaceable></term>
 
121
        <term><option>--prefix=<replaceable
 
122
        >PREFIX</replaceable></option></term>
 
123
        <term><option>-p
 
124
        <replaceable>PREFIX</replaceable></option></term>
140
125
        <listitem>
141
126
          <para>
142
127
            Prefix string shown before the password prompt.
156
141
      </varlistentry>
157
142
      
158
143
      <varlistentry>
 
144
        <term><option>--help</option></term>
159
145
        <term><option>-?</option></term>
160
 
        <term><option>--help</option></term>
161
146
        <listitem>
162
147
          <para>
163
148
            Gives a help message about options and their meanings.
175
160
      </varlistentry>
176
161
      
177
162
      <varlistentry>
 
163
        <term><option>--version</option></term>
178
164
        <term><option>-V</option></term>
179
 
        <term><option>--version</option></term>
180
165
        <listitem>
181
166
          <para>
182
167
            Prints the program version.
183
168
          </para>
184
169
        </listitem>
185
 
      </varlistentry>            
 
170
      </varlistentry>
186
171
    </variablelist>
187
172
  </refsect1>
188
173
  
200
185
    <title>ENVIRONMENT</title>
201
186
    <variablelist>
202
187
      <varlistentry>
203
 
        <term><envar>cryptsource</envar></term>
204
 
        <term><envar>crypttarget</envar></term>
 
188
        <term><envar>CRYPTTAB_SOURCE</envar></term>
 
189
        <term><envar>CRYPTTAB_NAME</envar></term>
205
190
        <listitem>
206
191
          <para>
207
192
            If set, these environment variables will be assumed to
215
200
          <manvolnum>8mandos</manvolnum></citerefentry>, which will
216
201
          normally have inherited them from
217
202
          <filename>/scripts/local-top/cryptroot</filename> in the
218
 
          initial RAM disk environment, which will have set them from
219
 
          parsing kernel arguments and
 
203
          initial <acronym>RAM</acronym> disk environment, which will
 
204
          have set them from parsing kernel arguments and
220
205
          <filename>/conf/conf.d/cryptroot</filename> (also in the
221
206
          initial RAM disk environment), which in turn will have been
222
207
          created when the initial RAM disk image was created by
239
224
    <para>
240
225
      None are known at this time.
241
226
    </para>
242
 
  </refsect1>  
 
227
  </refsect1>
243
228
  
244
229
  <refsect1 id="example">
245
230
    <title>EXAMPLE</title>
261
246
      <para>
262
247
        Show a prefix before the prompt; in this case, a host name.
263
248
        It might be useful to be reminded of which host needs a
264
 
        password, in case of KVM switches, etc.
 
249
        password, in case of <acronym>KVM</acronym> switches, etc.
265
250
      </para>
266
251
      <para>
267
252
 
291
276
      >plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum>
292
277
      </citerefentry>, and will, when run standalone, outside, in a
293
278
      normal environment, immediately output on its standard output
294
 
      any presumably secret password it just recieved.  Therefore,
 
279
      any presumably secret password it just received.  Therefore,
295
280
      when running this program standalone (which should never
296
281
      normally be done), take care not to type in any real secret
297
282
      password by force of habit, since it would then immediately be
309
294
  <refsect1 id="see_also">
310
295
    <title>SEE ALSO</title>
311
296
    <para>
 
297
      <citerefentry><refentrytitle>intro</refentrytitle>
 
298
      <manvolnum>8mandos</manvolnum></citerefentry>
312
299
      <citerefentry><refentrytitle>crypttab</refentrytitle>
313
300
      <manvolnum>5</manvolnum></citerefentry>
314
 
      <citerefentry><refentrytitle>password-request</refentrytitle>
 
301
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
315
302
      <manvolnum>8mandos</manvolnum></citerefentry>
316
303
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
317
304
      <manvolnum>8mandos</manvolnum></citerefentry>,