/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 at bsnet
  • Date: 2010-09-27 17:53:53 UTC
  • Revision ID: teddy@fukt.bsnet.se-20100927175353-skms2ds4cjswpf4t
* debian/mandos-client.README.Debian: Remove warning about --connect
                                      not looping, since it now does.

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugin-runner.xml
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">
5
4
<!ENTITY COMMANDNAME "plugin-runner">
6
 
<!ENTITY TIMESTAMP "2008-09-01">
 
5
<!ENTITY TIMESTAMP "2009-01-17">
 
6
<!ENTITY % common SYSTEM "common.ent">
 
7
%common;
7
8
]>
8
9
 
9
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
11
12
    <title>Mandos Manual</title>
12
13
    <!-- Nwalsh’s docbook scripts use this to generate the footer: -->
13
14
    <productname>Mandos</productname>
14
 
    <productnumber>&VERSION;</productnumber>
 
15
    <productnumber>&version;</productnumber>
15
16
    <date>&TIMESTAMP;</date>
16
17
    <authorgroup>
17
18
      <author>
31
32
    </authorgroup>
32
33
    <copyright>
33
34
      <year>2008</year>
 
35
      <year>2009</year>
34
36
      <holder>Teddy Hogeborn</holder>
35
37
      <holder>Björn Påhlsson</holder>
36
38
    </copyright>
37
39
    <xi:include href="legalnotice.xml"/>
38
40
  </refentryinfo>
39
 
 
 
41
  
40
42
  <refmeta>
41
43
    <refentrytitle>&COMMANDNAME;</refentrytitle>
42
44
    <manvolnum>8mandos</manvolnum>
45
47
  <refnamediv>
46
48
    <refname><command>&COMMANDNAME;</command></refname>
47
49
    <refpurpose>
48
 
      Run Mandos plugins.  Pass data from first succesful one.
 
50
      Run Mandos plugins, pass data from first to succeed.
49
51
    </refpurpose>
50
52
  </refnamediv>
51
 
 
 
53
  
52
54
  <refsynopsisdiv>
53
55
    <cmdsynopsis>
54
56
      <command>&COMMANDNAME;</command>
55
57
      <group rep="repeat">
56
 
        <arg choice="plain"><option>--global-envs=<replaceable
57
 
        >VAR</replaceable><literal>=</literal><replaceable
 
58
        <arg choice="plain"><option>--global-env=<replaceable
 
59
        >ENV</replaceable><literal>=</literal><replaceable
58
60
        >value</replaceable></option></arg>
59
 
        <arg choice="plain"><option>-e
60
 
        <replaceable>VAR</replaceable><literal>=</literal><replaceable
 
61
        <arg choice="plain"><option>-G
 
62
        <replaceable>ENV</replaceable><literal>=</literal><replaceable
61
63
        >value</replaceable> </option></arg>
62
64
      </group>
63
65
      <sbr/>
64
66
      <group rep="repeat">
65
 
        <arg choice="plain"><option>--envs-for=<replaceable
 
67
        <arg choice="plain"><option>--env-for=<replaceable
66
68
        >PLUGIN</replaceable><literal>:</literal><replaceable
67
69
        >ENV</replaceable><literal>=</literal><replaceable
68
70
        >value</replaceable></option></arg>
69
 
        <arg choice="plain"><option>-f<replaceable>
 
71
        <arg choice="plain"><option>-E<replaceable>
70
72
        PLUGIN</replaceable><literal>:</literal><replaceable
71
73
        >ENV</replaceable><literal>=</literal><replaceable
72
74
        >value</replaceable> </option></arg>
83
85
        <arg choice="plain"><option>--options-for=<replaceable
84
86
        >PLUGIN</replaceable><literal>:</literal><replaceable
85
87
        >OPTIONS</replaceable></option></arg>
86
 
        <arg choice="plain"><option>-f<replaceable>
 
88
        <arg choice="plain"><option>-o<replaceable>
87
89
        PLUGIN</replaceable><literal>:</literal><replaceable
88
90
        >OPTIONS</replaceable> </option></arg>
89
91
      </group>
