/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-07-14 23:39:53 UTC
  • mto: This revision was merged to the branch mainline in revision 384.
  • Revision ID: teddy@recompile.se-20190714233953-1zmsd3o062xloazt
Server bug fix: Allow restarts when using port= option

If the Mandos server is configured to use a specific TCP port to
listen to (by using the port= option in mandos.conf or the command
line --port option), that port becomes unusable for a time when the
Mandos server is restarted, making restarts fail.  Avoid this by, if a
port number is specified, using SO_REUSEADDR when binding the
listening TCP socket to a port number.

* mandos (IPv6_TCPServer.server_bind): Set self.allow_reuse_address if
                                       a port number is specified.

Reported-by: Juan Miguel Alcarria Herrera <juanmi@arco2000.es>

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 "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>
45
57
  <refnamediv>
46
58
    <refname><command>&COMMANDNAME;</command></refname>
47
59
    <refpurpose>
48
 
      Run Mandos plugins.  Pass data from first succesful one.
 
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
 
        <arg choice="plain"><option>-e
60
 
        <replaceable>VAR</replaceable><literal>=</literal><replaceable
 
71
        <arg choice="plain"><option>-G
 
72
        <replaceable>ENV</replaceable><literal>=</literal><replaceable
61
73
        >value</replaceable> </option></arg>
62
74
      </group>
63
75
      <sbr/>
66
78
        >PLUGIN</replaceable><literal>:</literal><replaceable
67
79
        >ENV</replaceable><literal>=</literal><replaceable
68
80
        >value</replaceable></option></arg>
69
 
        <arg choice="plain"><option>-f<replaceable>
 
81
        <arg choice="plain"><option>-E<replaceable>
70
82
        PLUGIN</replaceable><literal>:</literal><replaceable
71
83
        >ENV</replaceable><literal>=</literal><replaceable
72
84
        >value</replaceable> </option></arg>
83
95
        <arg choice="plain"><option>--options-for=<replaceable
84
96
        >PLUGIN</replaceable><literal>:</literal><replaceable
85
97
        >OPTIONS</replaceable></option></arg>
86
 
        <arg choice="plain"><option>-f<replaceable>
 
98
        <arg choice="plain"><option>-o<replaceable>
87
99
        PLUGIN</replaceable><literal>:</literal><replaceable
88
100
        >OPTIONS</replaceable> </option></arg>
89
101
      </group>
95
107
        <replaceable>PLUGIN</replaceable> </option></arg>
96
108
      </group>
97
109
      <sbr/>
 
110
      <group rep="repeat">
 
111
        <arg choice="plain"><option>--enable=<replaceable
 
112
        >PLUGIN</replaceable></option></arg>
 
113
        <arg choice="plain"><option>-e
 
114
        <replaceable>PLUGIN</replaceable> </option></arg>
 
115
      </group>
 
116
      <sbr/>
98
117
      <arg><option>--groupid=<replaceable
99
118
      >ID</replaceable></option></arg>
100
119
      <sbr/>
104
123
      <arg><option>--plugin-dir=<replaceable
105
124
      >DIRECTORY</replaceable></option></arg>
106
125
      <sbr/>
 
126
      <arg><option>--plugin-helper-dir=<replaceable
 
127
      >DIRECTORY</replaceable></option></arg>
 
128
      <sbr/>
 
129
      <arg><option>--config-file=<replaceable
 
130
      >FILE</replaceable></option></arg>
 
131
      <sbr/>
107
132
      <arg><option>--debug</option></arg>
108
133
    </cmdsynopsis>
109
134
    <cmdsynopsis>
130
155
    <title>DESCRIPTION</title>
131
156
    <para>
132
157
      <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.
 
158
      be specified as a <quote>keyscript</quote> for the root disk in
 
159
      <citerefentry><refentrytitle>crypttab</refentrytitle>
 
160
      <manvolnum>5</manvolnum></citerefentry>.  The aim of this
 
161
      program is therefore to output a password, which then
 
162
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
 
163
      <manvolnum>8</manvolnum></citerefentry> will use to unlock the
 
164
      root disk.
140
165
    </para>
141
166
    <para>
142
167
      This program is not meant to be invoked directly, but can be in
160
185
    <variablelist>
161
186
      <varlistentry>
162
187
        <term><option>--global-env
