/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 15:06:39 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080831150639-tqdkyea3b9p3rou7
* Makefile: Make all DocBook rules include legalnotice.xml as a
            dependency.

* legalnotice.xml: New file with just the <legalnotice> tag in it.

* mandos-clients.conf.xml (/refentry): Add XInclude namespace.
  (/refentry/refentryinfo/legalnotice): Replaced with an inclusion of
                                        "legalnotice.xml".
* mandos-keygen.xml (/refentry/refentryinfo/legalnotice): - '' -
* mandos-conf.xml (/refentry/refentryinfo/legalnotice): - '' -
* mandos.xml (/refentry/refentryinfo/legalnotice): - '' -

* overview.xml: Changed root node tag name in DOCTYPE declaration.

* plugin-runner.xml (/refentry): Add XInclude namespace.
  (/refentry/refentryinfo/legalnotice): Replaced with an inclusion of
                                        "legalnotice.xml".

* plugins.d/password-prompt.xml (/refentry): Add XInclude namespace.
  (/refentry/refentryinfo/legalnotice): Replaced with an inclusion of
                                        "legalnotice.xml".

* plugins.d/password-request.xml (/refentry): Add XInclude namespace.
  (/refentry/refentryinfo/legalnotice): Replaced with an inclusion of
                                        "legalnotice.xml".

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugin-runner.xml
1
1
<?xml version="1.0" encoding="UTF-8"?>
2
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
3
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
 
4
<!ENTITY VERSION "1.0">
4
5
<!ENTITY COMMANDNAME "plugin-runner">
5
 
<!ENTITY TIMESTAMP "2008-09-30">
6
 
<!ENTITY % common SYSTEM "common.ent">
7
 
%common;
 
6
<!ENTITY TIMESTAMP "2008-08-31">
8
7
]>
9
8
 
10
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
12
11
    <title>Mandos Manual</title>
13
12
    <!-- Nwalsh’s docbook scripts use this to generate the footer: -->
14
13
    <productname>Mandos</productname>
15
 
    <productnumber>&version;</productnumber>
 
14
    <productnumber>&VERSION;</productnumber>
16
15
    <date>&TIMESTAMP;</date>
17
16
    <authorgroup>
18
17
      <author>
37
36
    </copyright>
38
37
    <xi:include href="legalnotice.xml"/>
39
38
  </refentryinfo>
40
 
  
 
39
 
41
40
  <refmeta>
42
41
    <refentrytitle>&COMMANDNAME;</refentrytitle>
43
42
    <manvolnum>8mandos</manvolnum>
46
45
  <refnamediv>
47
46
    <refname><command>&COMMANDNAME;</command></refname>
48
47
    <refpurpose>
49
 
      Run Mandos plugins, pass data from first to succeed.
 
48
      Run Mandos plugins.  Pass data from first succesful one.
50
49
    </refpurpose>
51
50
  </refnamediv>
52
 
  
 
51
 
53
52
  <refsynopsisdiv>
54
53
    <cmdsynopsis>
55
54
      <command>&COMMANDNAME;</command>
56
55
      <group rep="repeat">
57
 
        <arg choice="plain"><option>--global-env=<replaceable
58
 
        >ENV</replaceable><literal>=</literal><replaceable
 
56
        <arg choice="plain"><option>--global-envs=<replaceable
 
57
        >VAR</replaceable><literal>=</literal><replaceable
59
58
        >value</replaceable></option></arg>
60
 
        <arg choice="plain"><option>-G
61
 
        <replaceable>ENV</replaceable><literal>=</literal><replaceable
 
59
        <arg choice="plain"><option>-e
 
60
        <replaceable>VAR</replaceable><literal>=</literal><replaceable
62
61
        >value</replaceable> </option></arg>
63
62
      </group>
64
63
      <sbr/>
65
64
      <group rep="repeat">
66
 
        <arg choice="plain"><option>--env-for=<replaceable
 
