/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-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
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">
4
5
<!ENTITY COMMANDNAME "plugin-runner">
5
 
<!ENTITY TIMESTAMP "2008-09-30">
6
 
<!ENTITY % common SYSTEM "common.ent">
7
 
%common;
 
6
<!ENTITY TIMESTAMP "2008-09-01">
8
7
]>
9
8
 
10
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
12
11
    <title>Mandos Manual</title>
13
12
    <!-- Nwalsh’s docbook scripts use this to generate the footer: -->
14
13
    <productname>Mandos</productname>
15
 
    <productnumber>&version;</productnumber>
 
14
    <productnumber>&VERSION;</productnumber>
16
15
    <date>&TIMESTAMP;</date>
17
16
    <authorgroup>
18
17
      <author>
37
36
    </copyright>
38
37
    <xi:include href="legalnotice.xml"/>
39
38
  </refentryinfo>
40
 
  
 
39
 
41
40
  <refmeta>
42
41
    <refentrytitle>&COMMANDNAME;</refentrytitle>
43
42
    <manvolnum>8mandos</manvolnum>
46
45
  <refnamediv>
47
46
    <refname><command>&COMMANDNAME;</command></refname>
48
47
    <refpurpose>
49
 
      Run Mandos plugins, pass data from first to succeed.
 
48
      Run Mandos plugins.  Pass data from first succesful one.
50
49
    </refpurpose>
51
50
  </refnamediv>
52
 
  
 
51
 
53
52
  <refsynopsisdiv>
54
53
    <cmdsynopsis>
55
54
      <command>&COMMANDNAME;</command>
56
55
      <group rep="repeat">
57
56
        <arg choice="plain"><option>--global-env=<replaceable
58
 
        >ENV</replaceable><literal>=</literal><replaceable
 
57
        >VAR</replaceable><literal>=</literal><replaceable
59
58
        >value</replaceable></option></arg>
60
 
        <arg choice="plain"><option>-G
61
 
        <replaceable>ENV</replaceable><literal>=</literal><replaceable
 
59
        <arg choice="plain"><option>-e
 
60
        <replaceable>VAR</replaceable><literal>=</literal><replaceable
62
61
        >value</replaceable> </option></arg>
63
62
      </group>
64
63
      <sbr/>
67
66
        >PLUGIN</replaceable><literal>:</literal><replaceable
68
67
        >ENV</replaceable><literal>=</literal><replaceable
69
68
        >value</replaceable></option></arg>
70
 
        <arg choice="plain"><option>-E<replaceable>
 
69
        <arg choice="plain"><option>-f<replaceable>
71
70
        PLUGIN</replaceable><literal>:</literal><replaceable
72
71
        >ENV</replaceable><literal>=</literal><replaceable
73
72
        >value</replaceable> </option></arg>
84
83
        <arg choice="plain"><option>--options-for=<replaceable
85
84
        >PLUGIN</replaceable><literal>:</literal><replaceable
86
85
        >OPTIONS</replaceable></option></arg>
87
 
        <arg choice="plain"><option>-o<replaceable>
 
86
        <arg choice="plain"><option>-f<replaceable>
88
87
        PLUGIN</replaceable><literal>:</literal><replaceable
89
88
        >OPTIONS</replaceable> </option></arg>
90
89
      </group>
96
95
        <replaceable>PLUGIN</replaceable> </option></arg>
97
96
      </group>
98
97
      <sbr/>
99
 
      <group rep="repeat">
100
 
        <arg choice="plain"><option>--enable=<replaceable
101
 
        >PLUGIN</replaceable></option></arg>
102
 
        <arg choice="plain"><option>-e
103
 
        <replaceable>PLUGIN</replaceable> </option></arg>
104
 
      </group>
105
 
      <sbr/>
106
98
      <arg><option>--groupid=<replaceable
107
99
      >ID</replaceable></option></arg>
108
100
      <sbr/>
112
104
      <arg><option>--plugin-dir=<replaceable
113
105
      >DIRECTORY</replaceable></option></arg>
114
106
      <sbr/>
115
 
      <arg><option>--config-file=<replaceable
116
 
      >FILE</replaceable></option></arg>
117
 
      <sbr/>
118
107
      <arg><option>--debug</option></arg>
119
108
    </cmdsynopsis>
120
109
    <cmdsynopsis>
141
130
    <title>DESCRIPTION</title>
142
131
    <para>
143
132
      <command>&COMMANDNAME;</command> is a program which is meant to
144
 
      be specified as a <quote>keyscript</quote> for the root disk in
145
 
      <citerefentry><refentrytitle>crypttab</refentrytitle>
146
 
      <manvolnum>5</manvolnum></citerefentry>.  The aim of this
