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