/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-08-31 08:47:38 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080831084738-uu70kayyt876982d
* mandos-keygen: Minor help text change.

* mandos-keygen.xml: Changed plural "keys" to singular "key"
                     throughout.
  (NAME): Improved wording.
  (DESCRIPTION): Improved wording.
  (OPTIONS): Split options in <term> tags into separate <term> tags.
             Use <option> tags.  Move long options before short
             options.  Uppercase replaceables.
  (OVERVIEW): Improved wording.
  (EXIT STATUS): Also cover --password option.
  (EXAMPLE): Add two examples using the --password option.
  (SECURITY): Improved wording.

* overview.xml: Improved wording.

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugin-runner.xml
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" [
4
6
<!ENTITY VERSION "1.0">
5
7
<!ENTITY COMMANDNAME "plugin-runner">
6
 
<!ENTITY TIMESTAMP "2008-09-01">
 
8
<!ENTITY TIMESTAMP "2008-08-30">
7
9
]>
8
10
 
9
 
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
 
11
<refentry>
10
12
  <refentryinfo>
11
13
    <title>Mandos Manual</title>
12
 
    <!-- Nwalsh’s docbook scripts use this to generate the footer: -->
 
14
    <!-- NWalsh's docbook scripts use this to generate the footer: -->
13
15
    <productname>Mandos</productname>
14
16
    <productnumber>&VERSION;</productnumber>
15
17
    <date>&TIMESTAMP;</date>
31
33
    </authorgroup>
32
34
    <copyright>
33
35
      <year>2008</year>
34
 
      <holder>Teddy Hogeborn</holder>
35
 
      <holder>Björn Påhlsson</holder>
 
36
      <holder>Teddy Hogeborn &amp; Björn Påhlsson</holder>
36
37
    </copyright>
37
 
    <xi:include href="legalnotice.xml"/>
 
38
    <legalnotice>
 
39
      <para>
 
40
        This manual page is free software: you can redistribute it
 
41
        and/or modify it under the terms of the GNU General Public
 
42
        License as published by the Free Software Foundation,
 
43
        either version 3 of the License, or (at your option) any
 
44
        later version.
 
45
      </para>
 
46
 
 
47
      <para>
 
48
        This manual page is distributed in the hope that it will
 
49
        be useful, but WITHOUT ANY WARRANTY; without even the
 
50
        implied warranty of MERCHANTABILITY or FITNESS FOR A
 
51
        PARTICULAR PURPOSE.  See the GNU General Public License
 
52
        for more details.
 
53
      </para>
 
54
 
 
55
      <para>
 
56
        You should have received a copy of the GNU General Public
 
57
        License along with this program; If not, see
 
58
        <ulink url="http://www.gnu.org/licenses/"/>.
 
59
      </para>
 
60
    </legalnotice>
38
61
  </refentryinfo>
39
62
 
40
63
  <refmeta>
53
76
    <cmdsynopsis>
54
77
      <command>&COMMANDNAME;</command>
55
78
      <group rep="repeat">
56
 
        <arg choice="plain"><option>--global-env=<replaceable
 
79
        <arg choice="plain"><option>--global-envs=<replaceable
57
80
        >VAR</replaceable><literal>=</literal><replaceable
58
81
        >value</replaceable></option></arg>
59
82
        <arg choice="plain"><option>-e
62
85
      </group>
63
86
      <sbr/>
64
87
      <group rep="repeat">
65
 
        <arg choice="plain"><option>--env-for=<replaceable
 
88
        <arg choice="plain"><option>--envs-for=<replaceable
66
89
        >PLUGIN</replaceable><literal>:</literal><replaceable
67
90
        >ENV</replaceable><literal>=</literal><replaceable
68
91
        >value</replaceable></option></arg>
109
132
    <cmdsynopsis>
110
133
      <command>&COMMANDNAME;</command>
111
134
      <group choice="req">
112
 
        <arg choice="plain"><option>--help</option></arg>
113
 
        <arg choice="plain"><option>-?</option></arg>
 
135
        <arg choice='plain'><option>--help</option></arg>
 
136
        <arg choice='plain'><option>-?</option></arg>
114
137
      </group>
115
138
    </cmdsynopsis>
116
139
    <cmdsynopsis>
117
140
      <command>&COMMANDNAME;</command>
