/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: 2025-06-27 19:56:23 UTC
  • mto: This revision was merged to the branch mainline in revision 414.
  • Revision ID: teddy@recompile.se-20250627195623-02t2vap0gixox3mo
Update Debian Policy version to 4.7.2; no other changes necessary.

* debian/control (Standards-Version): Change to "4.7.2".

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 "2019-02-10">
 
5
<!ENTITY TIMESTAMP "2025-06-27">
6
6
<!ENTITY % common SYSTEM "common.ent">
7
7
%common;
8
8
]>
43
43
      <year>2017</year>
44
44
      <year>2018</year>
45
45
      <year>2019</year>
 
46
      <year>2020</year>
 
47
      <year>2021</year>
 
48
      <year>2022</year>
 
49
      <year>2023</year>
 
50
      <year>2024</year>
46
51
      <holder>Teddy Hogeborn</holder>
47
52
      <holder>Björn Påhlsson</holder>
48
53
    </copyright>
423
428
    <title>PLUGINS</title>
424
429
    <para>
425
430
      This program will get a password by running a number of
426
 
      <firstterm>plugins</firstterm>, which are simply executable
427
 
      programs in a directory in the initial <acronym>RAM</acronym>
428
 
      disk environment.  The default directory is
 
431
      <firstterm>plugins</firstterm>, which are executable programs in
 
432
      a directory in the initial <acronym>RAM</acronym> disk
 
433
      environment.  The default directory is
429
434
      <filename>/lib/mandos/plugins.d</filename>, but this can be
430
435
      changed with the <option>--plugin-dir</option> option.  The
431
436
      plugins are started in parallel, and the first plugin to output
437
442
    <refsect2 id="writing_plugins">
438
443
      <title>WRITING PLUGINS</title>
439
444
      <para>
440
 
        A plugin is simply a program which prints a password to its
441
 
        standard output and then exits with a successful (zero) exit
442
 
        status.  If the exit status is not zero, any output on
 
445
        A plugin is an executable program which prints a password to
 
446
        its standard output and then exits with a successful (zero)
 
447
        exit status.  If the exit status is not zero, any output on
443
448
        standard output will be ignored by the plugin runner.  Any
444
449
        output on its standard error channel will simply be passed to
445
450
        the standard error of the plugin runner, usually the system
628
633
      <para>
629
634
        Read a different configuration file, run plugins from a
630
635
        different directory, specify an alternate plugin helper
631
 
        directory and add two options to the
 
636
        directory and add four options to the
632
637
        <citerefentry><refentrytitle >mandos-client</refentrytitle>
633
638
        <manvolnum>8mandos</manvolnum></citerefentry> plugin:
634
639
      </para>
635
640
      <para>
636
641
 
637
642
<!-- 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,--seckey=seckey.txt,--tls-pubkey=tls-pubkey.pem,--tls-privkey=tls-privkey.pem</userinput>
 
643
<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>
639
644
 
640
645
      </para>
641
646
    </informalexample>