147
 
      program is therefore to output a password, which then
148
 
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
149
 
      <manvolnum>8</manvolnum></citerefentry> will use to unlock the
150
 
      root disk.
 
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.
151
140
    </para>
152
141
    <para>
153
142
      This program is not meant to be invoked directly, but can be in
171
160
    <variablelist>
172
161
      <varlistentry>
173
162
        <term><option>--global-env
174
 
        <replaceable>ENV</replaceable><literal>=</literal><replaceable
 
163
        <replaceable>VAR</replaceable><literal>=</literal><replaceable
175
164
        >value</replaceable></option></term>
176
 
        <term><option>-G
177
 
        <replaceable>ENV</replaceable><literal>=</literal><replaceable
 
165
        <term><option>-e
 
166
        <replaceable>VAR</replaceable><literal>=</literal><replaceable
178
167
        >value</replaceable></option></term>
179
168
        <listitem>
180
169
          <para>
181
 
            This option will add an environment variable setting to
182
 
            all plugins.  This will override any inherited environment
183
 
            variable.
 
170
            
184
171
          </para>
185
172
        </listitem>
186
173
      </varlistentry>
190
177
        <replaceable>PLUGIN</replaceable><literal>:</literal
191
178
        ><replaceable>ENV</replaceable><literal>=</literal
192
179
        ><replaceable>value</replaceable></option></term>
193
 
        <term><option>-E
 
180
        <term><option>-f
194
181
        <replaceable>PLUGIN</replaceable><literal>:</literal
195
182
        ><replaceable>ENV</replaceable><literal>=</literal
196
183
        ><replaceable>value</replaceable></option></term>
197
184
        <listitem>
198
185
          <para>
199
 
            This option will add an environment variable setting to
200
 
            the <replaceable>PLUGIN</replaceable> plugin.  This will
201
 
            override any inherited environment variables or
202
 
            environment variables specified using
203
 
            <option>--global-env</option>.
204
186
          </para>
205
187
        </listitem>
206
188
      </varlistentry>
216
198
            <replaceable>OPTIONS</replaceable> is a comma separated
217
199
            list of options.  This is not a very useful option, except
218
200
            for specifying the <quote><option>--debug</option></quote>
219
 
            option to all plugins.
 
201
            for all plugins.
220
202
          </para>
221
203
        </listitem>
222
204
      </varlistentry>
242
224
            <option>--bar</option> with the option argument
243
225
            <quote>baz</quote> is either
244
226
            <userinput>--options-for=foo:--bar=baz</userinput> or
245
 
            <userinput>--options-for=foo:--bar,baz</userinput>.  Using
246
 
            <userinput>--options-for="foo:--bar baz"</userinput>. will
247
 
            <emphasis>not</emphasis> work.
 
227
            <userinput>--options-for=foo:--bar,baz</userinput>, but
 
228
            <emphasis>not</emphasis>
 
229
            <userinput>--options-for="foo:--bar baz"</userinput>.
248
230
          </para>
249
231
        </listitem>
250
232
      </varlistentry>
251
 
      
 
233
 
252
234
      <varlistentry>
253
 
        <term><option>--disable
 
235
        <term><option> --disable
254
236
        <replaceable>PLUGIN</replaceable></option></term>
255
237
        <term><option>-d
256
238
        <replaceable>PLUGIN</replaceable></option></term>
262
244
          </para>       
263
245
        </listitem>
264
246
      </varlistentry>
265
 
      
266
 
      <varlistentry>
267
 
        <term><option>--enable
268
 
        <replaceable>PLUGIN</replaceable></option></term>
269
 
        <term><option>-e
270
 
        <replaceable>PLUGIN</replaceable></option></term>
271
 
        <listitem>
272
 
          <para>
273
 
            Re-enable the plugin named
274
 
            <replaceable>PLUGIN</replaceable>.  This is only useful to
275
 
            undo a previous <option>--disable</option> option, maybe
276
 
            from the configuration file.
277
 
          </para>
278
 
        </listitem>
279
 
      </varlistentry>
280
 
      
 
247
 
281
248
      <varlistentry>
282
249
        <term><option>--groupid
283
250
        <replaceable>ID</replaceable></option></term>
290
257
          </para>
291
258
        </listitem>
292
259
      </varlistentry>
293
 
      
 
260
 
294
261
      <varlistentry>
295
262
        <term><option>--userid
296
263
        <replaceable>ID</replaceable></option></term>
303
270
          </para>
304
271
        </listitem>
305
272
      </varlistentry>
306
 
      
 
273
 
307
274
      <varlistentry>
308
275
        <term><option>--plugin-dir
309
276
        <replaceable>DIRECTORY</replaceable></option></term>
318
285
      </varlistentry>
319
286
      
