/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-08 01:17:17 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080808011717-h1vzp4vs7oyzkgx3
* mandos (IPv6_TCPServer.server_bind): Bug fix: allow port to be empty
                                       as well as None.
  (main): Bug fix: Let debug option default to 'None' to allow
          override from config file.

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugin-runner.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 VERSION "1.0">
5
 
<!ENTITY COMMANDNAME "plugin-runner">
6
 
<!ENTITY TIMESTAMP "2008-09-02">
7
 
]>
8
 
 
9
 
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
10
 
  <refentryinfo>
11
 
    <title>Mandos Manual</title>
12
 
    <!-- Nwalsh’s docbook scripts use this to generate the footer: -->
13
 
    <productname>Mandos</productname>
14
 
    <productnumber>&VERSION;</productnumber>
15
 
    <date>&TIMESTAMP;</date>
16
 
    <authorgroup>
17
 
      <author>
18
 
        <firstname>Björn</firstname>
19
 
        <surname>Påhlsson</surname>
20
 
        <address>
21
 
          <email>belorn@fukt.bsnet.se</email>
22
 
        </address>
23
 
      </author>
24
 
      <author>
25
 
        <firstname>Teddy</firstname>
26
 
        <surname>Hogeborn</surname>
27
 
        <address>
28
 
          <email>teddy@fukt.bsnet.se</email>
29
 
        </address>
30
 
      </author>
31
 
    </authorgroup>
32
 
    <copyright>
33
 
      <year>2008</year>
34
 
      <holder>Teddy Hogeborn</holder>
35
 
      <holder>Björn Påhlsson</holder>
36
 
    </copyright>
37
 
    <xi:include href="legalnotice.xml"/>
38
 
  </refentryinfo>
39
 
 
40
 
  <refmeta>
41
 
    <refentrytitle>&COMMANDNAME;</refentrytitle>
42
 
    <manvolnum>8mandos</manvolnum>
43
 
  </refmeta>
44
 
  
45
 
  <refnamediv>
46
 
    <refname><command>&COMMANDNAME;</command></refname>
47
 
    <refpurpose>
48
 
      Run Mandos plugins.  Pass data from first succesful one.
49
 
    </refpurpose>
50
 
  </refnamediv>
51
 
 
52
 
  <refsynopsisdiv>
53
 
    <cmdsynopsis>
54
 
      <command>&COMMANDNAME;</command>
55
 
      <group rep="repeat">
56
 
        <arg choice="plain"><option>--global-env=<replaceable
57
 
        >VAR</replaceable><literal>=</literal><replaceable
58
 
        >value</replaceable></option></arg>
59
 
        <arg choice="plain"><option>-G
60
 
        <replaceable>VAR</replaceable><literal>=</literal><replaceable
61
 
        >value</replaceable> </option></arg>
62
 
      </group>
63
 
      <sbr/>
64
 
      <group rep="repeat">
65
 
        <arg choice="plain"><option>--env-for=<replaceable
66
 
        >PLUGIN</replaceable><literal>:</literal><replaceable
67
 
        >ENV</replaceable><literal>=</literal><replaceable
68
 
        >value</replaceable></option></arg>
69
 
        <arg choice="plain"><option>-E<replaceable>
70
 
        PLUGIN</replaceable><literal>:</literal><replaceable
71
 
        >ENV</replaceable><literal>=</literal><replaceable
72
 
        >value</replaceable> </option></arg>
73
 
      </group>
74
 
      <sbr/>
75
 
      <group rep="repeat">
76
 
        <arg choice="plain"><option>--global-options=<replaceable
77
 
        >OPTIONS</replaceable></option></arg>
78
 
        <arg choice="plain"><option>-g<replaceable>
79
 
        OPTIONS</replaceable> </option></arg>
80
 
      </group>
81
 
      <sbr/>
82
 
      <group rep="repeat">
83
 
        <arg choice="plain"><option>--options-for=<replaceable
84
 
        >PLUGIN</replaceable><literal>:</literal><replaceable
85
 
        >OPTIONS</replaceable></option></arg>
86
 
        <arg choice="plain"><option>-o<replaceable>
87
 
        PLUGIN</replaceable><literal>:</literal><replaceable
88
 
        >OPTIONS</replaceable> </option></arg>
89
 
      </group>
90
 
      <sbr/>
91
 
      <group rep="repeat">
