/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 13:55:04 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080831135504-2ka1cccglsghslxy
* plugin-runner.xml (/refentry/refentryinfo/copyright): Split
                                                        copyright
                                                        holders.
* plugins.d/password-request.xml (/refentry/refentryinfo/copyright):
                                 Split copyright holders.

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