/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: 2008-09-02 06:13:47 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080902061347-psw61eqt17j425sq
* plugin-runner.c: Changed short option for "--global-env" to "-G",
                   changed short option for "--env-for" to "-E",
                   added new option "--enable" ("-e").

Show diffs side-by-side

added added

removed removed

Lines of Context:
3
3
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
4
<!ENTITY VERSION "1.0">
5
5
<!ENTITY COMMANDNAME "plugin-runner">
6
 
<!ENTITY TIMESTAMP "2008-09-19">
 
6
<!ENTITY TIMESTAMP "2008-09-01">
7
7
]>
8
8
 
9
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
36
36
    </copyright>
37
37
    <xi:include href="legalnotice.xml"/>
38
38
  </refentryinfo>
39
 
  
 
39
 
40
40
  <refmeta>
41
41
    <refentrytitle>&COMMANDNAME;</refentrytitle>
42
42
    <manvolnum>8mandos</manvolnum>
45
45
  <refnamediv>
46
46
    <refname><command>&COMMANDNAME;</command></refname>
47
47
    <refpurpose>
48
 
      Run Mandos plugins, pass data from first to succeed.
 
48
      Run Mandos plugins.  Pass data from first succesful one.
49
49
    </refpurpose>
50
50
  </refnamediv>
51
 
  
 
51
 
52
52
  <refsynopsisdiv>
53
53
    <cmdsynopsis>
54
54
      <command>&COMMANDNAME;</command>
55
55
      <group rep="repeat">
56
56
        <arg choice="plain"><option>--global-env=<replaceable
57
 
        >ENV</replaceable><literal>=</literal><replaceable
 
57
        >VAR</replaceable><literal>=</literal><replaceable
58
58
        >value</replaceable></option></arg>
59
 
        <arg choice="plain"><option>-G
60
 
        <replaceable>ENV</replaceable><literal>=</literal><replaceable
 
59
        <arg choice="plain"><option>-e
 
60
        <replaceable>VAR</replaceable><literal>=</literal><replaceable
61
61
        >value</replaceable> </option></arg>
62
62
      </group>
63
63
      <sbr/>
66
66
        >PLUGIN</replaceable><literal>:</literal><replaceable
67
67
        >ENV</replaceable><literal>=</literal><replaceable
68
68
        >value</replaceable></option></arg>
69
 
        <arg choice="plain"><option>-E<replaceable>
 
69
        <arg choice="plain"><option>-f<replaceable>
70
70
        PLUGIN</replaceable><literal>:</literal><replaceable
71
71
        >ENV</replaceable><literal>=</literal><replaceable
72
72
        >value</replaceable> </option></arg>
83
83
        <arg choice="plain"><option>--options-for=<replaceable
84
84
        >PLUGIN</replaceable><literal>:</literal><replaceable
85
85
        >OPTIONS</replaceable></option></arg>
86
 
        <arg choice="plain"><option>-o<replaceable>
 
86
        <arg choice="plain"><option>-f<replaceable>
87
87
        PLUGIN</replaceable><literal>:</literal><replaceable
88
88
        >OPTIONS</replaceable> </option></arg>
89
89
      </group>
95
95
        <replaceable>PLUGIN</replaceable> </option></arg>
96
96
      </group>
97
97
      <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
98
      <arg><option>--groupid=<replaceable
106
99
      >ID</replaceable></option></arg>
107
100
      <sbr/>
111
104
      <arg><option>--plugin-dir=<replaceable
112
105
      >DIRECTORY</replaceable></option></arg>
113
106
      <sbr/>
114
 
      <arg><option>--config-file=<replaceable
115
 
      >FILE</replaceable></option></arg>
116
 
      <sbr/>
117
107
      <arg><option>--debug</option></arg>
118
108
    </cmdsynopsis>
119
109
    <cmdsynopsis>
140
130
    <title>DESCRIPTION</title>
141
131
    <para>
142
132
      <command>&COMMANDNAME;</command> is a program which is meant to
143
 
      be specified as a <quote>keyscript</quote> for the root disk in
