/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-09 20:32:52 UTC
  • Revision ID: teddy@recompile.se-20150709203252-u10p7trfsxc1a9yp
Install client Diffie-Hellman parameters into initramfs.

* debian/control (Package: mandos-client/Recommends): Added
  "gnutls-bin | openssl" (to generate DH parameters).
* debian/mandos-client.postinst (create_dh_params): New function
                                                    called on package
                                                    configure.
* plugins.d/mandos-client.c (main): Bug fix: Work around Debian bug
                                    #633582 also for the
                                    "client-dhparams.pem" file.

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-05">
 
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>
48
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/>
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>
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
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
 
      options.
 
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
  
564
596
    </informalexample>
565
597
    <informalexample>
566
598
      <para>
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>
 
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>
570
603
        <manvolnum>8mandos</manvolnum></citerefentry> plugin:
571
604
      </para>
572
605
      <para>
573
606
 
574
607
<!-- do not wrap this line -->
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>
 
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>
576
609
 
577
610
      </para>
578
611
    </informalexample>
586
619
      non-privileged.  This user and group is then what all plugins
587
620
      will be started as.  Therefore, the only way to run a plugin as
588
621
      a privileged user is to have the set-user-ID or set-group-ID bit
589
 
      set on the plugin executable files (see <citerefentry>
 
622
      set on the plugin executable file (see <citerefentry>
590
623
      <refentrytitle>execve</refentrytitle><manvolnum>2</manvolnum>
591
624
      </citerefentry>).
592
625
    </para>
610
643
  <refsect1 id="see_also">
611
644
    <title>SEE ALSO</title>
612
645
    <para>
 
646
      <citerefentry><refentrytitle>intro</refentrytitle>
 
647
      <manvolnum>8mandos</manvolnum></citerefentry>,
613
648
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
614
649
      <manvolnum>8</manvolnum></citerefentry>,
615
650
      <citerefentry><refentrytitle>crypttab</refentrytitle>
620
655
      <manvolnum>8</manvolnum></citerefentry>,
621
656
      <citerefentry><refentrytitle>password-prompt</refentrytitle>
622
657
      <manvolnum>8mandos</manvolnum></citerefentry>,
623
 
      <citerefentry><refentrytitle>password-request</refentrytitle>
 
658
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
624
659
      <manvolnum>8mandos</manvolnum></citerefentry>
625
660
    </para>
626
661
  </refsect1>