/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: 2010-09-28 19:38:10 UTC
  • mfrom: (237.4.2 mandos-release)
  • Revision ID: teddy@fukt.bsnet.se-20100928193810-hw5fktxy93epthxx
Merge from release branch.

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugin-runner.xml
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
4
<!ENTITY COMMANDNAME "plugin-runner">
5
 
<!ENTITY TIMESTAMP "2023-04-30">
 
5
<!ENTITY TIMESTAMP "2009-01-17">
6
6
<!ENTITY % common SYSTEM "common.ent">
7
7
%common;
8
8
]>
19
19
        <firstname>Björn</firstname>
20
20
        <surname>Påhlsson</surname>
21
21
        <address>
22
 
          <email>belorn@recompile.se</email>
 
22
          <email>belorn@fukt.bsnet.se</email>
23
23
        </address>
24
24
      </author>
25
25
      <author>
26
26
        <firstname>Teddy</firstname>
27
27
        <surname>Hogeborn</surname>
28
28
        <address>
29
 
          <email>teddy@recompile.se</email>
 
29
          <email>teddy@fukt.bsnet.se</email>
30
30
        </address>
31
31
      </author>
32
32
    </authorgroup>
33
33
    <copyright>
34
34
      <year>2008</year>
35
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
 
      <year>2019</year>
46
36
      <holder>Teddy Hogeborn</holder>
47
37
      <holder>Björn Påhlsson</holder>
48
38
    </copyright>
123
113
      <arg><option>--plugin-dir=<replaceable
124
114
      >DIRECTORY</replaceable></option></arg>
125
115
      <sbr/>
126
 
      <arg><option>--plugin-helper-dir=<replaceable
127
 
      >DIRECTORY</replaceable></option></arg>
128
 
      <sbr/>
129
116
      <arg><option>--config-file=<replaceable
130
117
      >FILE</replaceable></option></arg>
131
118
      <sbr/>
273
260
            Disable the plugin named
274
261
            <replaceable>PLUGIN</replaceable>.  The plugin will not be
275
262
            started.
276
 
          </para>
 
263
          </para>       
277
264
        </listitem>
278
265
      </varlistentry>
279
266
      
332
319
      </varlistentry>
333
320
      
334
321
      <varlistentry>
335
 
        <term><option>--plugin-helper-dir
336
 
        <replaceable>DIRECTORY</replaceable></option></term>
337
 
        <listitem>
338
 
          <para>
339
 
            Specify a different plugin helper directory.  The default
340
 
            is <filename>/lib/mandos/plugin-helpers</filename>, which
341
 
            will exist in the initial <acronym>RAM</acronym> disk
342
 
            environment.  (This will simply be passed to all plugins
343
 
            via the <envar>MANDOSPLUGINHELPERDIR</envar> environment
344
 
            variable.  See <xref linkend="writing_plugins"/>)
345
 
          </para>
346
 
        </listitem>
347
 
      </varlistentry>
348
 
      
349
 
      <varlistentry>
350
322
        <term><option>--config-file
351
323
        <replaceable>FILE</replaceable></option></term>
352
324
        <listitem>
423
395
    <title>PLUGINS</title>
424
396
    <para>
425
397
      This program will get a password by running a number of
426
 
      <firstterm>plugins</firstterm>, which are executable programs in
427
 
      a directory in the initial <acronym>RAM</acronym> disk
428
 
      environment.  The default directory is
 
398
      <firstterm>plugins</firstterm>, which are simply executable
 
399
      programs in a directory in the initial <acronym>RAM</acronym>
 
400
      disk environment.  The default directory is
429
401
      <filename>/lib/mandos/plugins.d</filename>, but this can be
430
402
      changed with the <option>--plugin-dir</option> option.  The
431
403
      plugins are started in parallel, and the first plugin to output
437
409
    <refsect2 id="writing_plugins">
438
410
      <title>WRITING PLUGINS</title>
