/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-02 17:42:53 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080902174253-p3wxrq7z6ccnv7fs
* plugins.d/password-request.c (main): Change default GnuTLS priority
                                       string to
                             "SECURE256":!CTYPE-X.509:+CTYPE-OPENPGP".

* plugins.d/password-request.xml (DESCRIPTION): Improve wording.
  (PURPOSE, OVERVIEW): New sections.
  (OPTIONS): Improved wording.
  (EXIT STATUS): Add text.
  (ENVIRONMENT): Commented out.

Show diffs side-by-side

added added

removed removed

Lines of Context:
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-02">
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>
47
45
  <refnamediv>
48
46
    <refname><command>&COMMANDNAME;</command></refname>
49
47
    <refpurpose>
50
 
      Run Mandos plugins, pass data from first to succeed.
 
48
      Run Mandos plugins.  Pass data from first succesful one.
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/>
142
140
    <title>DESCRIPTION</title>
143
141
    <para>
144
142
      <command>&COMMANDNAME;</command> is a program which is meant to
145
 
      be specified as a <quote>keyscript</quote> for the root disk in
146
 
      <citerefentry><refentrytitle>crypttab</refentrytitle>
147
 
      <manvolnum>5</manvolnum></citerefentry>.  The aim of this
148
 
      program is therefore to output a password, which then
149
 
      <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>
150
148
      <manvolnum>8</manvolnum></citerefentry> will use to unlock the
151
149
      root disk.
152
150
    </para>
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>
274
272
            Re-enable the plugin named
275
273
            <replaceable>PLUGIN</replaceable>.  This is only useful to
276
274
            undo a previous <option>--disable</option> option, maybe
277
 
            from the configuration file.
 
275
            from the config file.
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.
435
428
      </para>
436
429
      <para>
437
430
        The plugin must not use resources, like for instance reading
438
 
        from the standard input, without knowing that no other plugin
439
 
        is also using it.
 
431
        from the standard input, without knowing that no other plugins
 
432
        are also using it.
440
433
      </para>
441
434
      <para>
442
435
        It is useful, but not required, for the plugin to take the
474
467
      only passes on its environment to all the plugins.  The
475
468
      environment passed to plugins can be modified using the
476
469
      <option>--global-env</option> and <option>--env-for</option>
477
 
      options.
 
470
      optins.
478
471
    </para>
479
472
  </refsect1>
480
473
  
517
510
    </para>
518
511
  </refsect1>
519
512
  
520
 
  <refsect1 id="bugs">
521
 
    <title>BUGS</title>
522
 
    <para>
523
 
      The <option>--config-file</option> option is ignored when
524
 
      specified from within a configuration file.
525
 
    </para>
526
 
  </refsect1>
 
513
<!--   <refsect1 id="bugs"> -->
 
514
<!--     <title>BUGS</title> -->
 
515
<!--     <para> -->
 
516
<!--     </para> -->
 
517
<!--   </refsect1> -->
527
518
  
528
519
  <refsect1 id="examples">
529
520
    <title>EXAMPLE</title>
571
562
    </informalexample>
572
563
    <informalexample>
573
564
      <para>
574
 
        Run plugins from a different directory, read a different
575
 
        configuration file, and add two options to the
576
 
        <citerefentry><refentrytitle >mandos-client</refentrytitle>
 
565
        Run plugins from a different directory and add a special
 
566
        option to the <citerefentry><refentrytitle
 
567
        >password-request</refentrytitle>
577
568
        <manvolnum>8mandos</manvolnum></citerefentry> plugin:
578
569
      </para>
579
570
      <para>
580
571
 
581
572
<!-- 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>
 
573
<userinput>&COMMANDNAME;  --plugin-dir=plugins.d --options-for=password-request:--keydir=keydir</userinput>
583
574
 
584
575
      </para>
585
576
    </informalexample>
593
584
      non-privileged.  This user and group is then what all plugins
594
585
      will be started as.  Therefore, the only way to run a plugin as
595
586
      a privileged user is to have the set-user-ID or set-group-ID bit
596
 
      set on the plugin executable file (see <citerefentry>
 
587
      set on the plugin executable files (see <citerefentry>
597
588
      <refentrytitle>execve</refentrytitle><manvolnum>2</manvolnum>
598
589
      </citerefentry>).
599
590
    </para>
600
591
    <para>
601
592
      If this program is used as a keyscript in <citerefentry
602
593
      ><refentrytitle>crypttab</refentrytitle><manvolnum>5</manvolnum>
603
 
      </citerefentry>, there is a slight risk that if this program
604
 
      fails to work, there might be no way to boot the system except
605
 
      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
606
597
      image to not run this program.  This is, however, unlikely,
607
598
      since the <citerefentry><refentrytitle
608
599
      >password-prompt</refentrytitle><manvolnum>8mandos</manvolnum>
627
618
      <manvolnum>8</manvolnum></citerefentry>,
628
619
      <citerefentry><refentrytitle>password-prompt</refentrytitle>
629
620
      <manvolnum>8mandos</manvolnum></citerefentry>,
630
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
621
      <citerefentry><refentrytitle>password-request</refentrytitle>
631
622
      <manvolnum>8mandos</manvolnum></citerefentry>
632
623
    </para>
633
624
  </refsect1>