/mandos/trunk

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/trunk

« back to all changes in this revision

Viewing changes to plugin-runner.xml

  • Committer: Teddy Hogeborn
  • Date: 2016-03-23 07:11:22 UTC
  • Revision ID: teddy@recompile.se-20160323071122-55srtjdizr21rr7f
Use HTTPS in home page links

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

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

Show diffs side-by-side

added added

removed removed

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