118
 
      <arg choice="plain"><option>--usage</option></arg>
 
141
      <arg choice='plain'><option>--usage</option></arg>
119
142
    </cmdsynopsis>
120
143
    <cmdsynopsis>
121
144
      <command>&COMMANDNAME;</command>
122
145
      <group choice="req">
123
 
        <arg choice="plain"><option>--version</option></arg>
124
 
        <arg choice="plain"><option>-V</option></arg>
 
146
        <arg choice='plain'><option>--version</option></arg>
 
147
        <arg choice='plain'><option>-V</option></arg>
125
148
      </group>
126
149
    </cmdsynopsis>
127
150
  </refsynopsisdiv>
128
 
  
 
151
 
129
152
  <refsect1 id="description">
130
153
    <title>DESCRIPTION</title>
131
154
    <para>
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
 
  
 
155
      <command>&COMMANDNAME;</command> is a plugin runner that waits
 
156
      for any of its plugins to return sucessfull with a password, and
 
157
      passes it to cryptsetup as stdout message. This command is not
 
158
      meant to be invoked directly, but is instead meant to be run by
 
159
      cryptsetup by being specified in /etc/crypttab as a keyscript
 
160
      and subsequlently started in the initrd environment. See
 
161
      <citerefentry><refentrytitle>crypttab</refentrytitle>
 
162
      <manvolnum>5</manvolnum></citerefentry> for more information on
 
163
      keyscripts.
 
164
    </para>
 
165
 
 
166
    <para>
 
167
      plugins is looked for in the plugins directory which by default will be
 
168
      /conf/conf.d/mandos/plugins.d if not changed by option --plugin-dir.
 
169
    </para>
 
170
  </refsect1>
158
171
  <refsect1>
159
172
    <title>OPTIONS</title>
160
173
    <variablelist>
161
174
      <varlistentry>
162
 
        <term><option>--global-env
163
 
        <replaceable>VAR</replaceable><literal>=</literal><replaceable
164
 
        >value</replaceable></option></term>
165
 
        <term><option>-e
166
 
        <replaceable>VAR</replaceable><literal>=</literal><replaceable
167
 
        >value</replaceable></option></term>
168
 
        <listitem>
169
 
          <para>
170
 
            This option will add an environment variable setting to
171
 
            all plugins.  This will override any inherited environment
172
 
            variable.
173
 
          </para>
174
 
        </listitem>
175
 
      </varlistentry>
176
 
      
177
 
      <varlistentry>
178
 
        <term><option>--env-for
179
 
        <replaceable>PLUGIN</replaceable><literal>:</literal
180
 
        ><replaceable>ENV</replaceable><literal>=</literal
181
 
        ><replaceable>value</replaceable></option></term>
182
 
        <term><option>-f
183
 
        <replaceable>PLUGIN</replaceable><literal>:</literal
184
 
        ><replaceable>ENV</replaceable><literal>=</literal
185
 
        ><replaceable>value</replaceable></option></term>
186
 
        <listitem>
187
 
          <para>
188
 
            This option will add an environment variable setting to
189
 
            the <replaceable>PLUGIN</replaceable> plugin.  This will
190
 
            override any inherited environment variables or
191
 
            environment variables specified using
192
 
            <option>--global-env</option>.
193
 
          </para>
194
 
        </listitem>
195
 
      </varlistentry>
196
 
      
197
 
      <varlistentry>
198
 
        <term><option>--global-options
199
 
        <replaceable>OPTIONS</replaceable></option></term>
200
 
        <term><option>-g
201
 
        <replaceable>OPTIONS</replaceable></option></term>
202
 
        <listitem>
203
 
          <para>
204
 
            Pass some options to <emphasis>all</emphasis> plugins.
205
 
            <replaceable>OPTIONS</replaceable> is a comma separated
206
 
            list of options.  This is not a very useful option, except
207
 
            for specifying the <quote><option>--debug</option></quote>
208
 
            for all plugins.
209
 
          </para>
210
 
        </listitem>
211
 
      </varlistentry>
212
 
      
213
 
      <varlistentry>
214
 
        <term><option>--options-for
215
 
        <replaceable>PLUGIN</replaceable><literal>:</literal
216
 
        ><replaceable>OPTION</replaceable></option></term>
217
 
        <term><option>-o