65
        <arg choice="plain"><option>--envs-for=<replaceable
67
66
        >PLUGIN</replaceable><literal>:</literal><replaceable
68
67
        >ENV</replaceable><literal>=</literal><replaceable
69
68
        >value</replaceable></option></arg>
70
 
        <arg choice="plain"><option>-E<replaceable>
 
69
        <arg choice="plain"><option>-f<replaceable>
71
70
        PLUGIN</replaceable><literal>:</literal><replaceable
72
71
        >ENV</replaceable><literal>=</literal><replaceable
73
72
        >value</replaceable> </option></arg>
84
83
        <arg choice="plain"><option>--options-for=<replaceable
85
84
        >PLUGIN</replaceable><literal>:</literal><replaceable
86
85
        >OPTIONS</replaceable></option></arg>
87
 
        <arg choice="plain"><option>-o<replaceable>
 
86
        <arg choice="plain"><option>-f<replaceable>
88
87
        PLUGIN</replaceable><literal>:</literal><replaceable
89
88
        >OPTIONS</replaceable> </option></arg>
90
89
      </group>
96
95
        <replaceable>PLUGIN</replaceable> </option></arg>
97
96
      </group>
98
97
      <sbr/>
99
 
      <group rep="repeat">
100
 
        <arg choice="plain"><option>--enable=<replaceable
101
 
        >PLUGIN</replaceable></option></arg>
102
 
        <arg choice="plain"><option>-e
103
 
        <replaceable>PLUGIN</replaceable> </option></arg>
104
 
      </group>
105
 
      <sbr/>
106
98
      <arg><option>--groupid=<replaceable
107
99
      >ID</replaceable></option></arg>
108
100
      <sbr/>
112
104
      <arg><option>--plugin-dir=<replaceable
113
105
      >DIRECTORY</replaceable></option></arg>
114
106
      <sbr/>
115
 
      <arg><option>--config-file=<replaceable
116
 
      >FILE</replaceable></option></arg>
117
 
      <sbr/>
118
107
      <arg><option>--debug</option></arg>
119
108
    </cmdsynopsis>
120
109
    <cmdsynopsis>
136
125
      </group>
137
126
    </cmdsynopsis>
138
127
  </refsynopsisdiv>
139
 
  
 
128
 
140
129
  <refsect1 id="description">
141
130
    <title>DESCRIPTION</title>
142
131
    <para>
143
 
      <command>&COMMANDNAME;</command> is a program which is meant to
144
 
      be specified as a <quote>keyscript</quote> for the root disk in
 
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
145
138
      <citerefentry><refentrytitle>crypttab</refentrytitle>
146
 
      <manvolnum>5</manvolnum></citerefentry>.  The aim of this
147
 
      program is therefore to output a password, which then
148
 
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
149
 
      <manvolnum>8</manvolnum></citerefentry> will use to unlock the
150
 
      root disk.
151
 
    </para>
152
 
    <para>
153
 
      This program is not meant to be invoked directly, but can be in
154
 
      order to test it.  Note that any password obtained will simply
155
 
      be output on standard output.
156
 
    </para>
157
 
  </refsect1>
158
 
  
159
 
  <refsect1 id="purpose">
160
 
    <title>PURPOSE</title>
161
 
    <para>
162
 
      The purpose of this is to enable <emphasis>remote and unattended
163
 
      rebooting</emphasis> of client host computer with an
164
 
      <emphasis>encrypted root file system</emphasis>.  See <xref
165
 
      linkend="overview"/> for details.
166
 
    </para>
167
 
  </refsect1>
168
 
  
 
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>
169
148
  <refsect1>
170
149
    <title>OPTIONS</title>
171
150
    <variablelist>
172
151
      <varlistentry>
173
 
        <term><option>--global-env
174
 
        <replaceable>ENV</replaceable><literal>=</literal><replaceable
175
 
        >value</replaceable></option></term>
176
 
        <term><option>-G
