/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: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 "2016-02-28">
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>
19
18
        <firstname>Björn</firstname>
20
19
        <surname>Påhlsson</surname>
21
20
        <address>
22
 
          <email>belorn@recompile.se</email>
 
21
          <email>belorn@fukt.bsnet.se</email>
23
22
        </address>
24
23
      </author>
25
24
      <author>
26
25
        <firstname>Teddy</firstname>
27
26
        <surname>Hogeborn</surname>
28
27
        <address>
29
 
          <email>teddy@recompile.se</email>
 
28
          <email>teddy@fukt.bsnet.se</email>
30
29
        </address>
31
30
      </author>
32
31
    </authorgroup>
33
32
    <copyright>
34
33
      <year>2008</year>
35
 
      <year>2009</year>
36
 
      <year>2010</year>
37
 
      <year>2011</year>
38
 
      <year>2012</year>
39
 
      <year>2013</year>
40
 
      <year>2014</year>
41
 
      <year>2015</year>
42
 
      <year>2016</year>
43
34
      <holder>Teddy Hogeborn</holder>
44
35
      <holder>Björn Påhlsson</holder>
45
36
    </copyright>
46
37
    <xi:include href="legalnotice.xml"/>
47
38
  </refentryinfo>
48
 
  
 
39
 
49
40
  <refmeta>
50
41
    <refentrytitle>&COMMANDNAME;</refentrytitle>
51
42
    <manvolnum>8mandos</manvolnum>
54
45
  <refnamediv>
55
46
    <refname><command>&COMMANDNAME;</command></refname>
56
47
    <refpurpose>
57
 
      Run Mandos plugins, pass data from first to succeed.
 
48
      Run Mandos plugins.  Pass data from first succesful one.
58
49
    </refpurpose>
59
50
  </refnamediv>
60
 
  
 
51
 
61
52
  <refsynopsisdiv>
62
53
    <cmdsynopsis>
63
54
      <command>&COMMANDNAME;</command>
64
55
      <group rep="repeat">
65
56
        <arg choice="plain"><option>--global-env=<replaceable
66
 
        >ENV</replaceable><literal>=</literal><replaceable
 
57
        >VAR</replaceable><literal>=</literal><replaceable
67
58
        >value</replaceable></option></arg>
68
 
        <arg choice="plain"><option>-G
69
 
        <replaceable>ENV</replaceable><literal>=</literal><replaceable
 
59
        <arg choice="plain"><option>-e
 
60
        <replaceable>VAR</replaceable><literal>=</literal><replaceable
70
61
        >value</replaceable> </option></arg>
71
62
      </group>
72
63
      <sbr/>
75
66
        >PLUGIN</replaceable><literal>:</literal><replaceable
76
67
        >ENV</replaceable><literal>=</literal><replaceable
77
68
        >value</replaceable></option></arg>
78
 
        <arg choice="plain"><option>-E<replaceable>
 
69
        <arg choice="plain"><option>-f<replaceable>
79
70
        PLUGIN</replaceable><literal>:</literal><replaceable
80
71
        >ENV</replaceable><literal>=</literal><replaceable
81
72
        >value</replaceable> </option></arg>
92
83
        <arg choice="plain"><option>--options-for=<replaceable
93
84
        >PLUGIN</replaceable><literal>:</literal><replaceable
94
85
        >OPTIONS</replaceable></option></arg>
95
 
        <arg choice="plain"><option>-o<replaceable>
 
86
        <arg choice="plain"><option>-f<replaceable>
96
87
        PLUGIN</replaceable><literal>:</literal><replaceable
97
88
        >OPTIONS</replaceable> </option></arg>
98
89
      </group>
104
95
        <replaceable>PLUGIN</replaceable> </option></arg>
105
96
      </group>
106
97
      <sbr/>
107
 
      <group rep="repeat">
108
 
        <arg choice="plain"><option>--enable=<replaceable
109
 
        >PLUGIN</replaceable></option></arg>
110
 
        <arg choice="plain"><option>-e
111
 
        <replaceable>PLUGIN</replaceable> </option></arg>