218
 
        <replaceable>PLUGIN</replaceable><literal>:</literal
219
 
        ><replaceable>OPTION</replaceable></option></term>
220
 
        <listitem>
221
 
          <para>
222
 
            Pass some options to a specific plugin.  <replaceable
223
 
            >PLUGIN</replaceable> is the name (file basename) of a
224
 
            plugin, and <replaceable>OPTIONS</replaceable> is a comma
225
 
            separated list of options.
226
 
          </para>
227
 
          <para>
228
 
            Note that since options are not split on whitespace, the
229
 
            way to pass, to the plugin
230
 
            <quote><filename>foo</filename></quote>, the option
231
 
            <option>--bar</option> with the option argument
232
 
            <quote>baz</quote> is either
233
 
            <userinput>--options-for=foo:--bar=baz</userinput> or
234
 
            <userinput>--options-for=foo:--bar,baz</userinput>, but
235
 
            <emphasis>not</emphasis>
236
 
            <userinput>--options-for="foo:--bar baz"</userinput>.
237
 
          </para>
238
 
        </listitem>
239
 
      </varlistentry>
240
 
 
241
 
      <varlistentry>
242
 
        <term><option> --disable
243
 
        <replaceable>PLUGIN</replaceable></option></term>
244
 
        <term><option>-d
245
 
        <replaceable>PLUGIN</replaceable></option></term>
246
 
        <listitem>
247
 
          <para>
248
 
            Disable the plugin named
249
 
            <replaceable>PLUGIN</replaceable>.  The plugin will not be
250
 
            started.
251
 
          </para>       
252
 
        </listitem>
253
 
      </varlistentry>
254
 
 
255
 
      <varlistentry>
256
 
        <term><option>--groupid
257
 
        <replaceable>ID</replaceable></option></term>
258
 
        <listitem>
259
 
          <para>
260
 
            Change to group ID <replaceable>ID</replaceable> on
261
 
            startup.  The default is 65534.  All plugins will be
262
 
            started using this group ID.  <emphasis>Note:</emphasis>
263
 
            This must be a number, not a name.
264
 
          </para>
265
 
        </listitem>
266
 
      </varlistentry>
267
 
 
268
 
      <varlistentry>
269
 
        <term><option>--userid
270
 
        <replaceable>ID</replaceable></option></term>
271
 
        <listitem>
272
 
          <para>
273
 
            Change to user ID <replaceable>ID</replaceable> on
274
 
            startup.  The default is 65534.  All plugins will be
275
 
            started using this user ID.  <emphasis>Note:</emphasis>
276
 
            This must be a number, not a name.
277
 
          </para>
278
 
        </listitem>
279
 
      </varlistentry>
280
 
 
281
 
      <varlistentry>
282
 
        <term><option>--plugin-dir
283
 
        <replaceable>DIRECTORY</replaceable></option></term>
284
 
        <listitem>
285
 
          <para>
286
 
            Specify a different plugin directory.  The default is
287
 
            <filename>/lib/mandos/plugins.d</filename>, which will
288
 
            exist in the initial <acronym>RAM</acronym> disk
289
 
            environment.
290
 
          </para>
291
 
        </listitem>
292
 
      </varlistentry>
293
 
      
294
 
      <varlistentry>
295
 
        <term><option>--debug</option></term>
296
 
        <listitem>
297
 
          <para>
298
 
            Enable debug mode.  This will enable a lot of output to
299
 
            standard error about what the program is doing.  The
300
 
            program will still perform all other functions normally.
301
 
            The default is to <emphasis>not</emphasis> run in debug
302
 
            mode.
303
 
          </para>
304
 
          <para>
305
 
            The plugins will <emphasis>not</emphasis> be affected by
306
 
            this option.  Use
307
 
            <userinput><option>--global-options=--debug</option></userinput>
308
 
            if complete debugging eruption is desired.
309
 
          </para>
310
 
        </listitem>
311
 
      </varlistentry>
312
 
      
313
 
      <varlistentry>
314
 
        <term><option>--help</option></term>
315
 
        <term><option>-?</option></term>
316
 
        <listitem>
317
 
          <para>
318
 
            Gives a help message about options and their meanings.
319
 
          </para>
320
 
        </listitem>
321
 
      </varlistentry>
322
 
      
323
 
      <varlistentry>
324
 
        <term><option>--usage</option></term>
