/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 plugin-runner.xml

  • Committer: Teddy Hogeborn
  • Date: 2008-08-31 13:55:04 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080831135504-2ka1cccglsghslxy
* plugin-runner.xml (/refentry/refentryinfo/copyright): Split
                                                        copyright
                                                        holders.
* plugins.d/password-request.xml (/refentry/refentryinfo/copyright):
                                 Split copyright holders.

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugin-runner.xml
1
 
<?xml version="1.0" encoding="UTF-8"?>
 
1
<?xml version='1.0' encoding='UTF-8'?>
 
2
<?xml-stylesheet type="text/xsl"
 
3
        href="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl"?>
2
4
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
5
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
6
<!ENTITY VERSION "1.0">
5
7
<!ENTITY COMMANDNAME "plugin-runner">
6
 
<!ENTITY TIMESTAMP "2008-09-01">
 
8
<!ENTITY TIMESTAMP "2008-08-31">
7
9
]>
8
10
 
9
 
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
 
11
<refentry>
10
12
  <refentryinfo>
11
13
    <title>Mandos Manual</title>
12
 
    <!-- Nwalsh’s docbook scripts use this to generate the footer: -->
 
14
    <!-- NWalsh's docbook scripts use this to generate the footer: -->
13
15
    <productname>Mandos</productname>
14
16
    <productnumber>&VERSION;</productnumber>
15
17
    <date>&TIMESTAMP;</date>
34
36
      <holder>Teddy Hogeborn</holder>
35
37
      <holder>Björn Påhlsson</holder>
36
38
    </copyright>
37
 
    <xi:include href="legalnotice.xml"/>
 
39
    <legalnotice>
 
40
      <para>
 
41
        This manual page is free software: you can redistribute it
 
42
        and/or modify it under the terms of the GNU General Public
 
43
        License as published by the Free Software Foundation,
 
44
        either version 3 of the License, or (at your option) any
 
45
        later version.
 
46
      </para>
 
47
 
 
48
      <para>
 
49
        This manual page is distributed in the hope that it will
 
50
        be useful, but WITHOUT ANY WARRANTY; without even the
 
51
        implied warranty of MERCHANTABILITY or FITNESS FOR A
 
52
        PARTICULAR PURPOSE.  See the GNU General Public License
 
53
        for more details.
 
54
      </para>
 
55
 
 
56
      <para>
 
57
        You should have received a copy of the GNU General Public
 
58
        License along with this program; If not, see
 
59
        <ulink url="http://www.gnu.org/licenses/"/>.
 
60
      </para>
 
61
    </legalnotice>
38
62
  </refentryinfo>
39
63
 
40
64
  <refmeta>
53
77
    <cmdsynopsis>
54
78
      <command>&COMMANDNAME;</command>
55
79
      <group rep="repeat">
56
 
        <arg choice="plain"><option>--global-env=<replaceable
 
80
        <arg choice="plain"><option>--global-envs=<replaceable
57
81
        >VAR</replaceable><literal>=</literal><replaceable
58
82
        >value</replaceable></option></arg>
59
83
        <arg choice="plain"><option>-e
62
86
      </group>
63
87
      <sbr/>
64
88
      <group rep="repeat">
65
 
        <arg choice="plain"><option>--env-for=<replaceable
 
89
        <arg choice="plain"><option>--envs-for=<replaceable
66
90
        >PLUGIN</replaceable><literal>:</literal><replaceable
67
91
        >ENV</replaceable><literal>=</literal><replaceable
68
92
        >value</replaceable></option></arg>
109
133
    <cmdsynopsis>
110
134
      <command>&COMMANDNAME;</command>
111
135
      <group choice="req">
112
 
        <arg choice="plain"><option>--help</option></arg>
113
 
        <arg choice="plain"><option>-?</option></arg>
 
136
        <arg choice='plain'><option>--help</option></arg>
 
137
        <arg choice='plain'><option>-?</option></arg>
114
138
      </group>
115
139
    </cmdsynopsis>
116
140
    <cmdsynopsis>
117
141
      <command>&COMMANDNAME;</command>
118
 
      <arg choice="plain"><option>--usage</option></arg>
 
142
      <arg choice='plain'><option>--usage</option></arg>
119
143
    </cmdsynopsis>
120
144
    <cmdsynopsis>
121
145
      <command>&COMMANDNAME;</command>
122
146
      <group choice="req">
123
 
        <arg choice="plain"><option>--version</option></arg>
124
 
        <arg choice="plain"><option>-V</option></arg>
 
147
        <arg choice='plain'><option>--version</option></arg>
 
