/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:53:17 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080901165317-77dccp81zyqimt2j
* plugin-runner.c (add_environment): Override existing environment
                                     variables when asked to do so.
                                     All callers changed.
  (main): Removed old argp.args_doc string.  Parse argument file
          before normal command line arguments.  Use ARGP_IN_ORDER
          flag in both calls to argp_parse.  Do not strdup() strings
          to be sent to add_environment().

* plugin-runner.xml (OPTIONS): Document "--global-env" and "--envs-for".
  (FILES): Note that the config file is parsed before the command line
           options.

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 "2009-01-17">
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>
32
31
    </authorgroup>
33
32
    <copyright>
34
33
      <year>2008</year>
35
 
      <year>2009</year>
36
34
      <holder>Teddy Hogeborn</holder>
37
35
      <holder>Björn Påhlsson</holder>
38
36
    </copyright>
39
37
    <xi:include href="legalnotice.xml"/>
40
38
  </refentryinfo>
41
 
  
 
39
 
42
40
  <refmeta>
43
41
    <refentrytitle>&COMMANDNAME;</refentrytitle>
44
42
    <manvolnum>8mandos</manvolnum>
47
45
  <refnamediv>
48
46
    <refname><command>&COMMANDNAME;</command></refname>
49
47
    <refpurpose>
50
 
      Run Mandos plugins, pass data from first to succeed.
 
48
      Run Mandos plugins.  Pass data from first succesful one.
51
49
    </refpurpose>
52
50
  </refnamediv>
53
 
  
 
51
 
54
52
  <refsynopsisdiv>
55
53
    <cmdsynopsis>
56
54
      <command>&COMMANDNAME;</command>
57
55
      <group rep="repeat">
58
56
        <arg choice="plain"><option>--global-env=<replaceable
59
 
        >ENV</replaceable><literal>=</literal><replaceable
 
57
        >VAR</replaceable><literal>=</literal><replaceable
60
58
        >value</replaceable></option></arg>
61
 
        <arg choice="plain"><option>-G
62
 
        <replaceable>ENV</replaceable><literal>=</literal><replaceable
 
59
        <arg choice="plain"><option>-e
 
60
        <replaceable>VAR</replaceable><literal>=</literal><replaceable
63
61
        >value</replaceable> </option></arg>
64
62
      </group>
65
63
      <sbr/>
68
66
        >PLUGIN</replaceable><literal>:</literal><replaceable
69
67
        >ENV</replaceable><literal>=</literal><replaceable
70
68
        >value</replaceable></option></arg>
71
 
        <arg choice="plain"><option>-E<replaceable>
 
69
        <arg choice="plain"><option>-f<replaceable>
72
70
        PLUGIN</replaceable><literal>:</literal><replaceable
73
71
        >ENV</replaceable><literal>=</literal><replaceable
74
72
        >value</replaceable> </option></arg>
85
83
        <arg choice="plain"><option>--options-for=<replaceable
86
84
        >PLUGIN</replaceable><literal>:</literal><replaceable
87
85
        >OPTIONS</replaceable></option></arg>
88
 
        <arg choice="plain"><option>-o<replaceable>
 
86
        <arg choice="plain"><option>-f<replaceable>
89
87
        PLUGIN</replaceable><literal>:</literal><replaceable
90
88
        >OPTIONS</replaceable> </option></arg>
91
89
      </group>
97
95
        <replaceable>PLUGIN</replaceable> </option></arg>
98
96
      </group>
99
97
      <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/>
107
98
      <arg><option>--groupid=<replaceable
108
99
      >ID</replaceable></option></arg>
109
100
      <sbr/>
113
104
      <arg><option>--plugin-dir=<replaceable
114
105
      >DIRECTORY</replaceable></option></arg>
115
106
      <sbr/>
116
 
      <arg><option>--config-file=<replaceable
117
 
      >FILE</replaceable></option></arg>
118
 
      <sbr/>
119
107
      <arg><option>--debug</option></arg>
120
108
    </cmdsynopsis>
121
109
    <cmdsynopsis>
142
130
    <title>DESCRIPTION</title>
143
131
    <para>
144
132
      <command>&COMMANDNAME;</command> is a program which is meant to
145
 
      be specified as a <quote>keyscript</quote> for the root disk in
146
 
      <citerefentry><refentrytitle>crypttab</refentrytitle>
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.
 
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.
152
140
    </para>
153
141
    <para>
154
142
      This program is not meant to be invoked directly, but can be in
172
160
    <variablelist>
173
161
      <varlistentry>
174
162
        <term><option>--global-env
175
 
        <replaceable>ENV</replaceable><literal>=</literal><replaceable
 
163
        <replaceable>VAR</replaceable><literal>=</literal><replaceable
176
164
        >value</replaceable></option></term>
177
 
        <term><option>-G
178
 
        <replaceable>ENV</replaceable><literal>=</literal><replaceable
 
165
        <term><option>-e
 
166
        <replaceable>VAR</replaceable><literal>=</literal><replaceable
179
167
        >value</replaceable></option></term>
180
168
        <listitem>
181
169
          <para>
191
179
        <replaceable>PLUGIN</replaceable><literal>:</literal
192
180
        ><replaceable>ENV</replaceable><literal>=</literal
193
181
        ><replaceable>value</replaceable></option></term>
194
 
        <term><option>-E
 
182
        <term><option>-f
