/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos-client.xml

  • Committer: Björn Påhlsson
  • Date: 2008-08-10 18:04:51 UTC
  • mto: (237.7.1 mandos) (24.1.154 mandos)
  • mto: This revision was merged to the branch mainline in revision 63.
  • Revision ID: belorn@braxen-20080810180451-fxxcjsd9xd7p2qah
Added all sections needed for mandos-client manual page

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