95
97
        <replaceable>PLUGIN</replaceable> </option></arg>
96
98
      </group>
97
99
      <sbr/>
 
100
      <group rep="repeat">
 
101
        <arg choice="plain"><option>--enable=<replaceable
 
102
        >PLUGIN</replaceable></option></arg>
 
103
        <arg choice="plain"><option>-e
 
104
        <replaceable>PLUGIN</replaceable> </option></arg>
 
105
      </group>
 
106
      <sbr/>
98
107
      <arg><option>--groupid=<replaceable
99
108
      >ID</replaceable></option></arg>
100
109
      <sbr/>
104
113
      <arg><option>--plugin-dir=<replaceable
105
114
      >DIRECTORY</replaceable></option></arg>
106
115
      <sbr/>
 
116
      <arg><option>--config-file=<replaceable
 
117
      >FILE</replaceable></option></arg>
 
118
      <sbr/>
107
119
      <arg><option>--debug</option></arg>
108
120
    </cmdsynopsis>
109
121
    <cmdsynopsis>
130
142
    <title>DESCRIPTION</title>
131
143
    <para>
132
144
      <command>&COMMANDNAME;</command> is a program which is meant to
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.
 
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>
 
150
      <manvolnum>8</manvolnum></citerefentry> will use to unlock the
 
151
      root disk.
140
152
    </para>
141
153
    <para>
142
154
      This program is not meant to be invoked directly, but can be in
159
171
    <title>OPTIONS</title>
160
172
    <variablelist>
161
173
      <varlistentry>
 
174
        <term><option>--global-env
 
175
        <replaceable>ENV</replaceable><literal>=</literal><replaceable
 
176
        >value</replaceable></option></term>
 
177
        <term><option>-G
 
178
        <replaceable>ENV</replaceable><literal>=</literal><replaceable
 
179
        >value</replaceable></option></term>
 
180
        <listitem>
 
181
          <para>
 
182
            This option will add an environment variable setting to
 
183
            all plugins.  This will override any inherited environment
 
184
            variable.
 
185
          </para>
 
186
        </listitem>
 
187
      </varlistentry>
 
188
      
 
189
      <varlistentry>
 
190
        <term><option>--env-for
 
191
        <replaceable>PLUGIN</replaceable><literal>:</literal
 
192
        ><replaceable>ENV</replaceable><literal>=</literal
 
193
        ><replaceable>value</replaceable></option></term>
 
194
        <term><option>-E
 
195
        <replaceable>PLUGIN</replaceable><literal>:</literal
 
196
        ><replaceable>ENV</replaceable><literal>=</literal
 
197
        ><replaceable>value</replaceable></option></term>
 
198
        <listitem>
 
199
          <para>
 
200
            This option will add an environment variable setting to
 
201
            the <replaceable>PLUGIN</replaceable> plugin.  This will
 
202
            override any inherited environment variables or
 
203
            environment variables specified using
 
204
            <option>--global-env</option>.
 
205
          </para>
 
206
        </listitem>
 
207
      </varlistentry>
 
208
      
 
209
      <varlistentry>
162
210
        <term><option>--global-options
163
211
        <replaceable>OPTIONS</replaceable></option></term>
164
212
        <term><option>-g
169
217
            <replaceable>OPTIONS</replaceable> is a comma separated
170
218
            list of options.  This is not a very useful option, except
171
219
            for specifying the <quote><option>--debug</option></quote>
172
 
            for all plugins.
 
220
            option to all plugins.
173
221
          </para>
174
222
        </listitem>
175
223
      </varlistentry>
195
243
            <option>--bar</option> with the option argument
196
244
            <quote>baz</quote> is either
197
245
            <userinput>--options-for=foo:--bar=baz</userinput> or
198
 
            <userinput>--options-for=foo:--bar,baz</userinput>, but
199
 
            <emphasis>not</emphasis>
200
 
            <userinput>--options-for="foo:--bar baz"</userinput>.
 
246
            <userinput>--options-for=foo:--bar,baz</userinput>.  Using
 
247
            <userinput>--options-for="foo:--bar baz"</userinput>. will
 
