/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: 2016-03-19 21:51:01 UTC
  • mfrom: (237.7.390 trunk)
  • Revision ID: teddy@recompile.se-20160319215101-sw7h1dvhpvadw2mb
Merge from trunk

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 "2016-03-17">
6
6
<!ENTITY % common SYSTEM "common.ent">
7
7
%common;
8
8
]>
40
40
      <year>2014</year>
41
41
      <year>2015</year>
42
42
      <year>2016</year>
43
 
      <year>2017</year>
44
 
      <year>2018</year>
45
 
      <year>2019</year>
46
43
      <holder>Teddy Hogeborn</holder>
47
44
      <holder>Björn Påhlsson</holder>
48
45
    </copyright>
423
420
    <title>PLUGINS</title>
424
421
    <para>
425
422
      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
 
423
      <firstterm>plugins</firstterm>, which are simply executable
 
424
      programs in a directory in the initial <acronym>RAM</acronym>
 
425
      disk environment.  The default directory is
429
426
      <filename>/lib/mandos/plugins.d</filename>, but this can be
430
427
      changed with the <option>--plugin-dir</option> option.  The
431
428
      plugins are started in parallel, and the first plugin to output
437
434
    <refsect2 id="writing_plugins">
438
435
      <title>WRITING PLUGINS</title>
439
436
      <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
 
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
443
440
        standard output will be ignored by the plugin runner.  Any
444
441
        output on its standard error channel will simply be passed to
445
442
        the standard error of the plugin runner, usually the system
628
625
      <para>
629
626
        Read a different configuration file, run plugins from a
630
627
        different directory, specify an alternate plugin helper
631
 
        directory and add four options to the
 
628
        directory and add two options to the
632
629
        <citerefentry><refentrytitle >mandos-client</refentrytitle>
633
630
        <manvolnum>8mandos</manvolnum></citerefentry> plugin:
634
631
      </para>
635
632
      <para>
636
633
 
637
634
<!-- 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>
 
635
<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>
639
636
 
640
637
      </para>
641
638
    </informalexample>