/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: 2008-07-19 18:43:24 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080719184324-iwhoa5in75xa0u2u
* mandos-clients.conf ([foo]/dn, [foo]/password, [braxen_client]/dn,
                       [braxen_client]/password): Removed.
  ([foo]/fingerprint, [braxen_client]/fingerprint): New.
  ([foo]/checker): New.
  ([foo]/secfile): New.
  ([braxen_client]/secret): New.

* server.py: New "--debug" option to set debug flag.  Removed "cert",
             "key", "ca", "crl", and "cred" variables.  Added default
             value for "checker" config file setting.  Do not pass
             credentials to IPv6_TCPServer constructor.
  (debug): New global debug flag.  Used by most debugging output code.
  (Client.__init__): Keyword argument "dn" replaced by "fingerprint",
                     "password" renamed to "secret", and "passfile"
                     renamed to "secfile".  New keyword argument
                     "checker". All callers changed.
  (Client.dn): Removed.
  (Client.fingerprint): New.
  (Client.password): Renamed to "secret"; all users changed.
  (Client.passfile): Renamed to "secfile"; all users changed.
  (Client.timeout, Client.interval): Changed to be properties; now
                                     automatically updates the
                                     "_timeout_milliseconds" and
                                     "_interval_milliseconds" values.
  (Client.timeout_milliseconds): Renamed to "_timeout_milliseconds".
  (Client.interval_milliseconds): Renamed to "_interval_milliseconds".
  (Client.check_command): New.
  (Client.start_checker): Use the new "check_command" attribute.
  (peer_certificate, fingerprint): New functions.

  (tcp_handler.handle): Use ClientSession with empty credentials
                        object instead of ServerSession.  Set gnutls
                        priority string.  Do not verify peer.  Use
                        fingerprint instead of DN when searching for
                        clients.  Bug fix: Loop sending data so even large
                        secret data strings are sent.
  (IPv6_TCPServer.credentials): Removed.
  (if_nametoindex): Do not import ctypes since that is now imported
                    globally.

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-09-30">
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.  This
88
 
      is not very useful on its own.  This program is really meant to
89
 
      run as a plugin in the <application>Mandos</application>
90
 
      client-side system, where it is used as a fallback and
91
 
      alternative to retrieving passwords from a <application
92
 
      >Mandos</application> server.
93
 
    </para>
94
 
    <para>
95
 
      This program is little more than a <citerefentry><refentrytitle
96
 
      >getpass</refentrytitle><manvolnum>3</manvolnum></citerefentry>
97
 
      wrapper, although actual use of that function is not guaranteed
98
 
      or implied.
99
 
    </para>
100
 
  </refsect1>
101
 
  
102
 
  <refsect1 id="options">
103
 
    <title>OPTIONS</title>
104
 
    <para>
105
 
      This program is commonly not invoked from the command line; it
106
 
      is normally started by the <application>Mandos</application>
107
 
      plugin runner, see <citerefentry><refentrytitle
108
 
      >plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum>
109
 
      </citerefentry>.  Any command line options this program accepts
110
 
      are therefore normally provided by the plugin runner, and not
111
 
      directly.
112
 
    </para>
113
 
    
114
 
    <variablelist>
115
 
      <varlistentry>
116
 
        <term><option>--prefix=<replaceable
117
 
        >PREFIX</replaceable></option></term>
118
 
        <term><option>-p
119
 
        <replaceable>PREFIX</replaceable></option></term>
120
 
        <listitem>
121
 
          <para>
122
 
            Prefix string shown before the password prompt.
123
 
          </para>
124
 
        </listitem>
125
 
      </varlistentry>
126
 
      
127
 
      <varlistentry>
128
 
        <term><option>--debug</option></term>
129
 
        <listitem>
130
 
          <para>
131
 
            Enable debug mode.  This will enable a lot of output to
132
 
            standard error about what the program is doing.  The
133
 
            program will still perform all other functions normally.
134
 
          </para>
135
 
        </listitem>
136
 
      </varlistentry>
137
 
      
138
 
      <varlistentry>
139
 
        <term><option>--help</option></term>
140
 
        <term><option>-?</option></term>
141
 
        <listitem>
142
 
          <para>
143
 
            Gives a help message about options and their meanings.
144
 
          </para>
145
 
        </listitem>
146
 
      </varlistentry>
147
 
      
148
 
      <varlistentry>
149
 
        <term><option>--usage</option></term>
150
 
        <listitem>
151
 
          <para>
152
 
            Gives a short usage message.
153
 
          </para>
154
 
        </listitem>
155
 
      </varlistentry>
156
 
      
157
 
      <varlistentry>
158
 
        <term><option>--version</option></term>
159
 
        <term><option>-V</option></term>
160
 
        <listitem>
161
 
          <para>
162
 
            Prints the program version.
163
 
          </para>
164
 
        </listitem>
165
 
      </varlistentry>
166
 
    </variablelist>
167
 
  </refsect1>
168
 
  
169
 
  <refsect1 id="exit_status">
170
 
    <title>EXIT STATUS</title>
171
 
    <para>
172
 
      If exit status is 0, the output from the program is the password
173
 
      as it was read.  Otherwise, if exit status is other than 0, the
174
 
      program has encountered an error, and any output so far could be