177
 
        <replaceable>ENV</replaceable><literal>=</literal><replaceable
178
 
        >value</replaceable></option></term>
179
 
        <listitem>
180
 
          <para>
181
 
            This option will add an environment variable setting to
182
 
            all plugins.  This will override any inherited environment
183
 
            variable.
184
 
          </para>
185
 
        </listitem>
186
 
      </varlistentry>
187
 
      
188
 
      <varlistentry>
189
 
        <term><option>--env-for
190
 
        <replaceable>PLUGIN</replaceable><literal>:</literal
191
 
        ><replaceable>ENV</replaceable><literal>=</literal
192
 
        ><replaceable>value</replaceable></option></term>
193
 
        <term><option>-E
194
 
        <replaceable>PLUGIN</replaceable><literal>:</literal
195
 
        ><replaceable>ENV</replaceable><literal>=</literal
196
 
        ><replaceable>value</replaceable></option></term>
197
 
        <listitem>
198
 
          <para>
199
 
            This option will add an environment variable setting to
200
 
            the <replaceable>PLUGIN</replaceable> plugin.  This will
201
 
            override any inherited environment variables or
202
 
            environment variables specified using
203
 
            <option>--global-env</option>.
204
 
          </para>
205
 
        </listitem>
206
 
      </varlistentry>
207
 
      
208
 
      <varlistentry>
209
152
        <term><option>--global-options
210
153
        <replaceable>OPTIONS</replaceable></option></term>
211
154
        <term><option>-g
212
155
        <replaceable>OPTIONS</replaceable></option></term>
213
156
        <listitem>
214
157
          <para>
215
 
            Pass some options to <emphasis>all</emphasis> plugins.
216
 
            <replaceable>OPTIONS</replaceable> is a comma separated
217
 
            list of options.  This is not a very useful option, except
218
 
            for specifying the <quote><option>--debug</option></quote>
219
 
            option to all plugins.
220
 
          </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>       
221
162
        </listitem>
222
163
      </varlistentry>
223
 
      
 
164
 
224
165
      <varlistentry>
225
166
        <term><option>--options-for
226
167
        <replaceable>PLUGIN</replaceable><literal>:</literal
230
171
        ><replaceable>OPTION</replaceable></option></term>
231
172
        <listitem>
232
173
          <para>
233
 
            Pass some options to a specific plugin.  <replaceable
234
 
            >PLUGIN</replaceable> is the name (file basename) of a
235
 
            plugin, and <replaceable>OPTIONS</replaceable> is a comma
236
 
            separated list of options.
237
 
          </para>
238
 
          <para>
239
 
            Note that since options are not split on whitespace, the
240
 
            way to pass, to the plugin
241
 
            <quote><filename>foo</filename></quote>, the option
242
 
            <option>--bar</option> with the option argument
243
 
            <quote>baz</quote> is either
244
 
            <userinput>--options-for=foo:--bar=baz</userinput> or
245
 
            <userinput>--options-for=foo:--bar,baz</userinput>.  Using
246
 
            <userinput>--options-for="foo:--bar baz"</userinput>. will
247
 
            <emphasis>not</emphasis> work.
248
 
          </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>       
249
178
        </listitem>
250
179
      </varlistentry>
251
 
      
 
180
 
252
181
      <varlistentry>
253
 
        <term><option>--disable
 
182
        <term><option> --disable
254
183
        <replaceable>PLUGIN</replaceable></option></term>
255
184
        <term><option>-d
256
185
        <replaceable>PLUGIN</replaceable></option></term>
257
186
        <listitem>
258
187
          <para>
259
 
            Disable the plugin named
260
 
            <replaceable>PLUGIN</replaceable>.  The plugin will not be
261
 
            started.
 
188
            Disable a specific plugin
262
189
          </para>       
263
190
        </listitem>
264
191
      </varlistentry>
265
 
      
266
 
      <varlistentry>
267
 
        <term><option>--enable
