/mandos/trunk

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

« back to all changes in this revision

Viewing changes to plugin-runner.xml

  • Committer: Teddy Hogeborn
  • Date: 2008-08-31 09:26:12 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080831092612-atz9uzia38h1ijy5
* mandos.xml (OPTIONS): Moved long options before short.  Use <option>
                        tags instead of <literal>.

Show diffs side-by-side

added added

removed removed

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