/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: 2008-09-05 18:37:28 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080905183728-l0m8v3vqa302uwrw
* mandos (main): Use EAFP with pidfile.

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 "2008-09-30">
6
 
<!ENTITY % common SYSTEM "common.ent">
7
 
%common;
 
6
<!ENTITY TIMESTAMP "2008-09-05">
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>
37
36
    </copyright>
38
37
    <xi:include href="legalnotice.xml"/>
39
38
  </refentryinfo>
40
 
  
 
39
 
41
40
  <refmeta>
42
41
    <refentrytitle>&COMMANDNAME;</refentrytitle>
43
42
    <manvolnum>8mandos</manvolnum>
49
48
      Run Mandos plugins, pass data from first to succeed.
50
49
    </refpurpose>
51
50
  </refnamediv>
52
 
  
 
51
 
53
52
  <refsynopsisdiv>
54
53
    <cmdsynopsis>
55
54
      <command>&COMMANDNAME;</command>
56
55
      <group rep="repeat">
57
56
        <arg choice="plain"><option>--global-env=<replaceable
58
 
        >ENV</replaceable><literal>=</literal><replaceable
 
57
        >VAR</replaceable><literal>=</literal><replaceable
59
58
        >value</replaceable></option></arg>
60
59
        <arg choice="plain"><option>-G
61
 
        <replaceable>ENV</replaceable><literal>=</literal><replaceable
 
60
        <replaceable>VAR</replaceable><literal>=</literal><replaceable
62
61
        >value</replaceable> </option></arg>
63
62
      </group>
64
63
      <sbr/>
171
170
    <variablelist>
172
171
      <varlistentry>
173
172
        <term><option>--global-env
174
 
        <replaceable>ENV</replaceable><literal>=</literal><replaceable
 
173
        <replaceable>VAR</replaceable><literal>=</literal><replaceable
175
174
        >value</replaceable></option></term>
176
175
        <term><option>-G
177
 
        <replaceable>ENV</replaceable><literal>=</literal><replaceable
 
176
        <replaceable>VAR</replaceable><literal>=</literal><replaceable
178
177
        >value</replaceable></option></term>
179
178
        <listitem>
180
179
          <para>
248
247
          </para>
249
248
        </listitem>
250
249
      </varlistentry>
251
 
      
 
250
 
252
251
      <varlistentry>
253
252
        <term><option>--disable
254
253
        <replaceable>PLUGIN</replaceable></option></term>
262
261
          </para>       
263
262
        </listitem>
264
263
      </varlistentry>
265
 
      
 
264
 
266
265
      <varlistentry>
267
266
        <term><option>--enable
268
267
        <replaceable>PLUGIN</replaceable></option></term>
277
276
          </para>
278
277
        </listitem>
279
278
      </varlistentry>
280
 
      
 
279
 
281
280
      <varlistentry>
282
281
        <term><option>--groupid
283
282
        <replaceable>ID</replaceable></option></term>
290
289
          </para>
291
290
        </listitem>
292
291
      </varlistentry>
293
 
      
 
292
 
294
293
      <varlistentry>
295
294
        <term><option>--userid
296
295
        <replaceable>ID</replaceable></option></term>
303
302
          </para>
304
303
        </listitem>
305
304
      </varlistentry>
306
 
      
 
305
 
307
306
      <varlistentry>
308
307
        <term><option>--plugin-dir
309
308
        <replaceable>DIRECTORY</replaceable></option></term>
366
365
          </para>
367
366
        </listitem>
368
367
      </varlistentry>
369
 
      
 
368
 
370
369
      <varlistentry>
371
370
        <term><option>--version</option></term>
372
371
        <term><option>-V</option></term>
378
377
      </varlistentry>
379
378
    </variablelist>
380
379
  </refsect1>
381
 
  
 
380
 
382
381
  <refsect1 id="overview">
383
382
    <title>OVERVIEW</title>
384
383
    <xi:include href="overview.xml"/>
404
403
      code will make this plugin-runner output the password from that
405
404
      plugin, stop any other plugins, and exit.
406
405
    </para>
407
 
    
 
406
 
408
407
    <refsect2 id="writing_plugins">
409
408
      <title>WRITING PLUGINS</title>
410
409
      <para>
417
416
        console.
418
417
      </para>
419
418
      <para>
420
 
        If the password is a single-line, manually entered passprase,
421
 
        a final trailing newline character should
422
 
        <emphasis>not</emphasis> be printed.
423
 
      </para>
424
 
      <para>
425
419
        The plugin will run in the initial RAM disk environment, so
426
420
        care must be taken not to depend on any files or running
427
421
        services not available there.
572
566
      <para>
573
567
        Run plugins from a different directory, read a different
574
568
        configuration file, and add two options to the
575
 
        <citerefentry><refentrytitle >mandos-client</refentrytitle>
 
569
        <citerefentry><refentrytitle >password-request</refentrytitle>
576
570
        <manvolnum>8mandos</manvolnum></citerefentry> plugin:
577
571
      </para>
578
572
      <para>
579
573
 
580
574
<!-- do not wrap this line -->
581
 
<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>
 
575
<userinput>&COMMANDNAME;  --config-file=/etc/mandos/plugin-runner.conf --plugin-dir /usr/lib/mandos/plugins.d --options-for=password-request:--pubkey=/etc/keys/mandos/pubkey.txt,--seckey=/etc/keys/mandos/seckey.txt</userinput>
582
576
 
583
577
      </para>
584
578
    </informalexample>
626
620
      <manvolnum>8</manvolnum></citerefentry>,
627
621
      <citerefentry><refentrytitle>password-prompt</refentrytitle>
628
622
      <manvolnum>8mandos</manvolnum></citerefentry>,
629
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
623
      <citerefentry><refentrytitle>password-request</refentrytitle>
630
624
      <manvolnum>8mandos</manvolnum></citerefentry>
631
625
    </para>
632
626
  </refsect1>