144
 
      <citerefentry><refentrytitle>crypttab</refentrytitle>
145
 
      <manvolnum>5</manvolnum></citerefentry>.  The aim of this
146
 
      program is therefore to output a password, which then
147
 
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
148
 
      <manvolnum>8</manvolnum></citerefentry> will use to unlock the
149
 
      root disk.
 
133
      be specified as <quote>keyscript</quote> in <citerefentry>
 
134
      <refentrytitle>crypttab</refentrytitle>
 
135
      <manvolnum>5</manvolnum></citerefentry> for the root disk.  The
 
136
      aim of this program is therefore to output a password, which
 
137
      then <citerefentry><refentrytitle>cryptsetup</refentrytitle>
 
138
      <manvolnum>8</manvolnum></citerefentry> will use to try and
 
139
      unlock the root disk.
150
140
    </para>
151
141
    <para>
152
142
      This program is not meant to be invoked directly, but can be in
170
160
    <variablelist>
171
161
      <varlistentry>
172
162
        <term><option>--global-env
173
 
        <replaceable>ENV</replaceable><literal>=</literal><replaceable
 
163
        <replaceable>VAR</replaceable><literal>=</literal><replaceable
174
164
        >value</replaceable></option></term>
175
 
        <term><option>-G
176
 
        <replaceable>ENV</replaceable><literal>=</literal><replaceable
 
165
        <term><option>-e
 
166
        <replaceable>VAR</replaceable><literal>=</literal><replaceable
177
167
        >value</replaceable></option></term>
178
168
        <listitem>
179
169
          <para>
189
179
        <replaceable>PLUGIN</replaceable><literal>:</literal
190
180
        ><replaceable>ENV</replaceable><literal>=</literal
191
181
        ><replaceable>value</replaceable></option></term>
192
 
        <term><option>-E
 
182
        <term><option>-f
193
183
        <replaceable>PLUGIN</replaceable><literal>:</literal
194
184
        ><replaceable>ENV</replaceable><literal>=</literal
195
185
        ><replaceable>value</replaceable></option></term>
215
205
            <replaceable>OPTIONS</replaceable> is a comma separated
216
206
            list of options.  This is not a very useful option, except
217
207
            for specifying the <quote><option>--debug</option></quote>
218
 
            option to all plugins.
 
208
            for all plugins.
219
209
          </para>
220
210
        </listitem>
221
211
      </varlistentry>
241
231
            <option>--bar</option> with the option argument
242
232
            <quote>baz</quote> is either
243
233
            <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.
 
234
            <userinput>--options-for=foo:--bar,baz</userinput>, but
 
235
            <emphasis>not</emphasis>
 
236
            <userinput>--options-for="foo:--bar baz"</userinput>.
247
237
          </para>
248
238
        </listitem>
249
239
      </varlistentry>
250
 
      
 
240
 
251
241
      <varlistentry>
252
 
        <term><option>--disable
 
242
        <term><option> --disable
253
243
        <replaceable>PLUGIN</replaceable></option></term>
254
244
        <term><option>-d
255
245
        <replaceable>PLUGIN</replaceable></option></term>
261
251
          </para>       
262
252
        </listitem>
263
253
      </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 configuration file.
276
 
          </para>
277
 
        </listitem>
278
 
      </varlistentry>
279
 
      
 
254
 
280
255
      <varlistentry>
281
256
        <term><option>--groupid
282
257
        <replaceable>ID</replaceable></option></term>
289
264
          </para>
290
265
        </listitem>
291
266
      </varlistentry>
292
 
      
 
267
 
293
268
      <varlistentry>
294
269
        <term><option>--userid
295
270
        <replaceable>ID</replaceable></option></term>
302
277
          </para>
303
278
        </listitem>
304
279
      </varlistentry>
305
 
      
 
280
 
306
281
      <varlistentry>
307
282
        <term><option>--plugin-dir
308
283
        <replaceable>DIRECTORY</replaceable></option></term>
317
292
      </varlistentry>
318
293
      
319
294
      <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
295
        <term><option>--debug</option></term>
