/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-08-10 09:00:23 UTC
  • Revision ID: teddy@recompile.se-20150810090023-fz6vjqr7zf33e2tf
Support the standard org.freedesktop.DBus.ObjectManager interface.

Now that the D-Bus standard has an interface to keep track of new and
removed objects, use that instead of our own methods.  This deprecates
our D-Bus methods "GetAllClients" and "GetAllClientsWithProperties"
and the signals "ClientAdded" and "ClientRemoved", all on the server
interface "se.recompile.Mandos".

* DBUS-API: Removed references to deprecated methods and signals;
  insert reference to the org.freedesktop.DBus.ObjectManager
  interface.
* mandos (DBusObjectWithProperties._get_all_interface_names): New.
  (dbus.OBJECT_MANAGER_IFACE): If not present, monkey patch.
  (DBusObjectWithObjectManager): New.
  (main/MandosDBusService): Inherit from DBusObjectWithObjectManager.
  (main/MandosDBusService.ClientRemoved): Annotate as deprecated.
  (main/MandosDBusService.GetAllClients): - '' -
  (main/MandosDBusService.GetAllClientsWithProperties): Annotate as
                                                        deprecated.
                                                        Also only
                                                        return
                                                        properties on
                                                        client
                                                        interface.
  (main/MandosDBusService.RemoveClient): Call client_removed_signal
                                         instead of ClientRemoved.
  (main/MandosDBusService.GetManagedObjects): New.
  (main/MandosDBusService.client_added_signal): New.
  (main/MandosDBusService.client_removed_signal): - '' -
  (main/cleanup): Call "client_removed_signal" instead of sending
                  "ClientRemoved" signal directly.
  (main): Call "client_added_signal" instead of sending "ClientAdded"
          signal directly.
* mandos-ctl: Use GetManagedObjects instead of
              GetAllClientsWithProperties.  Also, show better error
              message in case of failure to connect to the D-Bus

* mandos-monitor (MandosClientPropertyCache.properties_changed):
  Bug fix; only update properties on client interface.
  (UserInterface.find_and_remove_client): Change to accept arguments
                                          from InterfacesRemoved
                                          signal.  Also, bug fix:
                                          working error message when
                                          removing unknown client.
  (UserInterface.add_new_client): Change to accept arguments from
                                  InterfacesRemoved signal.  Pass
                                  properties to MandosClientWidget
                                  constructor.
  (UserInterface.run): Connect find_and_remove_client method to
                       InterfacesRemoved signal and the add_new_client
                       method to the InterfacesAdded signal.

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugin-runner.xml
1
 
<?xml version='1.0' encoding='UTF-8'?>
2
 
<?xml-stylesheet type="text/xsl"
3
 
        href="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl"?>
 
1
<?xml version="1.0" encoding="UTF-8"?>
4
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
5
3
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
6
 
<!ENTITY VERSION "1.0">
7
4
<!ENTITY COMMANDNAME "plugin-runner">
8
 
<!ENTITY TIMESTAMP "2008-08-31">
 
5
<!ENTITY TIMESTAMP "2015-07-20">
 
6
<!ENTITY % common SYSTEM "common.ent">
 
7
%common;
9
8
]>
10
9
 
11
 
<refentry>
 
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
12
11
  <refentryinfo>
13
12
    <title>Mandos Manual</title>
14
 
    <!-- NWalsh's docbook scripts use this to generate the footer: -->
 
13
    <!-- Nwalsh’s docbook scripts use this to generate the footer: -->
15
14
    <productname>Mandos</productname>
16
 
    <productnumber>&VERSION;</productnumber>
 
15
    <productnumber>&version;</productnumber>
17
16
    <date>&TIMESTAMP;</date>
18
17
    <authorgroup>
19
18
      <author>
20
19
        <firstname>Björn</firstname>
21
20
        <surname>Påhlsson</surname>
22
21
        <address>
23
 
          <email>belorn@fukt.bsnet.se</email>
 
22
          <email>belorn@recompile.se</email>
24
23
        </address>
25
24
      </author>
26
25
      <author>
27
26
        <firstname>Teddy</firstname>
28
27
        <surname>Hogeborn</surname>
29
28
        <address>
30
 
          <email>teddy@fukt.bsnet.se</email>
 
29
          <email>teddy@recompile.se</email>
