/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: Teddy Hogeborn
  • Date: 2008-09-02 06:13:47 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080902061347-psw61eqt17j425sq
* plugin-runner.c: Changed short option for "--global-env" to "-G",
                   changed short option for "--env-for" to "-E",
                   added new option "--enable" ("-e").

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 "2011-10-05">
6
 
<!ENTITY % common SYSTEM "common.ent">
7
 
%common;
 
6
<!ENTITY TIMESTAMP "2008-09-01">
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>
19
18
        <firstname>Björn</firstname>
20
19
        <surname>Påhlsson</surname>
21
20
        <address>
22
 
          <email>belorn@recompile.se</email>
 
21
          <email>belorn@fukt.bsnet.se</email>
23
22
        </address>
24
23
      </author>
25
24
      <author>
26
25
        <firstname>Teddy</firstname>
27
26
        <surname>Hogeborn</surname>
28
27
        <address>
29
 
          <email>teddy@recompile.se</email>
 
28
          <email>teddy@fukt.bsnet.se</email>
30
29
        </address>
31
30
      </author>
32
31
    </authorgroup>
33
32
    <copyright>
34
33
      <year>2008</year>
35
 
      <year>2009</year>
36
 
      <year>2011</year>
37
34
      <holder>Teddy Hogeborn</holder>
38
35
      <holder>Björn Påhlsson</holder>
39
36
    </copyright>
40
37
    <xi:include href="legalnotice.xml"/>
41
38
  </refentryinfo>
42
 
  
 
39
 
43
40
  <refmeta>
44
41
    <refentrytitle>&COMMANDNAME;</refentrytitle>
45
42
    <manvolnum>8mandos</manvolnum>
48
45
  <refnamediv>
49
46
    <refname><command>&COMMANDNAME;</command></refname>
50
47
    <refpurpose>
51
 
      Run Mandos plugins, pass data from first to succeed.
 
48
      Run Mandos plugins.  Pass data from first succesful one.
52
49
    </refpurpose>
53
50
  </refnamediv>
54
 
  
 
51
 
55
52
  <refsynopsisdiv>
56
53
    <cmdsynopsis>
57
54
      <command>&COMMANDNAME;</command>
58
55
      <group rep="repeat">
59
56
        <arg choice="plain"><option>--global-env=<replaceable
60
 
        >ENV</replaceable><literal>=</literal><replaceable
 
57
        >VAR</replaceable><literal>=</literal><replaceable
61
58
        >value</replaceable></option></arg>
62
 
        <arg choice="plain"><option>-G
63
 
        <replaceable>ENV</replaceable><literal>=</literal><replaceable
 
59
        <arg choice="plain"><option>-e
 
60
        <replaceable>VAR</replaceable><literal>=</literal><replaceable
64
61
        >value</replaceable> </option></arg>
65
62
      </group>
66
63
      <sbr/>
69
66
        >PLUGIN</replaceable><literal>:</literal><replaceable
70
67
        >ENV</replaceable><literal>=</literal><replaceable
71
68
        >value</replaceable></option></arg>
72
 
        <arg choice="plain"><option>-E<replaceable>
 
69
        <arg choice="plain"><option>-f<replaceable>
73
70
        PLUGIN</replaceable><literal>:</literal><replaceable
74
71
        >ENV</replaceable><literal>=</literal><replaceable
75
72
        >value</replaceable> </option></arg>
86
83
        <arg choice="plain"><option>--options-for=<replaceable
87
84
        >PLUGIN</replaceable><literal>:</literal><replaceable
88
85
        >OPTIONS</replaceable></option></arg>
89
 
        <arg choice="plain"><option>-o<replaceable>
 
86
        <arg choice="plain"><option>-f<replaceable>
90
87
        PLUGIN</replaceable><literal>:</literal><replaceable
91
88
        >OPTIONS</replaceable> </option></arg>
92
89
      </group>