333
296
        <listitem>
334
297
          <para>
365
328
          </para>
366
329
        </listitem>
367
330
      </varlistentry>
368
 
      
 
331
 
369
332
      <varlistentry>
370
333
        <term><option>--version</option></term>
371
334
        <term><option>-V</option></term>
377
340
      </varlistentry>
378
341
    </variablelist>
379
342
  </refsect1>
380
 
  
 
343
 
381
344
  <refsect1 id="overview">
382
345
    <title>OVERVIEW</title>
383
346
    <xi:include href="overview.xml"/>
403
366
      code will make this plugin-runner output the password from that
404
367
      plugin, stop any other plugins, and exit.
405
368
    </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
 
        If the password is a single-line, manually entered passprase,
420
 
        a final trailing newline character should
421
 
        <emphasis>not</emphasis> be printed.
422
 
      </para>
423
 
      <para>
424
 
        The plugin will run in the initial RAM disk environment, so
425
 
        care must be taken not to depend on any files or running
426
 
        services not available there.
427
 
      </para>
428
 
      <para>
429
 
        The plugin must exit cleanly and free all allocated resources
430
 
        upon getting the TERM signal, since this is what the plugin
431
 
        runner uses to stop all other plugins when one plugin has
432
 
        output a password and exited cleanly.
433
 
      </para>
434
 
      <para>
435
 
        The plugin must not use resources, like for instance reading
436
 
        from the standard input, without knowing that no other plugin
437
 
        is also using it.
438
 
      </para>
439
 
      <para>
440
 
        It is useful, but not required, for the plugin to take the
441
 
        <option>--debug</option> option.
442
 
      </para>
443
 
    </refsect2>
444
369
  </refsect1>
445
370
  
446
371
  <refsect1 id="fallback">
468
393
  <refsect1 id="environment">
469
394
    <title>ENVIRONMENT</title>
470
395
    <para>
471
 
      This program does not use any environment variables itself, it
472
 
      only passes on its environment to all the plugins.  The
473
 
      environment passed to plugins can be modified using the
474
 
      <option>--global-env</option> and <option>--env-for</option>
475
 
      options.
 
396
      
476
397
    </para>
477
398
  </refsect1>
478
399
  
479
 
  <refsect1 id="files">
 
400
  <refsect1 id="file">
480
401
    <title>FILES</title>
481
402
    <para>
482
403
      <variablelist>
494
415
              of a line is ignored.
495
416
            </para>
496
417
            <para>
497
 
              This program is meant to run in the initial RAM disk
498
 
              environment, so that is where this file is assumed to
499
 
              exist.  The file does not need to exist in the normal
500
 
              file system.
501
 
            </para>
502
 
            <para>
503
418
              This file will be processed <emphasis>before</emphasis>
504
419
              the normal command line options, so the latter can
505
420
              override the former, if need be.
506
421
            </para>
507
 
            <para>
508
 
              This file name is the default; the file to read for
509
 
              arguments can be changed using the
510
 
              <option>--config-file</option> option.
511
 
            </para>
512
422
          </listitem>
513
423
        </varlistentry>
514
424
      </variablelist>
518
428
  <refsect1 id="bugs">
519
429
    <title>BUGS</title>
520
430
    <para>
521
 
      The <option>--config-file</option> option is ignored when
522
 
      specified from within a configuration file.
 
431
      There is no <option>--enable</option> option to enable disabled
 
432
      plugins.
523
433
    </para>
524
434
  </refsect1>
525
435
  
526
436
  <refsect1 id="examples">
527
437
    <title>EXAMPLE</title>
528
 
    <informalexample>
529
 
      <para>
530
 
        Normal invocation needs no options:
531
 
      </para>
532
 
      <para>
533
 
        <userinput>&COMMANDNAME;</userinput>
534
 
      </para>
535
 
    </informalexample>
536
 
    <informalexample>
537
 
      <para>
538
 
        Run the program, but not the plugins, in debug mode:
539
 
      </para>
540
 
      <para>
541
 
        
542
 
        <!-- do not wrap this line -->
