/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-01 16:19:32 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080901161932-ostp7tulh9aijulh
* plugin-runner.c (add_environment): Never insert existing environment
                                     variables.
  (main): Rename "--global-envs" to "--global-env" and "--envs-for" to
          "--env-for".

* plugin-runner.xml (SYNOPSIS): Rename "--global-envs" to
                                "--global-env" and "--envs-for" to
                                "--env-for".
  (OPTIONS): Added "--global-env" and "--env-for".
  (FALLBACK): Add id attribute.
  (EXIT STATUS): Add text.
  (ENVIRONMENT): New section.
  (FILES): Document configuration file.

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugin-runner.xml
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-04">
 
6
<!ENTITY TIMESTAMP "2008-09-01">
7
7
]>
8
8
 
9
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
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
 
56
56
        <arg choice="plain"><option>--global-env=<replaceable
57
57
        >VAR</replaceable><literal>=</literal><replaceable
58
58
        >value</replaceable></option></arg>
59
 
        <arg choice="plain"><option>-G
 
59
        <arg choice="plain"><option>-e
60
60
        <replaceable>VAR</replaceable><literal>=</literal><replaceable
61
61
        >value</replaceable> </option></arg>
62
62
      </group>
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
172
162
        <term><option>--global-env
173
163
        <replaceable>VAR</replaceable><literal>=</literal><replaceable
174
164
        >value</replaceable></option></term>
175
 
        <term><option>-G
 
165
        <term><option>-e
176
166
        <replaceable>VAR</replaceable><literal>=</literal><replaceable
177
167
        >value</replaceable></option></term>
178
168
        <listitem>
179
169
          <para>
180
 
            This option will add an environment variable setting to
181
 
            all plugins.  This will override any inherited environment
182
 
            variable.
 
170
            
183
171
          </para>
184
172
        </listitem>
185
173
      </varlistentry>
189
177
        <replaceable>PLUGIN</replaceable><literal>:</literal
190
178
        ><replaceable>ENV</replaceable><literal>=</literal
191
179
        ><replaceable>value</replaceable></option></term>
192
 
        <term><option>-E
 
180
        <term><option>-f
193
181
        <replaceable>PLUGIN</replaceable><literal>:</literal
194
182
        ><replaceable>ENV</replaceable><literal>=</literal
195
183
        ><replaceable>value</replaceable></option></term>
196
184
        <listitem>
197
185
          <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
186
          </para>
204
187
        </listitem>
205
188
      </varlistentry>
215
198
            <replaceable>OPTIONS</replaceable> is a comma separated
216
199
            list of options.  This is not a very useful option, except
217
200
            for specifying the <quote><option>--debug</option></quote>
218
 
            option to all plugins.
 
201
            for all plugins.
219
202
          </para>
220
203
        </listitem>
221
204
      </varlistentry>
241
224
            <option>--bar</option> with the option argument
242
225
            <quote>baz</quote> is either
243
226
            <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.
 
227
            <userinput>--options-for=foo:--bar,baz</userinput>, but
 
228
            <emphasis>not</emphasis>
 
229
            <userinput>--options-for="foo:--bar baz"</userinput>.
247
230
          </para>
248
231
        </listitem>
249
232
      </varlistentry>
250
233
 
251
234
      <varlistentry>
252
 
        <term><option>--disable
 
235
        <term><option> --disable
253
236
        <replaceable>PLUGIN</replaceable></option></term>
254
237
        <term><option>-d
255
238
        <replaceable>PLUGIN</replaceable></option></term>
263
246
      </varlistentry>
264
247
 
265
248
      <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
 
 
280
 
      <varlistentry>
281
249
        <term><option>--groupid
282
250
        <replaceable>ID</replaceable></option></term>
283
251
        <listitem>
317
285
      </varlistentry>
318
286
      
319
287
      <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
288
        <term><option>--debug</option></term>
333
289
        <listitem>
334
290
          <para>
403
359
      code will make this plugin-runner output the password from that
404
360
      plugin, stop any other plugins, and exit.
405
361
    </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 plugin
432
 
        is 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
362
  </refsect1>
440
363
  
441
364
  <refsect1 id="fallback">
463
386
  <refsect1 id="environment">
464
387
    <title>ENVIRONMENT</title>
465
388
    <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
 
      options.
 
389
      
471
390
    </para>
472
391
  </refsect1>
473
392
  
474
 
  <refsect1 id="files">
 
393
  <refsect1 id="file">
475
394
    <title>FILES</title>
476
395
    <para>
477
396
      <variablelist>
488
407
              everything from a <quote>#</quote> character to the end
489
408
              of a line is ignored.
490
409
            </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
410
          </listitem>
508
411
        </varlistentry>
509
412
      </variablelist>
510
413
    </para>
511
414
  </refsect1>
512
415
  
513
 
<!--   <refsect1 id="bugs"> -->
514
 
<!--     <title>BUGS</title> -->
515
 
<!--     <para> -->
516
 
<!--     </para> -->
517
 
<!--   </refsect1> -->
 
416
  <refsect1 id="bugs">
 
417
    <title>BUGS</title>
 
418
    <para>
 
419
    </para>
 
420
  </refsect1>
518
421
  
519
422
  <refsect1 id="examples">
520
423
    <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 two
566
 
        options 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:--pubkey=keydir/pubkey.txt,--seckey=keydir/seckey.txt</userinput>
574
 
 
575
 
      </para>
576
 
    </informalexample>
 
424
    <para>
 
425
    </para>
577
426
  </refsect1>
 
427
  
578
428
  <refsect1 id="security">
579
429
    <title>SECURITY</title>
580
430
    <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 slight risk that if this program
595
 
      fails to work, there might be no way to boot the system except
596
 
      for 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
431
    </para>
606
432
  </refsect1>
607
433
  
610
436
    <para>
611
437
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
612
438
      <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
439
      <citerefentry><refentrytitle>mandos</refentrytitle>
618
440
      <manvolnum>8</manvolnum></citerefentry>,
619
441
      <citerefentry><refentrytitle>password-prompt</refentrytitle>