/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 recompile
  • Date: 2011-12-31 13:25:58 UTC
  • mto: This revision was merged to the branch mainline in revision 541.
  • Revision ID: teddy@recompile.se-20111231132558-z0dh7qgofgctmgri
* network-hooks.s/bridge: Don't use interface names directly; search
                          for interface names using their address.
  (addrtoif): New function.
* network-hooks.s/bridge.conf (PORTS): Removed.
  (PORT_ADDRESSES): New.
* network-hooks.s/wireless: Don't use interface names directly; search
                            for interface names using their address.
  (addrtoif): New function.
* network-hooks.s/wireless.conf: Specify address.

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 "2011-10-05">
 
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>
18
19
        <firstname>Björn</firstname>
19
20
        <surname>Påhlsson</surname>
20
21
        <address>
21
 
          <email>belorn@fukt.bsnet.se</email>
 
22
          <email>belorn@recompile.se</email>
22
23
        </address>
23
24
      </author>
24
25
      <author>
25
26
        <firstname>Teddy</firstname>
26
27
        <surname>Hogeborn</surname>
27
28
        <address>
28
 
          <email>teddy@fukt.bsnet.se</email>
 
29
          <email>teddy@recompile.se</email>
29
30
        </address>
30
31
      </author>
31
32
    </authorgroup>
32
33
    <copyright>
33
34
      <year>2008</year>
 
35
      <year>2009</year>
 
36
      <year>2011</year>
34
37
      <holder>Teddy Hogeborn</holder>
35
38
      <holder>Björn Påhlsson</holder>
36
39
    </copyright>
37
40
    <xi:include href="legalnotice.xml"/>
38
41
  </refentryinfo>
39
 
 
 
42
  
40
43
  <refmeta>
41
44
    <refentrytitle>&COMMANDNAME;</refentrytitle>
42
45
    <manvolnum>8mandos</manvolnum>
45
48
  <refnamediv>
46
49
    <refname><command>&COMMANDNAME;</command></refname>
47
50
    <refpurpose>
48
 
      Run Mandos plugins.  Pass data from first succesful one.
 
51
      Run Mandos plugins, pass data from first to succeed.
49
52
    </refpurpose>
50
53
  </refnamediv>
51
 
 
 
54
  
52
55
  <refsynopsisdiv>
53
56
    <cmdsynopsis>
54
57
      <command>&COMMANDNAME;</command>
55
58
      <group rep="repeat">
56
59
        <arg choice="plain"><option>--global-env=<replaceable
57
 
        >VAR</replaceable><literal>=</literal><replaceable
 
60
        >ENV</replaceable><literal>=</literal><replaceable
58
61
        >value</replaceable></option></arg>
59
 
        <arg choice="plain"><option>-e
60
 
        <replaceable>VAR</replaceable><literal>=</literal><replaceable
 
62
        <arg choice="plain"><option>-G
 
63
        <replaceable>ENV</replaceable><literal>=</literal><replaceable
61
64
        >value</replaceable> </option></arg>
62
65
      </group>
63
66
      <sbr/>
66
69
        >PLUGIN</replaceable><literal>:</literal><replaceable
67
70
        >ENV</replaceable><literal>=</literal><replaceable
68
71
        >value</replaceable></option></arg>
69
 
        <arg choice="plain"><option>-f<replaceable>
 
72
        <arg choice="plain"><option>-E<replaceable>
70
73
        PLUGIN</replaceable><literal>:</literal><replaceable
71
74
        >ENV</replaceable><literal>=</literal><replaceable
72
75
        >value</replaceable> </option></arg>
83
86
        <arg choice="plain"><option>--options-for=<replaceable
84
87
        >PLUGIN</replaceable><literal>:</literal><replaceable
85
88
        >OPTIONS</replaceable></option></arg>
86
 
        <arg choice="plain"><option>-f<replaceable>
 