163
 
        <replaceable>VAR</replaceable><literal>=</literal><replaceable
 
188
        <replaceable>ENV</replaceable><literal>=</literal><replaceable
164
189
        >value</replaceable></option></term>
165
 
        <term><option>-e
166
 
        <replaceable>VAR</replaceable><literal>=</literal><replaceable
 
190
        <term><option>-G
 
191
        <replaceable>ENV</replaceable><literal>=</literal><replaceable
167
192
        >value</replaceable></option></term>
168
193
        <listitem>
169
194
          <para>
179
204
        <replaceable>PLUGIN</replaceable><literal>:</literal
180
205
        ><replaceable>ENV</replaceable><literal>=</literal
181
206
        ><replaceable>value</replaceable></option></term>
182
 
        <term><option>-f
 
207
        <term><option>-E
183
208
        <replaceable>PLUGIN</replaceable><literal>:</literal
184
209
        ><replaceable>ENV</replaceable><literal>=</literal
185
210
        ><replaceable>value</replaceable></option></term>
205
230
            <replaceable>OPTIONS</replaceable> is a comma separated
206
231
            list of options.  This is not a very useful option, except
207
232
            for specifying the <quote><option>--debug</option></quote>
208
 
            for all plugins.
 
233
            option to all plugins.
209
234
          </para>
210
235
        </listitem>
211
236
      </varlistentry>
231
256
            <option>--bar</option> with the option argument
232
257
            <quote>baz</quote> is either
233
258
            <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>.
 
259
            <userinput>--options-for=foo:--bar,baz</userinput>.  Using
 
260
            <userinput>--options-for="foo:--bar baz"</userinput>. will
 
261
            <emphasis>not</emphasis> work.
237
262
          </para>
238
263
        </listitem>
239
264
      </varlistentry>
240
 
 
 
265
      
241
266
      <varlistentry>
242
 
        <term><option> --disable
 
267
        <term><option>--disable
243
268
        <replaceable>PLUGIN</replaceable></option></term>
244
269
        <term><option>-d
245
270
        <replaceable>PLUGIN</replaceable></option></term>
248
273
            Disable the plugin named
249
274
            <replaceable>PLUGIN</replaceable>.  The plugin will not be
250
275
            started.
251
 
          </para>       
252
 
        </listitem>
253
 
      </varlistentry>
254
 
 
 
276
          </para>
 
277
        </listitem>
 
278
      </varlistentry>
 
279
      
 
280
      <varlistentry>
 
281
        <term><option>--enable
 
282
        <replaceable>PLUGIN</replaceable></option></term>
 
283
        <term><option>-e
 
284
        <replaceable>PLUGIN</replaceable></option></term>
 
285
        <listitem>
 
286
          <para>
 
287
            Re-enable the plugin named
 
288
            <replaceable>PLUGIN</replaceable>.  This is only useful to
 
289
            undo a previous <option>--disable</option> option, maybe
 
290
            from the configuration file.
 
291
          </para>
 
292
        </listitem>
 
293
      </varlistentry>
 
294
      
255
295
      <varlistentry>
256
296
        <term><option>--groupid
257
297
        <replaceable>ID</replaceable></option></term>
264
304
          </para>
265
305
        </listitem>
266
306
      </varlistentry>
267
 
 
 
307
      
268
308
      <varlistentry>
269
309
        <term><option>--userid
270
310
        <replaceable>ID</replaceable></option></term>
277
317
          </para>
278
318
        </listitem>
279
319
      </varlistentry>
280
 
 
 
320
      
281
321
      <varlistentry>
282
322
        <term><option>--plugin-dir
283
323
        <replaceable>DIRECTORY</replaceable></option></term>
292
332
      </varlistentry>
293
333
      
294
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>
 
350
        <term><option>--config-file
 
351
        <replaceable>FILE</replaceable></option></term>
 
352
        <listitem>
 
353
          <para>
 
354
            Specify a different file to read additional options from.
 
355
            See <xref linkend="files"/>.  Other command line options
 
356
            will override options specified in the file.
 
357
          </para>
 
358
        </listitem>
 
359
      </varlistentry>
 
360
      
 
361
      <varlistentry>
295
362
        <term><option>--debug</option></term>
296
363
        <listitem>
297
364
          <para>
328
395
          </para>