320
287
      <varlistentry>
321
 
        <term><option>--config-file
322
 
        <replaceable>FILE</replaceable></option></term>
323
 
        <listitem>
324
 
          <para>
325
 
            Specify a different file to read additional options from.
326
 
            See <xref linkend="files"/>.  Other command line options
327
 
            will override options specified in the file.
328
 
          </para>
329
 
        </listitem>
330
 
      </varlistentry>
331
 
      
332
 
      <varlistentry>
333
288
        <term><option>--debug</option></term>
334
289
        <listitem>
335
290
          <para>
366
321
          </para>
367
322
        </listitem>
368
323
      </varlistentry>
369
 
      
 
324
 
370
325
      <varlistentry>
371
326
        <term><option>--version</option></term>
372
327
        <term><option>-V</option></term>
378
333
      </varlistentry>
379
334
    </variablelist>
380
335
  </refsect1>
381
 
  
 
336
 
382
337
  <refsect1 id="overview">
383
338
    <title>OVERVIEW</title>
384
339
    <xi:include href="overview.xml"/>
404
359
      code will make this plugin-runner output the password from that
405
360
      plugin, stop any other plugins, and exit.
406
361
    </para>
407
 
    
408
 
    <refsect2 id="writing_plugins">
409
 
      <title>WRITING PLUGINS</title>
410
 
      <para>
411
 
        A plugin is simply a program which prints a password to its
412
 
        standard output and then exits with a successful (zero) exit
413
 
        status.  If the exit status is not zero, any output on
414
 
        standard output will be ignored by the plugin runner.  Any
415
 
        output on its standard error channel will simply be passed to
416
 
        the standard error of the plugin runner, usually the system
417
 
        console.
418
 
      </para>
419
 
      <para>
420
 
        If the password is a single-line, manually entered passprase,
421
 
        a final trailing newline character should
422
 
        <emphasis>not</emphasis> be printed.
423
 
      </para>
424
 
      <para>
425
 
        The plugin will run in the initial RAM disk environment, so
426
 
        care must be taken not to depend on any files or running
427
 
        services not available there.
428
 
      </para>
429
 
      <para>
430
 
        The plugin must exit cleanly and free all allocated resources
431
 
        upon getting the TERM signal, since this is what the plugin
432
 
        runner uses to stop all other plugins when one plugin has
433
 
        output a password and exited cleanly.
434
 
      </para>
435
 
      <para>
436
 
        The plugin must not use resources, like for instance reading
437
 
        from the standard input, without knowing that no other plugin
438
 
        is also using it.
439
 
      </para>
440
 
      <para>
441
 
        It is useful, but not required, for the plugin to take the
442
 
        <option>--debug</option> option.
443
 
      </para>
444
 
    </refsect2>
445
362
  </refsect1>
446
363
  
447
364
  <refsect1 id="fallback">
469
386
  <refsect1 id="environment">
470
387
    <title>ENVIRONMENT</title>
471
388
    <para>
472
 
      This program does not use any environment variables itself, it
473
 
      only passes on its environment to all the plugins.  The
474
 
      environment passed to plugins can be modified using the
475
 
      <option>--global-env</option> and <option>--env-for</option>
476
 
      options.
 
389
      
477
390
    </para>
478
391
  </refsect1>
479
392
  
480
 
  <refsect1 id="files">
 
393
  <refsect1 id="file">
481
394
    <title>FILES</title>
482
395
    <para>
483
396
      <variablelist>
494
407
              everything from a <quote>#</quote> character to the end
495
408
              of a line is ignored.
496
409
            </para>
497
 
            <para>
498
 
              This program is meant to run in the initial RAM disk
499
 
              environment, so that is where this file is assumed to
500
 
              exist.  The file does not need to exist in the normal
501
 
              file system.
502
 
            </para>
503
 
            <para>
504
 
              This file will be processed <emphasis>before</emphasis>
505
 
              the normal command line options, so the latter can
506
 
              override the former, if need be.
507
 
            </para>
508
 
            <para>
509
 
              This file name is the default; the file to read for
510
 
              arguments can be changed using the
511
 
              <option>--config-file</option> option.
512
 
            </para>
513
410
          </listitem>
514
411
        </varlistentry>
515
412
      </variablelist>
519
416
  <refsect1 id="bugs">
520
417
    <title>BUGS</title>
521
418
    <para>
522
 
      The <option>--config-file</option> option is ignored when
523
 
      specified from within a configuration file.
524
419
    </para>
525
420
  </refsect1>
526
421
  
527
422
  <refsect1 id="examples">
528
423
    <title>EXAMPLE</title>
529
 
    <informalexample>
530
 
      <para>
531
 
        Normal invocation needs no options:
532
 
      </para>
533
 
      <para>
