/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-06 17:24:58 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080906172458-2x5wlfkn7oqckt1y
* legalnotice.xml: Copy DocBook 4.4-formatted text from
                   <http://www.gnu.org/licenses/gpl-3.0.dbk>.

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-02">
 
6
<!ENTITY TIMESTAMP "2008-09-06">
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 succesful one.
 
48
      Run Mandos plugins, pass data from first to succeed.
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 <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>
 
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>
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 config file.
 
275
            from the configuration file.
276
276
          </para>
277
277
        </listitem>
278
278
      </varlistentry>
416
416
        console.
417
417
      </para>
418
418
      <para>
 
419
        If the password is a single-line, manually entered passprase,
 
420
        a final trailing newline character should
 
421
        <emphasis>not</emphasis> be printed.
 
422
      </para>
 
423
      <para>
419
424
        The plugin will run in the initial RAM disk environment, so
420
425
        care must be taken not to depend on any files or running
421
426
        services not available there.
428
433
      </para>
429
434
      <para>
430
435
        The plugin must not use resources, like for instance reading
431
 
        from the standard input, without knowing that no other plugins
432
 
        are also using it.
 
436
        from the standard input, without knowing that no other plugin
 
437
        is also using it.
433
438
      </para>
434
439
      <para>
435
440
        It is useful, but not required, for the plugin to take the
467
472
      only passes on its environment to all the plugins.  The
468
473
      environment passed to plugins can be modified using the
469
474
      <option>--global-env</option> and <option>--env-for</option>
470
 
      optins.
 
475
      options.
471
476
    </para>
472
477
  </refsect1>
473
478
  
510
515
    </para>
511
516
  </refsect1>
512
517
  
513
 
<!--   <refsect1 id="bugs"> -->
514
 
<!--     <title>BUGS</title> -->
515
 
<!--     <para> -->
516
 
<!--     </para> -->
517
 
<!--   </refsect1> -->
 
518
  <refsect1 id="bugs">
 
519
    <title>BUGS</title>
 
520
    <para>
 
521
      The <option>--config-file</option> option is ignored when
 
522
      specified from within a configuration file.
 
523
    </para>
 
524
  </refsect1>
518
525
  
519
526
  <refsect1 id="examples">
520
527
    <title>EXAMPLE</title>
562
569
    </informalexample>
563
570
    <informalexample>
564
571
      <para>
565
 
        Run plugins from a different directory and add a special
566
 
        option to the <citerefentry><refentrytitle
567
 
        >password-request</refentrytitle>
 
572
        Run plugins from a different directory, read a different
 
573
        configuration file, and add two options to the
 
574
        <citerefentry><refentrytitle >mandos-client</refentrytitle>
568
575
        <manvolnum>8mandos</manvolnum></citerefentry> plugin:
569
576
      </para>
570
577
      <para>
571
578
 
572
579
<!-- do not wrap this line -->
573
 
<userinput>&COMMANDNAME;  --plugin-dir=plugins.d --options-for=password-request:--keydir=keydir</userinput>
 
580
<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>
574
581
 
575
582
      </para>
576
583
    </informalexample>
584
591
      non-privileged.  This user and group is then what all plugins
585
592
      will be started as.  Therefore, the only way to run a plugin as
586
593
      a privileged user is to have the set-user-ID or set-group-ID bit
587
 
      set on the plugin executable files (see <citerefentry>
 
594
      set on the plugin executable file (see <citerefentry>
588
595
      <refentrytitle>execve</refentrytitle><manvolnum>2</manvolnum>
589
596
      </citerefentry>).
590
597
    </para>
591
598
    <para>
592
599
      If this program is used as a keyscript in <citerefentry
593
600
      ><refentrytitle>crypttab</refentrytitle><manvolnum>5</manvolnum>
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
 
601
      </citerefentry>, there is a slight risk that if this program
 
602
      fails to work, there might be no way to boot the system except
 
603
      for booting from another media and editing the initial RAM disk
597
604
      image to not run this program.  This is, however, unlikely,
598
605
      since the <citerefentry><refentrytitle
599
606
      >password-prompt</refentrytitle><manvolnum>8mandos</manvolnum>
618
625
      <manvolnum>8</manvolnum></citerefentry>,
619
626
      <citerefentry><refentrytitle>password-prompt</refentrytitle>
620
627
      <manvolnum>8mandos</manvolnum></citerefentry>,
621
 
      <citerefentry><refentrytitle>password-request</refentrytitle>
 
628
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
622
629
      <manvolnum>8mandos</manvolnum></citerefentry>
623
630
    </para>
624
631
  </refsect1>