/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: 2008-08-30 11:39:54 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080830113954-sbvgeq7z0wkdvz17
* mandos-keygen.xml (ENVIRONMENT): Replaced <varname> with <envar>.
* mandos.xml (ENVIRONMENT): - '' -

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugin-runner.xml
1
 
<?xml version="1.0" encoding="UTF-8"?>
 
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"?>
2
4
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
5
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
 
6
<!ENTITY VERSION "1.0">
4
7
<!ENTITY COMMANDNAME "plugin-runner">
5
 
<!ENTITY TIMESTAMP "2016-03-17">
6
 
<!ENTITY % common SYSTEM "common.ent">
7
 
%common;
 
8
<!ENTITY TIMESTAMP "2008-08-29">
8
9
]>
9
10
 
10
 
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
 
11
<refentry>
11
12
  <refentryinfo>
12
13
    <title>Mandos Manual</title>
13
 
    <!-- Nwalsh’s docbook scripts use this to generate the footer: -->
 
14
    <!-- NWalsh's docbook scripts use this to generate the footer: -->
14
15
    <productname>Mandos</productname>
15
 
    <productnumber>&version;</productnumber>
 
16
    <productnumber>&VERSION;</productnumber>
16
17
    <date>&TIMESTAMP;</date>
17
18
    <authorgroup>
18
19
      <author>
19
20
        <firstname>Björn</firstname>
20
21
        <surname>Påhlsson</surname>
21
22
        <address>
22
 
          <email>belorn@recompile.se</email>
 
23
          <email>belorn@fukt.bsnet.se</email>
23
24
        </address>
24
25
      </author>
25
26
      <author>
26
27
        <firstname>Teddy</firstname>
27
28
        <surname>Hogeborn</surname>
28
29
        <address>
29
 
          <email>teddy@recompile.se</email>
 
30
          <email>teddy@fukt.bsnet.se</email>
30
31
        </address>
31
32
      </author>
32
33
    </authorgroup>
33
34
    <copyright>
34
35
      <year>2008</year>
35
 
      <year>2009</year>
36
 
      <year>2010</year>
37
 
      <year>2011</year>
38
 
      <year>2012</year>
39
 
      <year>2013</year>
40
 
      <year>2014</year>
41
 
      <year>2015</year>
42
 
      <year>2016</year>
43
 
      <holder>Teddy Hogeborn</holder>
44
 
      <holder>Björn Påhlsson</holder>
 
36
      <holder>Teddy Hogeborn &amp; Björn Påhlsson</holder>
45
37
    </copyright>
46
 
    <xi:include href="legalnotice.xml"/>
 
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>
47
61
  </refentryinfo>
48
 
  
 
62
 
49
63
  <refmeta>
50
64
    <refentrytitle>&COMMANDNAME;</refentrytitle>
51
65
    <manvolnum>8mandos</manvolnum>
54
68
  <refnamediv>
55
69
    <refname><command>&COMMANDNAME;</command></refname>
56
70
    <refpurpose>
57
 
      Run Mandos plugins, pass data from first to succeed.
 
71
      get password for encrypted rootdisk
58
72
    </refpurpose>
59
73
  </refnamediv>
60
 
  
 
74
 
61
75
  <refsynopsisdiv>
62
76
    <cmdsynopsis>
63
77
      <command>&COMMANDNAME;</command>
64
 
      <group rep="repeat">
65
 
        <arg choice="plain"><option>--global-env=<replaceable
66
 
        >ENV</replaceable><literal>=</literal><replaceable
67
 
        >value</replaceable></option></arg>
68
 
        <arg choice="plain"><option>-G
69
 
        <replaceable>ENV</replaceable><literal>=</literal><replaceable
70
 
        >value</replaceable> </option></arg>
71
 
      </group>
72
 
      <sbr/>
73
 
      <group rep="repeat">
74
 
        <arg choice="plain"><option>--env-for=<replaceable
75
 
        >PLUGIN</replaceable><literal>:</literal><replaceable