268
 
        <replaceable>PLUGIN</replaceable></option></term>
269
 
        <term><option>-e
270
 
        <replaceable>PLUGIN</replaceable></option></term>
271
 
        <listitem>
272
 
          <para>
273
 
            Re-enable the plugin named
274
 
            <replaceable>PLUGIN</replaceable>.  This is only useful to
275
 
            undo a previous <option>--disable</option> option, maybe
276
 
            from the configuration file.
277
 
          </para>
278
 
        </listitem>
279
 
      </varlistentry>
280
 
      
 
192
 
281
193
      <varlistentry>
282
194
        <term><option>--groupid
283
195
        <replaceable>ID</replaceable></option></term>
284
196
        <listitem>
285
197
          <para>
286
 
            Change to group ID <replaceable>ID</replaceable> on
287
 
            startup.  The default is 65534.  All plugins will be
288
 
            started using this group ID.  <emphasis>Note:</emphasis>
289
 
            This must be a number, not a name.
 
198
            Group ID the plugins will run as
290
199
          </para>
291
200
        </listitem>
292
201
      </varlistentry>
293
 
      
 
202
 
294
203
      <varlistentry>
295
204
        <term><option>--userid
296
205
        <replaceable>ID</replaceable></option></term>
297
206
        <listitem>
298
207
          <para>
299
 
            Change to user ID <replaceable>ID</replaceable> on
300
 
            startup.  The default is 65534.  All plugins will be
301
 
            started using this user ID.  <emphasis>Note:</emphasis>
302
 
            This must be a number, not a name.
 
208
            User ID the plugins will run as
303
209
          </para>
304
210
        </listitem>
305
211
      </varlistentry>
306
 
      
 
212
 
307
213
      <varlistentry>
308
214
        <term><option>--plugin-dir
309
215
        <replaceable>DIRECTORY</replaceable></option></term>
310
216
        <listitem>
311
217
          <para>
312
 
            Specify a different plugin directory.  The default is
313
 
            <filename>/lib/mandos/plugins.d</filename>, which will
314
 
            exist in the initial <acronym>RAM</acronym> disk
315
 
            environment.
316
 
          </para>
317
 
        </listitem>
318
 
      </varlistentry>
319
 
      
320
 
      <varlistentry>
321
 
        <term><option>--config-file
322
 
        <replaceable>FILE</replaceable></option></term>
323
 
        <listitem>
324
 
          <para>
325
 
            Specify a different file to read additional options from.
326
 
            See <xref linkend="files"/>.  Other command line options
327
 
            will override options specified in the file.
 
218
            Specify a different plugin directory
328
219
          </para>
329
220
        </listitem>
330
221
      </varlistentry>
333
224
        <term><option>--debug</option></term>
334
225
        <listitem>
335
226
          <para>
336
 
            Enable debug mode.  This will enable a lot of output to
337
 
            standard error about what the program is doing.  The
338
 
            program will still perform all other functions normally.
339
 
            The default is to <emphasis>not</emphasis> run in debug
340
 
            mode.
341
 
          </para>
342
 
          <para>
343
 
            The plugins will <emphasis>not</emphasis> be affected by
344
 
            this option.  Use
345
 
            <userinput><option>--global-options=--debug</option></userinput>
346
 
            if complete debugging eruption is desired.
 
227
            Debug mode
347
228
          </para>
348
229
        </listitem>
349
230
      </varlistentry>
353
234
        <term><option>-?</option></term>
354
235
        <listitem>
355
236
          <para>
356
 
            Gives a help message about options and their meanings.
 
237
            Gives a help message
357
238
          </para>
358
239
        </listitem>
359
240
      </varlistentry>
362
243
        <term><option>--usage</option></term>
363
244
        <listitem>
364
245
          <para>
365
 
            Gives a short usage message.
 
246
            Gives a short usage message
366
247
          </para>
367
248
        </listitem>
368
249
      </varlistentry>
369
 
      
 
250
 
