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