/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: 2016-03-23 07:11:22 UTC
  • Revision ID: teddy@recompile.se-20160323071122-55srtjdizr21rr7f
Use HTTPS in home page links

Since we have a real certificate now, change all links to the home
page to use HTTPS.

* README: Use HTTPS in home page links
* debian/control (Source: mandos/Homepage): - '' -
* debian/copyright (Source): - '' -
* intro.xml (SEE ALSO): - '' -
* mandos.lsm (Primary-site): - '' -

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-01">
 
5
<!ENTITY TIMESTAMP "2016-03-17">
 
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>
34
43
      <holder>Teddy Hogeborn</holder>
35
44
      <holder>Björn Påhlsson</holder>
36
45
    </copyright>
37
46
    <xi:include href="legalnotice.xml"/>
38
47
  </refentryinfo>
39
 
 
 
48
  
40
49
  <refmeta>
41
50
    <refentrytitle>&COMMANDNAME;</refentrytitle>
42
51
    <manvolnum>8mandos</manvolnum>
45
54
  <refnamediv>
46
55
    <refname><command>&COMMANDNAME;</command></refname>
47
56
    <refpurpose>
48
 
      Run Mandos plugins.  Pass data from first succesful one.
 
57
      Run Mandos plugins, pass data from first to succeed.
49
58
    </refpurpose>
50
59
  </refnamediv>
51
 
 
 
60
  
52
61
  <refsynopsisdiv>
53
62
    <cmdsynopsis>
54
63
      <command>&COMMANDNAME;</command>
55
64
      <group rep="repeat">
56
65
        <arg choice="plain"><option>--global-env=<replaceable
57
 
        >VAR</replaceable><literal>=</literal><replaceable
 
66
        >ENV</replaceable><literal>=</literal><replaceable
58
67
        >value</replaceable></option></arg>
59
 
        <arg choice="plain"><option>-e
60
 
        <replaceable>VAR</replaceable><literal>=</literal><replaceable
 
68
        <arg choice="plain"><option>-G
 
69
        <replaceable>ENV</replaceable><literal>=</literal><replaceable
61
70
        >value</replaceable> </option></arg>
62
71
      </group>
63
72
      <sbr/>
66
75
        >PLUGIN</replaceable><literal>:</literal><replaceable
67
76
        >ENV</replaceable><literal>=</literal><replaceable
68
77
        >value</replaceable></option></arg>
69
 
        <arg choice="plain"><option>-f<replaceable>
 
78
        <arg choice="plain"><option>-E<replaceable>
70
79
        PLUGIN</replaceable><literal>:</literal><replaceable
71
80
        >ENV</replaceable><literal>=</literal><replaceable
72
81
        >value</replaceable> </option></arg>
83
92
        <arg choice="plain"><option>--options-for=<replaceable
84
93
        >PLUGIN</replaceable><literal>:</literal><replaceable
85
94
        >OPTIONS</replaceable></option></arg>
86
 
        <arg choice="plain"><option>-f<replaceable>
 
95
        <arg choice="plain"><option>-o<replaceable>
87
96
        PLUGIN</replaceable><literal>:</literal><replaceable
88
97
        >OPTIONS</replaceable> </option></arg>
89
98
      </group>
95
104
        <replaceable>PLUGIN</replaceable> </option></arg>
96
105
      </group>
97
106
      <sbr/>
 
107
      <group rep="repeat">
 
108
        <arg choice="plain"><option>--enable=<replaceable
 
109
        >PLUGIN</replaceable></option></arg>
 
110
        <arg choice="plain"><option>-e
 
111
        <replaceable>PLUGIN</replaceable> </option></arg>
 
112
      </group>
 
113
      <sbr/>
98
114
      <arg><option>--groupid=<replaceable
99
115
      >ID</replaceable></option></arg>
100
116
      <sbr/>
104
120
      <arg><option>--plugin-dir=<replaceable
105
121
      >DIRECTORY</replaceable></option></arg>
106
122
      <sbr/>
 
123
      <arg><option>--plugin-helper-dir=<replaceable
 
124
      >DIRECTORY</replaceable></option></arg>
 
125
      <sbr/>
 
126
      <arg><option>--config-file=<replaceable
 
127
      >FILE</replaceable></option></arg>
 