112
 
      </group>
113
 
      <sbr/>
114
98
      <arg><option>--groupid=<replaceable
115
99
      >ID</replaceable></option></arg>
116
100
      <sbr/>
120
104
      <arg><option>--plugin-dir=<replaceable
121
105
      >DIRECTORY</replaceable></option></arg>
122
106
      <sbr/>
123
 
      <arg><option>--plugin-helper-dir=<replaceable
124
 
      >DIRECTORY</replaceable></option></arg>
125
 
      <sbr/>
126
 
      <arg><option>--config-file=<replaceable
127
 
      >FILE</replaceable></option></arg>
128
 
      <sbr/>
129
107
      <arg><option>--debug</option></arg>
130
108
    </cmdsynopsis>
131
109
    <cmdsynopsis>
152
130
    <title>DESCRIPTION</title>
153
131
    <para>
154
132
      <command>&COMMANDNAME;</command> is a program which is meant to
155
 
      be specified as a <quote>keyscript</quote> for the root disk in
156
 
      <citerefentry><refentrytitle>crypttab</refentrytitle>
157
 
      <manvolnum>5</manvolnum></citerefentry>.  The aim of this
158
 
      program is therefore to output a password, which then
159
 
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
160
 
      <manvolnum>8</manvolnum></citerefentry> will use to unlock the
161
 
      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.
162
140
    </para>
163
141
    <para>
164
142
      This program is not meant to be invoked directly, but can be in
182
160
    <variablelist>
183
161
      <varlistentry>
184
162
        <term><option>--global-env
185
 
        <replaceable>ENV</replaceable><literal>=</literal><replaceable
 
163
        <replaceable>VAR</replaceable><literal>=</literal><replaceable
186
164
        >value</replaceable></option></term>
187
 
        <term><option>-G
188
 
        <replaceable>ENV</replaceable><literal>=</literal><replaceable
 
165
        <term><option>-e
 
166
        <replaceable>VAR</replaceable><literal>=</literal><replaceable
189
167
        >value</replaceable></option></term>
190
168
        <listitem>
191
169
          <para>
201
179
        <replaceable>PLUGIN</replaceable><literal>:</literal
202
180
        ><replaceable>ENV</replaceable><literal>=</literal
203
181
        ><replaceable>value</replaceable></option></term>
204
 
        <term><option>-E
 
182
        <term><option>-f
205
183
        <replaceable>PLUGIN</replaceable><literal>:</literal
206
184
        ><replaceable>ENV</replaceable><literal>=</literal
207
185
        ><replaceable>value</replaceable></option></term>
227
205
            <replaceable>OPTIONS</replaceable> is a comma separated
228
206
            list of options.  This is not a very useful option, except
229
207
            for specifying the <quote><option>--debug</option></quote>
230
 
            option to all plugins.
 
208
            for all plugins.
231
209
          </para>
232
210
        </listitem>
233
211
      </varlistentry>
253
231
            <option>--bar</option> with the option argument
254
232
            <quote>baz</quote> is either
255
233
            <userinput>--options-for=foo:--bar=baz</userinput> or
256
 
            <userinput>--options-for=foo:--bar,baz</userinput>.  Using
257
 
            <userinput>--options-for="foo:--bar baz"</userinput>. will
258
 
            <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>.
259
237
          </para>
260
238
        </listitem>
261
239
      </varlistentry>
262
 
      
 
240
 
263
241
      <varlistentry>
264
 
        <term><option>--disable
 
242
        <term><option> --disable
265
243
        <replaceable>PLUGIN</replaceable></option></term>
266
244
        <term><option>-d
267
245
        <replaceable>PLUGIN</replaceable></option></term>
270
248
            Disable the plugin named
271
249
            <replaceable>PLUGIN</replaceable>.  The plugin will not be
272
250
            started.
273
 
          </para>
274
 
        </listitem>
275
 
      </varlistentry>
276
 
      
277
 
      <varlistentry>
278
 
        <term><option>--enable
279
 
        <replaceable>PLUGIN</replaceable></option></term>
280
 
        <term><option>-e