89
        <arg choice="plain"><option>-o<replaceable>
87
90
        PLUGIN</replaceable><literal>:</literal><replaceable
88
91
        >OPTIONS</replaceable> </option></arg>
89
92
      </group>
95
98
        <replaceable>PLUGIN</replaceable> </option></arg>
96
99
      </group>
97
100
      <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/>
98
108
      <arg><option>--groupid=<replaceable
99
109
      >ID</replaceable></option></arg>
100
110
      <sbr/>
104
114
      <arg><option>--plugin-dir=<replaceable
105
115
      >DIRECTORY</replaceable></option></arg>
106
116
      <sbr/>
 
117
      <arg><option>--config-file=<replaceable
 
118
      >FILE</replaceable></option></arg>
 
119
      <sbr/>
107
120
      <arg><option>--debug</option></arg>
108
121
    </cmdsynopsis>
109
122
    <cmdsynopsis>
130
143
    <title>DESCRIPTION</title>
131
144
    <para>
132
145
      <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.
 
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.
140
153
    </para>
141
154
    <para>
142
155
      This program is not meant to be invoked directly, but can be in
160
173
    <variablelist>
161
174
      <varlistentry>
162
175
        <term><option>--global-env
163
 
        <replaceable>VAR</replaceable><literal>=</literal><replaceable
 
176
        <replaceable>ENV</replaceable><literal>=</literal><replaceable
164
177
        >value</replaceable></option></term>
165
 
        <term><option>-e
166
 
        <replaceable>VAR</replaceable><literal>=</literal><replaceable
 
178
        <term><option>-G
 
179
        <replaceable>ENV</replaceable><literal>=</literal><replaceable
167
180
        >value</replaceable></option></term>
168
181
        <listitem>
169
182
          <para>
179
192
        <replaceable>PLUGIN</replaceable><literal>:</literal
180
193
        ><replaceable>ENV</replaceable><literal>=</literal
181
194
        ><replaceable>value</replaceable></option></term>
182
 
        <term><option>-f
 
195
        <term><option>-E
183
196
        <replaceable>PLUGIN</replaceable><literal>:</literal
184
197
        ><replaceable>ENV</replaceable><literal>=</literal
185
198
        ><replaceable>value</replaceable></option></term>
205
218
            <replaceable>OPTIONS</replaceable> is a comma separated
206
219
            list of options.  This is not a very useful option, except
207
220
            for specifying the <quote><option>--debug</option></quote>
208
 
            for all plugins.
 
221
            option to all plugins.
209
222
          </para>
210
223
        </listitem>
211
224
      </varlistentry>
231
244
            <option>--bar</option> with the option argument
232
245
            <quote>baz</quote> is either
233
246
            <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>.
 
247
            <userinput>--options-for=foo:--bar,baz</userinput>.  Using
 
248
            <userinput>--options-for="foo:--bar baz"</userinput>. will
 
249
            <emphasis>not</emphasis> work.
237
250
          </para>
238
251
        </listitem>
239
252
      </varlistentry>
240
 
 
 
253
      
241
254
      <varlistentry>
242
 
        <term><option> --disable
 
255
        <term><option>--disable
243
256
        <replaceable>PLUGIN</replaceable></option></term>
244
257
        <term><option>-d
245
258
        <replaceable>PLUGIN</replaceable></option></term>
248
261
            Disable the plugin named
249
262
            <replaceable>PLUGIN</replaceable>.  The plugin will not be
250
263
            started.
251
 
          </para>       
252
 
        </listitem>
253
 
      </varlistentry>
254
 
 
 
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
      
255
283
      <varlistentry>
256
284
        <term><option>--groupid
257
285
        <replaceable>ID</replaceable></option></term>
264
292
          </para>
265
293
        </listitem>
266
294
      </varlistentry>
267
 
 
 
295
      
268
296
      <varlistentry>
269
297
        <term><option>--userid
