/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-22 17:38:57 UTC
  • Revision ID: teddy@recompile.se-20240922173857-rfhxneq4207tx9o0
Only use D-Bus when necessary

If *both* "use_dbus" and "zeroconf" are false, by either setting them
to False in mandos.conf or by using the --no-dbus and --no-zeroconf
options (and a port number or socket is specified), then we do not
need to connect to D-Bus at all.

From: Mike Klein <mike@kleinnet.com>
Signed-off-by: Teddy Hogeborn <teddy@recompile.se>

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 "2011-10-05">
 
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>
36
37
      <year>2011</year>
 
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>
114
123
      <arg><option>--plugin-dir=<replaceable
115
124
      >DIRECTORY</replaceable></option></arg>
116
125
      <sbr/>
 
126
      <arg><option>--plugin-helper-dir=<replaceable
 
127
      >DIRECTORY</replaceable></option></arg>
 
128
      <sbr/>
117
129
      <arg><option>--config-file=<replaceable
118
130
      >FILE</replaceable></option></arg>
119
131
      <sbr/>
320
332
      </varlistentry>
321
333
      
322
334
      <varlistentry>
 
335
        <term><option>--plugin-helper-dir
 
336
        <replaceable>DIRECTORY</replaceable></option></term>
 
337
        <listitem>
 
338
          <para>
 
339
            Specify a different plugin helper directory.  The default
 
340
            is <filename>/lib/mandos/plugin-helpers</filename>, which
 
341
            will exist in the initial <acronym>RAM</acronym> disk
 
342
            environment.  (This will simply be passed to all plugins
 
343
            via the <envar>MANDOSPLUGINHELPERDIR</envar> environment
 
344
            variable.  See <xref linkend="writing_plugins"/>)
 
345
          </para>
 
346
        </listitem>
 
347
      </varlistentry>
 
348
      
 
349
      <varlistentry>
323
350
        <term><option>--config-file
324
351
        <replaceable>FILE</replaceable></option></term>
325
352
        <listitem>
396
423
    <title>PLUGINS</title>
397
424
    <para>
398
425
      This program will get a password by running a number of
399
 
      <firstterm>plugins</firstterm>, which are simply executable
400
 
      programs in a directory in the initial <acronym>RAM</acronym>
401
 
      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
402
429
      <filename>/lib/mandos/plugins.d</filename>, but this can be
403
430
      changed with the <option>--plugin-dir</option> option.  The
404
431
      plugins are started in parallel, and the first plugin to output
410
437
    <refsect2 id="writing_plugins">
411
438
      <title>WRITING PLUGINS</title>
412
439
      <para>
413
 
        A plugin is simply a program which prints a password to its
414
 
        standard output and then exits with a successful (zero) exit
415
 
        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
416
443
        standard output will be ignored by the plugin runner.  Any
417
444
        output on its standard error channel will simply be passed to
418
445
        the standard error of the plugin runner, usually the system
426
453
      <para>
427
454
        The plugin will run in the initial RAM disk environment, so
428
455
        care must be taken not to depend on any files or running
429
 
        services not available there.
 
456
        services not available there.  Any helper executables required
 
457
        by the plugin (which are not in the <envar>PATH</envar>) can
 
458
        be placed in the plugin helper directory, the name of which
 
459
        will be made available to the plugin via the
 
460
        <envar>MANDOSPLUGINHELPERDIR</envar> environment variable.
430
461
      </para>
431
462
      <para>
432
463
        The plugin must exit cleanly and free all allocated resources
475
506
      only passes on its environment to all the plugins.  The
476
507
      environment passed to plugins can be modified using the
477
508
      <option>--global-env</option> and <option>--env-for</option>
478
 
      options.
 
509
      options.  Also, the <option>--plugin-helper-dir</option> option
 
510
      will affect the environment variable
 
511
      <envar>MANDOSPLUGINHELPERDIR</envar> for the plugins.
479
512
    </para>
480
513
  </refsect1>
481
514
  
514
547
            </para>
515
548
          </listitem>
516
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>
517
570
      </variablelist>
518
571
    </para>
519
572
  </refsect1>
524
577
      The <option>--config-file</option> option is ignored when
525
578
      specified from within a configuration file.
526
579
    </para>
 
580
    <xi:include href="bugs.xml"/>
527
581
  </refsect1>
528
582
  
529
583
  <refsect1 id="examples">
572
626
    </informalexample>
573
627
    <informalexample>
574
628
      <para>
575
 
        Run plugins from a different directory, read a different
576
 
        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
577
632
        <citerefentry><refentrytitle >mandos-client</refentrytitle>
578
633
        <manvolnum>8mandos</manvolnum></citerefentry> plugin:
579
634
      </para>
580
635
      <para>
581
636
 
582
637
<!-- do not wrap this line -->
583
 
<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>
584
639
 
585
640
      </para>
586
641
    </informalexample>