31
30
        </address>
32
31
      </author>
33
32
    </authorgroup>
34
33
    <copyright>
35
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>
36
42
      <holder>Teddy Hogeborn</holder>
37
43
      <holder>Björn Påhlsson</holder>
38
44
    </copyright>
39
 
    <legalnotice>
40
 
      <para>
41
 
        This manual page is free software: you can redistribute it
42
 
        and/or modify it under the terms of the GNU General Public
43
 
        License as published by the Free Software Foundation,
44
 
        either version 3 of the License, or (at your option) any
45
 
        later version.
46
 
      </para>
47
 
 
48
 
      <para>
49
 
        This manual page is distributed in the hope that it will
50
 
        be useful, but WITHOUT ANY WARRANTY; without even the
51
 
        implied warranty of MERCHANTABILITY or FITNESS FOR A
52
 
        PARTICULAR PURPOSE.  See the GNU General Public License
53
 
        for more details.
54
 
      </para>
55
 
 
56
 
      <para>
57
 
        You should have received a copy of the GNU General Public
58
 
        License along with this program; If not, see
59
 
        <ulink url="http://www.gnu.org/licenses/"/>.
60
 
      </para>
61
 
    </legalnotice>
 
45
    <xi:include href="legalnotice.xml"/>
62
46
  </refentryinfo>
63
 
 
 
47
  
64
48
  <refmeta>
65
49
    <refentrytitle>&COMMANDNAME;</refentrytitle>
66
50
    <manvolnum>8mandos</manvolnum>
69
53
  <refnamediv>
70
54
    <refname><command>&COMMANDNAME;</command></refname>
71
55
    <refpurpose>
72
 
      Run Mandos plugins.  Pass data from first succesful one.
 
56
      Run Mandos plugins, pass data from first to succeed.
73
57
    </refpurpose>
74
58
  </refnamediv>
75
 
 
 
59
  
76
60
  <refsynopsisdiv>
77
61
    <cmdsynopsis>
78
62
      <command>&COMMANDNAME;</command>
79
63
      <group rep="repeat">
80
 
        <arg choice="plain"><option>--global-envs=<replaceable
81
 
        >VAR</replaceable><literal>=</literal><replaceable
 
64
        <arg choice="plain"><option>--global-env=<replaceable
 
65
        >ENV</replaceable><literal>=</literal><replaceable
82
66
        >value</replaceable></option></arg>
83
 
        <arg choice="plain"><option>-e
84
 
        <replaceable>VAR</replaceable><literal>=</literal><replaceable
 
67
        <arg choice="plain"><option>-G
 
68
        <replaceable>ENV</replaceable><literal>=</literal><replaceable
85
69
        >value</replaceable> </option></arg>
86
70
      </group>
87
71
      <sbr/>
88
72
      <group rep="repeat">
89
 
        <arg choice="plain"><option>--envs-for=<replaceable
 
73
        <arg choice="plain"><option>--env-for=<replaceable
90
74
        >PLUGIN</replaceable><literal>:</literal><replaceable
91
75
        >ENV</replaceable><literal>=</literal><replaceable
92
76
        >value</replaceable></option></arg>
93
 
        <arg choice="plain"><option>-f<replaceable>
 
77
        <arg choice="plain"><option>-E<replaceable>
94
78
        PLUGIN</replaceable><literal>:</literal><replaceable
95
79
        >ENV</replaceable><literal>=</literal><replaceable
96
80
        >value</replaceable> </option></arg>
107
91
        <arg choice="plain"><option>--options-for=<replaceable
108
92
        >PLUGIN</replaceable><literal>:</literal><replaceable
109
93
        >OPTIONS</replaceable></option></arg>
110
 
        <arg choice="plain"><option>-f<replaceable>
 
94
        <arg choice="plain"><option>-o<replaceable>
111
95
        PLUGIN</replaceable><literal>:</literal><replaceable
112
96
        >OPTIONS</replaceable> </option></arg>
113
97
      </group>
119
103
        <replaceable>PLUGIN</replaceable> </option></arg>
120
104
      </group>
121
105
      <sbr/>
 
106
      <group rep="repeat">
 
107
        <arg choice="plain"><option>--enable=<replaceable
 
108
        >PLUGIN</replaceable></option></arg>
 