534
 
        <userinput>&COMMANDNAME;</userinput>
535
 
      </para>
536
 
    </informalexample>
537
 
    <informalexample>
538
 
      <para>
539
 
        Run the program, but not the plugins, in debug mode:
540
 
      </para>
541
 
      <para>
542
 
        
543
 
        <!-- do not wrap this line -->
544
 
        <userinput>&COMMANDNAME; --debug</userinput>
545
 
        
546
 
      </para>
547
 
    </informalexample>
548
 
    <informalexample>
549
 
      <para>
550
 
        Run all plugins, but run the <quote>foo</quote> plugin in
551
 
        debug mode:
552
 
      </para>
553
 
      <para>
554
 
        
555
 
        <!-- do not wrap this line -->
556
 
        <userinput>&COMMANDNAME; --options-for=foo:--debug</userinput>
557
 
        
558
 
      </para>
559
 
    </informalexample>
560
 
    <informalexample>
561
 
      <para>
562
 
        Run all plugins, but not the program, in debug mode:
563
 
      </para>
564
 
      <para>
565
 
        
566
 
        <!-- do not wrap this line -->
567
 
        <userinput>&COMMANDNAME; --global-options=--debug</userinput>
568
 
        
569
 
      </para>
570
 
    </informalexample>
571
 
    <informalexample>
572
 
      <para>
573
 
        Run plugins from a different directory, read a different
574
 
        configuration file, and add two options to the
575
 
        <citerefentry><refentrytitle >mandos-client</refentrytitle>
576
 
        <manvolnum>8mandos</manvolnum></citerefentry> plugin:
577
 
      </para>
578
 
      <para>
579
 
 
580
 
<!-- do not wrap this line -->
581
 
<userinput>&COMMANDNAME;  --config-file=/etc/mandos/plugin-runner.conf --plugin-dir /usr/lib/mandos/plugins.d --options-for=mandos-client:--pubkey=/etc/keys/mandos/pubkey.txt,--seckey=/etc/keys/mandos/seckey.txt</userinput>
582
 
 
583
 
      </para>
584
 
    </informalexample>
 
424
    <para>
 
425
    </para>
585
426
  </refsect1>
 
427
  
586
428
  <refsect1 id="security">
587
429
    <title>SECURITY</title>
588
430
    <para>
589
 
      This program will, when starting, try to switch to another user.
590
 
      If it is started as root, it will succeed, and will by default
591
 
      switch to user and group 65534, which are assumed to be
592
 
      non-privileged.  This user and group is then what all plugins
593
 
      will be started as.  Therefore, the only way to run a plugin as
594
 
      a privileged user is to have the set-user-ID or set-group-ID bit
595
 
      set on the plugin executable file (see <citerefentry>
596
 
      <refentrytitle>execve</refentrytitle><manvolnum>2</manvolnum>
597
 
      </citerefentry>).
598
 
    </para>
599
 
    <para>
600
 
      If this program is used as a keyscript in <citerefentry
601
 
      ><refentrytitle>crypttab</refentrytitle><manvolnum>5</manvolnum>
602
 
      </citerefentry>, there is a slight risk that if this program
603
 
      fails to work, there might be no way to boot the system except
604
 
      for booting from another media and editing the initial RAM disk
605
 
      image to not run this program.  This is, however, unlikely,
606
 
      since the <citerefentry><refentrytitle
607
 
      >password-prompt</refentrytitle><manvolnum>8mandos</manvolnum>
608
 
      </citerefentry> plugin will read a password from the console in
609
 
      case of failure of the other plugins, and this plugin runner
610
 
      will also, in case of catastrophic failure, itself fall back to
611
 
      asking and outputting a password on the console (see <xref
612
 
      linkend="fallback"/>).
613
431
    </para>
614
432
  </refsect1>
615
433
  
618
436
    <para>
619
437
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
620
438
      <manvolnum>8</manvolnum></citerefentry>,
621
 
      <citerefentry><refentrytitle>crypttab</refentrytitle>
622
 
      <manvolnum>5</manvolnum></citerefentry>,
623
 
      <citerefentry><refentrytitle>execve</refentrytitle>
624
 
      <manvolnum>2</manvolnum></citerefentry>,
625
439
      <citerefentry><refentrytitle>mandos</refentrytitle>
626
440
      <manvolnum>8</manvolnum></citerefentry>,
627
441
      <citerefentry><refentrytitle>password-prompt</refentrytitle>
628
442
      <manvolnum>8mandos</manvolnum></citerefentry>,
629
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
443
      <citerefentry><refentrytitle>password-request</refentrytitle>
630
444
      <manvolnum>8mandos</manvolnum></citerefentry>
631
445
    </para>
632
446
  </refsect1>