281
 
        <replaceable>PLUGIN</replaceable></option></term>
282
 
        <listitem>
283
 
          <para>
284
 
            Re-enable the plugin named
285
 
            <replaceable>PLUGIN</replaceable>.  This is only useful to
286
 
            undo a previous <option>--disable</option> option, maybe
287
 
            from the configuration file.
288
 
          </para>
289
 
        </listitem>
290
 
      </varlistentry>
291
 
      
 
251
          </para>       
 
252
        </listitem>
 
253
      </varlistentry>
 
254
 
292
255
      <varlistentry>
293
256
        <term><option>--groupid
294
257
        <replaceable>ID</replaceable></option></term>
301
264
          </para>
302
265
        </listitem>
303
266
      </varlistentry>
304
 
      
 
267
 
305
268
      <varlistentry>
306
269
        <term><option>--userid
307
270
        <replaceable>ID</replaceable></option></term>
314
277
          </para>
315
278
        </listitem>
316
279
      </varlistentry>
317
 
      
 
280
 
318
281
      <varlistentry>
319
282
        <term><option>--plugin-dir
320
283
        <replaceable>DIRECTORY</replaceable></option></term>
329
292
      </varlistentry>
330
293
      
331
294
      <varlistentry>
332
 
        <term><option>--plugin-helper-dir
333
 
        <replaceable>DIRECTORY</replaceable></option></term>
334
 
        <listitem>
335
 
          <para>
336
 
            Specify a different plugin helper directory.  The default
337
 
            is <filename>/lib/mandos/plugin-helpers</filename>, which
338
 
            will exist in the initial <acronym>RAM</acronym> disk
339
 
            environment.  (This will simply be passed to all plugins
340
 
            via the <envar>MANDOSPLUGINHELPERDIR</envar> environment
341
 
            variable.  See <xref linkend="writing_plugins"/>)
342
 
          </para>
343
 
        </listitem>
344
 
      </varlistentry>
345
 
      
346
 
      <varlistentry>
347
 
        <term><option>--config-file
348
 
        <replaceable>FILE</replaceable></option></term>
349
 
        <listitem>
350
 
          <para>
351
 
            Specify a different file to read additional options from.
352
 
            See <xref linkend="files"/>.  Other command line options
353
 
            will override options specified in the file.
354
 
          </para>
355
 
        </listitem>
356
 
      </varlistentry>
357
 
      
358
 
      <varlistentry>
359
295
        <term><option>--debug</option></term>
360
296
        <listitem>
361
297
          <para>
392
328
          </para>
393
329
        </listitem>
394
330
      </varlistentry>
395
 
      
 
331
 
396
332
      <varlistentry>
397
333
        <term><option>--version</option></term>
398
334
        <term><option>-V</option></term>
404
340
      </varlistentry>
405
341
    </variablelist>
406
342
  </refsect1>
407
 
  
 
343
 
408
344
  <refsect1 id="overview">
409
345
    <title>OVERVIEW</title>
410
346
    <xi:include href="overview.xml"/>
430
366
      code will make this plugin-runner output the password from that
431
367
      plugin, stop any other plugins, and exit.
432
368
    </para>
433
 
    
434
 
    <refsect2 id="writing_plugins">
435
 
      <title>WRITING PLUGINS</title>
436
 
      <para>
437
 
        A plugin is simply a program which prints a password to its
438
 
        standard output and then exits with a successful (zero) exit
439
 
        status.  If the exit status is not zero, any output on
440
 
        standard output will be ignored by the plugin runner.  Any
441
 
        output on its standard error channel will simply be passed to
442
 
        the standard error of the plugin runner, usually the system
443
 
        console.
444
 
      </para>
445
 
      <para>
446
 
        If the password is a single-line, manually entered passprase,
447
 
        a final trailing newline character should
448
 
        <emphasis>not</emphasis> be printed.
449
 
      </para>
450
 
      <para>
451
 
        The plugin will run in the initial RAM disk environment, so
452
 
        care must be taken not to depend on any files or running
453
 
        services not available there.  Any helper executables required
454
 
        by the plugin (which are not in the <envar>PATH</envar>) can