109
        <arg choice="plain"><option>-e
 
110
        <replaceable>PLUGIN</replaceable> </option></arg>
 
111
      </group>
 
112
      <sbr/>
122
113
      <arg><option>--groupid=<replaceable
123
114
      >ID</replaceable></option></arg>
124
115
      <sbr/>
128
119
      <arg><option>--plugin-dir=<replaceable
129
120
      >DIRECTORY</replaceable></option></arg>
130
121
      <sbr/>
 
122
      <arg><option>--plugin-helper-dir=<replaceable
 
123
      >DIRECTORY</replaceable></option></arg>
 
124
      <sbr/>
 
125
      <arg><option>--config-file=<replaceable
 
126
      >FILE</replaceable></option></arg>
 
127
      <sbr/>
131
128
      <arg><option>--debug</option></arg>
132
129
    </cmdsynopsis>
133
130
    <cmdsynopsis>
134
131
      <command>&COMMANDNAME;</command>
135
132
      <group choice="req">
136
 
        <arg choice='plain'><option>--help</option></arg>
137
 
        <arg choice='plain'><option>-?</option></arg>
 
133
        <arg choice="plain"><option>--help</option></arg>
 
134
        <arg choice="plain"><option>-?</option></arg>
138
135
      </group>
139
136
    </cmdsynopsis>
140
137
    <cmdsynopsis>
141
138
      <command>&COMMANDNAME;</command>
142
 
      <arg choice='plain'><option>--usage</option></arg>
 
139
      <arg choice="plain"><option>--usage</option></arg>
143
140
    </cmdsynopsis>
144
141
    <cmdsynopsis>
145
142
      <command>&COMMANDNAME;</command>
146
143
      <group choice="req">
147
 
        <arg choice='plain'><option>--version</option></arg>
148
 
        <arg choice='plain'><option>-V</option></arg>
 
144
        <arg choice="plain"><option>--version</option></arg>
 
145
        <arg choice="plain"><option>-V</option></arg>
149
146
      </group>
150
147
    </cmdsynopsis>
151
148
  </refsynopsisdiv>
152
 
 
 
149
  
153
150
  <refsect1 id="description">
154
151
    <title>DESCRIPTION</title>
155
152
    <para>
156
 
      <command>&COMMANDNAME;</command> is a plugin runner that waits
157
 
      for any of its plugins to return sucessfull with a password, and
158
 
      passes it to cryptsetup as stdout message. This command is not
159
 
      meant to be invoked directly, but is instead meant to be run by
160
 
      cryptsetup by being specified in /etc/crypttab as a keyscript
161
 
      and subsequlently started in the initrd environment. See
 
153
      <command>&COMMANDNAME;</command> is a program which is meant to
 
154
      be specified as a <quote>keyscript</quote> for the root disk in
162
155
      <citerefentry><refentrytitle>crypttab</refentrytitle>
163
 
      <manvolnum>5</manvolnum></citerefentry> for more information on
164
 
      keyscripts.
165
 
    </para>
166
 
 
167
 
    <para>
168
 
      plugins is looked for in the plugins directory which by default will be
169
 
      /conf/conf.d/mandos/plugins.d if not changed by option --plugin-dir.
170
 
    </para>
171
 
  </refsect1>
 
156
      <manvolnum>5</manvolnum></citerefentry>.  The aim of this
 
157
      program is therefore to output a password, which then
 
158
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
 
159
      <manvolnum>8</manvolnum></citerefentry> will use to unlock the
 
160
      root disk.
 
161
    </para>
 
162
    <para>
 
163
      This program is not meant to be invoked directly, but can be in
 
164
      order to test it.  Note that any password obtained will simply
 
165
      be output on standard output.
 
166
    </para>
 
167
  </refsect1>
 
168
  
 
169
  <refsect1 id="purpose">
 
170
    <title>PURPOSE</title>
 
171
    <para>
 
172
      The purpose of this is to enable <emphasis>remote and unattended
 
173
      rebooting</emphasis> of client host computer with an
 
174
      <emphasis>encrypted root file system</emphasis>.  See <xref
 
175
      linkend="overview"/> for details.
 
176
    </para>
 
177
  </refsect1>
 
178
  
172
179
  <refsect1>
173
180
    <title>OPTIONS</title>