92
 
        <arg choice="plain"><option>--disable=<replaceable
93
 
        >PLUGIN</replaceable></option></arg>
94
 
        <arg choice="plain"><option>-d
95
 
        <replaceable>PLUGIN</replaceable> </option></arg>
96
 
      </group>
97
 
      <sbr/>
98
 
      <group rep="repeat">
99
 
        <arg choice="plain"><option>--enable=<replaceable
100
 
        >PLUGIN</replaceable></option></arg>
101
 
        <arg choice="plain"><option>-e
102
 
        <replaceable>PLUGIN</replaceable> </option></arg>
103
 
      </group>
104
 
      <sbr/>
105
 
      <arg><option>--groupid=<replaceable
106
 
      >ID</replaceable></option></arg>
107
 
      <sbr/>
108
 
      <arg><option>--userid=<replaceable
109
 
      >ID</replaceable></option></arg>
110
 
      <sbr/>
111
 
      <arg><option>--plugin-dir=<replaceable
112
 
      >DIRECTORY</replaceable></option></arg>
113
 
      <sbr/>
114
 
      <arg><option>--config-file=<replaceable
115
 
      >FILE</replaceable></option></arg>
116
 
      <sbr/>
117
 
      <arg><option>--debug</option></arg>
118
 
    </cmdsynopsis>
119
 
    <cmdsynopsis>
120
 
      <command>&COMMANDNAME;</command>
121
 
      <group choice="req">
122
 
        <arg choice="plain"><option>--help</option></arg>
123
 
        <arg choice="plain"><option>-?</option></arg>
124
 
      </group>
125
 
    </cmdsynopsis>
126
 
    <cmdsynopsis>
127
 
      <command>&COMMANDNAME;</command>
128
 
      <arg choice="plain"><option>--usage</option></arg>
129
 
    </cmdsynopsis>
130
 
    <cmdsynopsis>
131
 
      <command>&COMMANDNAME;</command>
132
 
      <group choice="req">
133
 
        <arg choice="plain"><option>--version</option></arg>
134
 
        <arg choice="plain"><option>-V</option></arg>
135
 
      </group>
136
 
    </cmdsynopsis>
137
 
  </refsynopsisdiv>
138
 
  
139
 
  <refsect1 id="description">
140
 
    <title>DESCRIPTION</title>
141
 
    <para>
142
 
      <command>&COMMANDNAME;</command> is a program which is meant to
143
 
      be specified as <quote>keyscript</quote> in <citerefentry>
144
 
      <refentrytitle>crypttab</refentrytitle>
145
 
      <manvolnum>5</manvolnum></citerefentry> for the root disk.  The
146
 
      aim of this program is therefore to output a password, which
147
 
      then <citerefentry><refentrytitle>cryptsetup</refentrytitle>
148
 
      <manvolnum>8</manvolnum></citerefentry> will use to try and
149
 
      unlock the root disk.
150
 
    </para>
151
 
    <para>
152
 
      This program is not meant to be invoked directly, but can be in
153
 
      order to test it.  Note that any password obtained will simply
154
 
      be output on standard output.
155
 
    </para>
156
 
  </refsect1>
157
 
  
158
 
  <refsect1 id="purpose">
159
 
    <title>PURPOSE</title>
160
 
    <para>
161
 
      The purpose of this is to enable <emphasis>remote and unattended
162
 
      rebooting</emphasis> of client host computer with an
163
 
      <emphasis>encrypted root file system</emphasis>.  See <xref
164
 
      linkend="overview"/> for details.
165
 
    </para>
166
 
  </refsect1>
167
 
  
168
 
  <refsect1>
169
 
    <title>OPTIONS</title>
170
 
    <variablelist>
171
 
      <varlistentry>
172
 
        <term><option>--global-env
173
 
        <replaceable>VAR</replaceable><literal>=</literal><replaceable
174
 
        >value</replaceable></option></term>
175
 
        <term><option>-e
176
 
        <replaceable>VAR</replaceable><literal>=</literal><replaceable
177
 
        >value</replaceable></option></term>
178
 
        <listitem>
179
 
          <para>
180
 
            This option will add an environment variable setting to
181
 
            all plugins.  This will override any inherited environment
182
 
            variable.
183
 
          </para>
184
 
        </listitem>
185
 
      </varlistentry>
186
 
      
187
 
      <varlistentry>
188
 
        <term><option>--env-for
