/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: 2018-02-06 19:49:19 UTC
  • Revision ID: teddy@recompile.se-20180206194919-rfmlt49naz5jnpfx
Fix Python 3 issue

* (mandos/MandosServer.handle_ipc): Decode bytes into string.

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 "2009-01-04">
 
5
<!ENTITY TIMESTAMP "2017-02-23">
6
6
<!ENTITY % common SYSTEM "common.ent">
7
7
%common;
8
8
]>
19
19
        <firstname>Björn</firstname>
20
20
        <surname>Påhlsson</surname>
21
21
        <address>
22
 
          <email>belorn@fukt.bsnet.se</email>
 
22
          <email>belorn@recompile.se</email>
23
23
        </address>
24
24
      </author>
25
25
      <author>
26
26
        <firstname>Teddy</firstname>
27
27
        <surname>Hogeborn</surname>
28
28
        <address>
29
 
          <email>teddy@fukt.bsnet.se</email>
 
29
          <email>teddy@recompile.se</email>
30
30
        </address>
31
31
      </author>
32
32
    </authorgroup>
33
33
    <copyright>
34
34
      <year>2008</year>
35
35
      <year>2009</year>
 
36
      <year>2010</year>
 
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>
36
44
      <holder>Teddy Hogeborn</holder>
37
45
      <holder>Björn Påhlsson</holder>
38
46
    </copyright>
113
121
      <arg><option>--plugin-dir=<replaceable
114
122
      >DIRECTORY</replaceable></option></arg>
115
123
      <sbr/>
 
124
      <arg><option>--plugin-helper-dir=<replaceable
 
125
      >DIRECTORY</replaceable></option></arg>
 
126
      <sbr/>
116
127
      <arg><option>--config-file=<replaceable
117
128
      >FILE</replaceable></option></arg>
118
129
      <sbr/>
260
271
            Disable the plugin named
261
272
            <replaceable>PLUGIN</replaceable>.  The plugin will not be
262
273
            started.
263
 
          </para>       
 
274
          </para>
264
275
        </listitem>
265
276
      </varlistentry>
266
277
      
319
330
      </varlistentry>
320
331
      
321
332
      <varlistentry>
 
333
        <term><option>--plugin-helper-dir
 
334
        <replaceable>DIRECTORY</replaceable></option></term>
 
335
        <listitem>
 
336
          <para>
 
337
            Specify a different plugin helper directory.  The default
 
338
            is <filename>/lib/mandos/plugin-helpers</filename>, which
 
339
            will exist in the initial <acronym>RAM</acronym> disk
 
340
            environment.  (This will simply be passed to all plugins
 
341
            via the <envar>MANDOSPLUGINHELPERDIR</envar> environment
 
342
            variable.  See <xref linkend="writing_plugins"/>)
 
343
          </para>
 
344
        </listitem>
 
345
      </varlistentry>
 
346
      
 
347
      <varlistentry>
322
348
        <term><option>--config-file
323
349
        <replaceable>FILE</replaceable></option></term>
324
350
        <listitem>
425
451
      <para>
426
452
        The plugin will run in the initial RAM disk environment, so
427
453
        care must be taken not to depend on any files or running
428
 
        services not available there.
 
454
        services not available there.  Any helper executables required
 
455
        by the plugin (which are not in the <envar>PATH</envar>) can
 
456
        be placed in the plugin helper directory, the name of which
 
457
        will be made available to the plugin via the
 
458
        <envar>MANDOSPLUGINHELPERDIR</envar> environment variable.
429
459
      </para>
430
460
      <para>
431
461
        The plugin must exit cleanly and free all allocated resources
474
504
      only passes on its environment to all the plugins.  The
475
505
      environment passed to plugins can be modified using the
476
506
      <option>--global-env</option> and <option>--env-for</option>
477
 
      options.
 
507
      options.  Also, the <option>--plugin-helper-dir</option> option
 
508
      will affect the environment variable
 
509
      <envar>MANDOSPLUGINHELPERDIR</envar> for the plugins.
478
510
    </para>
479
511
  </refsect1>
480
512
  
513
545
            </para>
514
546
          </listitem>
515
547
        </varlistentry>
 
548
        <varlistentry>
 
549
          <term><filename class="directory"
 
550
          >/lib/mandos/plugins.d</filename></term>
 
551
          <listitem>
 
552
            <para>
 
553
              The default plugin directory; can be changed by the
 
554
              <option>--plugin-dir</option> option.
 
555
            </para>
 
556
          </listitem>
 
557
        </varlistentry>
 
558
        <varlistentry>
 
559
          <term><filename class="directory"
 
560
          >/lib/mandos/plugin-helpers</filename></term>
 
561
          <listitem>
 
562
            <para>
 
563
              The default plugin helper directory; can be changed by
 
564
              the <option>--plugin-helper-dir</option> option.
 
565
            </para>
 
566
          </listitem>
 
567
        </varlistentry>
516
568
      </variablelist>
517
569
    </para>
518
570
  </refsect1>
523
575
      The <option>--config-file</option> option is ignored when
524
576
      specified from within a configuration file.
525
577
    </para>
 
578
    <xi:include href="bugs.xml"/>
526
579
  </refsect1>
527
580
  
528
581
  <refsect1 id="examples">
571
624
    </informalexample>
572
625
    <informalexample>
573
626
      <para>
574
 
        Run plugins from a different directory, read a different
575
 
        configuration file, and add two options to the
 
627
        Read a different configuration file, run plugins from a
 
628
        different directory, specify an alternate plugin helper
 
629
        directory and add two options to the
576
630
        <citerefentry><refentrytitle >mandos-client</refentrytitle>
577
631
        <manvolnum>8mandos</manvolnum></citerefentry> plugin:
578
632
      </para>
579
633
      <para>
580
634
 
581
635
<!-- do not wrap this line -->
582
 
<userinput>&COMMANDNAME;  --config-file=/etc/mandos/plugin-runner.conf --plugin-dir /usr/lib/mandos/plugins.d --options-for=mandos-client:--pubkey=/etc/keys/mandos/pubkey.txt,--seckey=/etc/keys/mandos/seckey.txt</userinput>
 
636
<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>
583
637
 
584
638
      </para>
585
639
    </informalexample>
617
671
  <refsect1 id="see_also">
618
672
    <title>SEE ALSO</title>
619
673
    <para>
 
674
      <citerefentry><refentrytitle>intro</refentrytitle>
 
675
      <manvolnum>8mandos</manvolnum></citerefentry>,
620
676
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
621
677
      <manvolnum>8</manvolnum></citerefentry>,
622
678
      <citerefentry><refentrytitle>crypttab</refentrytitle>