/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: 2015-07-12 01:41:14 UTC
  • Revision ID: teddy@recompile.se-20150712014114-qbala4mutkixxct3
Handle local Zeroconf service name collisions on startup, too.

* mandos (AvahiService.server_state_changed): Catch name collision
                                              error when adding
                                              server.

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-02">
 
5
<!ENTITY TIMESTAMP "2015-06-28">
 
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>2012</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
62
        <arg choice="plain"><option>-G
60
 
        <replaceable>VAR</replaceable><literal>=</literal><replaceable
 
63
        <replaceable>ENV</replaceable><literal>=</literal><replaceable
61
64
        >value</replaceable> </option></arg>
62
65
      </group>
63
66
      <sbr/>
111
114
      <arg><option>--plugin-dir=<replaceable
112
115
      >DIRECTORY</replaceable></option></arg>
113
116
      <sbr/>
 
117
      <arg><option>--plugin-helper-dir=<replaceable
 
118
      >DIRECTORY</replaceable></option></arg>
 
119
      <sbr/>
114
120
      <arg><option>--config-file=<replaceable
115
121
      >FILE</replaceable></option></arg>
116
122
      <sbr/>
140
146
    <title>DESCRIPTION</title>
141
147
    <para>
142
148
      <command>&COMMANDNAME;</command> is a program which is meant to
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>
 
149
      be specified as a <quote>keyscript</quote> for the root disk in
 
150
      <citerefentry><refentrytitle>crypttab</refentrytitle>
 
151
      <manvolnum>5</manvolnum></citerefentry>.  The aim of this
 
152
      program is therefore to output a password, which then
 
153
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
148
154
      <manvolnum>8</manvolnum></citerefentry> will use to unlock the
149
155
      root disk.
150
156
    </para>
170
176
    <variablelist>
171
177
      <varlistentry>
172
178
        <term><option>--global-env
173
 
        <replaceable>VAR</replaceable><literal>=</literal><replaceable
 
179
        <replaceable>ENV</replaceable><literal>=</literal><replaceable
174
180
        >value</replaceable></option></term>
175
181
        <term><option>-G
176
 
        <replaceable>VAR</replaceable><literal>=</literal><replaceable
 
182
        <replaceable>ENV</replaceable><literal>=</literal><replaceable
177
183
        >value</replaceable></option></term>
178
184
        <listitem>
179
185
          <para>
247
253
          </para>
248
254
        </listitem>
249
255
      </varlistentry>
250
 
 
 
256
      
251
257
      <varlistentry>
252
258
        <term><option>--disable
253
259
        <replaceable>PLUGIN</replaceable></option></term>
258
264
            Disable the plugin named
259
265
            <replaceable>PLUGIN</replaceable>.  The plugin will not be
260
266
            started.
261
 
          </para>       
 
267
          </para>
262
268
        </listitem>
263
269
      </varlistentry>
264
 
 
 
270
      
265
271
      <varlistentry>
266
272
        <term><option>--enable
267
273
        <replaceable>PLUGIN</replaceable></option></term>
272
278
            Re-enable the plugin named
273
279
            <replaceable>PLUGIN</replaceable>.  This is only useful to
274
280
            undo a previous <option>--disable</option> option, maybe
275
 
            from the config file.
 
281
            from the configuration file.
276
282
          </para>
277
283
        </listitem>
278
284
      </varlistentry>
279
 
 
 
285
      
280
286
      <varlistentry>
281
287
        <term><option>--groupid
282
288
        <replaceable>ID</replaceable></option></term>
289
295
          </para>
290
296
        </listitem>
291
297
      </varlistentry>
292
 
 
 
298
      
293
299
      <varlistentry>
294
300
        <term><option>--userid
295
301
        <replaceable>ID</replaceable></option></term>
302
308
          </para>
303
309
        </listitem>
304
310
      </varlistentry>
305
 
 
 
311
      
306
312
      <varlistentry>
307
313
        <term><option>--plugin-dir
308
314
        <replaceable>DIRECTORY</replaceable></option></term>
317
323
      </varlistentry>
318
324
      
319
325
      <varlistentry>
 
326
        <term><option>--plugin-helper-dir
 
327
        <replaceable>DIRECTORY</replaceable></option></term>
 
328
        <listitem>
 
329
          <para>
 
330
            Specify a different plugin helper directory.  The default
 
331
            is <filename>/lib/mandos/plugin-helpers</filename>, which
 
332
            will exist in the initial <acronym>RAM</acronym> disk
 
333
            environment.  (This will simply be passed to all plugins
 
334
            via the <envar>MANDOSPLUGINHELPERDIR</envar> environment
 
335
            variable.  See <xref linkend="writing_plugins"/>)
 
336
          </para>
 
337
        </listitem>
 
338
      </varlistentry>
 
339
      
 
340
      <varlistentry>
320
341
        <term><option>--config-file
321
342
        <replaceable>FILE</replaceable></option></term>
322
343
        <listitem>
365
386
          </para>
366
387
        </listitem>
367
388
      </varlistentry>
368
 
 
 
389
      
369
390
      <varlistentry>
370
391
        <term><option>--version</option></term>
371
392
        <term><option>-V</option></term>
377
398
      </varlistentry>
378
399
    </variablelist>
379
400
  </refsect1>
380
 
 
 
401
  
381
402
  <refsect1 id="overview">
382
403
    <title>OVERVIEW</title>
383
404
    <xi:include href="overview.xml"/>
403
424
      code will make this plugin-runner output the password from that
404
425
      plugin, stop any other plugins, and exit.
405
426
    </para>
406
 
 
 
427
    