189
 
        <replaceable>PLUGIN</replaceable><literal>:</literal
190
 
        ><replaceable>ENV</replaceable><literal>=</literal
191
 
        ><replaceable>value</replaceable></option></term>
192
 
        <term><option>-f
193
 
        <replaceable>PLUGIN</replaceable><literal>:</literal
194
 
        ><replaceable>ENV</replaceable><literal>=</literal
195
 
        ><replaceable>value</replaceable></option></term>
196
 
        <listitem>
197
 
          <para>
198
 
            This option will add an environment variable setting to
199
 
            the <replaceable>PLUGIN</replaceable> plugin.  This will
200
 
            override any inherited environment variables or
201
 
            environment variables specified using
202
 
            <option>--global-env</option>.
203
 
          </para>
204
 
        </listitem>
205
 
      </varlistentry>
206
 
      
207
 
      <varlistentry>
208
 
        <term><option>--global-options
209
 
        <replaceable>OPTIONS</replaceable></option></term>
210
 
        <term><option>-g
211
 
        <replaceable>OPTIONS</replaceable></option></term>
212
 
        <listitem>
213
 
          <para>
214
 
            Pass some options to <emphasis>all</emphasis> plugins.
215
 
            <replaceable>OPTIONS</replaceable> is a comma separated
216
 
            list of options.  This is not a very useful option, except
217
 
            for specifying the <quote><option>--debug</option></quote>
218
 
            for all plugins.
219
 
          </para>
220
 
        </listitem>
221
 
      </varlistentry>
222
 
      
223
 
      <varlistentry>
224
 
        <term><option>--options-for
225
 
        <replaceable>PLUGIN</replaceable><literal>:</literal
226
 
        ><replaceable>OPTION</replaceable></option></term>
227
 
        <term><option>-o
228
 
        <replaceable>PLUGIN</replaceable><literal>:</literal
229
 
        ><replaceable>OPTION</replaceable></option></term>
230
 
        <listitem>
231
 
          <para>
232
 
            Pass some options to a specific plugin.  <replaceable
233
 
            >PLUGIN</replaceable> is the name (file basename) of a
234
 
            plugin, and <replaceable>OPTIONS</replaceable> is a comma
235
 
            separated list of options.
236
 
          </para>
237
 
          <para>
238
 
            Note that since options are not split on whitespace, the
239
 
            way to pass, to the plugin
240
 
            <quote><filename>foo</filename></quote>, the option
241
 
            <option>--bar</option> with the option argument
242
 
            <quote>baz</quote> is either
243
 
            <userinput>--options-for=foo:--bar=baz</userinput> or
244
 
            <userinput>--options-for=foo:--bar,baz</userinput>, but
245
 
            <emphasis>not</emphasis>
246
 
            <userinput>--options-for="foo:--bar baz"</userinput>.
247
 
          </para>
248
 
        </listitem>
249
 
      </varlistentry>
250
 
 
251
 
      <varlistentry>
252
 
        <term><option>--disable
253
 
        <replaceable>PLUGIN</replaceable></option></term>
254
 
        <term><option>-d
255
 
        <replaceable>PLUGIN</replaceable></option></term>
256
 
        <listitem>
257
 
          <para>
258
 
            Disable the plugin named
259
 
            <replaceable>PLUGIN</replaceable>.  The plugin will not be
260
 
            started.
261
 
          </para>       
262
 
        </listitem>
263
 
      </varlistentry>
264
 
 
265
 
      <varlistentry>
266
 
        <term><option>--enable
267
 
        <replaceable>PLUGIN</replaceable></option></term>
268
 
        <term><option>-e
269
 
        <replaceable>PLUGIN</replaceable></option></term>
270
 
        <listitem>
271
 
          <para>
272
 
            Re-enable the plugin named
273
 
            <replaceable>PLUGIN</replaceable>.  This is only useful to
274
 
            undo a previous <option>--disable</option> option, maybe
275
 
            from the config file.
276
 
          </para>
277
 
        </listitem>
278
 
      </varlistentry>
279
 
 
280
 
      <varlistentry>
281
 
        <term><option>--groupid
282
 
        <replaceable>ID</replaceable></option></term>
283
 
        <listitem>
284
 
          <para>
285
 
            Change to group ID <replaceable>ID</replaceable> on
286
 
            startup.  The default is 65534.  All plugins will be
287
 
            started using this group ID.  <emphasis>Note:</emphasis>
