/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 mandos-client.xml

synopsis changed

Show diffs side-by-side

added added

removed removed

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