174
181
    <variablelist>
175
182
      <varlistentry>
 
183
        <term><option>--global-env
 
184
        <replaceable>ENV</replaceable><literal>=</literal><replaceable
 
185
        >value</replaceable></option></term>
 
186
        <term><option>-G
 
187
        <replaceable>ENV</replaceable><literal>=</literal><replaceable
 
188
        >value</replaceable></option></term>
 
189
        <listitem>
 
190
          <para>
 
191
            This option will add an environment variable setting to
 
192
            all plugins.  This will override any inherited environment
 
193
            variable.
 
194
          </para>
 
195
        </listitem>
 
196
      </varlistentry>
 
197
      
 
198
      <varlistentry>
 
199
        <term><option>--env-for
 
200
        <replaceable>PLUGIN</replaceable><literal>:</literal
 
201
        ><replaceable>ENV</replaceable><literal>=</literal
 
202
        ><replaceable>value</replaceable></option></term>
 
203
        <term><option>-E
 
204
        <replaceable>PLUGIN</replaceable><literal>:</literal
 
205
        ><replaceable>ENV</replaceable><literal>=</literal
 
206
        ><replaceable>value</replaceable></option></term>
 
207
        <listitem>
 
208
          <para>
 
209
            This option will add an environment variable setting to
 
210
            the <replaceable>PLUGIN</replaceable> plugin.  This will
 
211
            override any inherited environment variables or
 
212
            environment variables specified using
 
213
            <option>--global-env</option>.
 
214
          </para>
 
215
        </listitem>
 
216
      </varlistentry>
 
217
      
 
218
      <varlistentry>
176
219
        <term><option>--global-options
177
220
        <replaceable>OPTIONS</replaceable></option></term>
178
221
        <term><option>-g
179
222
        <replaceable>OPTIONS</replaceable></option></term>
180
223
        <listitem>
181
224
          <para>
182
 
            Global options given to all plugins as additional start
183
 
            arguments.  Options are specified with a -o flag followed
184
 
            by a comma separated string of options.
185
 
          </para>       
 
225
            Pass some options to <emphasis>all</emphasis> plugins.
 
226
            <replaceable>OPTIONS</replaceable> is a comma separated
 
227
            list of options.  This is not a very useful option, except
 
228
            for specifying the <quote><option>--debug</option></quote>
 
229
            option to all plugins.
 
230
          </para>
186
231
        </listitem>
187
232
      </varlistentry>
188
 
 
 
233
      
189
234
      <varlistentry>
190
235
        <term><option>--options-for
191
236
        <replaceable>PLUGIN</replaceable><literal>:</literal
195
240
        ><replaceable>OPTION</replaceable></option></term>
196
241
        <listitem>
197
242
          <para>
198
 
            Plugin specific options given to the plugin as additional
199
 
            start arguments.  Options are specified with a -o flag
200
 
            followed by a comma separated string of options.
201
 
          </para>       
 
243
            Pass some options to a specific plugin.  <replaceable
 
244
            >PLUGIN</replaceable> is the name (file basename) of a
 
245
            plugin, and <replaceable>OPTIONS</replaceable> is a comma
 
246
            separated list of options.
 
247
          </para>
 
248
          <para>
 
249
            Note that since options are not split on whitespace, the
 
250
            way to pass, to the plugin
 
251
            <quote><filename>foo</filename></quote>, the option
 
252
            <option>--bar</option> with the option argument
 
253
            <quote>baz</quote> is either
 
254
            <userinput>--options-for=foo:--bar=baz</userinput> or
 
255
            <userinput>--options-for=foo:--bar,baz</userinput>.  Using
 
256
            <userinput>--options-for="foo:--bar baz"</userinput>. will
 
257
            <emphasis>not</emphasis> work.
 
258
          </para>
202
259
        </listitem>
203
260
      </varlistentry>
204
 
 
 
261
      
205
262
      <varlistentry>
206
 
        <term><option> --disable
 
263
        <term><option>--disable
207
264
        <replaceable>PLUGIN</replaceable></option></term>
208
265
        <term><option>-d
209
266
        <replaceable>PLUGIN</replaceable></option></term>
210
267
        <listitem>
211
268
          <para>
212
 
            Disable a specific plugin
213
 
          </para>       
214
 
        </listitem>