148
        <arg choice='plain'><option>-V</option></arg>
125
149
      </group>
126
150
    </cmdsynopsis>
127
151
  </refsynopsisdiv>
128
 
  
 
152
 
129
153
  <refsect1 id="description">
130
154
    <title>DESCRIPTION</title>
131
155
    <para>
132
 
      <command>&COMMANDNAME;</command> is a program which is meant to
133
 
      be specified as <quote>keyscript</quote> in <citerefentry>
134
 
      <refentrytitle>crypttab</refentrytitle>
135
 
      <manvolnum>5</manvolnum></citerefentry> for the root disk.  The
136
 
      aim of this program is therefore to output a password, which
137
 
      then <citerefentry><refentrytitle>cryptsetup</refentrytitle>
138
 
      <manvolnum>8</manvolnum></citerefentry> will use to try and
139
 
      unlock the root disk.
140
 
    </para>
141
 
    <para>
142
 
      This program is not meant to be invoked directly, but can be in
143
 
      order to test it.  Note that any password obtained will simply
144
 
      be output on standard output.
145
 
    </para>
146
 
  </refsect1>
147
 
  
148
 
  <refsect1 id="purpose">
149
 
    <title>PURPOSE</title>
150
 
    <para>
151
 
      The purpose of this is to enable <emphasis>remote and unattended
152
 
      rebooting</emphasis> of client host computer with an
153
 
      <emphasis>encrypted root file system</emphasis>.  See <xref
154
 
      linkend="overview"/> for details.
155
 
    </para>
156
 
  </refsect1>
157
 
  
 
156
      <command>&COMMANDNAME;</command> is a plugin runner that waits
 
157
      for any of its plugins to return sucessfull with a password, and
 
158
      passes it to cryptsetup as stdout message. This command is not
 
159
      meant to be invoked directly, but is instead meant to be run by
 
160
      cryptsetup by being specified in /etc/crypttab as a keyscript
 
161
      and subsequlently started in the initrd environment. See
 
162
      <citerefentry><refentrytitle>crypttab</refentrytitle>
 
163
      <manvolnum>5</manvolnum></citerefentry> for more information on
 
164
      keyscripts.
 
165
    </para>
 
166
 
 
167
    <para>
 
168
      plugins is looked for in the plugins directory which by default will be
 
169
      /conf/conf.d/mandos/plugins.d if not changed by option --plugin-dir.
 
170
    </para>
 
171
  </refsect1>
158
172
  <refsect1>
159
173
    <title>OPTIONS</title>
160
174
    <variablelist>
161
175
      <varlistentry>
162
 
        <term><option>--global-env
163
 
        <replaceable>VAR</replaceable><literal>=</literal><replaceable
164
 
        >value</replaceable></option></term>
165
 
        <term><option>-e
166
 
        <replaceable>VAR</replaceable><literal>=</literal><replaceable
167
 
        >value</replaceable></option></term>
168
 
        <listitem>
169
 
          <para>
170
 
            
171
 
          </para>
172
 
        </listitem>
173
 
      </varlistentry>
174
 
      
175
 
      <varlistentry>
176
 
        <term><option>--env-for
177
 
        <replaceable>PLUGIN</replaceable><literal>:</literal
178
 
        ><replaceable>ENV</replaceable><literal>=</literal
179
 
        ><replaceable>value</replaceable></option></term>
180
 
        <term><option>-f
181
 
        <replaceable>PLUGIN</replaceable><literal>:</literal
182
 
        ><replaceable>ENV</replaceable><literal>=</literal
183
 
        ><replaceable>value</replaceable></option></term>
184
 
        <listitem>
185
 
          <para>
186
 
          </para>
187
 
        </listitem>
188
 
      </varlistentry>
189
 
      
190
 
      <varlistentry>
191
176
        <term><option>--global-options
192
177
        <replaceable>OPTIONS</replaceable></option></term>
193
178
        <term><option>-g
194
179
        <replaceable>OPTIONS</replaceable></option></term>
195
180
        <listitem>
196
181
          <para>
197
 
            Pass some options to <emphasis>all</emphasis> plugins.
198
 
            <replaceable>OPTIONS</replaceable> is a comma separated
199
 
            list of options.  This is not a very useful option, except
200
 
            for specifying the <quote><option>--debug</option></quote>
201
 
            for all plugins.
202
 
          </para>
 
182
            Global options given to all plugins as additional start
 
183
            arguments.  Options are specified with a -o flag followed
 
184
            by a comma separated string of options.
 
185
          </para>       
203
186
        </listitem>