329
396
        </listitem>
330
397
      </varlistentry>
331
 
 
 
398
      
332
399
      <varlistentry>
333
400
        <term><option>--version</option></term>
334
401
        <term><option>-V</option></term>
340
407
      </varlistentry>
341
408
    </variablelist>
342
409
  </refsect1>
343
 
 
 
410
  
344
411
  <refsect1 id="overview">
345
412
    <title>OVERVIEW</title>
346
413
    <xi:include href="overview.xml"/>
366
433
      code will make this plugin-runner output the password from that
367
434
      plugin, stop any other plugins, and exit.
368
435
    </para>
 
436
    
 
437
    <refsect2 id="writing_plugins">
 
438
      <title>WRITING PLUGINS</title>
 
439
      <para>
 
440
        A plugin is simply a program which prints a password to its
 
441
        standard output and then exits with a successful (zero) exit
 
442
        status.  If the exit status is not zero, any output on
 
443
        standard output will be ignored by the plugin runner.  Any
 
444
        output on its standard error channel will simply be passed to
 
445
        the standard error of the plugin runner, usually the system
 
446
        console.
 
447
      </para>
 
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>
 
454
        The plugin will run in the initial RAM disk environment, so
 
455
        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.
 
461
      </para>
 
462
      <para>
 
463
        The plugin must exit cleanly and free all allocated resources
 
464
        upon getting the TERM signal, since this is what the plugin
 
465
        runner uses to stop all other plugins when one plugin has
 
466
        output a password and exited cleanly.
 
467
      </para>
 
468
      <para>
 
469
        The plugin must not use resources, like for instance reading
 
470
        from the standard input, without knowing that no other plugin
 
471
        is also using it.
 
472
      </para>
 
473
      <para>
 
474
        It is useful, but not required, for the plugin to take the
 
475
        <option>--debug</option> option.
 
476
      </para>
 
477
    </refsect2>
369
478
  </refsect1>
370
479
  
371
480
  <refsect1 id="fallback">
393
502
  <refsect1 id="environment">
394
503
    <title>ENVIRONMENT</title>
395
504
    <para>
396
 
      
 
505
      This program does not use any environment variables itself, it
 
506
      only passes on its environment to all the plugins.  The
 
507
      environment passed to plugins can be modified using the
 
508
      <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.
397
512
    </para>
398
513
  </refsect1>
399
514
  
400
 
  <refsect1 id="file">
 
515
  <refsect1 id="files">
401
516
    <title>FILES</title>
402
517
    <para>
403
518
      <variablelist>
415
530
              of a line is ignored.
416
531
            </para>
417
532
            <para>
 
533
              This program is meant to run in the initial RAM disk
 
534
              environment, so that is where this file is assumed to
 
535
              exist.  The file does not need to exist in the normal
 
536
              file system.
 
537
            </para>
 
538
            <para>
418
539
              This file will be processed <emphasis>before</emphasis>
419
540
              the normal command line options, so the latter can
420
541
              override the former, if need be.
421
542
            </para>
 
543
            <para>
 
544
              This file name is the default; the file to read for
 
545
              arguments can be changed using the
 
546
              <option>--config-file</option> option.
 
547
            </para>
 
548
          </listitem>
 
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>
422
568
          </listitem>
423
569
        </varlistentry>
424
570
      </variablelist>
428
574
  <refsect1 id="bugs">
429
575
    <title>BUGS</title>
430
576
    <para>
431
 
      There is no <option>--enable</option> option to enable disabled
432
 
      plugins.
 
577
      The <option>--config-file</option> option is ignored when
 
578
      specified from within a configuration file.
433
579
    </para>
 
580
    <xi:include href="bugs.xml"/>
434
581
  </refsect1>
435
582
  
436
583
  <refsect1 id="examples">
437
584
    <title>EXAMPLE</title>
438
 
    <para>
439
 
    </para>
 
585
    <informalexample>
 
586
      <para>
 
587
        Normal invocation needs no options:
 
588
      </para>
 
589
      <para>
 
590
        <userinput>&COMMANDNAME;</userinput>
 
591
      </para>
 
592
    </informalexample>
 
593
    <informalexample>
 
594
      <para>
 
595
        Run the program, but not the plugins, in debug mode:
 
596
      </para>
 
597
      <para>
 