215
 
      </varlistentry>
216
 
 
 
269
            Disable the plugin named
 
270
            <replaceable>PLUGIN</replaceable>.  The plugin will not be
 
271
            started.
 
272
          </para>
 
273
        </listitem>
 
274
      </varlistentry>
 
275
      
 
276
      <varlistentry>
 
277
        <term><option>--enable
 
278
        <replaceable>PLUGIN</replaceable></option></term>
 
279
        <term><option>-e
 
280
        <replaceable>PLUGIN</replaceable></option></term>
 
281
        <listitem>
 
282
          <para>
 
283
            Re-enable the plugin named
 
284
            <replaceable>PLUGIN</replaceable>.  This is only useful to
 
285
            undo a previous <option>--disable</option> option, maybe
 
286
            from the configuration file.
 
287
          </para>
 
288
        </listitem>
 
289
      </varlistentry>
 
290
      
217
291
      <varlistentry>
218
292
        <term><option>--groupid
219
293
        <replaceable>ID</replaceable></option></term>
220
294
        <listitem>
221
295
          <para>
222
 
            Group ID the plugins will run as
 
296
            Change to group ID <replaceable>ID</replaceable> on
 
297
            startup.  The default is 65534.  All plugins will be
 
298
            started using this group ID.  <emphasis>Note:</emphasis>
 
299
            This must be a number, not a name.
223
300
          </para>
224
301
        </listitem>
225
302
      </varlistentry>
226
 
 
 
303
      
227
304
      <varlistentry>
228
305
        <term><option>--userid
229
306
        <replaceable>ID</replaceable></option></term>
230
307
        <listitem>
231
308
          <para>
232
 
            User ID the plugins will run as
 
309
            Change to user ID <replaceable>ID</replaceable> on
 
310
            startup.  The default is 65534.  All plugins will be
 
311
            started using this user ID.  <emphasis>Note:</emphasis>
 
312
            This must be a number, not a name.
233
313
          </para>
234
314
        </listitem>
235
315
      </varlistentry>
236
 
 
 
316
      
237
317
      <varlistentry>
238
318
        <term><option>--plugin-dir
239
319
        <replaceable>DIRECTORY</replaceable></option></term>
240
320
        <listitem>
241
321
          <para>
242
 
            Specify a different plugin directory
 
322
            Specify a different plugin directory.  The default is
 
323
            <filename>/lib/mandos/plugins.d</filename>, which will
 
324
            exist in the initial <acronym>RAM</acronym> disk
 
325
            environment.
 
326
          </para>
 
327
        </listitem>
 
328
      </varlistentry>
 
329
      
 
330
      <varlistentry>
 
331
        <term><option>--plugin-helper-dir
 
332
        <replaceable>DIRECTORY</replaceable></option></term>
 
333
        <listitem>
 
334
          <para>
 
335
            Specify a different plugin helper directory.  The default
 
336
            is <filename>/lib/mandos/plugin-helpers</filename>, which
 
337
            will exist in the initial <acronym>RAM</acronym> disk
 
338
            environment.  (This will simply be passed to all plugins
 
339
            via the <envar>MANDOSPLUGINHELPERDIR</envar> environment
 
340
            variable.  See <xref linkend="writing_plugins"/>)
 
341
          </para>
 
342
        </listitem>
 
343
      </varlistentry>
 
344
      
 
345
      <varlistentry>
 
346
        <term><option>--config-file
 
347
        <replaceable>FILE</replaceable></option></term>
 
348
        <listitem>
 
349
          <para>
 
350
            Specify a different file to read additional options from.
 
351
            See <xref linkend="files"/>.  Other command line options
 
352
            will override options specified in the file.
243
353
          </para>
244
354
        </listitem>
245
355
      </varlistentry>
248
358
        <term><option>--debug</option></term>
249
359
        <listitem>
250
360
          <para>
251
 
            Debug mode
 
361
            Enable debug mode.  This will enable a lot of output to
 
362
            standard error about what the program is doing.  The
 
363
            program will still perform all other functions normally.
 
364
            The default is to <emphasis>not</emphasis> run in debug
 
365
            mode.
 
366
          </para>
 
367
          <para>
 
368
            The plugins will <emphasis>not</emphasis> be affected by
 
369
            this option.  Use
 
