/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: 2024-09-08 00:24:32 UTC
  • mto: This revision was merged to the branch mainline in revision 410.
  • 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 "2019-02-10">
 
5
<!ENTITY TIMESTAMP "2023-04-30">
6
6
<!ENTITY % common SYSTEM "common.ent">
7
7
%common;
8
8
]>
423
423
    <title>PLUGINS</title>
424
424
    <para>
425
425
      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
 
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
429
429
      <filename>/lib/mandos/plugins.d</filename>, but this can be
430
430
      changed with the <option>--plugin-dir</option> option.  The
431
431
      plugins are started in parallel, and the first plugin to output
437
437
    <refsect2 id="writing_plugins">
438
438
      <title>WRITING PLUGINS</title>
439
439
      <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
 
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
443
443
        standard output will be ignored by the plugin runner.  Any
444
444
        output on its standard error channel will simply be passed to
445
445
        the standard error of the plugin runner, usually the system
628
628
      <para>
629
629
        Read a different configuration file, run plugins from a
630
630
        different directory, specify an alternate plugin helper
631
 
        directory and add two options to the
 
631
        directory and add four options to the
632
632
        <citerefentry><refentrytitle >mandos-client</refentrytitle>
633
633
        <manvolnum>8mandos</manvolnum></citerefentry> plugin:
634
634
      </para>
635
635
      <para>
636
636
 
637
637
<!-- 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>
 
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>
639
639
 
640
640
      </para>
641
641
    </informalexample>