543
 
        <userinput>&COMMANDNAME; --debug</userinput>
544
 
        
545
 
      </para>
546
 
    </informalexample>
547
 
    <informalexample>
548
 
      <para>
549
 
        Run all plugins, but run the <quote>foo</quote> plugin in
550
 
        debug mode:
551
 
      </para>
552
 
      <para>
553
 
        
554
 
        <!-- do not wrap this line -->
555
 
        <userinput>&COMMANDNAME; --options-for=foo:--debug</userinput>
556
 
        
557
 
      </para>
558
 
    </informalexample>
559
 
    <informalexample>
560
 
      <para>
561
 
        Run all plugins, but not the program, in debug mode:
562
 
      </para>
563
 
      <para>
564
 
        
565
 
        <!-- do not wrap this line -->
566
 
        <userinput>&COMMANDNAME; --global-options=--debug</userinput>
567
 
        
568
 
      </para>
569
 
    </informalexample>
570
 
    <informalexample>
571
 
      <para>
572
 
        Run plugins from a different directory, read a different
573
 
        configuration file, and add two options to the
574
 
        <citerefentry><refentrytitle >mandos-client</refentrytitle>
575
 
        <manvolnum>8mandos</manvolnum></citerefentry> plugin:
576
 
      </para>
577
 
      <para>
578
 
 
579
 
<!-- do not wrap this line -->
580
 
<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>
581
 
 
582
 
      </para>
583
 
    </informalexample>
 
438
    <para>
 
439
    </para>
584
440
  </refsect1>
 
441
  
585
442
  <refsect1 id="security">
586
443
    <title>SECURITY</title>
587
444
    <para>
588
 
      This program will, when starting, try to switch to another user.
589
 
      If it is started as root, it will succeed, and will by default
590
 
      switch to user and group 65534, which are assumed to be
591
 
      non-privileged.  This user and group is then what all plugins
592
 
      will be started as.  Therefore, the only way to run a plugin as
593
 
      a privileged user is to have the set-user-ID or set-group-ID bit
594
 
      set on the plugin executable file (see <citerefentry>
595
 
      <refentrytitle>execve</refentrytitle><manvolnum>2</manvolnum>
596
 
      </citerefentry>).
597
 
    </para>
598
 
    <para>
599
 
      If this program is used as a keyscript in <citerefentry
600
 
      ><refentrytitle>crypttab</refentrytitle><manvolnum>5</manvolnum>
601
 
      </citerefentry>, there is a slight risk that if this program
602
 
      fails to work, there might be no way to boot the system except
603
 
      for booting from another media and editing the initial RAM disk
604
 
      image to not run this program.  This is, however, unlikely,
605
 
      since the <citerefentry><refentrytitle
606
 
      >password-prompt</refentrytitle><manvolnum>8mandos</manvolnum>
607
 
      </citerefentry> plugin will read a password from the console in
608
 
      case of failure of the other plugins, and this plugin runner
609
 
      will also, in case of catastrophic failure, itself fall back to
610
 
      asking and outputting a password on the console (see <xref
611
 
      linkend="fallback"/>).
612
445
    </para>
613
446
  </refsect1>
614
447
  
617
450
    <para>
618
451
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
619
452
      <manvolnum>8</manvolnum></citerefentry>,
620
 
      <citerefentry><refentrytitle>crypttab</refentrytitle>
621
 
      <manvolnum>5</manvolnum></citerefentry>,
622
 
      <citerefentry><refentrytitle>execve</refentrytitle>
623
 
      <manvolnum>2</manvolnum></citerefentry>,
624
453
      <citerefentry><refentrytitle>mandos</refentrytitle>
625
454
      <manvolnum>8</manvolnum></citerefentry>,
626
455
      <citerefentry><refentrytitle>password-prompt</refentrytitle>
627
456
      <manvolnum>8mandos</manvolnum></citerefentry>,
628
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
457
      <citerefentry><refentrytitle>password-request</refentrytitle>
629
458
      <manvolnum>8mandos</manvolnum></citerefentry>
630
459
    </para>
631
460
  </refsect1>