370
251
      <varlistentry>
371
252
        <term><option>--version</option></term>
372
253
        <term><option>-V</option></term>
373
254
        <listitem>
374
255
          <para>
375
 
            Prints the program version.
 
256
            Prints the program version
376
257
          </para>
377
258
        </listitem>
378
259
      </varlistentry>
379
260
    </variablelist>
380
261
  </refsect1>
381
 
  
382
 
  <refsect1 id="overview">
383
 
    <title>OVERVIEW</title>
384
 
    <xi:include href="overview.xml"/>
385
 
    <para>
386
 
      This program will run on the client side in the initial
387
 
      <acronym>RAM</acronym> disk environment, and is responsible for
388
 
      getting a password.  It does this by running plugins, one of
389
 
      which will normally be the actual client program communicating
390
 
      with the server.
391
 
    </para>
392
 
  </refsect1>
393
 
  <refsect1 id="plugins">
394
 
    <title>PLUGINS</title>
395
 
    <para>
396
 
      This program will get a password by running a number of
397
 
      <firstterm>plugins</firstterm>, which are simply executable
398
 
      programs in a directory in the initial <acronym>RAM</acronym>
399
 
      disk environment.  The default directory is
400
 
      <filename>/lib/mandos/plugins.d</filename>, but this can be
401
 
      changed with the <option>--plugin-dir</option> option.  The
402
 
      plugins are started in parallel, and the first plugin to output
403
 
      a password <emphasis>and</emphasis> exit with a successful exit
404
 
      code will make this plugin-runner output the password from that
405
 
      plugin, stop any other plugins, and exit.
406
 
    </para>
407
 
    
408
 
    <refsect2 id="writing_plugins">
409
 
      <title>WRITING PLUGINS</title>
410
 
      <para>
411
 
        A plugin is simply a program which prints a password to its
412
 
        standard output and then exits with a successful (zero) exit
413
 
        status.  If the exit status is not zero, any output on
414
 
        standard output will be ignored by the plugin runner.  Any
415
 
        output on its standard error channel will simply be passed to
416
 
        the standard error of the plugin runner, usually the system
417
 
        console.
418
 
      </para>
419
 
      <para>
420
 
        If the password is a single-line, manually entered passprase,
421
 
        a final trailing newline character should
422
 
        <emphasis>not</emphasis> be printed.
423
 
      </para>
424
 
      <para>
425
 
        The plugin will run in the initial RAM disk environment, so
426
 
        care must be taken not to depend on any files or running
427
 
        services not available there.
428
 
      </para>
429
 
      <para>
430
 
        The plugin must exit cleanly and free all allocated resources
431
 
        upon getting the TERM signal, since this is what the plugin
432
 
        runner uses to stop all other plugins when one plugin has
433
 
        output a password and exited cleanly.
434
 
      </para>
435
 
      <para>
436
 
        The plugin must not use resources, like for instance reading
437
 
        from the standard input, without knowing that no other plugin
438
 
        is also using it.
439
 
      </para>
440
 
      <para>
441
 
        It is useful, but not required, for the plugin to take the
442
 
        <option>--debug</option> option.
443
 
      </para>
444
 
    </refsect2>
445
 
  </refsect1>
446
 
  
447
 
  <refsect1 id="fallback">
448
 
    <title>FALLBACK</title>
449
 
    <para>
450
 
      If no plugins succeed, this program will, as a fallback, ask for
451
 
      a password on the console using <citerefentry><refentrytitle
452
 
      >getpass</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
453
 
      and output it.  This is not meant to be the normal mode of
454
 
      operation, as there is a separate plugin for getting a password
455
 
      from the console.
456
 
    </para>
457
 
  </refsect1>
458
 
  
 
262
 
459
263
  <refsect1 id="exit_status">
460
264
    <title>EXIT STATUS</title>
461
265
    <para>
462
 
      Exit status of this program is zero if no errors were
