/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: 2024-09-08 00:24:32 UTC
  • Revision ID: teddy@recompile.se-20240908002432-0exnlv1fp73hps8j
Document how to add options to mandos-client when using dracut

* debian/mandos-client.README.Debian: Remove unnecessary word
  "simply".  Also add instructions on how to add the --connect=
  options to mandos-client when using dracut.
* dracut-module/ask-password-mandos.service ([Service]): Add comments
  that this file should *not* be modified, and explicit instructions
  on how to instead add extra options, like --debug, to mandos-client:
  using a systemd override unit file to set an environment variable.

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 "2018-02-08">
 
5
<!ENTITY TIMESTAMP "2023-04-30">
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>
45
46
      <holder>Teddy Hogeborn</holder>
46
47
      <holder>Björn Påhlsson</holder>
47
48
    </copyright>
422
423
    <title>PLUGINS</title>
423
424
    <para>
424
425
      This program will get a password by running a number of
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
 
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
428
429
      <filename>/lib/mandos/plugins.d</filename>, but this can be
429
430
      changed with the <option>--plugin-dir</option> option.  The
430
431
      plugins are started in parallel, and the first plugin to output
436
437
    <refsect2 id="writing_plugins">
437
438
      <title>WRITING PLUGINS</title>
438
439
      <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
 
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
442
443
        standard output will be ignored by the plugin runner.  Any
443
444
        output on its standard error channel will simply be passed to
444
445
        the standard error of the plugin runner, usually the system
627
628
      <para>
628
629
        Read a different configuration file, run plugins from a
629
630
        different directory, specify an alternate plugin helper
630
 
        directory and add two options to the
 
631
        directory and add four options to the
631
632
        <citerefentry><refentrytitle >mandos-client</refentrytitle>
632
633
        <manvolnum>8mandos</manvolnum></citerefentry> plugin:
633
634
      </para>
634
635
      <para>
635
636
 
636
637
<!-- 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
<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>
638
639
 
639
640
      </para>
640
641
    </informalexample>