455
 
        be placed in the plugin helper directory, the name of which
456
 
        will be made available to the plugin via the
457
 
        <envar>MANDOSPLUGINHELPERDIR</envar> environment variable.
458
 
      </para>
459
 
      <para>
460
 
        The plugin must exit cleanly and free all allocated resources
461
 
        upon getting the TERM signal, since this is what the plugin
462
 
        runner uses to stop all other plugins when one plugin has
463
 
        output a password and exited cleanly.
464
 
      </para>
465
 
      <para>
466
 
        The plugin must not use resources, like for instance reading
467
 
        from the standard input, without knowing that no other plugin
468
 
        is also using it.
469
 
      </para>
470
 
      <para>
471
 
        It is useful, but not required, for the plugin to take the
472
 
        <option>--debug</option> option.
473
 
      </para>
474
 
    </refsect2>
475
369
  </refsect1>
476
370
  
477
371
  <refsect1 id="fallback">
499
393
  <refsect1 id="environment">
500
394
    <title>ENVIRONMENT</title>
501
395
    <para>
502
 
      This program does not use any environment variables itself, it
503
 
      only passes on its environment to all the plugins.  The
504
 
      environment passed to plugins can be modified using the
505
 
      <option>--global-env</option> and <option>--env-for</option>
506
 
      options.  Also, the <option>--plugin-helper-dir</option> option
507
 
      will affect the environment variable
508
 
      <envar>MANDOSPLUGINHELPERDIR</envar> for the plugins.
 
396
      
509
397
    </para>
510
398
  </refsect1>
511
399
  
512
 
  <refsect1 id="files">
 
400
  <refsect1 id="file">
513
401
    <title>FILES</title>
514
402
    <para>
515
403
      <variablelist>
527
415
              of a line is ignored.
528
416
            </para>
529
417
            <para>
530
 
              This program is meant to run in the initial RAM disk
531
 
              environment, so that is where this file is assumed to
532
 
              exist.  The file does not need to exist in the normal
533
 
              file system.
534
 
            </para>
535
 
            <para>
536
418
              This file will be processed <emphasis>before</emphasis>
537
419
              the normal command line options, so the latter can
538
420
              override the former, if need be.
539
421
            </para>
540
 
            <para>
541
 
              This file name is the default; the file to read for
542
 
              arguments can be changed using the
543
 
              <option>--config-file</option> option.
544
 
            </para>
545
422
          </listitem>
546
423
        </varlistentry>
547
424
      </variablelist>
551
428
  <refsect1 id="bugs">
552
429
    <title>BUGS</title>
553
430
    <para>
554
 
      The <option>--config-file</option> option is ignored when
555
 
      specified from within a configuration file.
 
431
      There is no <option>--enable</option> option to enable disabled
 
432
      plugins.
556
433
    </para>
557
434
  </refsect1>
558
435
  
559
436
  <refsect1 id="examples">
560
437
    <title>EXAMPLE</title>
561
 
    <informalexample>
562
 
      <para>
563
 
        Normal invocation needs no options:
564
 
      </para>
565
 
      <para>
566
 
        <userinput>&COMMANDNAME;</userinput>
567
 
      </para>
568
 
    </informalexample>
569
 
    <informalexample>
570
 
      <para>
571
 
        Run the program, but not the plugins, in debug mode:
572
 
      </para>
573
 
      <para>
574
 
        
575
 
        <!-- do not wrap this line -->
576
 
        <userinput>&COMMANDNAME; --debug</userinput>
577
 
        
578
 
      </para>
579
 
    </informalexample>
580
 
    <informalexample>
581
 
      <para>
582
 
        Run all plugins, but run the <quote>foo</quote> plugin in
583
 
        debug mode:
584
 
      </para>
585
 
      <para>
586
 
        
587
 
        <!-- do not wrap this line -->
588
 
        <userinput>&COMMANDNAME; --options-for=foo:--debug</userinput>
589
 
        
590
 
      </para>
591
 
    </informalexample>
592
 
    <informalexample>
593
 
      <para>
