/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

Added configuration files support for mandos-client
Removed plus argument support for mandos-client

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