/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: 2009-11-09 07:35:16 UTC
  • Revision ID: teddy@fukt.bsnet.se-20091109073516-v1vem352uz0vuwrd
* dbus-mandos.conf: New; to be copied to
                    "/etc/dbus-1/system.d/mandos.conf".

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 "2009-10-30">
 
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>
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>
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>
 
39
    <xi:include href="../legalnotice.xml"/>
60
40
  </refentryinfo>
61
41
  
62
42
  <refmeta>
73
53
    <cmdsynopsis>
74
54
      <command>&COMMANDNAME;</command>
75
55
      <group choice="opt">
76
 
        <arg choice="plain"><option>-p <replaceable
 
56
        <arg choice="plain"><option>--prefix <replaceable
77
57
        >PREFIX</replaceable></option></arg>
78
 
        <arg choice="plain"><option>--prefix </option><replaceable
 
58
        <arg choice="plain"><option>-p </option><replaceable
79
59
        >PREFIX</replaceable></arg>
80
60
      </group>
 
61
      <sbr/>
81
62
      <arg choice="opt"><option>--debug</option></arg>
82
63
    </cmdsynopsis>
83
64
    <cmdsynopsis>
84
65
      <command>&COMMANDNAME;</command>
85
66
      <group choice="req">
 
67
        <arg choice="plain"><option>--help</option></arg>
86
68
        <arg choice="plain"><option>-?</option></arg>
87
 
        <arg choice="plain"><option>--help</option></arg>
88
69
      </group>
89
70
    </cmdsynopsis>
90
71
    <cmdsynopsis>
94
75
    <cmdsynopsis>
95
76
      <command>&COMMANDNAME;</command>
96
77
      <group choice="req">
 
78
        <arg choice="plain"><option>--version</option></arg>
97
79
        <arg choice="plain"><option>-V</option></arg>
98
 
        <arg choice="plain"><option>--version</option></arg>
99
80
      </group>
100
 
    </cmdsynopsis>    
 
81
    </cmdsynopsis>
101
82
  </refsynopsisdiv>
102
83
  
103
84
  <refsect1 id="description">
104
85
    <title>DESCRIPTION</title>
105
86
    <para>
106
87
      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.
 
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.
113
96
    </para>
114
97
    <para>
115
98
      This program is little more than a <citerefentry><refentrytitle
133
116
    
134
117
    <variablelist>
135
118
      <varlistentry>
136
 
        <term><option>-p</option> <replaceable>PREFIX</replaceable
137
 
        ></term>
138
 
        <term><option>--prefix=</option><replaceable
139
 
        >PREFIX</replaceable></term>
 
119
        <term><option>--prefix=<replaceable
 
120
        >PREFIX</replaceable></option></term>
 
121
        <term><option>-p
 
122
        <replaceable>PREFIX</replaceable></option></term>
140
123
        <listitem>
141
124
          <para>
142
125
            Prefix string shown before the password prompt.
156
139
      </varlistentry>
157
140
      
158
141
      <varlistentry>
 
142
        <term><option>--help</option></term>
159
143
        <term><option>-?</option></term>
160
 
        <term><option>--help</option></term>
161
144
        <listitem>
162
145
          <para>
163
146
            Gives a help message about options and their meanings.
175
158
      </varlistentry>
176
159
      
177
160
      <varlistentry>
 
161
        <term><option>--version</option></term>
178
162
        <term><option>-V</option></term>
179
 
        <term><option>--version</option></term>
180
163
        <listitem>
181
164
          <para>
182
165
            Prints the program version.
183
166
          </para>
184
167
        </listitem>
185
 
      </varlistentry>            
 
168
      </varlistentry>
186
169
    </variablelist>
187
170
  </refsect1>
188
171
  
200
183
    <title>ENVIRONMENT</title>
201
184
    <variablelist>
202
185
      <varlistentry>
203
 
        <term><envar>cryptsource</envar></term>
204
 
        <term><envar>crypttarget</envar></term>
 
186
        <term><envar>CRYPTTAB_SOURCE</envar></term>
 
187
        <term><envar>CRYPTTAB_NAME</envar></term>
205
188
        <listitem>
206
189
          <para>
207
190
            If set, these environment variables will be assumed to
215
198
          <manvolnum>8mandos</manvolnum></citerefentry>, which will
216
199
          normally have inherited them from
217
200
          <filename>/scripts/local-top/cryptroot</filename> in the
218
 
          initial RAM disk environment, which will have set them from
219
 
          parsing kernel arguments and
 
201
          initial <acronym>RAM</acronym> disk environment, which will
 
202
          have set them from parsing kernel arguments and
220
203
          <filename>/conf/conf.d/cryptroot</filename> (also in the
221
204
          initial RAM disk environment), which in turn will have been
222
205
          created when the initial RAM disk image was created by
239
222
    <para>
240
223
      None are known at this time.
241
224
    </para>
242
 
  </refsect1>  
 
225
  </refsect1>
243
226
  
244
227
  <refsect1 id="example">
245
228
    <title>EXAMPLE</title>
261
244
      <para>
262
245
        Show a prefix before the prompt; in this case, a host name.
263
246
        It might be useful to be reminded of which host needs a
264
 
        password, in case of KVM switches, etc.
 
247
        password, in case of <acronym>KVM</acronym> switches, etc.
265
248
      </para>
266
249
      <para>
267
250
 
291
274
      >plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum>
292
275
      </citerefentry>, and will, when run standalone, outside, in a
293
276
      normal environment, immediately output on its standard output
294
 
      any presumably secret password it just recieved.  Therefore,
 
277
      any presumably secret password it just received.  Therefore,
295
278
      when running this program standalone (which should never
296
279
      normally be done), take care not to type in any real secret
297
280
      password by force of habit, since it would then immediately be
311
294
    <para>
312
295
      <citerefentry><refentrytitle>crypttab</refentrytitle>
313
296
      <manvolnum>5</manvolnum></citerefentry>
314
 
      <citerefentry><refentrytitle>password-request</refentrytitle>
 
297
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
315
298
      <manvolnum>8mandos</manvolnum></citerefentry>
316
299
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
317
300
      <manvolnum>8mandos</manvolnum></citerefentry>,