175
 
      corrupt and/or truncated, and should therefore be ignored.
176
 
    </para>
177
 
  </refsect1>
178
 
  
179
 
  <refsect1 id="environment">
180
 
    <title>ENVIRONMENT</title>
181
 
    <variablelist>
182
 
      <varlistentry>
183
 
        <term><envar>cryptsource</envar></term>
184
 
        <term><envar>crypttarget</envar></term>
185
 
        <listitem>
186
 
          <para>
187
 
            If set, these environment variables will be assumed to
188
 
            contain the source device name and the target device
189
 
            mapper name, respectively, and will be shown as part of
190
 
            the prompt.
191
 
        </para>
192
 
        <para>
193
 
          These variables will normally be inherited from
194
 
          <citerefentry><refentrytitle>plugin-runner</refentrytitle>
195
 
          <manvolnum>8mandos</manvolnum></citerefentry>, which will
196
 
          normally have inherited them from
197
 
          <filename>/scripts/local-top/cryptroot</filename> in the
198
 
          initial <acronym>RAM</acronym> disk environment, which will
199
 
          have set them from parsing kernel arguments and
200
 
          <filename>/conf/conf.d/cryptroot</filename> (also in the
201
 
          initial RAM disk environment), which in turn will have been
202
 
          created when the initial RAM disk image was created by
203
 
          <filename
204
 
          >/usr/share/initramfs-tools/hooks/cryptroot</filename>, by
205
 
          extracting the information of the root file system from
206
 
          <filename >/etc/crypttab</filename>.
207
 
        </para>
208
 
        <para>
209
 
          This behavior is meant to exactly mirror the behavior of
210
 
          <command>askpass</command>, the default password prompter.
211
 
        </para>
212
 
        </listitem>
213
 
      </varlistentry>
214
 
    </variablelist>
215
 
  </refsect1>
216
 
  
217
 
  <refsect1 id="bugs">
218
 
    <title>BUGS</title>
219
 
    <para>
220
 
      None are known at this time.
221
 
    </para>
222
 
  </refsect1>
223
 
  
224
 
  <refsect1 id="example">
225
 
    <title>EXAMPLE</title>
226
 
    <para>
227
 
      Note that normally, command line options will not be given
228
 
      directly, but via options for the Mandos <citerefentry
229
 
      ><refentrytitle>plugin-runner</refentrytitle>
230
 
      <manvolnum>8mandos</manvolnum></citerefentry>.
231
 
    </para>
232
 
    <informalexample>
233
 
      <para>
234
 
        Normal invocation needs no options:
235
 
      </para>
236
 
      <para>
237
 
        <userinput>&COMMANDNAME;</userinput>
238
 
      </para>
239
 
    </informalexample>
240
 
    <informalexample>
241
 
      <para>
242
 
        Show a prefix before the prompt; in this case, a host name.
243
 
        It might be useful to be reminded of which host needs a
244
 
        password, in case of <acronym>KVM</acronym> switches, etc.
245
 
      </para>
246
 
      <para>
247
 
 
248
 
<!-- do not wrap this line -->
249
 
<userinput>&COMMANDNAME; --prefix=host.example.org:</userinput>
250
 
 
251
 
      </para>
252
 
    </informalexample>
253
 
    <informalexample>
254
 
      <para>
255
 
        Run in debug mode.
256
 
      </para>
257
 
      <para>
258
 
        <!-- do not wrap this line -->
259
 
        <userinput>&COMMANDNAME; --debug</userinput>
260
 
      </para>
261
 
    </informalexample>
262
 
  </refsect1>
263
 
  
264
 
  <refsect1 id="security">
265
 
    <title>SECURITY</title>
266
 
    <para>
267
 
      On its own, this program is very simple, and does not exactly
268
 
      present any security risks.  The one thing that could be
269
 
      considered worthy of note is this: This program is meant to be
270
 
      run by <citerefentry><refentrytitle
271
 
      >plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum>
272
 
      </citerefentry>, and will, when run standalone, outside, in a
273
 
      normal environment, immediately output on its standard output
274
 
      any presumably secret password it just received.  Therefore,
275
 
      when running this program standalone (which should never
276
 
      normally be done), take care not to type in any real secret
277
 
      password by force of habit, since it would then immediately be
278
 
      shown as output.
279
 
    </para>
280
 
    <para>
281
 
      To further alleviate any risk of being locked out of a system,
282
 
      the <citerefentry><refentrytitle>plugin-runner</refentrytitle>
283
 
      <manvolnum>8mandos</manvolnum></citerefentry> has a fallback
284
 
      mode which does the same thing as this program, only with less
285
 
      features.
286
 
    </para>
287
 
  </refsect1>
288
 
  
289
 
  <refsect1 id="see_also">
290
 
    <title>SEE ALSO</title>
291
 
    <para>
292
 
      <citerefentry><refentrytitle>crypttab</refentrytitle>
293
 
      <manvolnum>5</manvolnum></citerefentry>
294
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
295
 
      <manvolnum>8mandos</manvolnum></citerefentry>
296
 
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
297
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
298
 
    </para>
299
 
  </refsect1>
300
 
</refentry>
301
 
<!-- Local Variables: -->
302
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
303
 
<!-- time-stamp-end: "[\"']>" -->
304
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
305
 
<!-- End: -->