76
 
        >ENV</replaceable><literal>=</literal><replaceable
77
 
        >value</replaceable></option></arg>
78
 
        <arg choice="plain"><option>-E<replaceable>
79
 
        PLUGIN</replaceable><literal>:</literal><replaceable
80
 
        >ENV</replaceable><literal>=</literal><replaceable
81
 
        >value</replaceable> </option></arg>
82
 
      </group>
83
 
      <sbr/>
84
 
      <group rep="repeat">
85
 
        <arg choice="plain"><option>--global-options=<replaceable
86
 
        >OPTIONS</replaceable></option></arg>
87
 
        <arg choice="plain"><option>-g<replaceable>
88
 
        OPTIONS</replaceable> </option></arg>
89
 
      </group>
90
 
      <sbr/>
91
 
      <group rep="repeat">
92
 
        <arg choice="plain"><option>--options-for=<replaceable
93
 
        >PLUGIN</replaceable><literal>:</literal><replaceable
94
 
        >OPTIONS</replaceable></option></arg>
95
 
        <arg choice="plain"><option>-o<replaceable>
96
 
        PLUGIN</replaceable><literal>:</literal><replaceable
97
 
        >OPTIONS</replaceable> </option></arg>
98
 
      </group>
99
 
      <sbr/>
100
 
      <group rep="repeat">
101
 
        <arg choice="plain"><option>--disable=<replaceable
102
 
        >PLUGIN</replaceable></option></arg>
103
 
        <arg choice="plain"><option>-d
104
 
        <replaceable>PLUGIN</replaceable> </option></arg>
105
 
      </group>
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/>
114
 
      <arg><option>--groupid=<replaceable
115
 
      >ID</replaceable></option></arg>
116
 
      <sbr/>
117
 
      <arg><option>--userid=<replaceable
118
 
      >ID</replaceable></option></arg>
119
 
      <sbr/>
120
 
      <arg><option>--plugin-dir=<replaceable
121
 
      >DIRECTORY</replaceable></option></arg>
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/>
129
 
      <arg><option>--debug</option></arg>
130
 
    </cmdsynopsis>
131
 
    <cmdsynopsis>
132
 
      <command>&COMMANDNAME;</command>
133
 
      <group choice="req">
134
 
        <arg choice="plain"><option>--help</option></arg>
135
 
        <arg choice="plain"><option>-?</option></arg>
136
 
      </group>
137
 
    </cmdsynopsis>
138
 
    <cmdsynopsis>
139
 
      <command>&COMMANDNAME;</command>
140
 
      <arg choice="plain"><option>--usage</option></arg>
141
 
    </cmdsynopsis>
142
 
    <cmdsynopsis>
143
 
      <command>&COMMANDNAME;</command>
144
 
      <group choice="req">
145
 
        <arg choice="plain"><option>--version</option></arg>
146
 
        <arg choice="plain"><option>-V</option></arg>
147
 
      </group>
148
 
    </cmdsynopsis>
 
78
      <arg choice='opt'>--global-options<arg choice='plain'>OPTIONS</arg></arg>
 
79
      <arg choice='opt'>--options-for<arg choice='plain'>PLUGIN:OPTIONS</arg></arg>
 
80
      <arg choice='opt'>--disable<arg choice='plain'>PLUGIN</arg></arg>
 
81
      <arg choice='opt'>--groupid<arg choice='plain'>ID</arg></arg>
 
82
      <arg choice='opt'>--userid<arg choice='plain'>ID</arg></arg>
 
83
      <arg choice='opt'>--plugin-dir<arg choice='plain'>DIRECTORY</arg></arg>
 
84
      <arg choice='opt'>--debug</arg>
 
85
    </cmdsynopsis>
 
86
    <cmdsynopsis>
 
87
      <command>&COMMANDNAME;</command>
 
88
      <arg choice='plain'>--help</arg>
 
89
    </cmdsynopsis>
 
90
    <cmdsynopsis>
 
91
      <command>&COMMANDNAME;</command>
 
92
      <arg choice='plain'>--usage</arg>
 
