/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 plugin-runner.xml

  • Committer: Teddy Hogeborn
  • Date: 2008-09-01 08:29:23 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080901082923-i2liq6t7warmu9xe
* mandos.xml: Enclose "RAM" with <acronym>.
* overview.xml: - '' -

* plugin-runner.xml (DESCRIPTION): Improved wording.
  (PURPOSE): New section.
  (OPTIONS): Improved wording.
  (OVERVIEW, PLUGINS): New section.
  (FALLBACK): New empty placeholder section.

* plugins.d/password-prompt.xml: Enclose "RAM" with <acronym>.

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugin-runner.xml
3
3
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
4
<!ENTITY VERSION "1.0">
5
5
<!ENTITY COMMANDNAME "plugin-runner">
6
 
<!ENTITY TIMESTAMP "2008-08-31">
 
6
<!ENTITY TIMESTAMP "2008-09-01">
7
7
]>
8
8
 
9
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
125
125
      </group>
126
126
    </cmdsynopsis>
127
127
  </refsynopsisdiv>
128
 
 
 
128
  
129
129
  <refsect1 id="description">
130
130
    <title>DESCRIPTION</title>
131
131
    <para>
132
 
      <command>&COMMANDNAME;</command> is a plugin runner that waits
133
 
      for any of its plugins to return sucessfull with a password, and
134
 
      passes it to cryptsetup as stdout message. This command is not
135
 
      meant to be invoked directly, but is instead meant to be run by
136
 
      cryptsetup by being specified in /etc/crypttab as a keyscript
137
 
      and subsequlently started in the initrd environment. See
138
 
      <citerefentry><refentrytitle>crypttab</refentrytitle>
139
 
      <manvolnum>5</manvolnum></citerefentry> for more information on
140
 
      keyscripts.
141
 
    </para>
142
 
 
143
 
    <para>
144
 
      plugins is looked for in the plugins directory which by default will be
145
 
      /conf/conf.d/mandos/plugins.d if not changed by option --plugin-dir.
146
 
    </para>
147
 
  </refsect1>
 
132
      <command>&COMMANDNAME;</command> is a program which is meant to
 
133
      be specified as <quote>keyscript</quote> in <citerefentry>
 
134
      <refentrytitle>crypttab</refentrytitle>
 
135
      <manvolnum>5</manvolnum></citerefentry> for the root disk.  The
 
136
      aim of this program is therefore to output a password, which
 
137
      then <citerefentry><refentrytitle>cryptsetup</refentrytitle>
 
138
      <manvolnum>8</manvolnum></citerefentry> will use to try and
 
139
      unlock the root disk.
 
140
    </para>
 
141
    <para>
 
142
      This program is not meant to be invoked directly, but can be in
 
143
      order to test it.  Note that any password obtained will simply
 
144
      be output on standard output.
 
145
    </para>
 
146
  </refsect1>
 
147
  
 
148
  <refsect1 id="purpose">
 
149
    <title>PURPOSE</title>
 
150
    <para>
 
151
      The purpose of this is to enable <emphasis>remote and unattended
 
152
      rebooting</emphasis> of client host computer with an
 
153
      <emphasis>encrypted root file system</emphasis>.  See <xref
 
154
      linkend="overview"/> for details.
 
155
    </para>
 
156
  </refsect1>
 
157
  
148
158
  <refsect1>
149
159
    <title>OPTIONS</title>
150
160
    <variablelist>
155
165
        <replaceable>OPTIONS</replaceable></option></term>
156
166
        <listitem>
157
167
          <para>
158
 
            Global options given to all plugins as additional start
159
 
            arguments.  Options are specified with a -o flag followed
160
 
            by a comma separated string of options.
161
 
          </para>       
 
168
            Pass some options to <emphasis>all</emphasis> plugins.
 
169
            <replaceable>OPTIONS</replaceable> is a comma separated
 
170
            list of options.  This is not a very useful option, except
 
171
            for specifying the <quote><option>--debug</option></quote>
 
172
            for all plugins.
 
173
          </para>
162
174
        </listitem>
163
175
      </varlistentry>
164
 
 
 
176
      
165
177
      <varlistentry>
166
178
        <term><option>--options-for
167
179
        <replaceable>PLUGIN</replaceable><literal>:</literal
171
183
        ><replaceable>OPTION</replaceable></option></term>
172
184
        <listitem>
173
185
          <para>
174
 
            Plugin specific options given to the plugin as additional
175
 
            start arguments.  Options are specified with a -o flag
176
 
            followed by a comma separated string of options.
177
 
          </para>       
 
186
            Pass some options to a specific plugin.  <replaceable
 
187
            >PLUGIN</replaceable> is the name (file basename) of a
 
188
            plugin, and <replaceable>OPTIONS</replaceable> is a comma
 
189
            separated list of options.
 
190
          </para>
 
191
          <para>
 
192
            Note that since options are not split on whitespace, the
 
193
            way to pass, to the plugin
 
194
            <quote><filename>foo</filename></quote>, the option
 
195
            <option>--bar</option> with the option argument
 
196
            <quote>baz</quote> is either
 
197
            <userinput>--options-for=foo:--bar=baz</userinput> or
 
