/mandos/release

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

« back to all changes in this revision

Viewing changes to plugin-runner.xml

  • Committer: Teddy Hogeborn
  • Date: 2011-03-08 19:41:59 UTC
  • Revision ID: teddy@fukt.bsnet.se-20110308194159-h0p66a3rabn8cjkb
Tags: version-1.3.0-1
* Makefile (version): Changed to "1.3.0".
* NEWS (Version 1.3.0): New entry.
* debian/changelog (1.3.0-1): - '' -

Show diffs side-by-side

added added

removed removed

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