/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-08-20 03:22:45 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080820032245-ue341vdvzqdsg68l
* mandos (string_to_delta): Accept a whitespace-separated sequence of
                            intervals and return the sum.  This allows
                            "5m 30s" to be valid.
  (main): Provide an empty default value for the "host" option for
          "clients.conf", making it no longer a required option.

* mandos-clients.conf.xml: Removed <?xml-stylesheet>.
  (DESCRIPTION): Improved text.
  (DEFAULTS): Renamed to "OPTIONS".  Improved text for "timeout" and
              "interval".
  (CLIENTS): Removed; content moved to "OPTIONS".
  (EXPANSION): New section; document %(foo)s and %%(foo)s expansion.
  (FILES): Moved to before "EXAMPLES".
  (BUGS): New section.
  (EXAMPLES): Renamed to "EXAMPLE", as per man-pages(7).  Renamed
              example section "example_client" to "foo".  Changed
              example "host" setting to a more reasonable example host
              name.  Added additional example client "bar".

* mandos-conf.xml: Removed OVERVIEW entity.

Show diffs side-by-side

added added

removed removed

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