198
            <userinput>--options-for=foo:--bar,baz</userinput>, but
 
199
            <emphasis>not</emphasis>
 
200
            <userinput>--options-for="foo:--bar baz"</userinput>.
 
201
          </para>
178
202
        </listitem>
179
203
      </varlistentry>
180
204
 
185
209
        <replaceable>PLUGIN</replaceable></option></term>
186
210
        <listitem>
187
211
          <para>
188
 
            Disable a specific plugin
 
212
            Disable the plugin named
 
213
            <replaceable>PLUGIN</replaceable>.  The plugin will not be
 
214
            started.
189
215
          </para>       
190
216
        </listitem>
191
217
      </varlistentry>
195
221
        <replaceable>ID</replaceable></option></term>
196
222
        <listitem>
197
223
          <para>
198
 
            Group ID the plugins will run as
 
224
            Change to group ID <replaceable>ID</replaceable> on
 
225
            startup.  The default is 65534.  All plugins will be
 
226
            started using this group ID.  <emphasis>Note:</emphasis>
 
227
            This must be a number, not a name.
199
228
          </para>
200
229
        </listitem>
201
230
      </varlistentry>
205
234
        <replaceable>ID</replaceable></option></term>
206
235
        <listitem>
207
236
          <para>
208
 
            User ID the plugins will run as
 
237
            Change to user ID <replaceable>ID</replaceable> on
 
238
            startup.  The default is 65534.  All plugins will be
 
239
            started using this user ID.  <emphasis>Note:</emphasis>
 
240
            This must be a number, not a name.
209
241
          </para>
210
242
        </listitem>
211
243
      </varlistentry>
215
247
        <replaceable>DIRECTORY</replaceable></option></term>
216
248
        <listitem>
217
249
          <para>
218
 
            Specify a different plugin directory
 
250
            Specify a different plugin directory.  The default is
 
251
            <filename>/lib/mandos/plugins.d</filename>, which will
 
252
            exist in the initial <acronym>RAM</acronym> disk
 
253
            environment.
219
254
          </para>
220
255
        </listitem>
221
256
      </varlistentry>
224
259
        <term><option>--debug</option></term>
225
260
        <listitem>
226
261
          <para>
227
 
            Debug mode
 
262
            Enable debug mode.  This will enable a lot of output to
 
263
            standard error about what the program is doing.  The
 
264
            program will still perform all other functions normally.
 
265
            The default is to <emphasis>not</emphasis> run in debug
 
266
            mode.
 
267
          </para>
 
268
          <para>
 
269
            The plugins will <emphasis>not</emphasis> be affected by
 
270
            this option.  Use
 
271
            <userinput><option>--global-options=--debug</option></userinput>
 
272
            if complete debugging eruption is desired.
228
273
          </para>
229
274
        </listitem>
230
275
      </varlistentry>
234
279
        <term><option>-?</option></term>
235
280
        <listitem>
236
281
          <para>
237
 
            Gives a help message
 
282
            Gives a help message about options and their meanings.
238
283
          </para>
239
284
        </listitem>
240
285
      </varlistentry>
243
288
        <term><option>--usage</option></term>
244
289
        <listitem>
245
290
          <para>
246
 
            Gives a short usage message
 
291
            Gives a short usage message.
247
292
          </para>
248
293
        </listitem>
249
294
      </varlistentry>
253
298
        <term><option>-V</option></term>
254
299
        <listitem>
255
300
          <para>
256
 
            Prints the program version
 
301
            Prints the program version.
257
302
          </para>
258
303
        </listitem>
259
304
      </varlistentry>
260
305
    </variablelist>
261
306
  </refsect1>
262
307
 
 
308
  <refsect1 id="overview">
 
309
    <title>OVERVIEW</title>
 
310
    <xi:include href="overview.xml"/>
 
311
    <para>
 
312
      This program will run on the client side in the initial
 
313
      <acronym>RAM</acronym> disk environment, and is responsible for
 
314
      getting a password.  It does this by running plugins, one of
 
315
      which will normally be the actual client program communicating
 
316
      with the server.
 
317
    </para>
 
318
  </refsect1>
 
319
  <refsect1 id="plugins">
 
320
    <title>PLUGINS</title>
 
321
    <para>
 
322
      This program will get a password by running a number of
 
323
      <firstterm>plugins</firstterm>, which are simply executable
 
324
      programs in a directory in the initial <acronym>RAM</acronym>
 
325
      disk environment.  The default directory is
 
326
      <filename>/lib/mandos/plugins.d</filename>, but this can be
 
327
      changed with the <option>--plugin-dir</option> option.  The
 
328
      plugins are started in parallel, and the first plugin to output
 
329
      a password and exit with a successful exit code will make this
 
330
      plugin-runner output that password, stop any other plugins, and
 
331
      exit.
 
332
    </para>
 
333
  </refsect1>
 
334
  
 
335
  <refsect1>
 
336
    <title>FALLBACK</title>
 
337
    <para>
 
338
    </para>
 
339
  </refsect1>
263
340
  <refsect1 id="exit_status">
264
341
    <title>EXIT STATUS</title>
265
342
    <para>