598
        
 
599
        <!-- do not wrap this line -->
 
600
        <userinput>&COMMANDNAME; --debug</userinput>
 
601
        
 
602
      </para>
 
603
    </informalexample>
 
604
    <informalexample>
 
605
      <para>
 
606
        Run all plugins, but run the <quote>foo</quote> plugin in
 
607
        debug mode:
 
608
      </para>
 
609
      <para>
 
610
        
 
611
        <!-- do not wrap this line -->
 
612
        <userinput>&COMMANDNAME; --options-for=foo:--debug</userinput>
 
613
        
 
614
      </para>
 
615
    </informalexample>
 
616
    <informalexample>
 
617
      <para>
 
618
        Run all plugins, but not the program, in debug mode:
 
619
      </para>
 
620
      <para>
 
621
        
 
622
        <!-- do not wrap this line -->
 
623
        <userinput>&COMMANDNAME; --global-options=--debug</userinput>
 
624
        
 
625
      </para>
 
626
    </informalexample>
 
627
    <informalexample>
 
628
      <para>
 
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>
 
633
        <manvolnum>8mandos</manvolnum></citerefentry> plugin:
 
634
      </para>
 
635
      <para>
 
636
 
 
637
<!-- 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,--seckey=seckey.txt,--tls-pubkey=tls-pubkey.pem,--tls-privkey=tls-privkey.pem</userinput>
 
639
 
 
640
      </para>
 
641
    </informalexample>
440
642
  </refsect1>
441
 
  
442
643
  <refsect1 id="security">
443
644
    <title>SECURITY</title>
444
645
    <para>
 
646
      This program will, when starting, try to switch to another user.
 
647
      If it is started as root, it will succeed, and will by default
 
648
      switch to user and group 65534, which are assumed to be
 
649
      non-privileged.  This user and group is then what all plugins
 
650
      will be started as.  Therefore, the only way to run a plugin as
 
651
      a privileged user is to have the set-user-ID or set-group-ID bit
 
652
      set on the plugin executable file (see <citerefentry>
 
653
      <refentrytitle>execve</refentrytitle><manvolnum>2</manvolnum>
 
654
      </citerefentry>).
 
655
    </para>
 
656
    <para>
 
657
      If this program is used as a keyscript in <citerefentry
 
658
      ><refentrytitle>crypttab</refentrytitle><manvolnum>5</manvolnum>
 
659
      </citerefentry>, there is a slight risk that if this program
 
660
      fails to work, there might be no way to boot the system except
 
661
      for booting from another media and editing the initial RAM disk
 
662
      image to not run this program.  This is, however, unlikely,
 
663
      since the <citerefentry><refentrytitle
 
664
      >password-prompt</refentrytitle><manvolnum>8mandos</manvolnum>
 
665
      </citerefentry> plugin will read a password from the console in
 
666
      case of failure of the other plugins, and this plugin runner
 
667
      will also, in case of catastrophic failure, itself fall back to
 
668
      asking and outputting a password on the console (see <xref
 
669
      linkend="fallback"/>).
445
670
    </para>
446
671
  </refsect1>
447
672
  
448
673
  <refsect1 id="see_also">
449
674
    <title>SEE ALSO</title>
450
675
    <para>
 
676
      <citerefentry><refentrytitle>intro</refentrytitle>
 
677
      <manvolnum>8mandos</manvolnum></citerefentry>,
451
678
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
452
679
      <manvolnum>8</manvolnum></citerefentry>,
 
680
      <citerefentry><refentrytitle>crypttab</refentrytitle>
 
681
      <manvolnum>5</manvolnum></citerefentry>,
 
682
      <citerefentry><refentrytitle>execve</refentrytitle>
 
683
      <manvolnum>2</manvolnum></citerefentry>,
453
684
      <citerefentry><refentrytitle>mandos</refentrytitle>
454
685
      <manvolnum>8</manvolnum></citerefentry>,
455
686
      <citerefentry><refentrytitle>password-prompt</refentrytitle>
456
687
      <manvolnum>8mandos</manvolnum></citerefentry>,
457
 
      <citerefentry><refentrytitle>password-request</refentrytitle>
 
688
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
458
689
      <manvolnum>8mandos</manvolnum></citerefentry>
459
690
    </para>
460
691
  </refsect1>