594
 
        Run all plugins, but not the program, in debug mode:
595
 
      </para>
596
 
      <para>
597
 
        
598
 
        <!-- do not wrap this line -->
599
 
        <userinput>&COMMANDNAME; --global-options=--debug</userinput>
600
 
        
601
 
      </para>
602
 
    </informalexample>
603
 
    <informalexample>
604
 
      <para>
605
 
        Read a different configuration file, run plugins from a
606
 
        different directory, specify an alternate plugin helper
607
 
        directory and add two options to the
608
 
        <citerefentry><refentrytitle >mandos-client</refentrytitle>
609
 
        <manvolnum>8mandos</manvolnum></citerefentry> plugin:
610
 
      </para>
611
 
      <para>
612
 
 
613
 
<!-- do not wrap this line -->
614
 
<userinput>cd /etc/keys/mandos; &COMMANDNAME;  --config-file=/etc/mandos/plugin-runner.conf --plugin-dir /usr/lib/x86_64-linux-gnu/mandos/plugins.d --plugin-helper-dir /usr/lib/x86_64-linux-gnu/mandos/plugin-helpers --options-for=mandos-client:--pubkey=pubkey.txt,--seckey=seckey.txt</userinput>
615
 
 
616
 
      </para>
617
 
    </informalexample>
 
438
    <para>
 
439
    </para>
618
440
  </refsect1>
 
441
  
619
442
  <refsect1 id="security">
620
443
    <title>SECURITY</title>
621
444
    <para>
622
 
      This program will, when starting, try to switch to another user.
623
 
      If it is started as root, it will succeed, and will by default
624
 
      switch to user and group 65534, which are assumed to be
625
 
      non-privileged.  This user and group is then what all plugins
626
 
      will be started as.  Therefore, the only way to run a plugin as
627
 
      a privileged user is to have the set-user-ID or set-group-ID bit
628
 
      set on the plugin executable file (see <citerefentry>
629
 
      <refentrytitle>execve</refentrytitle><manvolnum>2</manvolnum>
630
 
      </citerefentry>).
631
 
    </para>
632
 
    <para>
633
 
      If this program is used as a keyscript in <citerefentry
634
 
      ><refentrytitle>crypttab</refentrytitle><manvolnum>5</manvolnum>
635
 
      </citerefentry>, there is a slight risk that if this program
636
 
      fails to work, there might be no way to boot the system except
637
 
      for booting from another media and editing the initial RAM disk
638
 
      image to not run this program.  This is, however, unlikely,
639
 
      since the <citerefentry><refentrytitle
640
 
      >password-prompt</refentrytitle><manvolnum>8mandos</manvolnum>
641
 
      </citerefentry> plugin will read a password from the console in
642
 
      case of failure of the other plugins, and this plugin runner
643
 
      will also, in case of catastrophic failure, itself fall back to
644
 
      asking and outputting a password on the console (see <xref
645
 
      linkend="fallback"/>).
646
445
    </para>
647
446
  </refsect1>
648
447
  
649
448
  <refsect1 id="see_also">
650
449
    <title>SEE ALSO</title>
651
450
    <para>
652
 
      <citerefentry><refentrytitle>intro</refentrytitle>
653
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
654
451
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
655
452
      <manvolnum>8</manvolnum></citerefentry>,
656
 
      <citerefentry><refentrytitle>crypttab</refentrytitle>
657
 
      <manvolnum>5</manvolnum></citerefentry>,
658
 
      <citerefentry><refentrytitle>execve</refentrytitle>
659
 
      <manvolnum>2</manvolnum></citerefentry>,
660
453
      <citerefentry><refentrytitle>mandos</refentrytitle>
661
454
      <manvolnum>8</manvolnum></citerefentry>,
662
455
      <citerefentry><refentrytitle>password-prompt</refentrytitle>
663
456
      <manvolnum>8mandos</manvolnum></citerefentry>,
664
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
457
      <citerefentry><refentrytitle>password-request</refentrytitle>
665
458
      <manvolnum>8mandos</manvolnum></citerefentry>
666
459
    </para>
667
460
  </refsect1>