/mandos/trunk

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

« back to all changes in this revision

Viewing changes to plugin-runner.xml

  • Committer: Teddy Hogeborn
  • Date: 2008-12-28 10:20:47 UTC
  • Revision ID: teddy@fukt.bsnet.se-20081228102047-1fhyj7oqxfdo44d2
* Makefile: Bug fix for Debian bug #509398; make sure "-z relro" is
            passed to linker, not C compiler.

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