/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: 2008-09-19 12:02:03 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080919120203-xvsf3w1h0n2bvtkb
* debian/mandos-client.postinst: Use "type" instead of "which".  Split
                                 to functions.  Create key.

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugin-runner.xml
1
1
<?xml version="1.0" encoding="UTF-8"?>
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
<!ENTITY VERSION "1.0">
4
5
<!ENTITY COMMANDNAME "plugin-runner">
5
 
<!ENTITY TIMESTAMP "2016-03-17">
6
 
<!ENTITY % common SYSTEM "common.ent">
7
 
%common;
 
6
<!ENTITY TIMESTAMP "2008-09-19">
8
7
]>
9
8
 
10
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
12
11
    <title>Mandos Manual</title>
13
12
    <!-- Nwalsh’s docbook scripts use this to generate the footer: -->
14
13
    <productname>Mandos</productname>
15
 
    <productnumber>&version;</productnumber>
 
14
    <productnumber>&VERSION;</productnumber>
16
15
    <date>&TIMESTAMP;</date>
17
16
    <authorgroup>
18
17
      <author>
19
18
        <firstname>Björn</firstname>
20
19
        <surname>Påhlsson</surname>
21
20
        <address>
22
 
          <email>belorn@recompile.se</email>
 
21
          <email>belorn@fukt.bsnet.se</email>
23
22
        </address>
24
23
      </author>
25
24
      <author>
26
25
        <firstname>Teddy</firstname>
27
26
        <surname>Hogeborn</surname>
28
27
        <address>
29
 
          <email>teddy@recompile.se</email>
 
28
          <email>teddy@fukt.bsnet.se</email>
30
29
        </address>
31
30
      </author>
32
31
    </authorgroup>
33
32
    <copyright>
34
33
      <year>2008</year>
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
34
      <holder>Teddy Hogeborn</holder>
44
35
      <holder>Björn Påhlsson</holder>
45
36
    </copyright>
120
111
      <arg><option>--plugin-dir=<replaceable
121
112
      >DIRECTORY</replaceable></option></arg>
122
113
      <sbr/>
123
 
      <arg><option>--plugin-helper-dir=<replaceable
124
 
      >DIRECTORY</replaceable></option></arg>
125
 
      <sbr/>
126
114
      <arg><option>--config-file=<replaceable
127
115
      >FILE</replaceable></option></arg>
128
116
      <sbr/>
270
258
            Disable the plugin named
271
259
            <replaceable>PLUGIN</replaceable>.  The plugin will not be
272
260
            started.
273
 
          </para>
 
261
          </para>       
274
262
        </listitem>
275
263
      </varlistentry>
276
264
      
329
317
      </varlistentry>
330
318
      
331
319
      <varlistentry>
332
 
        <term><option>--plugin-helper-dir
333
 
        <replaceable>DIRECTORY</replaceable></option></term>
334
 
        <listitem>
335
 
          <para>
336
 
            Specify a different plugin helper directory.  The default
337
 
            is <filename>/lib/mandos/plugin-helpers</filename>, which
338
 
            will exist in the initial <acronym>RAM</acronym> disk
339
 
            environment.  (This will simply be passed to all plugins
340
 
            via the <envar>MANDOSPLUGINHELPERDIR</envar> environment
341
 
            variable.  See <xref linkend="writing_plugins"/>)
342
 
          </para>
343
 
        </listitem>
344
 
      </varlistentry>
345
 
      
346
 
      <varlistentry>
347
320
        <term><option>--config-file
348
321
        <replaceable>FILE</replaceable></option></term>
349
322
        <listitem>
450
423
      <para>
451
424
        The plugin will run in the initial RAM disk environment, so
452
425
        care must be taken not to depend on any files or running
453
 
        services not available there.  Any helper executables required
454
 
        by the plugin (which are not in the <envar>PATH</envar>) can
455
 
        be placed in the plugin helper directory, the name of which
456
 
        will be made available to the plugin via the
457
 
        <envar>MANDOSPLUGINHELPERDIR</envar> environment variable.
 
426
        services not available there.
458
427
      </para>
459
428
      <para>
460
429
        The plugin must exit cleanly and free all allocated resources
503
472
      only passes on its environment to all the plugins.  The
504
473
      environment passed to plugins can be modified using the
505
474
      <option>--global-env</option> and <option>--env-for</option>
506
 
      options.  Also, the <option>--plugin-helper-dir</option> option
507
 
      will affect the environment variable
508
 
      <envar>MANDOSPLUGINHELPERDIR</envar> for the plugins.
 
475
      options.
509
476
    </para>
510
477
  </refsect1>
511
478
  
544
511
            </para>
545
512
          </listitem>
546
513
        </varlistentry>
547
 
        <varlistentry>
548
 
          <term><filename class="directory"
549
 
          >/lib/mandos/plugins.d</filename></term>
550
 
          <listitem>
551
 
            <para>
552
 
              The default plugin directory; can be changed by the
553
 
              <option>--plugin-dir</option> option.
554
 
            </para>
555
 
          </listitem>
556
 
        </varlistentry>
557
 
        <varlistentry>
558
 
          <term><filename class="directory"
559
 
          >/lib/mandos/plugin-helpers</filename></term>
560
 
          <listitem>
561
 
            <para>
562
 
              The default plugin helper directory; can be changed by
563
 
              the <option>--plugin-helper-dir</option> option.
564
 
            </para>
565
 
          </listitem>
566
 
        </varlistentry>
567
514
      </variablelist>
568
515
    </para>
569
516
  </refsect1>
574
521
      The <option>--config-file</option> option is ignored when
575
522
      specified from within a configuration file.
576
523
    </para>
577
 
    <xi:include href="bugs.xml"/>
578
524
  </refsect1>
579
525
  
580
526
  <refsect1 id="examples">
623
569
    </informalexample>
624
570
    <informalexample>
625
571
      <para>
626
 
        Read a different configuration file, run plugins from a
627
 
        different directory, specify an alternate plugin helper
628
 
        directory and add two options to the
 
572
        Run plugins from a different directory, read a different
 
573
        configuration file, and add two options to the
629
574
        <citerefentry><refentrytitle >mandos-client</refentrytitle>
630
575
        <manvolnum>8mandos</manvolnum></citerefentry> plugin:
631
576
      </para>
632
577
      <para>
633
578
 
634
579
<!-- do not wrap this line -->
635
 
<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>
 
580
<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
581
 
637
582
      </para>
638
583
    </informalexample>
670
615
  <refsect1 id="see_also">
671
616
    <title>SEE ALSO</title>
672
617
    <para>
673
 
      <citerefentry><refentrytitle>intro</refentrytitle>
674
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
675
618
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
676
619
      <manvolnum>8</manvolnum></citerefentry>,
677
620
      <citerefentry><refentrytitle>crypttab</refentrytitle>