370
            <userinput><option>--global-options=--debug</option></userinput>
 
371
            if complete debugging eruption is desired.
252
372
          </para>
253
373
        </listitem>
254
374
      </varlistentry>
258
378
        <term><option>-?</option></term>
259
379
        <listitem>
260
380
          <para>
261
 
            Gives a help message
 
381
            Gives a help message about options and their meanings.
262
382
          </para>
263
383
        </listitem>
264
384
      </varlistentry>
267
387
        <term><option>--usage</option></term>
268
388
        <listitem>
269
389
          <para>
270
 
            Gives a short usage message
 
390
            Gives a short usage message.
271
391
          </para>
272
392
        </listitem>
273
393
      </varlistentry>
274
 
 
 
394
      
275
395
      <varlistentry>
276
396
        <term><option>--version</option></term>
277
397
        <term><option>-V</option></term>
278
398
        <listitem>
279
399
          <para>
280
 
            Prints the program version
 
400
            Prints the program version.
281
401
          </para>
282
402
        </listitem>
283
403
      </varlistentry>
284
404
    </variablelist>
285
405
  </refsect1>
286
 
 
 
406
  
 
407
  <refsect1 id="overview">
 
408
    <title>OVERVIEW</title>
 
409
    <xi:include href="overview.xml"/>
 
410
    <para>
 
411
      This program will run on the client side in the initial
 
412
      <acronym>RAM</acronym> disk environment, and is responsible for
 
413
      getting a password.  It does this by running plugins, one of
 
414
      which will normally be the actual client program communicating
 
415
      with the server.
 
416
    </para>
 
417
  </refsect1>
 
418
  <refsect1 id="plugins">
 
419
    <title>PLUGINS</title>
 
420
    <para>
 
421
      This program will get a password by running a number of
 
422
      <firstterm>plugins</firstterm>, which are simply executable
 
423
      programs in a directory in the initial <acronym>RAM</acronym>
 
424
      disk environment.  The default directory is
 
425
      <filename>/lib/mandos/plugins.d</filename>, but this can be
 
426
      changed with the <option>--plugin-dir</option> option.  The
 
427
      plugins are started in parallel, and the first plugin to output
 
428
      a password <emphasis>and</emphasis> exit with a successful exit
 
429
      code will make this plugin-runner output the password from that
 
430
      plugin, stop any other plugins, and exit.
 
431
    </para>
 
432
    
 
433
    <refsect2 id="writing_plugins">
 
434
      <title>WRITING PLUGINS</title>
 
435
      <para>
 
436
        A plugin is simply a program which prints a password to its
 
437
        standard output and then exits with a successful (zero) exit
 
438
        status.  If the exit status is not zero, any output on
 
439
        standard output will be ignored by the plugin runner.  Any
 
440
        output on its standard error channel will simply be passed to
 
441
        the standard error of the plugin runner, usually the system
 
442
        console.
 
443
      </para>
 
444
      <para>
 
445
        If the password is a single-line, manually entered passprase,
 
446
        a final trailing newline character should
 
447
        <emphasis>not</emphasis> be printed.
 
448
      </para>
 
449
      <para>
 
450
        The plugin will run in the initial RAM disk environment, so
 
451
        care must be taken not to depend on any files or running
 
452
        services not available there.  Any helper executables required
 
453
        by the plugin (which are not in the <envar>PATH</envar>) can
 
454
        be placed in the plugin helper directory, the name of which
 
455
        will be made available to the plugin via the
 
456
        <envar>MANDOSPLUGINHELPERDIR</envar> environment variable.
 
457
      </para>
 
458
      <para>
 
459
        The plugin must exit cleanly and free all allocated resources
 
460
        upon getting the TERM signal, since this is what the plugin
 
461
        runner uses to stop all other plugins when one plugin has
 
462
        output a password and exited cleanly.
 
463
      </para>
 
464
      <para>
 
465
        The plugin must not use resources, like for instance reading
 
466
        from the standard input, without knowing that no other plugin
 
467
        is also using it.
 
468
      </para>
 
469
      <para>
 
470
        It is useful, but not required, for the plugin to take the
 
471
        <option>--debug</option> option.
 
472
      </para>
 
473
    </refsect2>
 
474
  </refsect1>
 
475
  
 
476
  <refsect1 id="fallback">
 