98
95
        <replaceable>PLUGIN</replaceable> </option></arg>
99
96
      </group>
100
97
      <sbr/>
101
 
      <group rep="repeat">
102
 
        <arg choice="plain"><option>--enable=<replaceable
103
 
        >PLUGIN</replaceable></option></arg>
104
 
        <arg choice="plain"><option>-e
105
 
        <replaceable>PLUGIN</replaceable> </option></arg>
106
 
      </group>
107
 
      <sbr/>
108
98
      <arg><option>--groupid=<replaceable
109
99
      >ID</replaceable></option></arg>
110
100
      <sbr/>
114
104
      <arg><option>--plugin-dir=<replaceable
115
105
      >DIRECTORY</replaceable></option></arg>
116
106
      <sbr/>
117
 
      <arg><option>--config-file=<replaceable
118
 
      >FILE</replaceable></option></arg>
119
 
      <sbr/>
120
107
      <arg><option>--debug</option></arg>
121
108
    </cmdsynopsis>
122
109
    <cmdsynopsis>
143
130
    <title>DESCRIPTION</title>
144
131
    <para>
145
132
      <command>&COMMANDNAME;</command> is a program which is meant to
146
 
      be specified as a <quote>keyscript</quote> for the root disk in
147
 
      <citerefentry><refentrytitle>crypttab</refentrytitle>
148
 
      <manvolnum>5</manvolnum></citerefentry>.  The aim of this
149
 
      program is therefore to output a password, which then
150
 
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
151
 
      <manvolnum>8</manvolnum></citerefentry> will use to unlock the
152
 
      root disk.
 
133
      be specified as <quote>keyscript</quote> in <citerefentry>
 
134
      <refentrytitle>crypttab</refentrytitle>
 
135
      <manvolnum>5</manvolnum></citerefentry> for the root disk.  The
 
136
      aim of this program is therefore to output a password, which
 
137
      then <citerefentry><refentrytitle>cryptsetup</refentrytitle>
 
138
      <manvolnum>8</manvolnum></citerefentry> will use to try and
 
139
      unlock the root disk.
153
140
    </para>
154
141
    <para>
155
142
      This program is not meant to be invoked directly, but can be in
173
160
    <variablelist>
174
161
      <varlistentry>
175
162
        <term><option>--global-env
176
 
        <replaceable>ENV</replaceable><literal>=</literal><replaceable
 
163
        <replaceable>VAR</replaceable><literal>=</literal><replaceable
177
164
        >value</replaceable></option></term>
178
 
        <term><option>-G
179
 
        <replaceable>ENV</replaceable><literal>=</literal><replaceable
 
165
        <term><option>-e
 
166
        <replaceable>VAR</replaceable><literal>=</literal><replaceable
180
167
        >value</replaceable></option></term>
181
168
        <listitem>
182
169
          <para>
192
179
        <replaceable>PLUGIN</replaceable><literal>:</literal
193
180
        ><replaceable>ENV</replaceable><literal>=</literal
194
181
        ><replaceable>value</replaceable></option></term>
195
 
        <term><option>-E
 
182
        <term><option>-f
196
183
        <replaceable>PLUGIN</replaceable><literal>:</literal
197
184
        ><replaceable>ENV</replaceable><literal>=</literal
198
185
        ><replaceable>value</replaceable></option></term>
218
205
            <replaceable>OPTIONS</replaceable> is a comma separated
219
206
            list of options.  This is not a very useful option, except
220
207
            for specifying the <quote><option>--debug</option></quote>
221
 
            option to all plugins.
 
208
            for all plugins.
222
209
          </para>
223
210
        </listitem>
224
211
      </varlistentry>
244
231
            <option>--bar</option> with the option argument
245
232
            <quote>baz</quote> is either
246
233
            <userinput>--options-for=foo:--bar=baz</userinput> or
247
 
            <userinput>--options-for=foo:--bar,baz</userinput>.  Using
