/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: 2008-12-29 02:44:54 UTC
  • Revision ID: teddy@fukt.bsnet.se-20081229024454-nbsei556dwy5azr1
* mandos (Client.timeout, Client.interval): Changed from being a
                                            property to be a normal
                                            attribute.
  (Client._timeout, Client._interval): Removed.
  (Client._timeout_milliseconds): Changed from being an attribute to
                                  be a method "timeout_milliseconds".
                                  All users changed.
  (Client._interval_milliseconds): Changed from being an attribute to
                                   be method "interval_milliseconds".
                                   All users changed.
  (Client.__init__): Take additional "use_dbus" keyword argument.
                     Only provide D-Bus interface if "use_dbus" is
                     True.
  (Client.use_dbus): New attribute.
  (Client.dbus_object_path): Changed to only be set if "self.use_dbus"
                             is True.
  (Client.enable, Client.disable, Client.checker_callback,
  Client.bump_timeout, Client.start_checker, Client.stop_checker):
  Only emit D-Bus signals if "self.use_dbus".
  (Client.SetChecker, Client.SetHost, Client.Enable): Bug fix: Emit
                                                      D-Bus signals.
  (Client.SetInterval, Client.SetTimeout): Changed to emit D-Bus
                                           signals.

  (main): Remove deprecated "default" keyword argument to "--check"
          option.  Added new "--no-dbus" option.  Added corresponding
          "use_dbus" server configuration option.  Only provide D-Bus
          interface and emit D-Bus signals if "use_dbus".  Pass
          "use_dbus" on to Client constructor.

* mandos-options.xml ([@id="dbus"]): New option.

* mandos.conf (use_dbus): New option.

* mandos.conf.xml (OPTIONS): New option "use_dbus".
  (EXAMPLE): - '' -

* mandos.xml (SYNOPSIS): New option "--no-dbus".
  (D-BUS INTERFACE): New section.

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugins.d/password-prompt.xml
 
1
<?xml version="1.0" encoding="UTF-8"?>
 
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
 
3
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
 
4
<!ENTITY COMMANDNAME "password-prompt">
 
5
<!ENTITY TIMESTAMP "2008-10-04">
 
6
<!ENTITY % common SYSTEM "../common.ent">
 
7
%common;
 
8
]>
 
9
 
 
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
 
11
  <refentryinfo>
 
12
    <title>Mandos Manual</title>
 
13
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
 
14
    <productname>Mandos</productname>
 
15
    <productnumber>&version;</productnumber>
 
16
    <date>&TIMESTAMP;</date>
 
17
    <authorgroup>
 
18
      <author>
 
19
        <firstname>Björn</firstname>
 
20
        <surname>Påhlsson</surname>
 
21
        <address>
 
22
          <email>belorn@fukt.bsnet.se</email>
 
23
        </address>
 
24
      </author>
 
25
      <author>
 
26
        <firstname>Teddy</firstname>
 
27
        <surname>Hogeborn</surname>
 
28
        <address>
 
29
          <email>teddy@fukt.bsnet.se</email>
 
30
        </address>
 
31
      </author>
 
32
    </authorgroup>
 
33
    <copyright>
 
34
      <year>2008</year>
 
35
      <holder>Teddy Hogeborn</holder>
 
36
      <holder>Björn Påhlsson</holder>
 
37
    </copyright>
 
38
    <xi:include href="../legalnotice.xml"/>
 
39
  </refentryinfo>
 
40
  
 
41
  <refmeta>
 
42
    <refentrytitle>&COMMANDNAME;</refentrytitle>
 
43
    <manvolnum>8mandos</manvolnum>
 
44
  </refmeta>
 
45
  
 
46
  <refnamediv>
 
47
    <refname><command>&COMMANDNAME;</command></refname>
 
48
    <refpurpose>Prompt for a password and output it.</refpurpose>
 
49
  </refnamediv>
 
50
  
 
51
  <refsynopsisdiv>
 
52
    <cmdsynopsis>
 
53
      <command>&COMMANDNAME;</command>
 
54
      <group choice="opt">
 
55
        <arg choice="plain"><option>--prefix <replaceable
 
56
        >PREFIX</replaceable></option></arg>
 
57
        <arg choice="plain"><option>-p </option><replaceable
 
58
        >PREFIX</replaceable></arg>
 
59
      </group>
 
60
      <sbr/>
 
61
      <arg choice="opt"><option>--debug</option></arg>
 
62
    </cmdsynopsis>
 
63
    <cmdsynopsis>
 
64
      <command>&COMMANDNAME;</command>
 
65
      <group choice="req">
 
66
        <arg choice="plain"><option>--help</option></arg>
 
67
        <arg choice="plain"><option>-?</option></arg>
 