128
      <sbr/>
107
129
      <arg><option>--debug</option></arg>
108
130
    </cmdsynopsis>
109
131
    <cmdsynopsis>
130
152
    <title>DESCRIPTION</title>
131
153
    <para>
132
154
      <command>&COMMANDNAME;</command> is a program which is meant to
133
 
      be specified as <quote>keyscript</quote> in <citerefentry>
134
 
      <refentrytitle>crypttab</refentrytitle>
135
 
      <manvolnum>5</manvolnum></citerefentry> for the root disk.  The
136
 
      aim of this program is therefore to output a password, which
137
 
      then <citerefentry><refentrytitle>cryptsetup</refentrytitle>
138
 
      <manvolnum>8</manvolnum></citerefentry> will use to try and
139
 
      unlock the root disk.
 
155
      be specified as a <quote>keyscript</quote> for the root disk in
 
156
      <citerefentry><refentrytitle>crypttab</refentrytitle>
 
157
      <manvolnum>5</manvolnum></citerefentry>.  The aim of this
 
158
      program is therefore to output a password, which then
 
159
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
 
160
      <manvolnum>8</manvolnum></citerefentry> will use to unlock the
 
161
      root disk.
140
162
    </para>
141
163
    <para>
142
164
      This program is not meant to be invoked directly, but can be in
160
182
    <variablelist>
161
183
      <varlistentry>
162
184
        <term><option>--global-env
163
 
        <replaceable>VAR</replaceable><literal>=</literal><replaceable
 
185
        <replaceable>ENV</replaceable><literal>=</literal><replaceable
164
186
        >value</replaceable></option></term>
165
 
        <term><option>-e
166
 
        <replaceable>VAR</replaceable><literal>=</literal><replaceable
 
187
        <term><option>-G
 
188
        <replaceable>ENV</replaceable><literal>=</literal><replaceable
167
189
        >value</replaceable></option></term>
168
190
        <listitem>
169
191
          <para>
179
201
        <replaceable>PLUGIN</replaceable><literal>:</literal
180
202
        ><replaceable>ENV</replaceable><literal>=</literal
181
203
        ><replaceable>value</replaceable></option></term>
182
 
        <term><option>-f
 
204
        <term><option>-E
183
205
        <replaceable>PLUGIN</replaceable><literal>:</literal
184
206
        ><replaceable>ENV</replaceable><literal>=</literal
185
207
        ><replaceable>value</replaceable></option></term>
205
227
            <replaceable>OPTIONS</replaceable> is a comma separated
206
228
            list of options.  This is not a very useful option, except
207
229
            for specifying the <quote><option>--debug</option></quote>
208
 
            for all plugins.
 
230
            option to all plugins.
209
231
          </para>
210
232
        </listitem>
211
233
      </varlistentry>
231
253
            <option>--bar</option> with the option argument
232
254
            <quote>baz</quote> is either
233
255
            <userinput>--options-for=foo:--bar=baz</userinput> or
234
 
            <userinput>--options-for=foo:--bar,baz</userinput>, but
235
 
            <emphasis>not</emphasis>
236
 
            <userinput>--options-for="foo:--bar baz"</userinput>.
 
256
            <userinput>--options-for=foo:--bar,baz</userinput>.  Using
 
257
            <userinput>--options-for="foo:--bar baz"</userinput>. will
 
258
            <emphasis>not</emphasis> work.
237
259
          </para>
238
260
        </listitem>
239
261
      </varlistentry>
240
 
 
 
262
      
241
263
      <varlistentry>
242
 
        <term><option> --disable
 
264
        <term><option>--disable
243
265
        <replaceable>PLUGIN</replaceable></option></term>
244
266
        <term><option>-d
245
267
        <replaceable>PLUGIN</replaceable></option></term>
248
270
            Disable the plugin named
249
271
            <replaceable>PLUGIN</replaceable>.  The plugin will not be
250
272
            started.
251
 
          </para>       
252
 
        </listitem>
253
 
      </varlistentry>
254
 
 
 
273
          </para>
 
274
        </listitem>
 
275
      </varlistentry>
 
276
      
 
277
      <varlistentry>
 
278
        <term><option>--enable
 
279
        <replaceable>PLUGIN</replaceable></option></term>
 
