/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: 2015-01-25 00:02:51 UTC
  • mto: (237.7.304 trunk)
  • mto: This revision was merged to the branch mainline in revision 325.
  • Revision ID: teddy@recompile.se-20150125000251-j2bw50gfq9smqyxe
mandos.xml (SEE ALSO): Update links.

Update link to GnuPG home page, change reference from TLS 1.1 to TLS
1.2, and change to latest RFC for using OpenPGP keys with TLS (and use
its correct title).

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