248
            <emphasis>not</emphasis> work.
201
249
          </para>
202
250
        </listitem>
203
251
      </varlistentry>
204
 
 
 
252
      
205
253
      <varlistentry>
206
 
        <term><option> --disable
 
254
        <term><option>--disable
207
255
        <replaceable>PLUGIN</replaceable></option></term>
208
256
        <term><option>-d
209
257
        <replaceable>PLUGIN</replaceable></option></term>
215
263
          </para>       
216
264
        </listitem>
217
265
      </varlistentry>
218
 
 
 
266
      
 
267
      <varlistentry>
 
268
        <term><option>--enable
 
269
        <replaceable>PLUGIN</replaceable></option></term>
 
270
        <term><option>-e
 
271
        <replaceable>PLUGIN</replaceable></option></term>
 
272
        <listitem>
 
273
          <para>
 
274
            Re-enable the plugin named
 
275
            <replaceable>PLUGIN</replaceable>.  This is only useful to
 
276
            undo a previous <option>--disable</option> option, maybe
 
277
            from the configuration file.
 
278
          </para>
 
279
        </listitem>
 
280
      </varlistentry>
 
281
      
219
282
      <varlistentry>
220
283
        <term><option>--groupid
221
284
        <replaceable>ID</replaceable></option></term>
228
291
          </para>
229
292
        </listitem>
230
293
      </varlistentry>
231
 
 
 
294
      
232
295
      <varlistentry>
233
296
        <term><option>--userid
234
297
        <replaceable>ID</replaceable></option></term>
241
304
          </para>
242
305
        </listitem>
243
306
      </varlistentry>
244
 
 
 
307
      
245
308
      <varlistentry>
246
309
        <term><option>--plugin-dir
247
310
        <replaceable>DIRECTORY</replaceable></option></term>
256
319
      </varlistentry>
257
320
      
258
321
      <varlistentry>
 
322
        <term><option>--config-file
 
323
        <replaceable>FILE</replaceable></option></term>
 
324
        <listitem>
 
325
          <para>
 
326
            Specify a different file to read additional options from.
 
327
            See <xref linkend="files"/>.  Other command line options
 
328
            will override options specified in the file.
 
329
          </para>
 
330
        </listitem>
 
331
      </varlistentry>
 
332
      
 
333
      <varlistentry>
259
334
        <term><option>--debug</option></term>
260
335
        <listitem>
261
336
          <para>
292
367
          </para>
293
368
        </listitem>
294
369
      </varlistentry>
295
 
 
 
370
      
296
371
      <varlistentry>
297
372
        <term><option>--version</option></term>
298
373
        <term><option>-V</option></term>
304
379
      </varlistentry>
305
380
    </variablelist>
306
381
  </refsect1>
307
 
 
 
382
  
308
383
  <refsect1 id="overview">
309
384
    <title>OVERVIEW</title>
310
385
    <xi:include href="overview.xml"/>
326
401
      <filename>/lib/mandos/plugins.d</filename>, but this can be
327
402
      changed with the <option>--plugin-dir</option> option.  The
328
403
      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.
 
404
      a password <emphasis>and</emphasis> exit with a successful exit
 
405
      code will make this plugin-runner output the password from that
 
406
      plugin, stop any other plugins, and exit.
332
407
    </para>
 
408
    
 
409
    <refsect2 id="writing_plugins">
 
410
      <title>WRITING PLUGINS</title>
 
411
      <para>
 
412
        A plugin is simply a program which prints a password to its
 
413
        standard output and then exits with a successful (zero) exit
 
414
        status.  If the exit status is not zero, any output on
 
415
        standard output will be ignored by the plugin runner.  Any
 
416
        output on its standard error channel will simply be passed to
 
417
        the standard error of the plugin runner, usually the system
 
418
        console.
 
419
      </para>
 
420
      <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
        The plugin will run in the initial RAM disk environment, so
 
427
        care must be taken not to depend on any files or running
 
428
        services not available there.
 
429
      </para>
 
430
      <para>
 
431
        The plugin must exit cleanly and free all allocated resources
 
432
        upon getting the TERM signal, since this is what the plugin
 