68
      </group>
 
69
    </cmdsynopsis>
 
70
    <cmdsynopsis>
 
71
      <command>&COMMANDNAME;</command>
 
72
      <arg choice="plain"><option>--usage</option></arg>
 
73
    </cmdsynopsis>
 
74
    <cmdsynopsis>
 
75
      <command>&COMMANDNAME;</command>
 
76
      <group choice="req">
 
77
        <arg choice="plain"><option>--version</option></arg>
 
78
        <arg choice="plain"><option>-V</option></arg>
 
79
      </group>
 
80
    </cmdsynopsis>
 
81
  </refsynopsisdiv>
 
82
  
 
83
  <refsect1 id="description">
 
84
    <title>DESCRIPTION</title>
 
85
    <para>
 
86
      All <command>&COMMANDNAME;</command> does is prompt for a
 
87
      password and output any given password to standard output.
 
88
    </para>
 
89
    <para>
 
90
      This program is not very useful on its own.  This program is
 
91
      really meant to run as a plugin in the <application
 
92
      >Mandos</application> client-side system, where it is used as a
 
93
      fallback and alternative to retrieving passwords from a
 
94
      <application >Mandos</application> server.
 
95
    </para>
 
96
    <para>
 
97
      This program is little more than a <citerefentry><refentrytitle
 
98
      >getpass</refentrytitle><manvolnum>3</manvolnum></citerefentry>
 
99
      wrapper, although actual use of that function is not guaranteed
 
100
      or implied.
 
101
    </para>
 
102
  </refsect1>
 
103
  
 
104
  <refsect1 id="options">
 
105
    <title>OPTIONS</title>
 
106
    <para>
 
107
      This program is commonly not invoked from the command line; it
 
108
      is normally started by the <application>Mandos</application>
 
109
      plugin runner, see <citerefentry><refentrytitle
 
110
      >plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum>
 
111
      </citerefentry>.  Any command line options this program accepts
 
112
      are therefore normally provided by the plugin runner, and not
 
113
      directly.
 
114
    </para>
 
115
    
 
116
    <variablelist>
 
117
      <varlistentry>
 
118
        <term><option>--prefix=<replaceable
 
119
        >PREFIX</replaceable></option></term>
 
120
        <term><option>-p
 
121
        <replaceable>PREFIX</replaceable></option></term>
 
122
        <listitem>
 
123
          <para>
 
124
            Prefix string shown before the password prompt.
 
125
          </para>
 
126
        </listitem>
 
127
      </varlistentry>
 
128
      
 
129
      <varlistentry>
 
130
        <term><option>--debug</option></term>
 
131
        <listitem>
 
132
          <para>
 
133
            Enable debug mode.  This will enable a lot of output to
 
134
            standard error about what the program is doing.  The
 
135
            program will still perform all other functions normally.
 
136
          </para>
 
137
        </listitem>
 
138
      </varlistentry>
 
139
      
 
140
      <varlistentry>
 
141
        <term><option>--help</option></term>
 
142
        <term><option>-?</option></term>
 
143
        <listitem>
 
144
          <para>
 
145
            Gives a help message about options and their meanings.
 
146
          </para>
 
147
        </listitem>
 
148
      </varlistentry>
 
149
      
 
150
      <varlistentry>
 
151
        <term><option>--usage</option></term>
 
152
        <listitem>
 
153
          <para>
 
154
            Gives a short usage message.
 
155
          </para>
 
156
        </listitem>
 
157
      </varlistentry>
 
158
      
 
159
      <varlistentry>
 
160
        <term><option>--version</option></term>
 
161
        <term><option>-V</option></term>
 
162
        <listitem>
 
163
          <para>
 
164
            Prints the program version.
 
165
          </para>
 
166
        </listitem>
 
167
      </varlistentry>
 
168
    </variablelist>
 
169
  </refsect1>
 
170
  
 
171
  <refsect1 id="exit_status">
 
172
    <title>EXIT STATUS</title>
 
173
    <para>
 
174
      If exit status is 0, the output from the program is the password
 
175
      as it was read.  Otherwise, if exit status is other than 0, the
 
176
      program has encountered an error, and any output so far could be
 
177
      corrupt and/or truncated, and should therefore be ignored.
 
178
    </para>
 
179
  </refsect1>
 
180
  
 
181
  <refsect1 id="environment">
 
182
    <title>ENVIRONMENT</title>
 
183
    <variablelist>
 
184
      <varlistentry>
 
185
        <term><envar>cryptsource</envar></term>
 
186
        <term><envar>crypttarget</envar></term>
 
187
        <listitem>
 
188
          <para>
 
189
            If set, these environment variables will be assumed to
 
190
            contain the source device name and the target device
 