477
    <title>FALLBACK</title>
 
478
    <para>
 
479
      If no plugins succeed, this program will, as a fallback, ask for
 
480
      a password on the console using <citerefentry><refentrytitle
 
481
      >getpass</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
 
482
      and output it.  This is not meant to be the normal mode of
 
483
      operation, as there is a separate plugin for getting a password
 
484
      from the console.
 
485
    </para>
 
486
  </refsect1>
 
487
  
287
488
  <refsect1 id="exit_status">
288
489
    <title>EXIT STATUS</title>
289
490
    <para>
290
 
    </para>
291
 
  </refsect1>
292
 
 
293
 
  <refsect1 id="file">
 
491
      Exit status of this program is zero if no errors were
 
492
      encountered, and otherwise not.  The fallback (see <xref
 
493
      linkend="fallback"/>) may or may not have succeeded in either
 
494
      case.
 
495
    </para>
 
496
  </refsect1>
 
497
  
 
498
  <refsect1 id="environment">
 
499
    <title>ENVIRONMENT</title>
 
500
    <para>
 
501
      This program does not use any environment variables itself, it
 
502
      only passes on its environment to all the plugins.  The
 
503
      environment passed to plugins can be modified using the
 
504
      <option>--global-env</option> and <option>--env-for</option>
 
505
      options.  Also, the <option>--plugin-helper-dir</option> option
 
506
      will affect the environment variable
 
507
      <envar>MANDOSPLUGINHELPERDIR</envar> for the plugins.
 
508
    </para>
 
509
  </refsect1>
 
510
  
 
511
  <refsect1 id="files">
294
512
    <title>FILES</title>
295
513
    <para>
296
 
    </para>
297
 
  </refsect1>
298
 
 
299
 
  <refsect1 id="notes">
300
 
    <title>NOTES</title>
301
 
    <para>
 
514
      <variablelist>
 
515
        <varlistentry>
 
516
          <term><filename
 
517
          >/conf/conf.d/mandos/plugin-runner.conf</filename></term>
 
518
          <listitem>
 
519
            <para>
 
520
              Since this program will be run as a keyscript, there is
 
521
              little to no opportunity to pass command line arguments
 
522
              to it.  Therefore, it will <emphasis>also</emphasis>
 
523
              read this file and use its contents as
 
524
              whitespace-separated command line options.  Also,
 
525
              everything from a <quote>#</quote> character to the end
 
526
              of a line is ignored.
 
527
            </para>
 
528
            <para>
 
529
              This program is meant to run in the initial RAM disk
 
530
              environment, so that is where this file is assumed to
 
531
              exist.  The file does not need to exist in the normal
 
532
              file system.
 
533
            </para>
 
534
            <para>
 
535
              This file will be processed <emphasis>before</emphasis>
 
536
              the normal command line options, so the latter can
 
537
              override the former, if need be.
 
538
            </para>
 
539
            <para>
 
540
              This file name is the default; the file to read for
 
541
              arguments can be changed using the
 
542
              <option>--config-file</option> option.
 
543
            </para>
 
544
          </listitem>
 
545
        </varlistentry>
 
546
      </variablelist>
302
547
    </para>
303
548
  </refsect1>
304
549
  
305
550
  <refsect1 id="bugs">
306
551
    <title>BUGS</title>
307
552
    <para>
 
553
      The <option>--config-file</option> option is ignored when
 
554
      specified from within a configuration file.
308
555
    </para>
309
556
  </refsect1>
310
 
 
 
557
  
311
558
  <refsect1 id="examples">
312
559
    <title>EXAMPLE</title>
313
 
    <para>
314
 
    </para>
 
560
    <informalexample>
 
561
      <para>
 
562
        Normal invocation needs no options:
 
563
      </para>
 
564
      <para>
 
565
        <userinput>&COMMANDNAME;</userinput>
 
566
      </para>
 
567
    </informalexample>
 
568
    <informalexample>
 
569
      <para>
 
570
        Run the program, but not the plugins, in debug mode:
 
571
      </para>
 
572
      <para>
 
573
        
 
574
        <!-- do not wrap this line -->
 
575
        <userinput>&COMMANDNAME; --debug</userinput>
 
576
        
 
577
      </para>
 
578
    </informalexample>
 
579
    <informalexample>
 
