/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-01 16:19:32 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080901161932-ostp7tulh9aijulh
* plugin-runner.c (add_environment): Never insert existing environment
                                     variables.
  (main): Rename "--global-envs" to "--global-env" and "--envs-for" to
          "--env-for".

* plugin-runner.xml (SYNOPSIS): Rename "--global-envs" to
                                "--global-env" and "--envs-for" to
                                "--env-for".
  (OPTIONS): Added "--global-env" and "--env-for".
  (FALLBACK): Add id attribute.
  (EXIT STATUS): Add text.
  (ENVIRONMENT): New section.
  (FILES): Document configuration file.

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugin-runner.xml
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
59
        <arg choice="plain"><option>-e
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>
159
159
    <title>OPTIONS</title>
160
160
    <variablelist>
161
161
      <varlistentry>
 
162
        <term><option>--global-env
 
163
        <replaceable>VAR</replaceable><literal>=</literal><replaceable
 
164
        >value</replaceable></option></term>
 
165
        <term><option>-e
 
166
        <replaceable>VAR</replaceable><literal>=</literal><replaceable
 
167
        >value</replaceable></option></term>
 
168
        <listitem>
 
169
          <para>
 
170
            
 
171
          </para>
 
172
        </listitem>
 
173
      </varlistentry>
 
174
      
 
175
      <varlistentry>
 
176
        <term><option>--env-for
 
177
        <replaceable>PLUGIN</replaceable><literal>:</literal
 
178
        ><replaceable>ENV</replaceable><literal>=</literal
 
179
        ><replaceable>value</replaceable></option></term>
 
180
        <term><option>-f
 
181
        <replaceable>PLUGIN</replaceable><literal>:</literal
 
182
        ><replaceable>ENV</replaceable><literal>=</literal
 
183
        ><replaceable>value</replaceable></option></term>
 
184
        <listitem>
 
185
          <para>
 
186
          </para>
 
187
        </listitem>
 
188
      </varlistentry>
 
189
      
 
190
      <varlistentry>
162
191
        <term><option>--global-options
163
192
        <replaceable>OPTIONS</replaceable></option></term>
164
193
        <term><option>-g
326
355
      <filename>/lib/mandos/plugins.d</filename>, but this can be
327
356
      changed with the <option>--plugin-dir</option> option.  The
328
357
      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.
 
358
      a password <emphasis>and</emphasis> exit with a successful exit
 
359
      code will make this plugin-runner output the password from that
 
360
      plugin, stop any other plugins, and exit.
332
361
    </para>
333
362
  </refsect1>
334
363
  
335
 
  <refsect1>
 
364
  <refsect1 id="fallback">
336
365
    <title>FALLBACK</title>
337
366
    <para>
 
367
      If no plugins succeed, this program will, as a fallback, ask for
 
368
      a password on the console using <citerefentry><refentrytitle
 
369
      >getpass</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
 
370
      and output it.  This is not meant to be the normal mode of
 
371
      operation, as there is a separate plugin for getting a password
 
372
      from the console.
338
373
    </para>
339
374
  </refsect1>
 
375
  
340
376
  <refsect1 id="exit_status">
341
377
    <title>EXIT STATUS</title>
342
378
    <para>
343
 
    </para>
344
 
  </refsect1>
345
 
 
 
379
      Exit status of this program is zero if no errors were
 
380
      encountered, and otherwise not.  The fallback (see <xref
 
381
      linkend="fallback"/>) may or may not have succeeded in either
 
382
      case.
 
383
    </para>
 
384
  </refsect1>
 
385
  
 
386
  <refsect1 id="environment">
 
387
    <title>ENVIRONMENT</title>
 
388
    <para>
 
389
      
 
390
    </para>
 
391
  </refsect1>
 
392
  
346
393
  <refsect1 id="file">
347
394
    <title>FILES</title>
348
395
    <para>
349
 
    </para>
350
 
  </refsect1>
351
 
 
352
 
  <refsect1 id="notes">
353
 
    <title>NOTES</title>
354
 
    <para>
 
396
      <variablelist>
 
397
        <varlistentry>
 
398
          <term><filename
 
399
          >/conf/conf.d/mandos/plugin-runner.conf</filename></term>
 
400
          <listitem>
 
401
            <para>
 
402
              Since this program will be run as a keyscript, there is
 
403
              little to no opportunity to pass command line arguments
 
404
              to it.  Therefore, it will <emphasis>also</emphasis>
 
405
              read this file and use its contents as
 
406
              whitespace-separated command line options.  Also,
 
407
              everything from a <quote>#</quote> character to the end
 
408
              of a line is ignored.
 
409
            </para>
 
410
          </listitem>
 
411
        </varlistentry>
 
412
      </variablelist>
355
413
    </para>
356
414
  </refsect1>
357
415
  
360
418
    <para>
361
419
    </para>
362
420
  </refsect1>
363
 
 
 
421
  
364
422
  <refsect1 id="examples">
365
423
    <title>EXAMPLE</title>
366
424
    <para>
367
425
    </para>
368
426
  </refsect1>
369
 
 
 
427
  
370
428
  <refsect1 id="security">
371
429
    <title>SECURITY</title>
372
430
    <para>
373
431
    </para>
374
432
  </refsect1>
375
 
 
 
433
  
376
434
  <refsect1 id="see_also">
377
435
    <title>SEE ALSO</title>
378
436
    <para>
386
444
      <manvolnum>8mandos</manvolnum></citerefentry>
387
445
    </para>
388
446
  </refsect1>
389
 
 
 
447
  
390
448
</refentry>
391
449
<!-- Local Variables: -->
392
450
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->