/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-09-05 07:15:46 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080905071546-ax00hzgq40xzprn0
* Makefile (purge-client): Also remove "plugin-runner.conf".

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 "2019-07-26">
6
 
<!ENTITY % common SYSTEM "common.ent">
7
 
%common;
 
6
<!ENTITY TIMESTAMP "2008-09-04">
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>2010</year>
37
 
      <year>2011</year>
38
 
      <year>2012</year>
39
 
      <year>2013</year>
40
 
      <year>2014</year>
41
 
      <year>2015</year>
42
 
      <year>2016</year>
43
 
      <year>2017</year>
44
 
      <year>2018</year>
45
 
      <year>2019</year>
46
34
      <holder>Teddy Hogeborn</holder>
47
35
      <holder>Björn Påhlsson</holder>
48
36
    </copyright>
49
37
    <xi:include href="legalnotice.xml"/>
50
38
  </refentryinfo>
51
 
  
 
39
 
52
40
  <refmeta>
53
41
    <refentrytitle>&COMMANDNAME;</refentrytitle>
54
42
    <manvolnum>8mandos</manvolnum>
60
48
      Run Mandos plugins, pass data from first to succeed.
61
49
    </refpurpose>
62
50
  </refnamediv>
63
 
  
 
51
 
64
52
  <refsynopsisdiv>
65
53
    <cmdsynopsis>
66
54
      <command>&COMMANDNAME;</command>
67
55
      <group rep="repeat">
68
56
        <arg choice="plain"><option>--global-env=<replaceable
69
 
        >ENV</replaceable><literal>=</literal><replaceable
 
57
        >VAR</replaceable><literal>=</literal><replaceable
70
58
        >value</replaceable></option></arg>
71
59
        <arg choice="plain"><option>-G
72
 
        <replaceable>ENV</replaceable><literal>=</literal><replaceable
 
60
        <replaceable>VAR</replaceable><literal>=</literal><replaceable
73
61
        >value</replaceable> </option></arg>
74
62
      </group>
75
63
      <sbr/>
123
111
      <arg><option>--plugin-dir=<replaceable
124
112
      >DIRECTORY</replaceable></option></arg>
125
113
      <sbr/>
126
 
      <arg><option>--plugin-helper-dir=<replaceable
127
 
      >DIRECTORY</replaceable></option></arg>
128
 
      <sbr/>
129
114
      <arg><option>--config-file=<replaceable
130
115
      >FILE</replaceable></option></arg>
131
116
      <sbr/>
185
170
    <variablelist>
186
171
      <varlistentry>
187
172
        <term><option>--global-env
188
 
        <replaceable>ENV</replaceable><literal>=</literal><replaceable
 
173
        <replaceable>VAR</replaceable><literal>=</literal><replaceable
189
174
        >value</replaceable></option></term>
190
175
        <term><option>-G
191
 
        <replaceable>ENV</replaceable><literal>=</literal><replaceable
 
176
        <replaceable>VAR</replaceable><literal>=</literal><replaceable
192
177
        >value</replaceable></option></term>
193
178
        <listitem>
194
179
          <para>
262
247
          </para>
263
248
        </listitem>
264
249
      </varlistentry>
265
 
      
 
250
 
266
251
      <varlistentry>
267
252
        <term><option>--disable
268
253
        <replaceable>PLUGIN</replaceable></option></term>
273
258
            Disable the plugin named
274
259
            <replaceable>PLUGIN</replaceable>.  The plugin will not be
275
260
            started.
276
 
          </para>
 
261
          </para>       
277
262
        </listitem>
278
263
      </varlistentry>
279
 
      
 
264
 
280
265
      <varlistentry>
281
266
        <term><option>--enable
282
267
        <replaceable>PLUGIN</replaceable></option></term>
291
276
          </para>
292
277
        </listitem>
293
278
      </varlistentry>
294
 
      
 
279
 
295
280
      <varlistentry>
296
281
        <term><option>--groupid
297
282
        <replaceable>ID</replaceable></option></term>
304
289
          </para>
305
290
        </listitem>
306
291
      </varlistentry>
307
 
      
 
292
 
308
293
      <varlistentry>
309
294
        <term><option>--userid
310
295
        <replaceable>ID</replaceable></option></term>
317
302
          </para>
318
303
        </listitem>
319
304
      </varlistentry>
320
 
      
 
305
 
321
306
      <varlistentry>
322
307
        <term><option>--plugin-dir
323
308
        <replaceable>DIRECTORY</replaceable></option></term>
332
317
      </varlistentry>
333
318
      
334
319
      <varlistentry>
335
 
        <term><option>--plugin-helper-dir
336
 
        <replaceable>DIRECTORY</replaceable></option></term>
337
 
        <listitem>
338
 
          <para>
339
 
            Specify a different plugin helper directory.  The default
340
 
            is <filename>/lib/mandos/plugin-helpers</filename>, which
341
 
            will exist in the initial <acronym>RAM</acronym> disk
342
 
            environment.  (This will simply be passed to all plugins
343
 
            via the <envar>MANDOSPLUGINHELPERDIR</envar> environment
344
 
            variable.  See <xref linkend="writing_plugins"/>)
345
 
          </para>
346
 
        </listitem>
347
 
      </varlistentry>
348
 
      
349
 
      <varlistentry>
350
320
        <term><option>--config-file
351
321
        <replaceable>FILE</replaceable></option></term>
352
322
        <listitem>
395
365
          </para>
396
366
        </listitem>
397
367
      </varlistentry>
398
 
      
 
368
 