433
        runner uses to stop all other plugins when one plugin has
 
434
        output a password and exited cleanly.
 
435
      </para>
 
436
      <para>
 
437
        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.
 
440
      </para>
 
441
      <para>
 
442
        It is useful, but not required, for the plugin to take the
 
443
        <option>--debug</option> option.
 
444
      </para>
 
445
    </refsect2>
333
446
  </refsect1>
334
447
  
335
 
  <refsect1>
 
448
  <refsect1 id="fallback">
336
449
    <title>FALLBACK</title>
337
450
    <para>
 
451
      If no plugins succeed, this program will, as a fallback, ask for
 
452
      a password on the console using <citerefentry><refentrytitle
 
453
      >getpass</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
 
454
      and output it.  This is not meant to be the normal mode of
 
455
      operation, as there is a separate plugin for getting a password
 
456
      from the console.
338
457
    </para>
339
458
  </refsect1>
 
459
  
340
460
  <refsect1 id="exit_status">
341
461
    <title>EXIT STATUS</title>
342
462
    <para>
343
 
    </para>
344
 
  </refsect1>
345
 
 
346
 
  <refsect1 id="file">
 
463
      Exit status of this program is zero if no errors were
 
464
      encountered, and otherwise not.  The fallback (see <xref
 
465
      linkend="fallback"/>) may or may not have succeeded in either
 
466
      case.
 
467
    </para>
 
468
  </refsect1>
 
469
  
 
470
  <refsect1 id="environment">
 
471
    <title>ENVIRONMENT</title>
 
472
    <para>
 
473
      This program does not use any environment variables itself, it
 
474
      only passes on its environment to all the plugins.  The
 
475
      environment passed to plugins can be modified using the
 
476
      <option>--global-env</option> and <option>--env-for</option>
 
477
      options.
 
478
    </para>
 
479
  </refsect1>
 
480
  
 
481
  <refsect1 id="files">
347
482
    <title>FILES</title>
348
483
    <para>
349
 
    </para>
350
 
  </refsect1>
351
 
 
352
 
  <refsect1 id="notes">
353
 
    <title>NOTES</title>
354
 
    <para>
 
484
      <variablelist>
 
485
        <varlistentry>
 
486
          <term><filename
 
487
          >/conf/conf.d/mandos/plugin-runner.conf</filename></term>
 
488
          <listitem>
 
489
            <para>
 
490
              Since this program will be run as a keyscript, there is
 
491
              little to no opportunity to pass command line arguments
 
492
              to it.  Therefore, it will <emphasis>also</emphasis>
 
493
              read this file and use its contents as
 
494
              whitespace-separated command line options.  Also,
 
495
              everything from a <quote>#</quote> character to the end
 
496
              of a line is ignored.
 
497
            </para>
 
498
            <para>
 
499
              This program is meant to run in the initial RAM disk
 
500
              environment, so that is where this file is assumed to
 
501
              exist.  The file does not need to exist in the normal
 
502
              file system.
 
503
            </para>
 
504
            <para>
 
505
              This file will be processed <emphasis>before</emphasis>
 
506
              the normal command line options, so the latter can
 
507
              override the former, if need be.
 
508
            </para>
 
509
            <para>
 
510
              This file name is the default; the file to read for
 
511
              arguments can be changed using the
 
512
              <option>--config-file</option> option.
 
513
            </para>
 
514
          </listitem>
 
515
        </varlistentry>
 
516
      </variablelist>
355
517
    </para>
356
518
  </refsect1>
357
519
  
358
520
  <refsect1 id="bugs">
359
521
    <title>BUGS</title>
360
522
    <para>
 
523
      The <option>--config-file</option> option is ignored when
 
524
      specified from within a configuration file.
361
525
    </para>
362
526
  </refsect1>
363
 
 
 
527
  
364
528
  <refsect1 id="examples">
365
529
    <title>EXAMPLE</title>
366
 
    <para>
367
 
    </para>
 
530
    <informalexample>
 
531
      <para>
 
532
        Normal invocation needs no options:
 
533
      </para>
 
534
      <para>
 