204
187
      </varlistentry>
205
 
      
 
188
 
206
189
      <varlistentry>
207
190
        <term><option>--options-for
208
191
        <replaceable>PLUGIN</replaceable><literal>:</literal
212
195
        ><replaceable>OPTION</replaceable></option></term>
213
196
        <listitem>
214
197
          <para>
215
 
            Pass some options to a specific plugin.  <replaceable
216
 
            >PLUGIN</replaceable> is the name (file basename) of a
217
 
            plugin, and <replaceable>OPTIONS</replaceable> is a comma
218
 
            separated list of options.
219
 
          </para>
220
 
          <para>
221
 
            Note that since options are not split on whitespace, the
222
 
            way to pass, to the plugin
223
 
            <quote><filename>foo</filename></quote>, the option
224
 
            <option>--bar</option> with the option argument
225
 
            <quote>baz</quote> is either
226
 
            <userinput>--options-for=foo:--bar=baz</userinput> or
227
 
            <userinput>--options-for=foo:--bar,baz</userinput>, but
228
 
            <emphasis>not</emphasis>
229
 
            <userinput>--options-for="foo:--bar baz"</userinput>.
230
 
          </para>
 
198
            Plugin specific options given to the plugin as additional
 
199
            start arguments.  Options are specified with a -o flag
 
200
            followed by a comma separated string of options.
 
201
          </para>       
231
202
        </listitem>
232
203
      </varlistentry>
233
204
 
238
209
        <replaceable>PLUGIN</replaceable></option></term>
239
210
        <listitem>
240
211
          <para>
241
 
            Disable the plugin named
242
 
            <replaceable>PLUGIN</replaceable>.  The plugin will not be
243
 
            started.
 
212
            Disable a specific plugin
244
213
          </para>       
245
214
        </listitem>
246
215
      </varlistentry>
250
219
        <replaceable>ID</replaceable></option></term>
251
220
        <listitem>
252
221
          <para>
253
 
            Change to group ID <replaceable>ID</replaceable> on
254
 
            startup.  The default is 65534.  All plugins will be
255
 
            started using this group ID.  <emphasis>Note:</emphasis>
256
 
            This must be a number, not a name.
 
222
            Group ID the plugins will run as
257
223
          </para>
258
224
        </listitem>
259
225
      </varlistentry>
263
229
        <replaceable>ID</replaceable></option></term>
264
230
        <listitem>
265
231
          <para>
266
 
            Change to user ID <replaceable>ID</replaceable> on
267
 
            startup.  The default is 65534.  All plugins will be
268
 
            started using this user ID.  <emphasis>Note:</emphasis>
269
 
            This must be a number, not a name.
 
232
            User ID the plugins will run as
270
233
          </para>
271
234
        </listitem>
272
235
      </varlistentry>
276
239
        <replaceable>DIRECTORY</replaceable></option></term>
277
240
        <listitem>
278
241
          <para>
279
 
            Specify a different plugin directory.  The default is
280
 
            <filename>/lib/mandos/plugins.d</filename>, which will
281
 
            exist in the initial <acronym>RAM</acronym> disk
282
 
            environment.
 
242
            Specify a different plugin directory
283
243
          </para>
284
244
        </listitem>
285
245
      </varlistentry>
288
248
        <term><option>--debug</option></term>
289
249
        <listitem>
290
250
          <para>
291
 
            Enable debug mode.  This will enable a lot of output to
292
 
            standard error about what the program is doing.  The
293
 
            program will still perform all other functions normally.
294
 
            The default is to <emphasis>not</emphasis> run in debug
295
 
            mode.
296
 
          </para>
297
 
          <para>
298
 
            The plugins will <emphasis>not</emphasis> be affected by
299
 
            this option.  Use
300
 
            <userinput><option>--global-options=--debug</option></userinput>
301
 
            if complete debugging eruption is desired.
 
251
            Debug mode
302
252
          </para>
303
253
        </listitem>
304
254
      </varlistentry>
308
258
        <term><option>-?</option></term>
309
259
        <listitem>
310
260
          <para>
311
 
            Gives a help message about options and their meanings.
 
261
            Gives a help message
312
262
          </para>
313
263
        </listitem>
314
264
      </varlistentry>
317
267
        <term><option>--usage</option></term>
318
268
        <listitem>
319
269
          <para>
320
 
            Gives a short usage message.
 
270
            Gives a short usage message
321
271
          </para>
322
272
        </listitem>
323
273
      </varlistentry>
327
277
        <term><option>-V</option></term>
328
278
        <listitem>