399
369
      <varlistentry>
400
370
        <term><option>--version</option></term>
401
371
        <term><option>-V</option></term>
407
377
      </varlistentry>
408
378
    </variablelist>
409
379
  </refsect1>
410
 
  
 
380
 
411
381
  <refsect1 id="overview">
412
382
    <title>OVERVIEW</title>
413
383
    <xi:include href="overview.xml"/>
433
403
      code will make this plugin-runner output the password from that
434
404
      plugin, stop any other plugins, and exit.
435
405
    </para>
436
 
    
 
406
 
437
407
    <refsect2 id="writing_plugins">
438
408
      <title>WRITING PLUGINS</title>
439
409
      <para>
446
416
        console.
447
417
      </para>
448
418
      <para>
449
 
        If the password is a single-line, manually entered passprase,
450
 
        a final trailing newline character should
451
 
        <emphasis>not</emphasis> be printed.
452
 
      </para>
453
 
      <para>
454
419
        The plugin will run in the initial RAM disk environment, so
455
420
        care must be taken not to depend on any files or running
456
 
        services not available there.  Any helper executables required
457
 
        by the plugin (which are not in the <envar>PATH</envar>) can
458
 
        be placed in the plugin helper directory, the name of which
459
 
        will be made available to the plugin via the
460
 
        <envar>MANDOSPLUGINHELPERDIR</envar> environment variable.
 
421
        services not available there.
461
422
      </para>
462
423
      <para>
463
424
        The plugin must exit cleanly and free all allocated resources
506
467
      only passes on its environment to all the plugins.  The
507
468
      environment passed to plugins can be modified using the
508
469
      <option>--global-env</option> and <option>--env-for</option>
509
 
      options.  Also, the <option>--plugin-helper-dir</option> option
510
 
      will affect the environment variable
511
 
      <envar>MANDOSPLUGINHELPERDIR</envar> for the plugins.
 
470
      options.
512
471
    </para>
513
472
  </refsect1>
514
473
  
547
506
            </para>
548
507
          </listitem>
549
508
        </varlistentry>
550
 
        <varlistentry>
551
 
          <term><filename class="directory"
552
 
          >/lib/mandos/plugins.d</filename></term>
553
 
          <listitem>
554
 
            <para>
555
 
              The default plugin directory; can be changed by the
556
 
              <option>--plugin-dir</option> option.
557
 
            </para>
558
 
          </listitem>
559
 
        </varlistentry>
560
 
        <varlistentry>
561
 
          <term><filename class="directory"
562
 
          >/lib/mandos/plugin-helpers</filename></term>
563
 
          <listitem>
564
 
            <para>
565
 
              The default plugin helper directory; can be changed by
566
 
              the <option>--plugin-helper-dir</option> option.
567
 
            </para>
568
 
          </listitem>
569
 
        </varlistentry>
570
509
      </variablelist>
571
510
    </para>
572
511
  </refsect1>
577
516
      The <option>--config-file</option> option is ignored when
578
517
      specified from within a configuration file.
579
518
    </para>
580
 
    <xi:include href="bugs.xml"/>
581
519
  </refsect1>
582
520
  
583
521
  <refsect1 id="examples">
626
564
    </informalexample>
627
565
    <informalexample>
628
566
      <para>
629
 
        Read a different configuration file, run plugins from a
630
 
        different directory, specify an alternate plugin helper
631
 
        directory and add four options to the
632
 
        <citerefentry><refentrytitle >mandos-client</refentrytitle>
 
567
        Run plugins from a different directory and add two
 
568
        options to the <citerefentry><refentrytitle
 
569
        >password-request</refentrytitle>
633
570
        <manvolnum>8mandos</manvolnum></citerefentry> plugin:
634
571
      </para>
635
572
      <para>
636
573
 
637
574
<!-- do not wrap this line -->
638
 
<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,&#x200b;--seckey=seckey.txt,&#x200b;--tls-pubkey=tls-pubkey.pem,&#x200b;--tls-privkey=tls-privkey.pem</userinput>
 
575
<userinput>&COMMANDNAME;  --plugin-dir=plugins.d --options-for=password-request:--pubkey=keydir/pubkey.txt,--seckey=keydir/seckey.txt</userinput>
639
576
 
640
577
      </para>
641
578
    </informalexample>
649
586
      non-privileged.  This user and group is then what all plugins
650
587
      will be started as.  Therefore, the only way to run a plugin as
651
588
      a privileged user is to have the set-user-ID or set-group-ID bit
652
 
      set on the plugin executable file (see <citerefentry>
 
589
      set on the plugin executable files (see <citerefentry>
653
590
      <refentrytitle>execve</refentrytitle><manvolnum>2</manvolnum>
654
591
      </citerefentry>).
655
592
    </para>
673
610
  <refsect1 id="see_also">
674
611
    <title>SEE ALSO</title>
675
612
    <para>
676
 
      <citerefentry><refentrytitle>intro</refentrytitle>
677
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
678
613
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
679
614
      <manvolnum>8</manvolnum></citerefentry>,
680
615
      <citerefentry><refentrytitle>crypttab</refentrytitle>
685
620
      <manvolnum>8</manvolnum></citerefentry>,
686
621
      <citerefentry><refentrytitle>password-prompt</refentrytitle>
687
622
      <manvolnum>8mandos</manvolnum></citerefentry>,
688
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
623
      <citerefentry><refentrytitle>password-request</refentrytitle>
689
624
      <manvolnum>8mandos</manvolnum></citerefentry>
690
625
    </para>
691
626
  </refsect1>