/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: 2010-10-11 18:17:25 UTC
  • mfrom: (237.4.12 mandos-release)
  • Revision ID: teddy@fukt.bsnet.se-20101011181725-ud266ctjhu3s730q
Merge from release branch.

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