280
        <term><option>-e
 
281
        <replaceable>PLUGIN</replaceable></option></term>
 
282
        <listitem>
 
283
          <para>
 
284
            Re-enable the plugin named
 
285
            <replaceable>PLUGIN</replaceable>.  This is only useful to
 
286
            undo a previous <option>--disable</option> option, maybe
 
287
            from the configuration file.
 
288
          </para>
 
289
        </listitem>
 
290
      </varlistentry>
 
291
      
255
292
      <varlistentry>
256
293
        <term><option>--groupid
257
294
        <replaceable>ID</replaceable></option></term>
264
301
          </para>
265
302
        </listitem>
266
303
      </varlistentry>
267
 
 
 
304
      
268
305
      <varlistentry>
269
306
        <term><option>--userid
270
307
        <replaceable>ID</replaceable></option></term>
277
314
          </para>
278
315
        </listitem>
279
316
      </varlistentry>
280
 
 
 
317
      
281
318
      <varlistentry>
282
319
        <term><option>--plugin-dir
283
320
        <replaceable>DIRECTORY</replaceable></option></term>
292
329
      </varlistentry>
293
330
      
294
331
      <varlistentry>
 
332
        <term><option>--plugin-helper-dir
 
333
        <replaceable>DIRECTORY</replaceable></option></term>
 
334
        <listitem>
 
335
          <para>
 
336
            Specify a different plugin helper directory.  The default
 
337
            is <filename>/lib/mandos/plugin-helpers</filename>, which
 
338
            will exist in the initial <acronym>RAM</acronym> disk
 
339
            environment.  (This will simply be passed to all plugins
 
340
            via the <envar>MANDOSPLUGINHELPERDIR</envar> environment
 
341
            variable.  See <xref linkend="writing_plugins"/>)
 
342
          </para>
 
343
        </listitem>
 
344
      </varlistentry>
 
345
      
 
346
      <varlistentry>
 
347
        <term><option>--config-file
 
348
        <replaceable>FILE</replaceable></option></term>
 
349
        <listitem>
 
350
          <para>
 
351
            Specify a different file to read additional options from.
 
352
            See <xref linkend="files"/>.  Other command line options
 
353
            will override options specified in the file.
 
354
          </para>
 
355
        </listitem>
 
356
      </varlistentry>
 
357
      
 
358
      <varlistentry>
295
359
        <term><option>--debug</option></term>
296
360
        <listitem>
297
361
          <para>
328
392
          </para>
329
393
        </listitem>
330
394
      </varlistentry>
331
 
 
 
395
      
332
396
      <varlistentry>
333
397
        <term><option>--version</option></term>
334
398
        <term><option>-V</option></term>
340
404
      </varlistentry>
341
405
    </variablelist>
342
406
  </refsect1>
343
 
 
 
407
  
344
408
  <refsect1 id="overview">
345
409
    <title>OVERVIEW</title>
346
410
    <xi:include href="overview.xml"/>
366
430
      code will make this plugin-runner output the password from that
367
431
      plugin, stop any other plugins, and exit.
368
432
    </para>
 
433
    
 
434
    <refsect2 id="writing_plugins">
 
435
      <title>WRITING PLUGINS</title>
 
436
      <para>
 
437
        A plugin is simply a program which prints a password to its
 
438
        standard output and then exits with a successful (zero) exit
 
439
        status.  If the exit status is not zero, any output on
 
440
        standard output will be ignored by the plugin runner.  Any
 
441
        output on its standard error channel will simply be passed to
 
442
        the standard error of the plugin runner, usually the system
 
443
        console.
 
444
      </para>
 
445
      <para>
 
446
        If the password is a single-line, manually entered passprase,
 
447
        a final trailing newline character should
 
448
        <emphasis>not</emphasis> be printed.
 
449
      </para>
 
450
      <para>
 
451
        The plugin will run in the initial RAM disk environment, so
 
452
        care must be taken not to depend on any files or running
 
453
        services not available there.  Any helper executables required
 
454
        by the plugin (which are not in the <envar>PATH</envar>) can
 
455
        be placed in the plugin helper directory, the name of which
 
456
        will be made available to the plugin via the
 