195
183
        <replaceable>PLUGIN</replaceable><literal>:</literal
196
184
        ><replaceable>ENV</replaceable><literal>=</literal
197
185
        ><replaceable>value</replaceable></option></term>
217
205
            <replaceable>OPTIONS</replaceable> is a comma separated
218
206
            list of options.  This is not a very useful option, except
219
207
            for specifying the <quote><option>--debug</option></quote>
220
 
            option to all plugins.
 
208
            for all plugins.
221
209
          </para>
222
210
        </listitem>
223
211
      </varlistentry>
243
231
            <option>--bar</option> with the option argument
244
232
            <quote>baz</quote> is either
245
233
            <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.
 
234
            <userinput>--options-for=foo:--bar,baz</userinput>, but
 
235
            <emphasis>not</emphasis>
 
236
            <userinput>--options-for="foo:--bar baz"</userinput>.
249
237
          </para>
250
238
        </listitem>
251
239
      </varlistentry>
252
 
      
 
240
 
253
241
      <varlistentry>
254
 
        <term><option>--disable
 
242
        <term><option> --disable
255
243
        <replaceable>PLUGIN</replaceable></option></term>
256
244
        <term><option>-d
257
245
        <replaceable>PLUGIN</replaceable></option></term>
263
251
          </para>       
264
252
        </listitem>
265
253
      </varlistentry>
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
 
      
 
254
 
282
255
      <varlistentry>
283
256
        <term><option>--groupid
284
257
        <replaceable>ID</replaceable></option></term>
291
264
          </para>
292
265
        </listitem>
293
266
      </varlistentry>
294
 
      
 
267
 
295
268
      <varlistentry>
296
269
        <term><option>--userid
297
270
        <replaceable>ID</replaceable></option></term>
304
277
          </para>
305
278
        </listitem>
306
279
      </varlistentry>
307
 
      
 
280
 
308
281
      <varlistentry>
309
282
        <term><option>--plugin-dir
310
283
        <replaceable>DIRECTORY</replaceable></option></term>
319
292
      </varlistentry>
320
293
      
321
294
      <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.
329
 
          </para>
330
 
        </listitem>
331
 
      </varlistentry>
332
 
      
333
 
      <varlistentry>
334
295
        <term><option>--debug</option></term>
335
296
        <listitem>
336
297
          <para>
367
328
          </para>
368
329
        </listitem>
369
330
      </varlistentry>
370
 
      
 
331
 
371
332
      <varlistentry>
372
333
        <term><option>--version</option></term>
373
334
        <term><option>-V</option></term>
379
340
      </varlistentry>
380
341
    </variablelist>
381
342
  </refsect1>
382
 
  
 
343
 
383
344
  <refsect1 id="overview">
384
345
    <title>OVERVIEW</title>
385
346
    <xi:include href="overview.xml"/>
405
366
      code will make this plugin-runner output the password from that
406
367
      plugin, stop any other plugins, and exit.
407
368
    </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
369
  </refsect1>
447
370
  
448
371
  <refsect1 id="fallback">
470
393
  <refsect1 id="environment">
471
394
    <title>ENVIRONMENT</title>
472
395
    <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.
 
396
      
478
397
    </para>
479
398
  </refsect1>
480
399
  
481
 
  <refsect1 id="files">
 
400
  <refsect1 id="file">
482
401
    <title>FILES</title>
483
402
    <para>
484
403
      <variablelist>
496
415
              of a line is ignored.
497
416
            </para>
498
417
            <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
418
              This file will be processed <emphasis>before</emphasis>
506
419
              the normal command line options, so the latter can
507
420
              override the former, if need be.
508
421
            </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
422
          </listitem>
515
423
        </varlistentry>
516
424
      </variablelist>
520
428
  <refsect1 id="bugs">
521
429
    <title>BUGS</title>
522
430
    <para>
523
 
      The <option>--config-file</option> option is ignored when
524
 
      specified from within a configuration file.
 
431
      There is no <option>--enable</option> option to enable disabled
 
432
      plugins.
525
433
    </para>
526
434
  </refsect1>
527
435
  
528
436
  <refsect1 id="examples">
529
437
    <title>EXAMPLE</title>
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>
 
438
    <para>
 
439
    </para>
586
440
  </refsect1>
 
441
  
587
442
  <refsect1 id="security">
588
443
    <title>SECURITY</title>
589
444
    <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"/>).
614
445
    </para>
615
446
  </refsect1>
616
447
  
619
450
    <para>
620
451
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
621
452
      <manvolnum>8</manvolnum></citerefentry>,
622
 
      <citerefentry><refentrytitle>crypttab</refentrytitle>
623
 
      <manvolnum>5</manvolnum></citerefentry>,
624
 
      <citerefentry><refentrytitle>execve</refentrytitle>
625
 
      <manvolnum>2</manvolnum></citerefentry>,
626
453
      <citerefentry><refentrytitle>mandos</refentrytitle>
627
454
      <manvolnum>8</manvolnum></citerefentry>,
628
455
      <citerefentry><refentrytitle>password-prompt</refentrytitle>
629
456
      <manvolnum>8mandos</manvolnum></citerefentry>,
630
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
457
      <citerefentry><refentrytitle>password-request</refentrytitle>
631
458
      <manvolnum>8mandos</manvolnum></citerefentry>
632
459
    </para>
633
460
  </refsect1>