325
 
        <listitem>
326
 
          <para>
327
 
            Gives a short usage message.
328
 
          </para>
329
 
        </listitem>
330
 
      </varlistentry>
331
 
 
332
 
      <varlistentry>
333
 
        <term><option>--version</option></term>
334
 
        <term><option>-V</option></term>
335
 
        <listitem>
336
 
          <para>
337
 
            Prints the program version.
 
175
        <term><literal>-g</literal>,<literal>--global-options
 
176
        <replaceable>OPTIONS</replaceable></literal></term>
 
177
        <listitem>
 
178
          <para>
 
179
            Global options given to all plugins as additional start
 
180
            arguments.  Options are specified with a -o flag followed
 
181
            by a comma separated string of options.
 
182
          </para>       
 
183
        </listitem>
 
184
      </varlistentry>
 
185
 
 
186
      <varlistentry>
 
187
        <term><literal>-o</literal>,<literal> --options-for
 
188
        <replaceable>PLUGIN</replaceable>:<replaceable>OPTION</replaceable>
 
189
        </literal></term>
 
190
        <listitem>
 
191
          <para>
 
192
            Plugin specific options given to the plugin as additional
 
193
            start arguments.  Options are specified with a -o flag
 
194
            followed by a comma separated string of options.
 
195
          </para>       
 
196
        </listitem>
 
197
      </varlistentry>
 
198
 
 
199
      <varlistentry>
 
200
        <term><literal>-d</literal>,<literal> --disable
 
201
        <replaceable>PLUGIN</replaceable>
 
202
        </literal></term>
 
203
        <listitem>
 
204
          <para>
 
205
            Disable a specific plugin
 
206
          </para>       
 
207
        </listitem>
 
208
      </varlistentry>
 
209
 
 
210
      <varlistentry>
 
211
        <term><literal>--groupid <replaceable>ID</replaceable>
 
212
        </literal></term>
 
213
        <listitem>
 
214
          <para>
 
215
            Group ID the plugins will run as
 
216
          </para>
 
217
        </listitem>
 
218
      </varlistentry>
 
219
 
 
220
      <varlistentry>
 
221
        <term><literal>--userid <replaceable>ID</replaceable>
 
222
        </literal></term>
 
223
        <listitem>
 
224
          <para>
 
225
            User ID the plugins will run as
 
226
          </para>
 
227
        </listitem>
 
228
      </varlistentry>
 
229
 
 
230
      <varlistentry>
 
231
        <term><literal>--plugin-dir <replaceable>DIRECTORY</replaceable>
 
232
        </literal></term>
 
233
        <listitem>
 
234
          <para>
 
235
            Specify a different plugin directory
 
236
          </para>
 
237
        </listitem>
 
238
      </varlistentry>
 
239
      
 
240
      <varlistentry>
 
241
        <term><literal>--debug</literal></term>
 
242
        <listitem>
 
243
          <para>
 
244
            Debug mode
 
245
          </para>
 
246
        </listitem>
 
247
      </varlistentry>
 
248
      
 
249
      <varlistentry>
 
250
        <term><literal>-?</literal>, <literal>--help</literal></term>
 
251
        <listitem>
 
252
          <para>
 
253
            Gives a help message
 
254
          </para>
 
255
        </listitem>
 
256
      </varlistentry>
 
257
      
 
258
      <varlistentry>
 
259
        <term><literal>--usage</literal></term>
 
260
        <listitem>
 
261
          <para>
 
262
            Gives a short usage message
 
263
          </para>
 
264
        </listitem>
 
265
      </varlistentry>
 
266
 
 
267
      <varlistentry>
 
268
        <term><literal>-V</literal>, <literal>--version</literal></term>
 
269
        <listitem>
 
270
          <para>
 
271
            Prints the program version
338
272
          </para>
339
273
        </listitem>
340
274
      </varlistentry>
341
275
    </variablelist>
342
276
  </refsect1>
343
277
 
344
 
  <refsect1 id="overview">
345
 
    <title>OVERVIEW</title>
346
 
    <xi:include href="overview.xml"/>
347
 
    <para>
348
 
      This program will run on the client side in the initial
349
 
      <acronym>RAM</acronym> disk environment, and is responsible for
350
 
      getting a password.  It does this by running plugins, one of
351
 
      which will normally be the actual client program communicating
