/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: 2016-03-05 22:43:39 UTC
  • mfrom: (237.4.67 release)
  • Revision ID: teddy@recompile.se-20160305224339-a3kklul7we8jozno
Merge from release branch.

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