270
298
        <replaceable>ID</replaceable></option></term>
277
305
          </para>
278
306
        </listitem>
279
307
      </varlistentry>
280
 
 
 
308
      
281
309
      <varlistentry>
282
310
        <term><option>--plugin-dir
283
311
        <replaceable>DIRECTORY</replaceable></option></term>
292
320
      </varlistentry>
293
321
      
294
322
      <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>
295
335
        <term><option>--debug</option></term>
296
336
        <listitem>
297
337
          <para>
328
368
          </para>
329
369
        </listitem>
330
370
      </varlistentry>
331
 
 
 
371
      
332
372
      <varlistentry>
333
373
        <term><option>--version</option></term>
334
374
        <term><option>-V</option></term>
340
380
      </varlistentry>
341
381
    </variablelist>
342
382
  </refsect1>
343
 
 
 
383
  
344
384
  <refsect1 id="overview">
345
385
    <title>OVERVIEW</title>
346
386
    <xi:include href="overview.xml"/>
366
406
      code will make this plugin-runner output the password from that
367
407
      plugin, stop any other plugins, and exit.
368
408
    </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>
369
447
  </refsect1>
370
448
  
371
449
  <refsect1 id="fallback">
393
471
  <refsect1 id="environment">
394
472
    <title>ENVIRONMENT</title>
395
473
    <para>
396
 
      
 
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.
397
479
    </para>
398
480
  </refsect1>
399
481
  
400
 
  <refsect1 id="file">
 
482
  <refsect1 id="files">
401
483
    <title>FILES</title>
402
484
    <para>
403
485
      <variablelist>
415
497
              of a line is ignored.
416
498
            </para>
417
499
            <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>
418
506
              This file will be processed <emphasis>before</emphasis>
419
507
              the normal command line options, so the latter can
420
508
              override the former, if need be.
421
509
            </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>
422
515
          </listitem>
423
516
        </varlistentry>
424
517
      </variablelist>
428
521
  <refsect1 id="bugs">
429
522
    <title>BUGS</title>
430
523
    <para>
431
 
      There is no <option>--enable</option> option to enable disabled
432
 
      plugins.
 
524
      The <option>--config-file</option> option is ignored when
 
525
      specified from within a configuration file.
433
526
    </para>
434
527
  </refsect1>
435
528
  
436
529
  <refsect1 id="examples">
437
530
    <title>EXAMPLE</title>
438
 
    <para>
439
 
    </para>
 
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>
440
587
  </refsect1>
441
 
  
442
588
  <refsect1 id="security">
443
589
    <title>SECURITY</title>
444
590
    <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"/>).
445
615
    </para>
446
616
  </refsect1>
447
617
  
448
618
  <refsect1 id="see_also">
449
619
    <title>SEE ALSO</title>
450
620
    <para>
 
621
      <citerefentry><refentrytitle>intro</refentrytitle>
 
622
      <manvolnum>8mandos</manvolnum></citerefentry>,
451
623
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
452
624
      <manvolnum>8</manvolnum></citerefentry>,
 
625
      <citerefentry><refentrytitle>crypttab</refentrytitle>
 
626
      <manvolnum>5</manvolnum></citerefentry>,
 
627
      <citerefentry><refentrytitle>execve</refentrytitle>
 
628
      <manvolnum>2</manvolnum></citerefentry>,
453
629
      <citerefentry><refentrytitle>mandos</refentrytitle>
454
630
      <manvolnum>8</manvolnum></citerefentry>,
455
631
      <citerefentry><refentrytitle>password-prompt</refentrytitle>
456
632
      <manvolnum>8mandos</manvolnum></citerefentry>,
457
 
      <citerefentry><refentrytitle>password-request</refentrytitle>
 
633
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
458
634
      <manvolnum>8mandos</manvolnum></citerefentry>
459
635
    </para>
460
636
  </refsect1>