457
        <envar>MANDOSPLUGINHELPERDIR</envar> environment variable.
 
458
      </para>
 
459
      <para>
 
460
        The plugin must exit cleanly and free all allocated resources
 
461
        upon getting the TERM signal, since this is what the plugin
 
462
        runner uses to stop all other plugins when one plugin has
 
463
        output a password and exited cleanly.
 
464
      </para>
 
465
      <para>
 
466
        The plugin must not use resources, like for instance reading
 
467
        from the standard input, without knowing that no other plugin
 
468
        is also using it.
 
469
      </para>
 
470
      <para>
 
471
        It is useful, but not required, for the plugin to take the
 
472
        <option>--debug</option> option.
 
473
      </para>
 
474
    </refsect2>
369
475
  </refsect1>
370
476
  
371
477
  <refsect1 id="fallback">
393
499
  <refsect1 id="environment">
394
500
    <title>ENVIRONMENT</title>
395
501
    <para>
396
 
      
 
502
      This program does not use any environment variables itself, it
 
503
      only passes on its environment to all the plugins.  The
 
504
      environment passed to plugins can be modified using the
 
505
      <option>--global-env</option> and <option>--env-for</option>
 
506
      options.  Also, the <option>--plugin-helper-dir</option> option
 
507
      will affect the environment variable
 
508
      <envar>MANDOSPLUGINHELPERDIR</envar> for the plugins.
397
509
    </para>
398
510
  </refsect1>
399
511
  
400
 
  <refsect1 id="file">
 
512
  <refsect1 id="files">
401
513
    <title>FILES</title>
402
514
    <para>
403
515
      <variablelist>
415
527
              of a line is ignored.
416
528
            </para>
417
529
            <para>
 
530
              This program is meant to run in the initial RAM disk
 
531
              environment, so that is where this file is assumed to
 
532
              exist.  The file does not need to exist in the normal
 
533
              file system.
 
534
            </para>
 
535
            <para>
418
536
              This file will be processed <emphasis>before</emphasis>
419
537
              the normal command line options, so the latter can
420
538
              override the former, if need be.
421
539
            </para>
 
540
            <para>
 
541
              This file name is the default; the file to read for
 
542
              arguments can be changed using the
 
543
              <option>--config-file</option> option.
 
544
            </para>
 
545
          </listitem>
 
546
        </varlistentry>
 
547
        <varlistentry>
 
548
          <term><filename class="directory"
 
549
          >/lib/mandos/plugins.d</filename></term>
 
550
          <listitem>
 
551
            <para>
 
552
              The default plugin directory; can be changed by the
 
553
              <option>--plugin-dir</option> option.
 
554
            </para>
 
555
          </listitem>
 
556
        </varlistentry>
 
557
        <varlistentry>
 
558
          <term><filename class="directory"
 
559
          >/lib/mandos/plugin-helpers</filename></term>
 
560
          <listitem>
 
561
            <para>
 
562
              The default plugin helper directory; can be changed by
 
563
              the <option>--plugin-helper-dir</option> option.
 
564
            </para>
422
565
          </listitem>
423
566
        </varlistentry>
424
567
      </variablelist>
428
571
  <refsect1 id="bugs">
429
572
    <title>BUGS</title>
430
573
    <para>
431
 
      There is no <option>--enable</option> option to enable disabled
432
 
      plugins.
 
574
      The <option>--config-file</option> option is ignored when
 
575
      specified from within a configuration file.
433
576
    </para>
 
577
    <xi:include href="bugs.xml"/>
434
578
  </refsect1>
435
579
  
436
580
  <refsect1 id="examples">
437
581
    <title>EXAMPLE</title>
438
 
    <para>
439
 
    </para>
 
582
    <informalexample>
 
583
      <para>
 
584
        Normal invocation needs no options:
 
585
      </para>
 
586
      <para>
 
587
        <userinput>&COMMANDNAME;</userinput>
 
588
      </para>
 
589
    </informalexample>
 
590
    <informalexample>
 
591
      <para>
 
592
        Run the program, but not the plugins, in debug mode:
 
593
      </para>
 
594
      <para>
 
595
        
 
596
        <!-- do not wrap this line -->
 
597
        <userinput>&COMMANDNAME; --debug</userinput>
 
598
        
 
599
      </para>
 