93
    </cmdsynopsis>
 
94
    <cmdsynopsis>
 
95
      <command>&COMMANDNAME;</command>
 
96
      <arg choice='plain'>--version</arg>
 
97
    </cmdsynopsis>    
149
98
  </refsynopsisdiv>
150
 
  
 
99
 
151
100
  <refsect1 id="description">
152
101
    <title>DESCRIPTION</title>
153
102
    <para>
154
 
      <command>&COMMANDNAME;</command> is a program which is meant to
155
 
      be specified as a <quote>keyscript</quote> for the root disk in
 
103
      <command>&COMMANDNAME;</command> is a plugin runner that waits
 
104
      for any of its plugins to return sucessfull with a password, and
 
105
      passes it to cryptsetup as stdout message. This command is not
 
106
      meant to be invoked directly, but is instead meant to be run by
 
107
      cryptsetup by being specified in /etc/crypttab as a keyscript
 
108
      and subsequlently started in the initrd environment. See
156
109
      <citerefentry><refentrytitle>crypttab</refentrytitle>
157
 
      <manvolnum>5</manvolnum></citerefentry>.  The aim of this
158
 
      program is therefore to output a password, which then
159
 
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
160
 
      <manvolnum>8</manvolnum></citerefentry> will use to unlock the
161
 
      root disk.
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
 
  
 
110
      <manvolnum>5</manvolnum></citerefentry> for more information on
 
111
      keyscripts.    
 
112
    </para>
 
113
 
 
114
    <para>
 
115
      plugins is looked for in the plugins directory which by default will be
 
116
      /conf/conf.d/mandos/plugins.d if not changed by option --plugin-dir.
 
117
    </para>
 
118
  </refsect1>
180
119
  <refsect1>
181
120
    <title>OPTIONS</title>
182
121
    <variablelist>
183
122
      <varlistentry>
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.
402
 
          </para>
403
 
        </listitem>
404
 
      </varlistentry>
 
123
        <term><literal>-g</literal>,<literal>--global-options
 
124
        <replaceable>OPTIONS</replaceable></literal></term>
 
125
        <listitem>
 
126
          <para>
 
127
            Global options given to all plugins as additional start
 
128
            arguments.  Options are specified with a -o flag followed
 
129
            by a comma separated string of options.
 
130
          </para>         
 
131
        </listitem>
 
132
      </varlistentry>
 
133
 
 
134
      <varlistentry>
 
135
        <term><literal>-o</literal>,<literal> --options-for
 
136
        <replaceable>PLUGIN</replaceable>:<replaceable>OPTION</replaceable>
 
137
        </literal></term>
 
138
        <listitem>
 
139
          <para>
 
140
            Plugin specific options given to the plugin as additional
 
141
            start arguments.  Options are specified with a -o flag
 
142
            followed by a comma separated string of options.
 
143
          </para>         
 
144
        </listitem>
 
145
      </varlistentry>      
 
146
 
 
147
      <varlistentry>
 
148
        <term><literal>-d</literal>,<literal> --disable
 
149
        <replaceable>PLUGIN</replaceable>
 
150
        </literal></term>
 
151
        <listitem>
 
152
          <para>
 
153
            Disable a specific plugin
 
154
          </para>         
 
155
        </listitem>
 
156
      </varlistentry>
 
157
 
 
158
      <varlistentry>
 
159
        <term><literal>--groupid <replaceable>ID</replaceable>
 
160
        </literal></term>
 
161
        <listitem>
 
162
          <para>
 
163
            Group ID the plugins will run as
 
164
          </para>
 
165
        </listitem>
 
166
      </varlistentry>      
 
167
 
 
168
      <varlistentry>
 
169
        <term><literal>--userid <replaceable>ID</replaceable>
 
170
        </literal></term>
 
171
        <listitem>
 
172
          <para>
 
173
            User ID the plugins will run as
 
174
          </para>
 
175
        </listitem>
 
176
      </varlistentry>      
 
177
 
 
178
      <varlistentry>
 
