/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: Björn Påhlsson
  • Date: 2008-09-03 18:47:50 UTC
  • mto: (237.7.1 mandos) (24.1.154 mandos)
  • mto: This revision was merged to the branch mainline in revision 149.
  • Revision ID: belorn@braxen-20080903184750-s0k0jrrq0lxiamwh
removed keyring pre-requirement for starting password-request.
        Keys will now be imported in run-time to a run-time created keyring

Changed seckey and pubkey to be paths to private and public keys of the pgp encrypted password and gnutls authentication credentials.

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugin-runner.xml
3
3
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
4
<!ENTITY VERSION "1.0">
5
5
<!ENTITY COMMANDNAME "plugin-runner">
6
 
<!ENTITY TIMESTAMP "2008-09-01">
 
6
<!ENTITY TIMESTAMP "2008-09-02">
7
7
]>
8
8
 
9
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
53
53
    <cmdsynopsis>
54
54
      <command>&COMMANDNAME;</command>
55
55
      <group rep="repeat">
56
 
        <arg choice="plain"><option>--global-envs=<replaceable
 
56
        <arg choice="plain"><option>--global-env=<replaceable
57
57
        >VAR</replaceable><literal>=</literal><replaceable
58
58
        >value</replaceable></option></arg>
59
 
        <arg choice="plain"><option>-e
 
59
        <arg choice="plain"><option>-G
60
60
        <replaceable>VAR</replaceable><literal>=</literal><replaceable
61
61
        >value</replaceable> </option></arg>
62
62
      </group>
63
63
      <sbr/>
64
64
      <group rep="repeat">
65
 
        <arg choice="plain"><option>--envs-for=<replaceable
 
65
        <arg choice="plain"><option>--env-for=<replaceable
66
66
        >PLUGIN</replaceable><literal>:</literal><replaceable
67
67
        >ENV</replaceable><literal>=</literal><replaceable
68
68
        >value</replaceable></option></arg>
69
 
        <arg choice="plain"><option>-f<replaceable>
 
69
        <arg choice="plain"><option>-E<replaceable>
70
70
        PLUGIN</replaceable><literal>:</literal><replaceable
71
71
        >ENV</replaceable><literal>=</literal><replaceable
72
72
        >value</replaceable> </option></arg>
83
83
        <arg choice="plain"><option>--options-for=<replaceable
84
84
        >PLUGIN</replaceable><literal>:</literal><replaceable
85
85
        >OPTIONS</replaceable></option></arg>
86
 
        <arg choice="plain"><option>-f<replaceable>
 
86
        <arg choice="plain"><option>-o<replaceable>
87
87
        PLUGIN</replaceable><literal>:</literal><replaceable
88
88
        >OPTIONS</replaceable> </option></arg>
89
89
      </group>
95
95
        <replaceable>PLUGIN</replaceable> </option></arg>
96
96
      </group>
97
97
      <sbr/>
 
98
      <group rep="repeat">
 
99
        <arg choice="plain"><option>--enable=<replaceable
 
100
        >PLUGIN</replaceable></option></arg>
 
101
        <arg choice="plain"><option>-e
 
102
        <replaceable>PLUGIN</replaceable> </option></arg>
 
103
      </group>
 
104
      <sbr/>
98
105
      <arg><option>--groupid=<replaceable
99
106
      >ID</replaceable></option></arg>
100
107
      <sbr/>
104
111
      <arg><option>--plugin-dir=<replaceable
105
112
      >DIRECTORY</replaceable></option></arg>
106
113
      <sbr/>
 
114
      <arg><option>--config-file=<replaceable
 
115
      >FILE</replaceable></option></arg>
 
116
      <sbr/>
107
117
      <arg><option>--debug</option></arg>
108
118
    </cmdsynopsis>
109
119
    <cmdsynopsis>
159
169
    <title>OPTIONS</title>
160
170
    <variablelist>
161
171
      <varlistentry>
 
172
        <term><option>--global-env
 