463
 
      encountered, and otherwise not.  The fallback (see <xref
464
 
      linkend="fallback"/>) may or may not have succeeded in either
465
 
      case.
466
 
    </para>
467
 
  </refsect1>
468
 
  
469
 
  <refsect1 id="environment">
470
 
    <title>ENVIRONMENT</title>
471
 
    <para>
472
 
      This program does not use any environment variables itself, it
473
 
      only passes on its environment to all the plugins.  The
474
 
      environment passed to plugins can be modified using the
475
 
      <option>--global-env</option> and <option>--env-for</option>
476
 
      options.
477
 
    </para>
478
 
  </refsect1>
479
 
  
480
 
  <refsect1 id="files">
 
266
    </para>
 
267
  </refsect1>
 
268
 
 
269
  <refsect1 id="file">
481
270
    <title>FILES</title>
482
271
    <para>
483
 
      <variablelist>
484
 
        <varlistentry>
485
 
          <term><filename
486
 
          >/conf/conf.d/mandos/plugin-runner.conf</filename></term>
487
 
          <listitem>
488
 
            <para>
489
 
              Since this program will be run as a keyscript, there is
490
 
              little to no opportunity to pass command line arguments
491
 
              to it.  Therefore, it will <emphasis>also</emphasis>
492
 
              read this file and use its contents as
493
 
              whitespace-separated command line options.  Also,
494
 
              everything from a <quote>#</quote> character to the end
495
 
              of a line is ignored.
496
 
            </para>
497
 
            <para>
498
 
              This program is meant to run in the initial RAM disk
499
 
              environment, so that is where this file is assumed to
500
 
              exist.  The file does not need to exist in the normal
501
 
              file system.
502
 
            </para>
503
 
            <para>
504
 
              This file will be processed <emphasis>before</emphasis>
505
 
              the normal command line options, so the latter can
506
 
              override the former, if need be.
507
 
            </para>
508
 
            <para>
509
 
              This file name is the default; the file to read for
510
 
              arguments can be changed using the
511
 
              <option>--config-file</option> option.
512
 
            </para>
513
 
          </listitem>
514
 
        </varlistentry>
515
 
      </variablelist>
 
272
    </para>
 
273
  </refsect1>
 
274
 
 
275
  <refsect1 id="notes">
 
276
    <title>NOTES</title>
 
277
    <para>
516
278
    </para>
517
279
  </refsect1>
518
280
  
519
281
  <refsect1 id="bugs">
520
282
    <title>BUGS</title>
521
283
    <para>
522
 
      The <option>--config-file</option> option is ignored when
523
 
      specified from within a configuration file.
524
284
    </para>
525
285
  </refsect1>
526
 
  
 
286
 
527
287
  <refsect1 id="examples">
528
288
    <title>EXAMPLE</title>
529
 
    <informalexample>
530
 
      <para>
531
 
        Normal invocation needs no options:
532
 
      </para>
533
 
      <para>
534
 
        <userinput>&COMMANDNAME;</userinput>
535
 
      </para>
536
 
    </informalexample>
537
 
    <informalexample>
538
 
      <para>
539
 
        Run the program, but not the plugins, in debug mode:
540
 
      </para>
541
 
      <para>
542
 
        
543
 
        <!-- do not wrap this line -->
544
 
        <userinput>&COMMANDNAME; --debug</userinput>
545
 
        
546
 
      </para>
547
 
    </informalexample>
548
 
    <informalexample>
549
 
      <para>
550
 
        Run all plugins, but run the <quote>foo</quote> plugin in
551
 
        debug mode:
552
 
      </para>
553
 
      <para>
554
 
        
555
 
        <!-- do not wrap this line -->
556
 
        <userinput>&COMMANDNAME; --options-for=foo:--debug</userinput>
557
 
        
558
 
      </para>
559
 
    </informalexample>
560
 
    <informalexample>
561
 
      <para>
562
 
        Run all plugins, but not the program, in debug mode:
