/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-10-05 17:38:31 UTC
  • Revision ID: teddy@fukt.bsnet.se-20081005173831-fysrfayl4yvhlo6x
* INSTALL: Add instructions on how to set the correct network
           interface on the cient, and also how to test the server and
           verify the password.

* TODO: Clean up old stuff.

* debian/mandos-client.README.Debian: Separate into sections with
                                      headlines.  Add instructions on
                                      how to test the server and
                                      verify the password.

* plugin-runner.conf: Add reminder to update initrd image.

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