191
            mapper name, respectively, and will be shown as part of
 
192
            the prompt.
 
193
        </para>
 
194
        <para>
 
195
          These variables will normally be inherited from
 
196
          <citerefentry><refentrytitle>plugin-runner</refentrytitle>
 
197
          <manvolnum>8mandos</manvolnum></citerefentry>, which will
 
198
          normally have inherited them from
 
199
          <filename>/scripts/local-top/cryptroot</filename> in the
 
200
          initial <acronym>RAM</acronym> disk environment, which will
 
201
          have set them from parsing kernel arguments and
 
202
          <filename>/conf/conf.d/cryptroot</filename> (also in the
 
203
          initial RAM disk environment), which in turn will have been
 
204
          created when the initial RAM disk image was created by
 
205
          <filename
 
206
          >/usr/share/initramfs-tools/hooks/cryptroot</filename>, by
 
207
          extracting the information of the root file system from
 
208
          <filename >/etc/crypttab</filename>.
 
209
        </para>
 
210
        <para>
 
211
          This behavior is meant to exactly mirror the behavior of
 
212
          <command>askpass</command>, the default password prompter.
 
213
        </para>
 
214
        </listitem>
 
215
      </varlistentry>
 
216
    </variablelist>
 
217
  </refsect1>
 
218
  
 
219
  <refsect1 id="bugs">
 
220
    <title>BUGS</title>
 
221
    <para>
 
222
      None are known at this time.
 
223
    </para>
 
224
  </refsect1>
 
225
  
 
226
  <refsect1 id="example">
 
227
    <title>EXAMPLE</title>
 
228
    <para>
 
229
      Note that normally, command line options will not be given
 
230
      directly, but via options for the Mandos <citerefentry
 
231
      ><refentrytitle>plugin-runner</refentrytitle>
 
232
      <manvolnum>8mandos</manvolnum></citerefentry>.
 
233
    </para>
 
234
    <informalexample>
 
235
      <para>
 
236
        Normal invocation needs no options:
 
237
      </para>
 
238
      <para>
 
239
        <userinput>&COMMANDNAME;</userinput>
 
240
      </para>
 
241
    </informalexample>
 
242
    <informalexample>
 
243
      <para>
 
244
        Show a prefix before the prompt; in this case, a host name.
 
245
        It might be useful to be reminded of which host needs a
 
246
        password, in case of <acronym>KVM</acronym> switches, etc.
 
247
      </para>
 
248
      <para>
 
249
 
 
250
<!-- do not wrap this line -->
 
251
<userinput>&COMMANDNAME; --prefix=host.example.org:</userinput>
 
252
 
 
253
      </para>
 
254
    </informalexample>
 
255
    <informalexample>
 
256
      <para>
 
257
        Run in debug mode.
 
258
      </para>
 
259
      <para>
 
260
        <!-- do not wrap this line -->
 
261
        <userinput>&COMMANDNAME; --debug</userinput>
 
262
      </para>
 
263
    </informalexample>
 
264
  </refsect1>
 
265
  
 
266
  <refsect1 id="security">
 
267
    <title>SECURITY</title>
 
268
    <para>
 
269
      On its own, this program is very simple, and does not exactly
 
270
      present any security risks.  The one thing that could be
 
271
      considered worthy of note is this: This program is meant to be
 
272
      run by <citerefentry><refentrytitle
 
273
      >plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum>
 
274
      </citerefentry>, and will, when run standalone, outside, in a
 
275
      normal environment, immediately output on its standard output
 
276
      any presumably secret password it just received.  Therefore,
 
277
      when running this program standalone (which should never
 
278
      normally be done), take care not to type in any real secret
 
279
      password by force of habit, since it would then immediately be
 
280
      shown as output.
 
281
    </para>
 
282
    <para>
 
283
      To further alleviate any risk of being locked out of a system,
 
284
      the <citerefentry><refentrytitle>plugin-runner</refentrytitle>
 
285
      <manvolnum>8mandos</manvolnum></citerefentry> has a fallback
 
286
      mode which does the same thing as this program, only with less
 
287
      features.
 
288
    </para>
 
289
  </refsect1>
 
290
  
 
291
  <refsect1 id="see_also">
 
292
    <title>SEE ALSO</title>
 
293
    <para>
 
294
      <citerefentry><refentrytitle>crypttab</refentrytitle>
 
295
      <manvolnum>5</manvolnum></citerefentry>
 
296
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
297
      <manvolnum>8mandos</manvolnum></citerefentry>
 
298
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
 
299
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
300
    </para>
 
301
  </refsect1>
 
302
</refentry>
 
303
<!-- Local Variables: -->
 
304
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
305
<!-- time-stamp-end: "[\"']>" -->
 
306
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
307
<!-- End: -->