352
 
      with the server.
353
 
    </para>
354
 
  </refsect1>
355
 
  <refsect1 id="plugins">
356
 
    <title>PLUGINS</title>
357
 
    <para>
358
 
      This program will get a password by running a number of
359
 
      <firstterm>plugins</firstterm>, which are simply executable
360
 
      programs in a directory in the initial <acronym>RAM</acronym>
361
 
      disk environment.  The default directory is
362
 
      <filename>/lib/mandos/plugins.d</filename>, but this can be
363
 
      changed with the <option>--plugin-dir</option> option.  The
364
 
      plugins are started in parallel, and the first plugin to output
365
 
      a password <emphasis>and</emphasis> exit with a successful exit
366
 
      code will make this plugin-runner output the password from that
367
 
      plugin, stop any other plugins, and exit.
368
 
    </para>
369
 
  </refsect1>
370
 
  
371
 
  <refsect1 id="fallback">
372
 
    <title>FALLBACK</title>
373
 
    <para>
374
 
      If no plugins succeed, this program will, as a fallback, ask for
375
 
      a password on the console using <citerefentry><refentrytitle
376
 
      >getpass</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
377
 
      and output it.  This is not meant to be the normal mode of
378
 
      operation, as there is a separate plugin for getting a password
379
 
      from the console.
380
 
    </para>
381
 
  </refsect1>
382
 
  
383
278
  <refsect1 id="exit_status">
384
279
    <title>EXIT STATUS</title>
385
280
    <para>
386
 
      Exit status of this program is zero if no errors were
387
 
      encountered, and otherwise not.  The fallback (see <xref
388
 
      linkend="fallback"/>) may or may not have succeeded in either
389
 
      case.
390
 
    </para>
391
 
  </refsect1>
392
 
  
393
 
  <refsect1 id="environment">
394
 
    <title>ENVIRONMENT</title>
395
 
    <para>
396
 
      
397
 
    </para>
398
 
  </refsect1>
399
 
  
 
281
    </para>
 
282
  </refsect1>
 
283
 
400
284
  <refsect1 id="file">
401
285
    <title>FILES</title>
402
286
    <para>
403
 
      <variablelist>
404
 
        <varlistentry>
405
 
          <term><filename
406
 
          >/conf/conf.d/mandos/plugin-runner.conf</filename></term>
407
 
          <listitem>
408
 
            <para>
409
 
              Since this program will be run as a keyscript, there is
410
 
              little to no opportunity to pass command line arguments
411
 
              to it.  Therefore, it will <emphasis>also</emphasis>
412
 
              read this file and use its contents as
413
 
              whitespace-separated command line options.  Also,
414
 
              everything from a <quote>#</quote> character to the end
415
 
              of a line is ignored.
416
 
            </para>
417
 
            <para>
418
 
              This file will be processed <emphasis>before</emphasis>
419
 
              the normal command line options, so the latter can
420
 
              override the former, if need be.
421
 
            </para>
422
 
          </listitem>
423
 
        </varlistentry>
424
 
      </variablelist>
 
287
    </para>
 
288
  </refsect1>
 
289
 
 
290
  <refsect1 id="notes">
 
291
    <title>NOTES</title>
 
292
    <para>
425
293
    </para>
426
294
  </refsect1>
427
295
  
428
296
  <refsect1 id="bugs">
429
297
    <title>BUGS</title>
430
298
    <para>
431
 
      There is no <option>--enable</option> option to enable disabled
432
 
      plugins.
433
299
    </para>
434
300
  </refsect1>
435
 
  
 
301
 
436
302
  <refsect1 id="examples">
437
303
    <title>EXAMPLE</title>
438
304
    <para>
439
305
    </para>
440
306
  </refsect1>
441
 
  
 
307
 
442
308
  <refsect1 id="security">
443
309
    <title>SECURITY</title>
444
310
    <para>
445
311
    </para>
446
312
  </refsect1>
447
 
  
 
313
 
448
314
  <refsect1 id="see_also">
449
315
    <title>SEE ALSO</title>
450
316
    <para>
458
324
      <manvolnum>8mandos</manvolnum></citerefentry>
459
325
    </para>
460
326
  </refsect1>
461
 
  
 
327
 
462
328
</refentry>
463
329
<!-- Local Variables: -->
464
330
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->