535
        <userinput>&COMMANDNAME;</userinput>
 
536
      </para>
 
537
    </informalexample>
 
538
    <informalexample>
 
539
      <para>
 
540
        Run the program, but not the plugins, in debug mode:
 
541
      </para>
 
542
      <para>
 
543
        
 
544
        <!-- do not wrap this line -->
 
545
        <userinput>&COMMANDNAME; --debug</userinput>
 
546
        
 
547
      </para>
 
548
    </informalexample>
 
549
    <informalexample>
 
550
      <para>
 
551
        Run all plugins, but run the <quote>foo</quote> plugin in
 
552
        debug mode:
 
553
      </para>
 
554
      <para>
 
555
        
 
556
        <!-- do not wrap this line -->
 
557
        <userinput>&COMMANDNAME; --options-for=foo:--debug</userinput>
 
558
        
 
559
      </para>
 
560
    </informalexample>
 
561
    <informalexample>
 
562
      <para>
 
563
        Run all plugins, but not the program, in debug mode:
 
564
      </para>
 
565
      <para>
 
566
        
 
567
        <!-- do not wrap this line -->
 
568
        <userinput>&COMMANDNAME; --global-options=--debug</userinput>
 
569
        
 
570
      </para>
 
571
    </informalexample>
 
572
    <informalexample>
 
573
      <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>
 
577
        <manvolnum>8mandos</manvolnum></citerefentry> plugin:
 
578
      </para>
 
579
      <para>
 
580
 
 
581
<!-- 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>
 
583
 
 
584
      </para>
 
585
    </informalexample>
368
586
  </refsect1>
369
 
 
370
587
  <refsect1 id="security">
371
588
    <title>SECURITY</title>
372
589
    <para>
 
590
      This program will, when starting, try to switch to another user.
 
591
      If it is started as root, it will succeed, and will by default
 
592
      switch to user and group 65534, which are assumed to be
 
593
      non-privileged.  This user and group is then what all plugins
 
594
      will be started as.  Therefore, the only way to run a plugin as
 
595
      a privileged user is to have the set-user-ID or set-group-ID bit
 
596
      set on the plugin executable file (see <citerefentry>
 
597
      <refentrytitle>execve</refentrytitle><manvolnum>2</manvolnum>
 
598
      </citerefentry>).
 
599
    </para>
 
600
    <para>
 
601
      If this program is used as a keyscript in <citerefentry
 
602
      ><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
 
606
      image to not run this program.  This is, however, unlikely,
 
607
      since the <citerefentry><refentrytitle
 
608
      >password-prompt</refentrytitle><manvolnum>8mandos</manvolnum>
 
609
      </citerefentry> plugin will read a password from the console in
 
610
      case of failure of the other plugins, and this plugin runner
 
611
      will also, in case of catastrophic failure, itself fall back to
 
612
      asking and outputting a password on the console (see <xref
 
613
      linkend="fallback"/>).
373
614
    </para>
374
615
  </refsect1>
375
 
 
 
616
  
376
617
  <refsect1 id="see_also">
377
618
    <title>SEE ALSO</title>
378
619
    <para>
379
620
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
380
621
      <manvolnum>8</manvolnum></citerefentry>,
 
622
      <citerefentry><refentrytitle>crypttab</refentrytitle>
 
623
      <manvolnum>5</manvolnum></citerefentry>,
 
624
      <citerefentry><refentrytitle>execve</refentrytitle>
 
625
      <manvolnum>2</manvolnum></citerefentry>,
381
626
      <citerefentry><refentrytitle>mandos</refentrytitle>
382
627
      <manvolnum>8</manvolnum></citerefentry>,
383
628
      <citerefentry><refentrytitle>password-prompt</refentrytitle>
384
629
      <manvolnum>8mandos</manvolnum></citerefentry>,
385
 
      <citerefentry><refentrytitle>password-request</refentrytitle>
 
630
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
386
631
      <manvolnum>8mandos</manvolnum></citerefentry>
387
632
    </para>
388
633
  </refsect1>
389
 
 
 
634
  
390
635
</refentry>
391
636
<!-- Local Variables: -->
392
637
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->