/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:31:34 UTC
  • mto: This revision was merged to the branch mainline in revision 410.
  • Revision ID: teddy@recompile.se-20240908003134-kvu38pk7wzhz4rbu
Very minor security improvement when uninstalling package

* debian/mandos-client.postrm: Also shred(1) tls-privkkey.pem.

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 "2015-07-20">
 
5
<!ENTITY TIMESTAMP "2023-04-30">
6
6
<!ENTITY % common SYSTEM "common.ent">
7
7
%common;
8
8
]>
39
39
      <year>2013</year>
40
40
      <year>2014</year>
41
41
      <year>2015</year>
 
42
      <year>2016</year>
 
43
      <year>2017</year>
 
44
      <year>2018</year>
 
45
      <year>2019</year>
42
46
      <holder>Teddy Hogeborn</holder>
43
47
      <holder>Björn Påhlsson</holder>
44
48
    </copyright>
419
423
    <title>PLUGINS</title>
420
424
    <para>
421
425
      This program will get a password by running a number of
422
 
      <firstterm>plugins</firstterm>, which are simply executable
423
 
      programs in a directory in the initial <acronym>RAM</acronym>
424
 
      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
425
429
      <filename>/lib/mandos/plugins.d</filename>, but this can be
426
430
      changed with the <option>--plugin-dir</option> option.  The
427
431
      plugins are started in parallel, and the first plugin to output
433
437
    <refsect2 id="writing_plugins">
434
438
      <title>WRITING PLUGINS</title>
435
439
      <para>
436
 
        A plugin is simply a program which prints a password to its
437
 
        standard output and then exits with a successful (zero) exit
438
 
        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
439
443
        standard output will be ignored by the plugin runner.  Any
440
444
        output on its standard error channel will simply be passed to
441
445
        the standard error of the plugin runner, usually the system
543
547
            </para>
544
548
          </listitem>
545
549
        </varlistentry>
 
550
        <varlistentry>
 
551
          <term><filename class="directory"
 
552
          >/lib/mandos/plugins.d</filename></term>
 
553
          <listitem>
 
554
            <para>
 
555
              The default plugin directory; can be changed by the
 
556
              <option>--plugin-dir</option> option.
 
557
            </para>
 
558
          </listitem>
 
559
        </varlistentry>
 
560
        <varlistentry>
 
561
          <term><filename class="directory"
 
562
          >/lib/mandos/plugin-helpers</filename></term>
 
563
          <listitem>
 
564
            <para>
 
565
              The default plugin helper directory; can be changed by
 
566
              the <option>--plugin-helper-dir</option> option.
 
567
            </para>
 
568
          </listitem>
 
569
        </varlistentry>
546
570
      </variablelist>
547
571
    </para>
548
572
  </refsect1>
553
577
      The <option>--config-file</option> option is ignored when
554
578
      specified from within a configuration file.
555
579
    </para>
 
580
    <xi:include href="bugs.xml"/>
556
581
  </refsect1>
557
582
  
558
583
  <refsect1 id="examples">
603
628
      <para>
604
629
        Read a different configuration file, run plugins from a
605
630
        different directory, specify an alternate plugin helper
606
 
        directory and add two options to the
 
631
        directory and add four options to the
607
632
        <citerefentry><refentrytitle >mandos-client</refentrytitle>
608
633
        <manvolnum>8mandos</manvolnum></citerefentry> plugin:
609
634
      </para>
610
635
      <para>
611
636
 
612
637
<!-- do not wrap this line -->
613
 
<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>
614
639
 
615
640
      </para>
616
641
    </informalexample>