600
    </informalexample>
 
601
    <informalexample>
 
602
      <para>
 
603
        Run all plugins, but run the <quote>foo</quote> plugin in
 
604
        debug mode:
 
605
      </para>
 
606
      <para>
 
607
        
 
608
        <!-- do not wrap this line -->
 
609
        <userinput>&COMMANDNAME; --options-for=foo:--debug</userinput>
 
610
        
 
611
      </para>
 
612
    </informalexample>
 
613
    <informalexample>
 
614
      <para>
 
615
        Run all plugins, but not the program, in debug mode:
 
616
      </para>
 
617
      <para>
 
618
        
 
619
        <!-- do not wrap this line -->
 
620
        <userinput>&COMMANDNAME; --global-options=--debug</userinput>
 
621
        
 
622
      </para>
 
623
    </informalexample>
 
624
    <informalexample>
 
625
      <para>
 
626
        Read a different configuration file, run plugins from a
 
627
        different directory, specify an alternate plugin helper
 
628
        directory and add two options to the
 
629
        <citerefentry><refentrytitle >mandos-client</refentrytitle>
 
630
        <manvolnum>8mandos</manvolnum></citerefentry> plugin:
 
631
      </para>
 
632
      <para>
 
633
 
 
634
<!-- do not wrap this line -->
 
635
<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>
 
636
 
 
637
      </para>
 
638
    </informalexample>
440
639
  </refsect1>
441
 
  
442
640
  <refsect1 id="security">
443
641
    <title>SECURITY</title>
444
642
    <para>
 
643
      This program will, when starting, try to switch to another user.
 
644
      If it is started as root, it will succeed, and will by default
 
645
      switch to user and group 65534, which are assumed to be
 
646
      non-privileged.  This user and group is then what all plugins
 
647
      will be started as.  Therefore, the only way to run a plugin as
 
648
      a privileged user is to have the set-user-ID or set-group-ID bit
 
649
      set on the plugin executable file (see <citerefentry>
 
650
      <refentrytitle>execve</refentrytitle><manvolnum>2</manvolnum>
 
651
      </citerefentry>).
 
652
    </para>
 
653
    <para>
 
654
      If this program is used as a keyscript in <citerefentry
 
655
      ><refentrytitle>crypttab</refentrytitle><manvolnum>5</manvolnum>
 
656
      </citerefentry>, there is a slight risk that if this program
 
657
      fails to work, there might be no way to boot the system except
 
658
      for booting from another media and editing the initial RAM disk
 
659
      image to not run this program.  This is, however, unlikely,
 
660
      since the <citerefentry><refentrytitle
 
661
      >password-prompt</refentrytitle><manvolnum>8mandos</manvolnum>
 
662
      </citerefentry> plugin will read a password from the console in
 
663
      case of failure of the other plugins, and this plugin runner
 
664
      will also, in case of catastrophic failure, itself fall back to
 
665
      asking and outputting a password on the console (see <xref
 
666
      linkend="fallback"/>).
445
667
    </para>
446
668
  </refsect1>
447
669
  
448
670
  <refsect1 id="see_also">
449
671
    <title>SEE ALSO</title>
450
672
    <para>
 
673
      <citerefentry><refentrytitle>intro</refentrytitle>
 
674
      <manvolnum>8mandos</manvolnum></citerefentry>,
451
675
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
452
676
      <manvolnum>8</manvolnum></citerefentry>,
 
677
      <citerefentry><refentrytitle>crypttab</refentrytitle>
 
678
      <manvolnum>5</manvolnum></citerefentry>,
 
679
      <citerefentry><refentrytitle>execve</refentrytitle>
 
680
      <manvolnum>2</manvolnum></citerefentry>,
453
681
      <citerefentry><refentrytitle>mandos</refentrytitle>
454
682
      <manvolnum>8</manvolnum></citerefentry>,
455
683
      <citerefentry><refentrytitle>password-prompt</refentrytitle>
456
684
      <manvolnum>8mandos</manvolnum></citerefentry>,
457
 
      <citerefentry><refentrytitle>password-request</refentrytitle>
 
685
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
458
686
      <manvolnum>8mandos</manvolnum></citerefentry>
459
687
    </para>
460
688
  </refsect1>