288
 
            This must be a number, not a name.
289
 
          </para>
290
 
        </listitem>
291
 
      </varlistentry>
292
 
 
293
 
      <varlistentry>
294
 
        <term><option>--userid
295
 
        <replaceable>ID</replaceable></option></term>
296
 
        <listitem>
297
 
          <para>
298
 
            Change to user ID <replaceable>ID</replaceable> on
299
 
            startup.  The default is 65534.  All plugins will be
300
 
            started using this user ID.  <emphasis>Note:</emphasis>
301
 
            This must be a number, not a name.
302
 
          </para>
303
 
        </listitem>
304
 
      </varlistentry>
305
 
 
306
 
      <varlistentry>
307
 
        <term><option>--plugin-dir
308
 
        <replaceable>DIRECTORY</replaceable></option></term>
309
 
        <listitem>
310
 
          <para>
311
 
            Specify a different plugin directory.  The default is
312
 
            <filename>/lib/mandos/plugins.d</filename>, which will
313
 
            exist in the initial <acronym>RAM</acronym> disk
314
 
            environment.
315
 
          </para>
316
 
        </listitem>
317
 
      </varlistentry>
318
 
      
319
 
      <varlistentry>
320
 
        <term><option>--config-file
321
 
        <replaceable>FILE</replaceable></option></term>
322
 
        <listitem>
323
 
          <para>
324
 
            Specify a different file to read additional options from.
325
 
            See <xref linkend="files"/>.  Other command line options
326
 
            will override options specified in the file.
327
 
          </para>
328
 
        </listitem>
329
 
      </varlistentry>
330
 
      
331
 
      <varlistentry>
332
 
        <term><option>--debug</option></term>
333
 
        <listitem>
334
 
          <para>
335
 
            Enable debug mode.  This will enable a lot of output to
336
 
            standard error about what the program is doing.  The
337
 
            program will still perform all other functions normally.
338
 
            The default is to <emphasis>not</emphasis> run in debug
339
 
            mode.
340
 
          </para>
341
 
          <para>
342
 
            The plugins will <emphasis>not</emphasis> be affected by
343
 
            this option.  Use
344
 
            <userinput><option>--global-options=--debug</option></userinput>
345
 
            if complete debugging eruption is desired.
346
 
          </para>
347
 
        </listitem>
348
 
      </varlistentry>
349
 
      
350
 
      <varlistentry>
351
 
        <term><option>--help</option></term>
352
 
        <term><option>-?</option></term>
353
 
        <listitem>
354
 
          <para>
355
 
            Gives a help message about options and their meanings.
356
 
          </para>
357
 
        </listitem>
358
 
      </varlistentry>
359
 
      
360
 
      <varlistentry>
361
 
        <term><option>--usage</option></term>
362
 
        <listitem>
363
 
          <para>
364
 
            Gives a short usage message.
365
 
          </para>
366
 
        </listitem>
367
 
      </varlistentry>
368
 
 
369
 
      <varlistentry>
370
 
        <term><option>--version</option></term>
371
 
        <term><option>-V</option></term>
372
 
        <listitem>
373
 
          <para>
374
 
            Prints the program version.
375
 
          </para>
376
 
        </listitem>
377
 
      </varlistentry>
378
 
    </variablelist>
379
 
  </refsect1>
380
 
 
381
 
  <refsect1 id="overview">
382
 
    <title>OVERVIEW</title>
383
 
    <xi:include href="overview.xml"/>
384
 
    <para>
385
 
      This program will run on the client side in the initial
386
 
      <acronym>RAM</acronym> disk environment, and is responsible for
387
 
      getting a password.  It does this by running plugins, one of
388
 
      which will normally be the actual client program communicating
389
 
      with the server.
390
 
    </para>
391
 
  </refsect1>
392
 
  <refsect1 id="plugins">
393
 
    <title>PLUGINS</title>
394
 
    <para>
395
 
      This program will get a password by running a number of
396
 
      <firstterm>plugins</firstterm>, which are simply executable
397
 
      programs in a directory in the initial <acronym>RAM</acronym>
398
 
      disk environment.  The default directory is
399
 
      <filename>/lib/mandos/plugins.d</filename>, but this can be
400
 
      changed with the <option>--plugin-dir</option> option.  The
401
 
      plugins are started in parallel, and the first plugin to output
402
 
      a password <emphasis>and</emphasis> exit with a successful exit
