/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-02 10:27:08 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080902102708-j5k6ec3lcgkaeipv
* plugin-runner.xml: Changed short option for "--global-env" to "-G",
                     changed short option for "--env-for" to "-E".
                     added new options "--enable" ("-e") and
                     "--config-file".
  (ENVIRONMENT): Added text.
  (FILES): Changed id to "files".  Improved wording and add more text.

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 "2018-02-08">
6
 
<!ENTITY % common SYSTEM "common.ent">
7
 
%common;
 
6
<!ENTITY TIMESTAMP "2008-09-02">
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
59
        <arg choice="plain"><option>-G
71
 
        <replaceable>ENV</replaceable><literal>=</literal><replaceable
 
60
        <replaceable>VAR</replaceable><literal>=</literal><replaceable
72
61
        >value</replaceable> </option></arg>
73
62
      </group>
74
63
      <sbr/>
122
111
      <arg><option>--plugin-dir=<replaceable
123
112
      >DIRECTORY</replaceable></option></arg>
124
113
      <sbr/>
125
 
      <arg><option>--plugin-helper-dir=<replaceable
126
 
      >DIRECTORY</replaceable></option></arg>
127
 
      <sbr/>
128
114
      <arg><option>--config-file=<replaceable
129
115
      >FILE</replaceable></option></arg>
130
116
      <sbr/>
154
140
    <title>DESCRIPTION</title>
155
141
    <para>
156
142
      <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.
 
143
      be specified as <quote>keyscript</quote> in <citerefentry>
 
144
      <refentrytitle>crypttab</refentrytitle>
 
145
      <manvolnum>5</manvolnum></citerefentry> for the root disk.  The
 
146
      aim of this program is therefore to output a password, which
 
147
      then <citerefentry><refentrytitle>cryptsetup</refentrytitle>
 
148
      <manvolnum>8</manvolnum></citerefentry> will use to try and
 
149
      unlock the root disk.
164
150
    </para>
165
151
    <para>
166
152
      This program is not meant to be invoked directly, but can be in
184
170
    <variablelist>
185
171
      <varlistentry>
186
172
        <term><option>--global-env
187
 
        <replaceable>ENV</replaceable><literal>=</literal><replaceable
 
173
        <replaceable>VAR</replaceable><literal>=</literal><replaceable
188
174
        >value</replaceable></option></term>
189
 
        <term><option>-G
190
 
        <replaceable>ENV</replaceable><literal>=</literal><replaceable
 
175
        <term><option>-e
 
176
        <replaceable>VAR</replaceable><literal>=</literal><replaceable
191
177
        >value</replaceable></option></term>
192
178
        <listitem>
193
179
          <para>
203
189
        <replaceable>PLUGIN</replaceable><literal>:</literal
204
190
        ><replaceable>ENV</replaceable><literal>=</literal
205
191
        ><replaceable>value</replaceable></option></term>
206
 
        <term><option>-E
 
192
        <term><option>-f
207
193
        <replaceable>PLUGIN</replaceable><literal>:</literal
208
194
        ><replaceable>ENV</replaceable><literal>=</literal
209
195
        ><replaceable>value</replaceable></option></term>
229
215
            <replaceable>OPTIONS</replaceable> is a comma separated
230
216
            list of options.  This is not a very useful option, except
231
217
            for specifying the <quote><option>--debug</option></quote>
232
 
            option to all plugins.
 
218
            for all plugins.
233
219
          </para>
234
220
        </listitem>
235
221
      </varlistentry>
255
241
            <option>--bar</option> with the option argument
256
242
            <quote>baz</quote> is either
257
243
            <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.
 
244
            <userinput>--options-for=foo:--bar,baz</userinput>, but
 
245
            <emphasis>not</emphasis>
 
246
            <userinput>--options-for="foo:--bar baz"</userinput>.
261
247
          </para>
262
248
        </listitem>
263
249
      </varlistentry>
264
 
      
 
250
 
265
251
      <varlistentry>
266
252
        <term><option>--disable
267
253
        <replaceable>PLUGIN</replaceable></option></term>
272
258
            Disable the plugin named