248
 
            <userinput>--options-for="foo:--bar baz"</userinput>. will
249
 
            <emphasis>not</emphasis> work.
 
234
            <userinput>--options-for=foo:--bar,baz</userinput>, but
 
235
            <emphasis>not</emphasis>
 
236
            <userinput>--options-for="foo:--bar baz"</userinput>.
250
237
          </para>
251
238
        </listitem>
252
239
      </varlistentry>
253
 
      
 
240
 
254
241
      <varlistentry>
255
 
        <term><option>--disable
 
242
        <term><option> --disable
256
243
        <replaceable>PLUGIN</replaceable></option></term>
257
244
        <term><option>-d
258
245
        <replaceable>PLUGIN</replaceable></option></term>
261
248
            Disable the plugin named
262
249
            <replaceable>PLUGIN</replaceable>.  The plugin will not be
263
250
            started.
264
 
          </para>
265
 
        </listitem>
266
 
      </varlistentry>
267
 
      
268
 
      <varlistentry>
269
 
        <term><option>--enable
270
 
        <replaceable>PLUGIN</replaceable></option></term>
271
 
        <term><option>-e
272
 
        <replaceable>PLUGIN</replaceable></option></term>
273
 
        <listitem>
274
 
          <para>
275
 
            Re-enable the plugin named
276
 
            <replaceable>PLUGIN</replaceable>.  This is only useful to
277
 
            undo a previous <option>--disable</option> option, maybe
278
 
            from the configuration file.
279
 
          </para>
280
 
        </listitem>
281
 
      </varlistentry>
282
 
      
 
251
          </para>       
 
252
        </listitem>
 
253
      </varlistentry>
 
254
 
283
255
      <varlistentry>
284
256
        <term><option>--groupid
285
257
        <replaceable>ID</replaceable></option></term>
292
264
          </para>
293
265
        </listitem>
294
266
      </varlistentry>
295
 
      
 
267
 
296
268
      <varlistentry>
297
269
        <term><option>--userid
298
270
        <replaceable>ID</replaceable></option></term>
305
277
          </para>
306
278
        </listitem>
307
279
      </varlistentry>
308
 
      
 
280
 
309
281
      <varlistentry>
310
282
        <term><option>--plugin-dir
311
283
        <replaceable>DIRECTORY</replaceable></option></term>
320
292
      </varlistentry>
321
293
      
322
294
      <varlistentry>
323
 
        <term><option>--config-file
324
 
        <replaceable>FILE</replaceable></option></term>
325
 
        <listitem>
326
 
          <para>
327
 
            Specify a different file to read additional options from.
328
 
            See <xref linkend="files"/>.  Other command line options
329
 
            will override options specified in the file.
330
 
          </para>
331
 
        </listitem>
332
 
      </varlistentry>
333
 
      
334
 
      <varlistentry>
335
295
        <term><option>--debug</option></term>
336
296
        <listitem>
337
297
          <para>
368
328
          </para>
369
329
        </listitem>
370
330
      </varlistentry>
371
 
      
 
331
 
372
332
      <varlistentry>
373
333
        <term><option>--version</option></term>
374
334
        <term><option>-V</option></term>
380
340
      </varlistentry>
381
341
    </variablelist>
382
342
  </refsect1>
383
 
  
 
343
 
384
344
  <refsect1 id="overview">
385
345
    <title>OVERVIEW</title>
386
346
    <xi:include href="overview.xml"/>
406
366
      code will make this plugin-runner output the password from that
407
367
      plugin, stop any other plugins, and exit.
408
368
    </para>
409
 
    
410
 
    <refsect2 id="writing_plugins">
411
 
      <title>WRITING PLUGINS</title>
412
 
      <para>
413
 
        A plugin is simply a program which prints a password to its
414
 
        standard output and then exits with a successful (zero) exit
415
 
        status.  If the exit status is not zero, any output on
416
 
        standard output will be ignored by the plugin runner.  Any