407
428
    <refsect2 id="writing_plugins">
408
429
      <title>WRITING PLUGINS</title>
409
430
      <para>
416
437
        console.
417
438
      </para>
418
439
      <para>
 
440
        If the password is a single-line, manually entered passprase,
 
441
        a final trailing newline character should
 
442
        <emphasis>not</emphasis> be printed.
 
443
      </para>
 
444
      <para>
419
445
        The plugin will run in the initial RAM disk environment, so
420
446
        care must be taken not to depend on any files or running
421
 
        services not available there.
 
447
        services not available there.  Any helper executables required
 
448
        by the plugin (which are not in the <envar>PATH</envar>) can
 
449
        be placed in the plugin helper directory, the name of which
 
450
        will be made available to the plugin via the
 
451
        <envar>MANDOSPLUGINHELPERDIR</envar> environment variable.
422
452
      </para>
423
453
      <para>
424
454
        The plugin must exit cleanly and free all allocated resources
428
458
      </para>
429
459
      <para>
430
460
        The plugin must not use resources, like for instance reading
431
 
        from the standard input, without knowing that no other plugins
432
 
        are also using it.
 
461
        from the standard input, without knowing that no other plugin
 
462
        is also using it.
433
463
      </para>
434
464
      <para>
435
465
        It is useful, but not required, for the plugin to take the
467
497
      only passes on its environment to all the plugins.  The
468
498
      environment passed to plugins can be modified using the
469
499
      <option>--global-env</option> and <option>--env-for</option>
470
 
      optins.
 
500
      options.  Also, the <option>--plugin-helper-dir</option> option
 
501
      will affect the environment variable
 
502
      <envar>MANDOSPLUGINHELPERDIR</envar> for the plugins.
471
503
    </para>
472
504
  </refsect1>
473
505
  
510
542
    </para>
511
543
  </refsect1>
512
544
  
513
 
<!--   <refsect1 id="bugs"> -->
514
 
<!--     <title>BUGS</title> -->
515
 
<!--     <para> -->
516
 
<!--     </para> -->
517
 
<!--   </refsect1> -->
 
545
  <refsect1 id="bugs">
 
546
    <title>BUGS</title>
 
547
    <para>
 
548
      The <option>--config-file</option> option is ignored when
 
549
      specified from within a configuration file.
 
550
    </para>
 
551
  </refsect1>
518
552
  
519
553
  <refsect1 id="examples">
520
554
    <title>EXAMPLE</title>
562
596
    </informalexample>
563
597
    <informalexample>
564
598
      <para>
565
 
        Run plugins from a different directory and add a special
566
 
        option to the <citerefentry><refentrytitle
567
 
        >password-request</refentrytitle>
 
599
        Read a different configuration file, run plugins from a
 
600
        different directory, specify an alternate plugin helper
 
601
        directory and add two options to the
 
602
        <citerefentry><refentrytitle >mandos-client</refentrytitle>
568
603
        <manvolnum>8mandos</manvolnum></citerefentry> plugin:
569
604
      </para>
570
605
      <para>
571
606
 
572
607
<!-- do not wrap this line -->
573
 
<userinput>&COMMANDNAME;  --plugin-dir=plugins.d --options-for=password-request:--keydir=keydir</userinput>
 
608
<userinput>cd /etc/keys/mandos; &COMMANDNAME;  --config-file=/etc/mandos/plugin-runner.conf --plugin-dir /usr/lib/x86_64-linux-gnu/mandos/plugins.d --plugin-helper-dir /usr/lib/x86_64-linux-gnu/mandos/plugin-helpers --options-for=mandos-client:--pubkey=pubkey.txt,--seckey=seckey.txt</userinput>
574
609
 
575
610
      </para>
576
611
    </informalexample>
584
619
      non-privileged.  This user and group is then what all plugins
585
620
      will be started as.  Therefore, the only way to run a plugin as
586
621
      a privileged user is to have the set-user-ID or set-group-ID bit
587
 
      set on the plugin executable files (see <citerefentry>
 
622
      set on the plugin executable file (see <citerefentry>
588
623
      <refentrytitle>execve</refentrytitle><manvolnum>2</manvolnum>
589
624
      </citerefentry>).
590
625
    </para>
591
626
    <para>
592
627
      If this program is used as a keyscript in <citerefentry
593
628
      ><refentrytitle>crypttab</refentrytitle><manvolnum>5</manvolnum>
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
 
629
      </citerefentry>, there is a slight risk that if this program
 
630
      fails to work, there might be no way to boot the system except
 
631
      for booting from another media and editing the initial RAM disk
597
632
      image to not run this program.  This is, however, unlikely,
598
633
      since the <citerefentry><refentrytitle
599
634
      >password-prompt</refentrytitle><manvolnum>8mandos</manvolnum>
608
643
  <refsect1 id="see_also">
609
644
    <title>SEE ALSO</title>
610
645
    <para>
 
646
      <citerefentry><refentrytitle>intro</refentrytitle>
 
647
      <manvolnum>8mandos</manvolnum></citerefentry>,
611
648
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
612
649
      <manvolnum>8</manvolnum></citerefentry>,
613
650
      <citerefentry><refentrytitle>crypttab</refentrytitle>
618
655
      <manvolnum>8</manvolnum></citerefentry>,
619
656
      <citerefentry><refentrytitle>password-prompt</refentrytitle>
620
657
      <manvolnum>8mandos</manvolnum></citerefentry>,
621
 
      <citerefentry><refentrytitle>password-request</refentrytitle>
 
658
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
622
659
      <manvolnum>8mandos</manvolnum></citerefentry>
623
660
    </para>
624
661
  </refsect1>