/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to plugin-runner.xml

  • Committer: Teddy Hogeborn
  • Date: 2008-09-19 17:30:43 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080919173043-oar4cbayx4ow122x
* debian/control (mandos, mandos-client): Depend on "adduser".
  (mandos): Removed unused substitution variables.

* debian/mandos-client.postinst (update_initramfs, create_key): Do not
                                                                use
                                                                "type".
  (add_mandos_user): Do not call the user "Mandos password daemon".

* debian/mandos.postinst (add_mandos_user): - '' -

* debian/mandos-client.postrm (purge): Do not use "type".  Do not
                                       remove config directories; this
                                       is done automatically.

Show diffs side-by-side

added added

removed removed

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