273
259
            <replaceable>PLUGIN</replaceable>.  The plugin will not be
274
260
            started.
275
 
          </para>
 
261
          </para>       
276
262
        </listitem>
277
263
      </varlistentry>
278
 
      
 
264
 
279
265
      <varlistentry>
280
266
        <term><option>--enable
281
267
        <replaceable>PLUGIN</replaceable></option></term>
286
272
            Re-enable the plugin named
287
273
            <replaceable>PLUGIN</replaceable>.  This is only useful to
288
274
            undo a previous <option>--disable</option> option, maybe
289
 
            from the configuration file.
 
275
            from the config file.
290
276
          </para>
291
277
        </listitem>
292
278
      </varlistentry>
293
 
      
 
279
 
294
280
      <varlistentry>
295
281
        <term><option>--groupid
296
282
        <replaceable>ID</replaceable></option></term>
303
289
          </para>
304
290
        </listitem>
305
291
      </varlistentry>
306
 
      
 
292
 
307
293
      <varlistentry>
308
294
        <term><option>--userid
309
295
        <replaceable>ID</replaceable></option></term>
316
302
          </para>
317
303
        </listitem>
318
304
      </varlistentry>
319
 
      
 
305
 
320
306
      <varlistentry>
321
307
        <term><option>--plugin-dir
322
308
        <replaceable>DIRECTORY</replaceable></option></term>
331
317
      </varlistentry>
332
318
      
333
319
      <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
320
        <term><option>--config-file
350
321
        <replaceable>FILE</replaceable></option></term>
351
322
        <listitem>
394
365
          </para>
395
366
        </listitem>
396
367
      </varlistentry>
397
 
      
 
368
 
398
369
      <varlistentry>
399
370
        <term><option>--version</option></term>
400
371
        <term><option>-V</option></term>
406
377
      </varlistentry>
407
378
    </variablelist>
408
379
  </refsect1>
409
 
  
 
380
 
410
381
  <refsect1 id="overview">
411
382
    <title>OVERVIEW</title>
412
383
    <xi:include href="overview.xml"/>
432
403
      code will make this plugin-runner output the password from that
433
404
      plugin, stop any other plugins, and exit.
434
405
    </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
406
  </refsect1>
478
407
  
479
408
  <refsect1 id="fallback">
505
434
      only passes on its environment to all the plugins.  The
506
435
      environment passed to plugins can be modified using the
507
436
      <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.
 
437
      optins.
511
438
    </para>
512
439
  </refsect1>
513
440
  
546
473
            </para>
547
474
          </listitem>
548
475
        </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
 
          </listitem>
568
 
        </varlistentry>
569
476
      </variablelist>
570
477
    </para>
571
478
  </refsect1>
573
480
  <refsect1 id="bugs">
574
481
    <title>BUGS</title>
575
482
    <para>
576
 
      The <option>--config-file</option> option is ignored when
577
 
      specified from within a configuration file.
578
483
    </para>
579
 
    <xi:include href="bugs.xml"/>
580
484
  </refsect1>
581
485
  
582
486
  <refsect1 id="examples">
583
487
    <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>
 
488
    <para>
 
489
    </para>
641
490
  </refsect1>
 
491
  
642
492
  <refsect1 id="security">
643
493
    <title>SECURITY</title>
644
494
    <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
495
    </para>
670
496
  </refsect1>
671
497
  
672
498
  <refsect1 id="see_also">
673
499
    <title>SEE ALSO</title>
674
500
    <para>
675
 
      <citerefentry><refentrytitle>intro</refentrytitle>
676
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
677
501
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
678
502
      <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
503
      <citerefentry><refentrytitle>mandos</refentrytitle>
684
504
      <manvolnum>8</manvolnum></citerefentry>,
685
505
      <citerefentry><refentrytitle>password-prompt</refentrytitle>
686
506
      <manvolnum>8mandos</manvolnum></citerefentry>,
687
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
507
      <citerefentry><refentrytitle>password-request</refentrytitle>
688
508
      <manvolnum>8mandos</manvolnum></citerefentry>
689
509
    </para>
690
510
  </refsect1>