439
411
      <para>
440
 
        A plugin is an executable program which prints a password to
441
 
        its standard output and then exits with a successful (zero)
442
 
        exit status.  If the exit status is not zero, any output on
 
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
443
415
        standard output will be ignored by the plugin runner.  Any
444
416
        output on its standard error channel will simply be passed to
445
417
        the standard error of the plugin runner, usually the system
453
425
      <para>
454
426
        The plugin will run in the initial RAM disk environment, so
455
427
        care must be taken not to depend on any files or running
456
 
        services not available there.  Any helper executables required
457
 
        by the plugin (which are not in the <envar>PATH</envar>) can
458
 
        be placed in the plugin helper directory, the name of which
459
 
        will be made available to the plugin via the
460
 
        <envar>MANDOSPLUGINHELPERDIR</envar> environment variable.
 
428
        services not available there.
461
429
      </para>
462
430
      <para>
463
431
        The plugin must exit cleanly and free all allocated resources
506
474
      only passes on its environment to all the plugins.  The
507
475
      environment passed to plugins can be modified using the
508
476
      <option>--global-env</option> and <option>--env-for</option>
509
 
      options.  Also, the <option>--plugin-helper-dir</option> option
510
 
      will affect the environment variable
511
 
      <envar>MANDOSPLUGINHELPERDIR</envar> for the plugins.
 
477
      options.
512
478
    </para>
513
479
  </refsect1>
514
480
  
547
513
            </para>
548
514
          </listitem>
549
515
        </varlistentry>
550
 
        <varlistentry>
551
 
          <term><filename class="directory"
552
 
          >/lib/mandos/plugins.d</filename></term>
553
 
          <listitem>
554
 
            <para>
555
 
              The default plugin directory; can be changed by the
556
 
              <option>--plugin-dir</option> option.
557
 
            </para>
558
 
          </listitem>
559
 
        </varlistentry>
560
 
        <varlistentry>
561
 
          <term><filename class="directory"
562
 
          >/lib/mandos/plugin-helpers</filename></term>
563
 
          <listitem>
564
 
            <para>
565
 
              The default plugin helper directory; can be changed by
566
 
              the <option>--plugin-helper-dir</option> option.
567
 
            </para>
568
 
          </listitem>
569
 
        </varlistentry>
570
516
      </variablelist>
571
517
    </para>
572
518
  </refsect1>
577
523
      The <option>--config-file</option> option is ignored when
578
524
      specified from within a configuration file.
579
525
    </para>
580
 
    <xi:include href="bugs.xml"/>
581
526
  </refsect1>
582
527
  
583
528
  <refsect1 id="examples">
626
571
    </informalexample>
627
572
    <informalexample>
628
573
      <para>
629
 
        Read a different configuration file, run plugins from a
630
 
        different directory, specify an alternate plugin helper
631
 
        directory and add four options to the
 
574
        Run plugins from a different directory, read a different
 
575
        configuration file, and add two options to the
632
576
        <citerefentry><refentrytitle >mandos-client</refentrytitle>
633
577
        <manvolnum>8mandos</manvolnum></citerefentry> plugin:
634
578
      </para>
635
579
      <para>
636
580
 
637
581
<!-- do not wrap this line -->
638
 
<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,&#x200b;--seckey=seckey.txt,&#x200b;--tls-pubkey=tls-pubkey.pem,&#x200b;--tls-privkey=tls-privkey.pem</userinput>
 
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>
639
583
 
640
584
      </para>
641
585
    </informalexample>
673
617
  <refsect1 id="see_also">
674
618
    <title>SEE ALSO</title>
675
619
    <para>
676
 
      <citerefentry><refentrytitle>intro</refentrytitle>
677
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
678
620
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
679
621
      <manvolnum>8</manvolnum></citerefentry>,
680
622
      <citerefentry><refentrytitle>crypttab</refentrytitle>