/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 02:39:45 UTC
  • Revision ID: teddy@recompile.se-20240908023945-6tjq4xb1fcxhvrvu
http://bugs.debian.org/1060546
Prefer the systemd-dev package as a build dependency

When building, we only need the systemd.pc pkgconfig file, and
systemd-dev is a new package which, if available, contains that file
without bringing in the whole of systemd.  So prefer using that
package as a build dependency.

* debian/control (Source: mandos/Build-Depends): Change "systemd" to
  "systemd-dev | systemd".

Closes: #1060546
Reported-By: Michael Biebl <biebl@debian.org>

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-06-28">
 
5
<!ENTITY TIMESTAMP "2023-04-30">
6
6
<!ENTITY % common SYSTEM "common.ent">
7
7
%common;
8
8
]>
33
33
    <copyright>
34
34
      <year>2008</year>
35
35
      <year>2009</year>
 
36
      <year>2010</year>
 
37
      <year>2011</year>
36
38
      <year>2012</year>
 
39
      <year>2013</year>
 
40
      <year>2014</year>
 
41
      <year>2015</year>
 
42
      <year>2016</year>
 
43
      <year>2017</year>
 
44
      <year>2018</year>
 
45
      <year>2019</year>
37
46
      <holder>Teddy Hogeborn</holder>
38
47
      <holder>Björn Påhlsson</holder>
39
48
    </copyright>
414
423
    <title>PLUGINS</title>
415
424
    <para>
416
425
      This program will get a password by running a number of
417
 
      <firstterm>plugins</firstterm>, which are simply executable
418
 
      programs in a directory in the initial <acronym>RAM</acronym>
419
 
      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
420
429
      <filename>/lib/mandos/plugins.d</filename>, but this can be
421
430
      changed with the <option>--plugin-dir</option> option.  The
422
431
      plugins are started in parallel, and the first plugin to output
428
437
    <refsect2 id="writing_plugins">
429
438
      <title>WRITING PLUGINS</title>
430
439
      <para>
431
 
        A plugin is simply a program which prints a password to its
432
 
        standard output and then exits with a successful (zero) exit
433
 
        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
434
443
        standard output will be ignored by the plugin runner.  Any
435
444
        output on its standard error channel will simply be passed to
436
445
        the standard error of the plugin runner, usually the system
538
547
            </para>
539
548
          </listitem>
540
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>
541
570
      </variablelist>
542
571
    </para>
543
572
  </refsect1>
548
577
      The <option>--config-file</option> option is ignored when
549
578
      specified from within a configuration file.
550
579
    </para>
 
580
    <xi:include href="bugs.xml"/>
551
581
  </refsect1>
552
582
  
553
583
  <refsect1 id="examples">
596
626
    </informalexample>
597
627
    <informalexample>
598
628
      <para>
599
 
        Run plugins from a different directory, read a different
600
 
        configuration file, and add two options to the
 
629
        Read a different configuration file, run plugins from a
 
630
        different directory, specify an alternate plugin helper
 
631
        directory and add four options to the
601
632
        <citerefentry><refentrytitle >mandos-client</refentrytitle>
602
633
        <manvolnum>8mandos</manvolnum></citerefentry> plugin:
603
634
      </para>
604
635
      <para>
605
636
 
606
637
<!-- do not wrap this line -->
607
 
<userinput>cd /etc/keys/mandos; &COMMANDNAME;  --config-file=/etc/mandos/plugin-runner.conf --plugin-dir /usr/lib/mandos/plugins.d --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>
608
639
 
609
640
      </para>
610
641
    </informalexample>