563
 
      </para>
564
 
      <para>
565
 
        
566
 
        <!-- do not wrap this line -->
567
 
        <userinput>&COMMANDNAME; --global-options=--debug</userinput>
568
 
        
569
 
      </para>
570
 
    </informalexample>
571
 
    <informalexample>
572
 
      <para>
573
 
        Run plugins from a different directory, read a different
574
 
        configuration file, and add two options to the
575
 
        <citerefentry><refentrytitle >mandos-client</refentrytitle>
576
 
        <manvolnum>8mandos</manvolnum></citerefentry> plugin:
577
 
      </para>
578
 
      <para>
579
 
 
580
 
<!-- do not wrap this line -->
581
 
<userinput>&COMMANDNAME;  --config-file=/etc/mandos/plugin-runner.conf --plugin-dir /usr/lib/mandos/plugins.d --options-for=mandos-client:--pubkey=/etc/keys/mandos/pubkey.txt,--seckey=/etc/keys/mandos/seckey.txt</userinput>
582
 
 
583
 
      </para>
584
 
    </informalexample>
 
289
    <para>
 
290
    </para>
585
291
  </refsect1>
 
292
 
586
293
  <refsect1 id="security">
587
294
    <title>SECURITY</title>
588
295
    <para>
589
 
      This program will, when starting, try to switch to another user.
590
 
      If it is started as root, it will succeed, and will by default
591
 
      switch to user and group 65534, which are assumed to be
592
 
      non-privileged.  This user and group is then what all plugins
593
 
      will be started as.  Therefore, the only way to run a plugin as
594
 
      a privileged user is to have the set-user-ID or set-group-ID bit
595
 
      set on the plugin executable file (see <citerefentry>
596
 
      <refentrytitle>execve</refentrytitle><manvolnum>2</manvolnum>
597
 
      </citerefentry>).
598
 
    </para>
599
 
    <para>
600
 
      If this program is used as a keyscript in <citerefentry
601
 
      ><refentrytitle>crypttab</refentrytitle><manvolnum>5</manvolnum>
602
 
      </citerefentry>, there is a slight risk that if this program
603
 
      fails to work, there might be no way to boot the system except
604
 
      for booting from another media and editing the initial RAM disk
605
 
      image to not run this program.  This is, however, unlikely,
606
 
      since the <citerefentry><refentrytitle
607
 
      >password-prompt</refentrytitle><manvolnum>8mandos</manvolnum>
608
 
      </citerefentry> plugin will read a password from the console in
609
 
      case of failure of the other plugins, and this plugin runner
610
 
      will also, in case of catastrophic failure, itself fall back to
611
 
      asking and outputting a password on the console (see <xref
612
 
      linkend="fallback"/>).
613
296
    </para>
614
297
  </refsect1>
615
 
  
 
298
 
616
299
  <refsect1 id="see_also">
617
300
    <title>SEE ALSO</title>
618
301
    <para>
619
302
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
620
303
      <manvolnum>8</manvolnum></citerefentry>,
621
 
      <citerefentry><refentrytitle>crypttab</refentrytitle>
622
 
      <manvolnum>5</manvolnum></citerefentry>,
623
 
      <citerefentry><refentrytitle>execve</refentrytitle>
624
 
      <manvolnum>2</manvolnum></citerefentry>,
625
304
      <citerefentry><refentrytitle>mandos</refentrytitle>
626
305
      <manvolnum>8</manvolnum></citerefentry>,
627
306
      <citerefentry><refentrytitle>password-prompt</refentrytitle>
628
307
      <manvolnum>8mandos</manvolnum></citerefentry>,
629
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
308
      <citerefentry><refentrytitle>password-request</refentrytitle>
630
309
      <manvolnum>8mandos</manvolnum></citerefentry>
631
310
    </para>
632
311
  </refsect1>
633
 
  
 
312
 
634
313
</refentry>
635
314
<!-- Local Variables: -->
636
315
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->