580
      <para>
 
581
        Run all plugins, but run the <quote>foo</quote> plugin in
 
582
        debug mode:
 
583
      </para>
 
584
      <para>
 
585
        
 
586
        <!-- do not wrap this line -->
 
587
        <userinput>&COMMANDNAME; --options-for=foo:--debug</userinput>
 
588
        
 
589
      </para>
 
590
    </informalexample>
 
591
    <informalexample>
 
592
      <para>
 
593
        Run all plugins, but not the program, in debug mode:
 
594
      </para>
 
595
      <para>
 
596
        
 
597
        <!-- do not wrap this line -->
 
598
        <userinput>&COMMANDNAME; --global-options=--debug</userinput>
 
599
        
 
600
      </para>
 
601
    </informalexample>
 
602
    <informalexample>
 
603
      <para>
 
604
        Read a different configuration file, run plugins from a
 
605
        different directory, specify an alternate plugin helper
 
606
        directory and add two options to the
 
607
        <citerefentry><refentrytitle >mandos-client</refentrytitle>
 
608
        <manvolnum>8mandos</manvolnum></citerefentry> plugin:
 
609
      </para>
 
610
      <para>
 
611
 
 
612
<!-- do not wrap this line -->
 
613
<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>
 
614
 
 
615
      </para>
 
616
    </informalexample>
315
617
  </refsect1>
316
 
 
317
618
  <refsect1 id="security">
318
619
    <title>SECURITY</title>
319
620
    <para>
 
621
      This program will, when starting, try to switch to another user.
 
622
      If it is started as root, it will succeed, and will by default
 
623
      switch to user and group 65534, which are assumed to be
 
624
      non-privileged.  This user and group is then what all plugins
 
625
      will be started as.  Therefore, the only way to run a plugin as
 
626
      a privileged user is to have the set-user-ID or set-group-ID bit
 
627
      set on the plugin executable file (see <citerefentry>
 
628
      <refentrytitle>execve</refentrytitle><manvolnum>2</manvolnum>
 
629
      </citerefentry>).
 
630
    </para>
 
631
    <para>
 
632
      If this program is used as a keyscript in <citerefentry
 
633
      ><refentrytitle>crypttab</refentrytitle><manvolnum>5</manvolnum>
 
634
      </citerefentry>, there is a slight risk that if this program
 
635
      fails to work, there might be no way to boot the system except
 
636
      for booting from another media and editing the initial RAM disk
 
637
      image to not run this program.  This is, however, unlikely,
 
638
      since the <citerefentry><refentrytitle
 
639
      >password-prompt</refentrytitle><manvolnum>8mandos</manvolnum>
 
640
      </citerefentry> plugin will read a password from the console in
 
641
      case of failure of the other plugins, and this plugin runner
 
642
      will also, in case of catastrophic failure, itself fall back to
 
643
      asking and outputting a password on the console (see <xref
 
644
      linkend="fallback"/>).
320
645
    </para>
321
646
  </refsect1>
322
 
 
 
647
  
323
648
  <refsect1 id="see_also">
324
649
    <title>SEE ALSO</title>
325
650
    <para>
 
651
      <citerefentry><refentrytitle>intro</refentrytitle>
 
652
      <manvolnum>8mandos</manvolnum></citerefentry>,
326
653
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
327
654
      <manvolnum>8</manvolnum></citerefentry>,
 
655
      <citerefentry><refentrytitle>crypttab</refentrytitle>
 
656
      <manvolnum>5</manvolnum></citerefentry>,
 
657
      <citerefentry><refentrytitle>execve</refentrytitle>
 
658
      <manvolnum>2</manvolnum></citerefentry>,
328
659
      <citerefentry><refentrytitle>mandos</refentrytitle>
329
660
      <manvolnum>8</manvolnum></citerefentry>,
330
661
      <citerefentry><refentrytitle>password-prompt</refentrytitle>
331
662
      <manvolnum>8mandos</manvolnum></citerefentry>,
332
 
      <citerefentry><refentrytitle>password-request</refentrytitle>
 
663
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
333
664
      <manvolnum>8mandos</manvolnum></citerefentry>
334
665
    </para>
335
666
  </refsect1>
336
 
 
 
667
  
337
668
</refentry>
338
669
<!-- Local Variables: -->
339
670
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->