173
        <replaceable>VAR</replaceable><literal>=</literal><replaceable
 
174
        >value</replaceable></option></term>
 
175
        <term><option>-e
 
176
        <replaceable>VAR</replaceable><literal>=</literal><replaceable
 
177
        >value</replaceable></option></term>
 
178
        <listitem>
 
179
          <para>
 
180
            This option will add an environment variable setting to
 
181
            all plugins.  This will override any inherited environment
 
182
            variable.
 
183
          </para>
 
184
        </listitem>
 
185
      </varlistentry>
 
186
      
 
187
      <varlistentry>
 
188
        <term><option>--env-for
 
189
        <replaceable>PLUGIN</replaceable><literal>:</literal
 
190
        ><replaceable>ENV</replaceable><literal>=</literal
 
191
        ><replaceable>value</replaceable></option></term>
 
192
        <term><option>-f
 
193
        <replaceable>PLUGIN</replaceable><literal>:</literal
 
194
        ><replaceable>ENV</replaceable><literal>=</literal
 
195
        ><replaceable>value</replaceable></option></term>
 
196
        <listitem>
 
197
          <para>
 
198
            This option will add an environment variable setting to
 
199
            the <replaceable>PLUGIN</replaceable> plugin.  This will
 
200
            override any inherited environment variables or
 
201
            environment variables specified using
 
202
            <option>--global-env</option>.
 
203
          </para>
 
204
        </listitem>
 
205
      </varlistentry>
 
206
      
 
207
      <varlistentry>
162
208
        <term><option>--global-options
163
209
        <replaceable>OPTIONS</replaceable></option></term>
164
210
        <term><option>-g
203
249
      </varlistentry>
204
250
 
205
251
      <varlistentry>
206
 
        <term><option> --disable
 
252
        <term><option>--disable
207
253
        <replaceable>PLUGIN</replaceable></option></term>
208
254
        <term><option>-d
209
255
        <replaceable>PLUGIN</replaceable></option></term>
217
263
      </varlistentry>
218
264
 
219
265
      <varlistentry>
 
266
        <term><option>--enable
 
267
        <replaceable>PLUGIN</replaceable></option></term>
 
268
        <term><option>-e
 
269
        <replaceable>PLUGIN</replaceable></option></term>
 
270
        <listitem>
 
271
          <para>
 
272
            Re-enable the plugin named
 
273
            <replaceable>PLUGIN</replaceable>.  This is only useful to
 
274
            undo a previous <option>--disable</option> option, maybe
 
275
            from the config file.
 
276
          </para>
 
277
        </listitem>
 
278
      </varlistentry>
 
279
 
 
280
      <varlistentry>
220
281
        <term><option>--groupid
221
282
        <replaceable>ID</replaceable></option></term>
222
283
        <listitem>
256
317
      </varlistentry>
257
318
      
258
319
      <varlistentry>
 
320
        <term><option>--config-file
 
321
        <replaceable>FILE</replaceable></option></term>
 
322
        <listitem>
 
323
          <para>
 
324
            Specify a different file to read additional options from.
 
325
            See <xref linkend="files"/>.  Other command line options
 
326
            will override options specified in the file.
 
327
          </para>
 
328
        </listitem>
 
329
      </varlistentry>
 
330
      
 
331
      <varlistentry>
259
332
        <term><option>--debug</option></term>
260
333
        <listitem>
261
334
          <para>
326
399
      <filename>/lib/mandos/plugins.d</filename>, but this can be
327
400
      changed with the <option>--plugin-dir</option> option.  The
328
401
      plugins are started in parallel, and the first plugin to output
329
 
      a password and exit with a successful exit code will make this
330
 
      plugin-runner output that password, stop any other plugins, and
331
 
      exit.
 
402
      a password <emphasis>and</emphasis> exit with a successful exit
 
403
      code will make this plugin-runner output the password from that
 
404
      plugin, stop any other plugins, and exit.
332
405
    </para>
333
406
  </refsect1>
