/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

merge

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