179
        <term><literal>--plugin-dir <replaceable>DIRECTORY</replaceable>
 
180
        </literal></term>
 
181
        <listitem>
 
182
          <para>
 
183
            Specify a different plugin directory
 
184
          </para>
 
185
        </listitem>
 
186
      </varlistentry>       
 
187
      
 
188
      <varlistentry>
 
189
        <term><literal>--debug</literal></term>
 
190
        <listitem>
 
191
          <para>
 
192
            Debug mode
 
193
          </para>
 
194
        </listitem>
 
195
      </varlistentry>
 
196
      
 
197
      <varlistentry>
 
198
        <term><literal>-?</literal>, <literal>--help</literal></term>
 
199
        <listitem>
 
200
          <para>
 
201
            Gives a help message
 
202
          </para>
 
203
        </listitem>
 
204
      </varlistentry>
 
205
      
 
206
      <varlistentry>
 
207
        <term><literal>--usage</literal></term>
 
208
        <listitem>
 
209
          <para>
 
210
            Gives a short usage message
 
211
          </para>
 
212
        </listitem>
 
213
      </varlistentry>
 
214
 
 
215
      <varlistentry>
 
216
        <term><literal>-V</literal>, <literal>--version</literal></term>
 
217
        <listitem>
 
218
          <para>
 
219
            Prints the program version
 
220
          </para>
 
221
        </listitem>
 
222
      </varlistentry>            
405
223
    </variablelist>
406
224
  </refsect1>
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
 
  
 
225
 
489
226
  <refsect1 id="exit_status">
490
227
    <title>EXIT STATUS</title>
491
228
    <para>
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">
 
229
    </para>
 
230
  </refsect1>
 
231
 
 
232
  <refsect1 id="file">
513
233
    <title>FILES</title>
514
234
    <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>
 
235
    </para>
 
236
  </refsect1>  
 
237
 
 
238
  <refsect1 id="notes">
 
239
    <title>NOTES</title>
 
240
    <para>
568
241
    </para>
569
242
  </refsect1>
570
243
  
571
244
  <refsect1 id="bugs">
572
245
    <title>BUGS</title>
573
246
    <para>
574
 
      The <option>--config-file</option> option is ignored when
575
 
      specified from within a configuration file.
576
247
    </para>
577
 
    <xi:include href="bugs.xml"/>
578
 
  </refsect1>
579
 
  
 
248
  </refsect1>  
 
249
 
580
250
  <refsect1 id="examples">
581
251
    <title>EXAMPLE</title>
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>
 
252
    <para>
 
253
    </para>
639
254
  </refsect1>
 
255
 
640
256
  <refsect1 id="security">
641
257
    <title>SECURITY</title>
642
258
    <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"/>).
667
259
    </para>
668
260
  </refsect1>
669
 
  
 
261
 
670
262
  <refsect1 id="see_also">
671
263
    <title>SEE ALSO</title>
672
264
    <para>
673
 
      <citerefentry><refentrytitle>intro</refentrytitle>
674
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
675
265
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
676
266
      <manvolnum>8</manvolnum></citerefentry>,
677
 
      <citerefentry><refentrytitle>crypttab</refentrytitle>
678
 
      <manvolnum>5</manvolnum></citerefentry>,
679
 
      <citerefentry><refentrytitle>execve</refentrytitle>
680
 
      <manvolnum>2</manvolnum></citerefentry>,
681
267
      <citerefentry><refentrytitle>mandos</refentrytitle>
682
268
      <manvolnum>8</manvolnum></citerefentry>,
683
269
      <citerefentry><refentrytitle>password-prompt</refentrytitle>
684
270
      <manvolnum>8mandos</manvolnum></citerefentry>,
685
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
271
      <citerefentry><refentrytitle>password-request</refentrytitle>
686
272
      <manvolnum>8mandos</manvolnum></citerefentry>
687
273
    </para>
688
274
  </refsect1>
689
 
  
 
275
 
690
276
</refentry>
691
277
<!-- Local Variables: -->
692
278
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->