417
 
        output on its standard error channel will simply be passed to
418
 
        the standard error of the plugin runner, usually the system
419
 
        console.
420
 
      </para>
421
 
      <para>
422
 
        If the password is a single-line, manually entered passprase,
423
 
        a final trailing newline character should
424
 
        <emphasis>not</emphasis> be printed.
425
 
      </para>
426
 
      <para>
427
 
        The plugin will run in the initial RAM disk environment, so
428
 
        care must be taken not to depend on any files or running
429
 
        services not available there.
430
 
      </para>
431
 
      <para>
432
 
        The plugin must exit cleanly and free all allocated resources
433
 
        upon getting the TERM signal, since this is what the plugin
434
 
        runner uses to stop all other plugins when one plugin has
435
 
        output a password and exited cleanly.
436
 
      </para>
437
 
      <para>
438
 
        The plugin must not use resources, like for instance reading
439
 
        from the standard input, without knowing that no other plugin
440
 
        is also using it.
441
 
      </para>
442
 
      <para>
443
 
        It is useful, but not required, for the plugin to take the
444
 
        <option>--debug</option> option.
445
 
      </para>
446
 
    </refsect2>
447
369
  </refsect1>
448
370
  
449
371
  <refsect1 id="fallback">
471
393
  <refsect1 id="environment">
472
394
    <title>ENVIRONMENT</title>
473
395
    <para>
474
 
      This program does not use any environment variables itself, it
475
 
      only passes on its environment to all the plugins.  The
476
 
      environment passed to plugins can be modified using the
477
 
      <option>--global-env</option> and <option>--env-for</option>
478
 
      options.
 
396
      
479
397
    </para>
480
398
  </refsect1>
481
399
  
482
 
  <refsect1 id="files">
 
400
  <refsect1 id="file">
483
401
    <title>FILES</title>
484
402
    <para>
485
403
      <variablelist>
497
415
              of a line is ignored.
498
416
            </para>
499
417
            <para>
500
 
              This program is meant to run in the initial RAM disk
501
 
              environment, so that is where this file is assumed to
502
 
              exist.  The file does not need to exist in the normal
503
 
              file system.
504
 
            </para>
505
 
            <para>
506
418
              This file will be processed <emphasis>before</emphasis>
507
419
              the normal command line options, so the latter can
508
420
              override the former, if need be.
509
421
            </para>
510
 
            <para>
511
 
              This file name is the default; the file to read for
512
 
              arguments can be changed using the
513
 
              <option>--config-file</option> option.
514
 
            </para>
515
422
          </listitem>
516
423
        </varlistentry>
517
424
      </variablelist>
521
428
  <refsect1 id="bugs">
522
429
    <title>BUGS</title>
523
430
    <para>
524
 
      The <option>--config-file</option> option is ignored when
525
 
      specified from within a configuration file.
 
431
      There is no <option>--enable</option> option to enable disabled
 
432
      plugins.
526
433
    </para>
527
434
  </refsect1>
528
435
  
529
436
  <refsect1 id="examples">
530
437
    <title>EXAMPLE</title>
531
 
    <informalexample>
532
 
      <para>
533
 
        Normal invocation needs no options:
534
 
      </para>
535
 
      <para>
536
 
        <userinput>&COMMANDNAME;</userinput>
537
 
      </para>
538
 
    </informalexample>
539
 
    <informalexample>
540
 
      <para>
541
 
        Run the program, but not the plugins, in debug mode:
542
 
      </para>
543
 
      <para>
544
 
        
545
 
        <!-- do not wrap this line -->
546
 
        <userinput>&COMMANDNAME; --debug</userinput>
547
 
        
548
 
      </para>
549
 
    </informalexample>
550
 
    <informalexample>
551
 
      <para>
552
 
        Run all plugins, but run the <quote>foo</quote> plugin in
553
 
        debug mode:
554
 
      </para>
555
 
      <para>