334
407
  
335
 
  <refsect1>
 
408
  <refsect1 id="fallback">
336
409
    <title>FALLBACK</title>
337
410
    <para>
 
411
      If no plugins succeed, this program will, as a fallback, ask for
 
412
      a password on the console using <citerefentry><refentrytitle
 
413
      >getpass</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
 
414
      and output it.  This is not meant to be the normal mode of
 
415
      operation, as there is a separate plugin for getting a password
 
416
      from the console.
338
417
    </para>
339
418
  </refsect1>
 
419
  
340
420
  <refsect1 id="exit_status">
341
421
    <title>EXIT STATUS</title>
342
422
    <para>
343
 
    </para>
344
 
  </refsect1>
345
 
 
346
 
  <refsect1 id="file">
 
423
      Exit status of this program is zero if no errors were
 
424
      encountered, and otherwise not.  The fallback (see <xref
 
425
      linkend="fallback"/>) may or may not have succeeded in either
 
426
      case.
 
427
    </para>
 
428
  </refsect1>
 
429
  
 
430
  <refsect1 id="environment">
 
431
    <title>ENVIRONMENT</title>
 
432
    <para>
 
433
      This program does not use any environment variables itself, it
 
434
      only passes on its environment to all the plugins.  The
 
435
      environment passed to plugins can be modified using the
 
436
      <option>--global-env</option> and <option>--env-for</option>
 
437
      optins.
 
438
    </para>
 
439
  </refsect1>
 
440
  
 
441
  <refsect1 id="files">
347
442
    <title>FILES</title>
348
443
    <para>
349
 
    </para>
350
 
  </refsect1>
351
 
 
352
 
  <refsect1 id="notes">
353
 
    <title>NOTES</title>
354
 
    <para>
 
444
      <variablelist>
 
445
        <varlistentry>
 
446
          <term><filename
 
447
          >/conf/conf.d/mandos/plugin-runner.conf</filename></term>
 
448
          <listitem>
 
449
            <para>
 
450
              Since this program will be run as a keyscript, there is
 
451
              little to no opportunity to pass command line arguments
 
452
              to it.  Therefore, it will <emphasis>also</emphasis>
 
453
              read this file and use its contents as
 
454
              whitespace-separated command line options.  Also,
 
455
              everything from a <quote>#</quote> character to the end
 
456
              of a line is ignored.
 
457
            </para>
 
458
            <para>
 
459
              This program is meant to run in the initial RAM disk
 
460
              environment, so that is where this file is assumed to
 
461
              exist.  The file does not need to exist in the normal
 
462
              file system.
 
463
            </para>
 
464
            <para>
 
465
              This file will be processed <emphasis>before</emphasis>
 
466
              the normal command line options, so the latter can
 
467
              override the former, if need be.
 
468
            </para>
 
469
            <para>
 
470
              This file name is the default; the file to read for
 
471
              arguments can be changed using the
 
472
              <option>--config-file</option> option.
 
473
            </para>
 
474
          </listitem>
 
475
        </varlistentry>
 
476
      </variablelist>
355
477
    </para>
356
478
  </refsect1>
357
479
  
360
482
    <para>
361
483
    </para>
362
484
  </refsect1>
363
 
 
 
485
  
364
486
  <refsect1 id="examples">
365
487
    <title>EXAMPLE</title>
366
488
    <para>
367
489
    </para>
368
490
  </refsect1>
369
 
 
 
491
  
370
492
  <refsect1 id="security">
371
493
    <title>SECURITY</title>
372
494
    <para>
373
495
    </para>
374
496
  </refsect1>
375
 
 
 
497
  
376
498
  <refsect1 id="see_also">
377
499
    <title>SEE ALSO</title>
378
500
    <para>
386
508
      <manvolnum>8mandos</manvolnum></citerefentry>
387
509
    </para>
388
510
  </refsect1>
389
 
 
 
511
  
390
512
</refentry>
391
513
<!-- Local Variables: -->
392
514
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->