/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to plugin-runner.xml

  • Committer: Teddy Hogeborn
  • Date: 2019-06-20 18:54:10 UTC
  • mto: This revision was merged to the branch mainline in revision 384.
  • Revision ID: teddy@recompile.se-20190620185410-pwi5fyzzz0bd9s2x
Doc fix: Use new style interface names instead of "eth0"

* debian/mandos-client.README.Debian: Also use "enp1s0" as an example
                                      interface name.
* mandos.conf.xml (EXAMPLE): Change "interface" to "enp1s0", and
                             update priority string to new default.

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