556
 
        
557
 
        <!-- do not wrap this line -->
558
 
        <userinput>&COMMANDNAME; --options-for=foo:--debug</userinput>
559
 
        
560
 
      </para>
561
 
    </informalexample>
562
 
    <informalexample>
563
 
      <para>
564
 
        Run all plugins, but not the program, in debug mode:
565
 
      </para>
566
 
      <para>
567
 
        
568
 
        <!-- do not wrap this line -->
569
 
        <userinput>&COMMANDNAME; --global-options=--debug</userinput>
570
 
        
571
 
      </para>
572
 
    </informalexample>
573
 
    <informalexample>
574
 
      <para>
575
 
        Run plugins from a different directory, read a different
576
 
        configuration file, and add two options to the
577
 
        <citerefentry><refentrytitle >mandos-client</refentrytitle>
578
 
        <manvolnum>8mandos</manvolnum></citerefentry> plugin:
579
 
      </para>
580
 
      <para>
581
 
 
582
 
<!-- do not wrap this line -->
583
 
<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>
584
 
 
585
 
      </para>
586
 
    </informalexample>
 
438
    <para>
 
439
    </para>
587
440
  </refsect1>
 
441
  
588
442
  <refsect1 id="security">
589
443
    <title>SECURITY</title>
590
444
    <para>
591
 
      This program will, when starting, try to switch to another user.
592
 
      If it is started as root, it will succeed, and will by default
593
 
      switch to user and group 65534, which are assumed to be
594
 
      non-privileged.  This user and group is then what all plugins
595
 
      will be started as.  Therefore, the only way to run a plugin as
596
 
      a privileged user is to have the set-user-ID or set-group-ID bit
597
 
      set on the plugin executable file (see <citerefentry>
598
 
      <refentrytitle>execve</refentrytitle><manvolnum>2</manvolnum>
599
 
      </citerefentry>).
600
 
    </para>
601
 
    <para>
602
 
      If this program is used as a keyscript in <citerefentry
603
 
      ><refentrytitle>crypttab</refentrytitle><manvolnum>5</manvolnum>
604
 
      </citerefentry>, there is a slight risk that if this program
605
 
      fails to work, there might be no way to boot the system except
606
 
      for booting from another media and editing the initial RAM disk
607
 
      image to not run this program.  This is, however, unlikely,
608
 
      since the <citerefentry><refentrytitle
609
 
      >password-prompt</refentrytitle><manvolnum>8mandos</manvolnum>
610
 
      </citerefentry> plugin will read a password from the console in
611
 
      case of failure of the other plugins, and this plugin runner
612
 
      will also, in case of catastrophic failure, itself fall back to
613
 
      asking and outputting a password on the console (see <xref
614
 
      linkend="fallback"/>).
615
445
    </para>
616
446
  </refsect1>
617
447
  
618
448
  <refsect1 id="see_also">
619
449
    <title>SEE ALSO</title>
620
450
    <para>
621
 
      <citerefentry><refentrytitle>intro</refentrytitle>
622
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
623
451
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
624
452
      <manvolnum>8</manvolnum></citerefentry>,
625
 
      <citerefentry><refentrytitle>crypttab</refentrytitle>
626
 
      <manvolnum>5</manvolnum></citerefentry>,
627
 
      <citerefentry><refentrytitle>execve</refentrytitle>
628
 
      <manvolnum>2</manvolnum></citerefentry>,
629
453
      <citerefentry><refentrytitle>mandos</refentrytitle>
630
454
      <manvolnum>8</manvolnum></citerefentry>,
631
455
      <citerefentry><refentrytitle>password-prompt</refentrytitle>
632
456
      <manvolnum>8mandos</manvolnum></citerefentry>,
633
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
457
      <citerefentry><refentrytitle>password-request</refentrytitle>
634
458
      <manvolnum>8mandos</manvolnum></citerefentry>
635
459
    </para>
636
460
  </refsect1>