/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-03 13:59:58 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080903135958-k0he2xucqmx7nz4b
* plugins.d/password-request.xml (OPTIONS): Improved wording.
  (FILES): Add text about public and secret key files.
  (BUGS): Commented out.
  (EXAMPLE): Added examples.

Show diffs side-by-side

added added

removed removed

Lines of Context:
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-04">
 
6
<!ENTITY TIMESTAMP "2008-09-02">
7
7
]>
8
8
 
9
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
45
45
  <refnamediv>
46
46
    <refname><command>&COMMANDNAME;</command></refname>
47
47
    <refpurpose>
48
 
      Run Mandos plugins, pass data from first to succeed.
 
48
      Run Mandos plugins.  Pass data from first succesful one.
49
49
    </refpurpose>
50
50
  </refnamediv>
51
51
 
140
140
    <title>DESCRIPTION</title>
141
141
    <para>
142
142
      <command>&COMMANDNAME;</command> is a program which is meant to
143
 
      be specified as a <quote>keyscript</quote> for the root disk in
144
 
      <citerefentry><refentrytitle>crypttab</refentrytitle>
145
 
      <manvolnum>5</manvolnum></citerefentry>.  The aim of this
146
 
      program is therefore to output a password, which then
147
 
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
 
143
      be specified as <quote>keyscript</quote> in <citerefentry>
 
144
      <refentrytitle>crypttab</refentrytitle>
 
145
      <manvolnum>5</manvolnum></citerefentry> for the root disk.  The
 
146
      aim of this program is therefore to output a password, which
 
147
      then <citerefentry><refentrytitle>cryptsetup</refentrytitle>
148
148
      <manvolnum>8</manvolnum></citerefentry> will use to unlock the
149
149
      root disk.
150
150
    </para>
272
272
            Re-enable the plugin named
273
273
            <replaceable>PLUGIN</replaceable>.  This is only useful to
274
274
            undo a previous <option>--disable</option> option, maybe
275
 
            from the configuration file.
 
275
            from the config file.
276
276
          </para>
277
277
        </listitem>
278
278
      </varlistentry>
428
428
      </para>
429
429
      <para>
430
430
        The plugin must not use resources, like for instance reading
431
 
        from the standard input, without knowing that no other plugin
432
 
        is also using it.
 
431
        from the standard input, without knowing that no other plugins
 
432
        are also using it.
433
433
      </para>
434
434
      <para>
435
435
        It is useful, but not required, for the plugin to take the
467
467
      only passes on its environment to all the plugins.  The
468
468
      environment passed to plugins can be modified using the
469
469
      <option>--global-env</option> and <option>--env-for</option>
470
 
      options.
 
470
      optins.
471
471
    </para>
472
472
  </refsect1>
473
473
  
510
510
    </para>
511
511
  </refsect1>
512
512
  
513
 
  <refsect1 id="bugs">
514
 
    <title>BUGS</title>
515
 
    <para>
516
 
      The <option>--config-file</option> option is ignored when
517
 
      specified from within a configuration file.
518
 
    </para>
519
 
  </refsect1>
 
513
<!--   <refsect1 id="bugs"> -->
 
514
<!--     <title>BUGS</title> -->
 
515
<!--     <para> -->
 
516
<!--     </para> -->
 
517
<!--   </refsect1> -->
520
518
  
521
519
  <refsect1 id="examples">
522
520
    <title>EXAMPLE</title>
564
562
    </informalexample>
565
563
    <informalexample>
566
564
      <para>
567
 
        Run plugins from a different directory and add two
568
 
        options to the <citerefentry><refentrytitle
 
565
        Run plugins from a different directory and add a special
 
566
        option to the <citerefentry><refentrytitle
569
567
        >password-request</refentrytitle>
570
568
        <manvolnum>8mandos</manvolnum></citerefentry> plugin:
571
569
      </para>
572
570
      <para>
573
571
 
574
572
<!-- do not wrap this line -->
575
 
<userinput>&COMMANDNAME;  --plugin-dir=plugins.d --options-for=password-request:--pubkey=keydir/pubkey.txt,--seckey=keydir/seckey.txt</userinput>
 
573
<userinput>&COMMANDNAME;  --plugin-dir=plugins.d --options-for=password-request:--keydir=keydir</userinput>
576
574
 
577
575
      </para>
578
576
    </informalexample>
593
591
    <para>
594
592
      If this program is used as a keyscript in <citerefentry
595
593
      ><refentrytitle>crypttab</refentrytitle><manvolnum>5</manvolnum>
596
 
      </citerefentry>, there is a slight risk that if this program
597
 
      fails to work, there might be no way to boot the system except
598
 
      for booting from another media and editing the initial RAM disk
 
594
      </citerefentry>, there is a risk that if this program fails to
 
595
      work, there might be no way to boot the system except for
 
596
      booting from another media and editing the initial RAM disk
599
597
      image to not run this program.  This is, however, unlikely,
600
598
      since the <citerefentry><refentrytitle
601
599
      >password-prompt</refentrytitle><manvolnum>8mandos</manvolnum>