329
279
          <para>
330
 
            Prints the program version.
 
280
            Prints the program version
331
281
          </para>
332
282
        </listitem>
333
283
      </varlistentry>
334
284
    </variablelist>
335
285
  </refsect1>
336
286
 
337
 
  <refsect1 id="overview">
338
 
    <title>OVERVIEW</title>
339
 
    <xi:include href="overview.xml"/>
340
 
    <para>
341
 
      This program will run on the client side in the initial
342
 
      <acronym>RAM</acronym> disk environment, and is responsible for
343
 
      getting a password.  It does this by running plugins, one of
344
 
      which will normally be the actual client program communicating
345
 
      with the server.
346
 
    </para>
347
 
  </refsect1>
348
 
  <refsect1 id="plugins">
349
 
    <title>PLUGINS</title>
350
 
    <para>
351
 
      This program will get a password by running a number of
352
 
      <firstterm>plugins</firstterm>, which are simply executable
353
 
      programs in a directory in the initial <acronym>RAM</acronym>
354
 
      disk environment.  The default directory is
355
 
      <filename>/lib/mandos/plugins.d</filename>, but this can be
356
 
      changed with the <option>--plugin-dir</option> option.  The
357
 
      plugins are started in parallel, and the first plugin to output
358
 
      a password <emphasis>and</emphasis> exit with a successful exit
359
 
      code will make this plugin-runner output the password from that
360
 
      plugin, stop any other plugins, and exit.
361
 
    </para>
362
 
  </refsect1>
363
 
  
364
 
  <refsect1 id="fallback">
365
 
    <title>FALLBACK</title>
366
 
    <para>
367
 
      If no plugins succeed, this program will, as a fallback, ask for
368
 
      a password on the console using <citerefentry><refentrytitle
369
 
      >getpass</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
370
 
      and output it.  This is not meant to be the normal mode of
371
 
      operation, as there is a separate plugin for getting a password
372
 
      from the console.
373
 
    </para>
374
 
  </refsect1>
375
 
  
376
287
  <refsect1 id="exit_status">
377
288
    <title>EXIT STATUS</title>
378
289
    <para>
379
 
      Exit status of this program is zero if no errors were
380
 
      encountered, and otherwise not.  The fallback (see <xref
381
 
      linkend="fallback"/>) may or may not have succeeded in either
382
 
      case.
383
 
    </para>
384
 
  </refsect1>
385
 
  
386
 
  <refsect1 id="environment">
387
 
    <title>ENVIRONMENT</title>
388
 
    <para>
389
 
      
390
 
    </para>
391
 
  </refsect1>
392
 
  
 
290
    </para>
 
291
  </refsect1>
 
292
 
393
293
  <refsect1 id="file">
394
294
    <title>FILES</title>
395
295
    <para>
396
 
      <variablelist>
397
 
        <varlistentry>
398
 
          <term><filename
399
 
          >/conf/conf.d/mandos/plugin-runner.conf</filename></term>
400
 
          <listitem>
401
 
            <para>
402
 
              Since this program will be run as a keyscript, there is
403
 
              little to no opportunity to pass command line arguments
404
 
              to it.  Therefore, it will <emphasis>also</emphasis>
405
 
              read this file and use its contents as
406
 
              whitespace-separated command line options.  Also,
407
 
              everything from a <quote>#</quote> character to the end
408
 
              of a line is ignored.
409
 
            </para>
410
 
          </listitem>
411
 
        </varlistentry>
412
 
      </variablelist>
 
296
    </para>
 
297
  </refsect1>
 
298
 
 
299
  <refsect1 id="notes">
 
300
    <title>NOTES</title>
 
301
    <para>
413
302
    </para>
414
303
  </refsect1>
415
304
  
418
307
    <para>
419
308
    </para>
420
309
  </refsect1>
421
 
  
 
310
 
422
311
  <refsect1 id="examples">
423
312
    <title>EXAMPLE</title>
424
313
    <para>
425
314
    </para>
426
315
  </refsect1>
427
 
  
 
316
 
428
317
  <refsect1 id="security">
429
318
    <title>SECURITY</title>
430
319
    <para>
431
320
    </para>
432
321
  </refsect1>
433
 
  
 
322
 
434
323
  <refsect1 id="see_also">
435
324
    <title>SEE ALSO</title>
436
325
    <para>
444
333
      <manvolnum>8mandos</manvolnum></citerefentry>
445
334
    </para>
446
335
  </refsect1>
447
 
  
 
336
 
448
337
</refentry>
449
338
<!-- Local Variables: -->
450
339
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->