403
 
      code will make this plugin-runner output the password from that
404
 
      plugin, stop any other plugins, and exit.
405
 
    </para>
406
 
  </refsect1>
407
 
  
408
 
  <refsect1 id="fallback">
409
 
    <title>FALLBACK</title>
410
 
    <para>
411
 
      If no plugins succeed, this program will, as a fallback, ask for
412
 
      a password on the console using <citerefentry><refentrytitle
413
 
      >getpass</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
414
 
      and output it.  This is not meant to be the normal mode of
415
 
      operation, as there is a separate plugin for getting a password
416
 
      from the console.
417
 
    </para>
418
 
  </refsect1>
419
 
  
420
 
  <refsect1 id="exit_status">
421
 
    <title>EXIT STATUS</title>
422
 
    <para>
423
 
      Exit status of this program is zero if no errors were
424
 
      encountered, and otherwise not.  The fallback (see <xref
425
 
      linkend="fallback"/>) may or may not have succeeded in either
426
 
      case.
427
 
    </para>
428
 
  </refsect1>
429
 
  
430
 
  <refsect1 id="environment">
431
 
    <title>ENVIRONMENT</title>
432
 
    <para>
433
 
      This program does not use any environment variables itself, it
434
 
      only passes on its environment to all the plugins.  The
435
 
      environment passed to plugins can be modified using the
436
 
      <option>--global-env</option> and <option>--env-for</option>
437
 
      optins.
438
 
    </para>
439
 
  </refsect1>
440
 
  
441
 
  <refsect1 id="files">
442
 
    <title>FILES</title>
443
 
    <para>
444
 
      <variablelist>
445
 
        <varlistentry>
446
 
          <term><filename
447
 
          >/conf/conf.d/mandos/plugin-runner.conf</filename></term>
448
 
          <listitem>
449
 
            <para>
450
 
              Since this program will be run as a keyscript, there is
451
 
              little to no opportunity to pass command line arguments
452
 
              to it.  Therefore, it will <emphasis>also</emphasis>
453
 
              read this file and use its contents as
454
 
              whitespace-separated command line options.  Also,
455
 
              everything from a <quote>#</quote> character to the end
456
 
              of a line is ignored.
457
 
            </para>
458
 
            <para>
459
 
              This program is meant to run in the initial RAM disk
460
 
              environment, so that is where this file is assumed to
461
 
              exist.  The file does not need to exist in the normal
462
 
              file system.
463
 
            </para>
464
 
            <para>
465
 
              This file will be processed <emphasis>before</emphasis>
466
 
              the normal command line options, so the latter can
467
 
              override the former, if need be.
468
 
            </para>
469
 
            <para>
470
 
              This file name is the default; the file to read for
471
 
              arguments can be changed using the
472
 
              <option>--config-file</option> option.
473
 
            </para>
474
 
          </listitem>
475
 
        </varlistentry>
476
 
      </variablelist>
477
 
    </para>
478
 
  </refsect1>
479
 
  
480
 
  <refsect1 id="bugs">
481
 
    <title>BUGS</title>
482
 
    <para>
483
 
    </para>
484
 
  </refsect1>
485
 
  
486
 
  <refsect1 id="examples">
487
 
    <title>EXAMPLE</title>
488
 
    <para>
489
 
    </para>
490
 
  </refsect1>
491
 
  
492
 
  <refsect1 id="security">
493
 
    <title>SECURITY</title>
494
 
    <para>
495
 
    </para>
496
 
  </refsect1>
497
 
  
498
 
  <refsect1 id="see_also">
499
 
    <title>SEE ALSO</title>
500
 
    <para>
501
 
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
502
 
      <manvolnum>8</manvolnum></citerefentry>,
503
 
      <citerefentry><refentrytitle>mandos</refentrytitle>
504
 
      <manvolnum>8</manvolnum></citerefentry>,
505
 
      <citerefentry><refentrytitle>password-prompt</refentrytitle>
506
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
507
 
      <citerefentry><refentrytitle>password-request</refentrytitle>
508
 
      <manvolnum>8mandos</manvolnum></citerefentry>
509
 
    </para>
510
 
  </refsect1>
511
 
  
512
 
</refentry>
513
 
<!-- Local Variables: -->
514
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
515
 
<!-- time-stamp-end: "[\"']>" -->
516
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
517
 
<!-- End: -->