/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 16:24:33 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080905162433-58fgx91ae9foxlh1
* Makefile (PIDDIR, USER, GROUP): Removed.
  (install-server): Do not create $(PIDDIR).
  (uninstall-server): Do not remove $(PIDDIR).

* init.d-mandos (PIDFILE): Changed to "/var/run/$NAME.pid".

* mandos (IPv6_TCPServer.enabled): New attribute.
  (IPv6_TCPServer.server_activate): Only call method of superclass if
                                    "self.enabled".
  (IPv6_TCPServer.enable): Set "self.enabled" to True.
  (main): Create client Set() early.  Create IPv6_TCPServer object
          early.  Switch to user and group "mandos", "nobody" or
          65534, if possible.  Enable IPv6_TCPServer *after* switching
          user.

* mandos-keygen (KEYDIR): Changed to "/etc/keys/mandos".

* mandos.xml (FILES): Changed PID file.
  (SECURITY): The server does need to be privileged, but switches to a
              non-privileged user.

* plugin-runner.xml (EXAMPLE): Changed long example to something more
                               realistic.

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