/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 08:47:38 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080831084738-uu70kayyt876982d
* mandos-keygen: Minor help text change.

* mandos-keygen.xml: Changed plural "keys" to singular "key"
                     throughout.
  (NAME): Improved wording.
  (DESCRIPTION): Improved wording.
  (OPTIONS): Split options in <term> tags into separate <term> tags.
             Use <option> tags.  Move long options before short
             options.  Uppercase replaceables.
  (OVERVIEW): Improved wording.
  (EXIT STATUS): Also cover --password option.
  (EXAMPLE): Add two examples using the --password option.
  (SECURITY): Improved wording.

* overview.xml: Improved wording.

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-30">
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>
31
33
    </authorgroup>
32
34
    <copyright>
33
35
      <year>2008</year>
34
 
      <holder>Teddy Hogeborn</holder>
35
 
      <holder>Björn Påhlsson</holder>
 
36
      <holder>Teddy Hogeborn &amp; Björn Påhlsson</holder>
36
37
    </copyright>
37
 
    <xi:include href="legalnotice.xml"/>
 
38
    <legalnotice>
 
39
      <para>
 
40
        This manual page is free software: you can redistribute it
 
41
        and/or modify it under the terms of the GNU General Public
 
42
        License as published by the Free Software Foundation,
 
43
        either version 3 of the License, or (at your option) any
 
44
        later version.
 
45
      </para>
 
46
 
 
47
      <para>
 
48
        This manual page is distributed in the hope that it will
 
49
        be useful, but WITHOUT ANY WARRANTY; without even the
 
50
        implied warranty of MERCHANTABILITY or FITNESS FOR A
 
51
        PARTICULAR PURPOSE.  See the GNU General Public License
 
52
        for more details.
 
53
      </para>
 
54
 
 
55
      <para>
 
56
        You should have received a copy of the GNU General Public
 
57
        License along with this program; If not, see
 
58
        <ulink url="http://www.gnu.org/licenses/"/>.
 
59
      </para>
 
60
    </legalnotice>
38
61
  </refentryinfo>
39
62
 
40
63
  <refmeta>
109
132
    <cmdsynopsis>
110
133
      <command>&COMMANDNAME;</command>
111
134
      <group choice="req">
112
 
        <arg choice="plain"><option>--help</option></arg>
113
 
        <arg choice="plain"><option>-?</option></arg>
 
135
        <arg choice='plain'><option>--help</option></arg>
 
136
        <arg choice='plain'><option>-?</option></arg>
114
137
      </group>
115
138
    </cmdsynopsis>
116
139
    <cmdsynopsis>
117
140
      <command>&COMMANDNAME;</command>
118
 
      <arg choice="plain"><option>--usage</option></arg>
 
141
      <arg choice='plain'><option>--usage</option></arg>
119
142
    </cmdsynopsis>
120
143
    <cmdsynopsis>
121
144
      <command>&COMMANDNAME;</command>
122
145
      <group choice="req">
123
 
        <arg choice="plain"><option>--version</option></arg>
124
 
        <arg choice="plain"><option>-V</option></arg>
 
146
        <arg choice='plain'><option>--version</option></arg>
 
147
        <arg choice='plain'><option>-V</option></arg>
125
148
      </group>
126
149
    </cmdsynopsis>
127
150
  </refsynopsisdiv>
128
 
  
 
151
 
129
152
  <refsect1 id="description">
130
153
    <title>DESCRIPTION</title>
131
154
    <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
 
  
 
155
      <command>&COMMANDNAME;</command> is a plugin runner that waits
 
156
      for any of its plugins to return sucessfull with a password, and
 
157
      passes it to cryptsetup as stdout message. This command is not
 
158
      meant to be invoked directly, but is instead meant to be run by
 
159
      cryptsetup by being specified in /etc/crypttab as a keyscript
 
160
      and subsequlently started in the initrd environment. See
 
161
      <citerefentry><refentrytitle>crypttab</refentrytitle>
 
162
      <manvolnum>5</manvolnum></citerefentry> for more information on
 
163
      keyscripts.
 
164
    </para>
 
165
 
 
166
    <para>
 
167
      plugins is looked for in the plugins directory which by default will be
 
168
      /conf/conf.d/mandos/plugins.d if not changed by option --plugin-dir.
 
169
    </para>
 
170
  </refsect1>
158
171
  <refsect1>
159
172
    <title>OPTIONS</title>
160
173
    <variablelist>
161
174
      <varlistentry>
162
 
        <term><option>--global-options
163
 
        <replaceable>OPTIONS</replaceable></option></term>
164
 
        <term><option>-g
165
 
        <replaceable>OPTIONS</replaceable></option></term>
166
 
        <listitem>
167
 
          <para>
168
 
            Pass some options to <emphasis>all</emphasis> plugins.
169
 
            <replaceable>OPTIONS</replaceable> is a comma separated
170
 
            list of options.  This is not a very useful option, except
171
 
            for specifying the <quote><option>--debug</option></quote>
172
 
            for all plugins.
173
 
          </para>
174
 
        </listitem>
175
 
      </varlistentry>
176
 
      
177
 
      <varlistentry>
178
 
        <term><option>--options-for
179
 
        <replaceable>PLUGIN</replaceable><literal>:</literal
180
 
        ><replaceable>OPTION</replaceable></option></term>
181
 
        <term><option>-o
182
 
        <replaceable>PLUGIN</replaceable><literal>:</literal
183
 
        ><replaceable>OPTION</replaceable></option></term>
184
 
        <listitem>
185
 
          <para>
186
 
            Pass some options to a specific plugin.  <replaceable
187
 
            >PLUGIN</replaceable> is the name (file basename) of a
188
 
            plugin, and <replaceable>OPTIONS</replaceable> is a comma
189
 
            separated list of options.
190
 
          </para>
191
 
          <para>
192
 
            Note that since options are not split on whitespace, the
193
 
            way to pass, to the plugin
194
 
            <quote><filename>foo</filename></quote>, the option
195
 
            <option>--bar</option> with the option argument
196
 
            <quote>baz</quote> is either
197
 
            <userinput>--options-for=foo:--bar=baz</userinput> or
198
 
            <userinput>--options-for=foo:--bar,baz</userinput>, but
199
 
            <emphasis>not</emphasis>
200
 
            <userinput>--options-for="foo:--bar baz"</userinput>.
201
 
          </para>
202
 
        </listitem>
203
 
      </varlistentry>
204
 
 
205
 
      <varlistentry>
206
 
        <term><option> --disable
207
 
        <replaceable>PLUGIN</replaceable></option></term>
208
 
        <term><option>-d
209
 
        <replaceable>PLUGIN</replaceable></option></term>
210
 
        <listitem>
211
 
          <para>
212
 
            Disable the plugin named
213
 
            <replaceable>PLUGIN</replaceable>.  The plugin will not be
214
 
            started.
215
 
          </para>       
216
 
        </listitem>
217
 
      </varlistentry>
218
 
 
219
 
      <varlistentry>
220
 
        <term><option>--groupid
221
 
        <replaceable>ID</replaceable></option></term>
222
 
        <listitem>
223
 
          <para>
224
 
            Change to group ID <replaceable>ID</replaceable> on
225
 
            startup.  The default is 65534.  All plugins will be
226
 
            started using this group ID.  <emphasis>Note:</emphasis>
227
 
            This must be a number, not a name.
228
 
          </para>
229
 
        </listitem>
230
 
      </varlistentry>
231
 
 
232
 
      <varlistentry>
233
 
        <term><option>--userid
234
 
        <replaceable>ID</replaceable></option></term>
235
 
        <listitem>
236
 
          <para>
237
 
            Change to user ID <replaceable>ID</replaceable> on
238
 
            startup.  The default is 65534.  All plugins will be
239
 
            started using this user ID.  <emphasis>Note:</emphasis>
240
 
            This must be a number, not a name.
241
 
          </para>
242
 
        </listitem>
243
 
      </varlistentry>
244
 
 
245
 
      <varlistentry>
246
 
        <term><option>--plugin-dir
247
 
        <replaceable>DIRECTORY</replaceable></option></term>
248
 
        <listitem>
249
 
          <para>
250
 
            Specify a different plugin directory.  The default is
251
 
            <filename>/lib/mandos/plugins.d</filename>, which will
252
 
            exist in the initial <acronym>RAM</acronym> disk
253
 
            environment.
254
 
          </para>
255
 
        </listitem>
256
 
      </varlistentry>
257
 
      
258
 
      <varlistentry>
259
 
        <term><option>--debug</option></term>
260
 
        <listitem>
261
 
          <para>
262
 
            Enable debug mode.  This will enable a lot of output to
263
 
            standard error about what the program is doing.  The
264
 
            program will still perform all other functions normally.
265
 
            The default is to <emphasis>not</emphasis> run in debug
266
 
            mode.
267
 
          </para>
268
 
          <para>
269
 
            The plugins will <emphasis>not</emphasis> be affected by
270
 
            this option.  Use
271
 
            <userinput><option>--global-options=--debug</option></userinput>
272
 
            if complete debugging eruption is desired.
273
 
          </para>
274
 
        </listitem>
275
 
      </varlistentry>
276
 
      
277
 
      <varlistentry>
278
 
        <term><option>--help</option></term>
279
 
        <term><option>-?</option></term>
280
 
        <listitem>
281
 
          <para>
282
 
            Gives a help message about options and their meanings.
283
 
          </para>
284
 
        </listitem>
285
 
      </varlistentry>
286
 
      
287
 
      <varlistentry>
288
 
        <term><option>--usage</option></term>
289
 
        <listitem>
290
 
          <para>
291
 
            Gives a short usage message.
292
 
          </para>
293
 
        </listitem>
294
 
      </varlistentry>
295
 
 
296
 
      <varlistentry>
297
 
        <term><option>--version</option></term>
298
 
        <term><option>-V</option></term>
299
 
        <listitem>
300
 
          <para>
301
 
            Prints the program version.
 
175
        <term><literal>-g</literal>,<literal>--global-options
 
176
        <replaceable>OPTIONS</replaceable></literal></term>
 
177
        <listitem>
 
178
          <para>
 
179
            Global options given to all plugins as additional start
 
180
            arguments.  Options are specified with a -o flag followed
 
181
            by a comma separated string of options.
 
182
          </para>       
 
183
        </listitem>
 
184
      </varlistentry>
 
185
 
 
186
      <varlistentry>
 
187
        <term><literal>-o</literal>,<literal> --options-for
 
188
        <replaceable>PLUGIN</replaceable>:<replaceable>OPTION</replaceable>
 
189
        </literal></term>
 
190
        <listitem>
 
191
          <para>
 
192
            Plugin specific options given to the plugin as additional
 
193
            start arguments.  Options are specified with a -o flag
 
194
            followed by a comma separated string of options.
 
195
          </para>       
 
196
        </listitem>
 
197
      </varlistentry>
 
198
 
 
199
      <varlistentry>
 
200
        <term><literal>-d</literal>,<literal> --disable
 
201
        <replaceable>PLUGIN</replaceable>
 
202
        </literal></term>
 
203
        <listitem>
 
204
          <para>
 
205
            Disable a specific plugin
 
206
          </para>       
 
207
        </listitem>
 
208
      </varlistentry>
 
209
 
 
210
      <varlistentry>
 
211
        <term><literal>--groupid <replaceable>ID</replaceable>
 
212
        </literal></term>
 
213
        <listitem>
 
214
          <para>
 
215
            Group ID the plugins will run as
 
216
          </para>
 
217
        </listitem>
 
218
      </varlistentry>
 
219
 
 
220
      <varlistentry>
 
221
        <term><literal>--userid <replaceable>ID</replaceable>
 
222
        </literal></term>
 
223
        <listitem>
 
224
          <para>
 
225
            User ID the plugins will run as
 
226
          </para>
 
227
        </listitem>
 
228
      </varlistentry>
 
229
 
 
230
      <varlistentry>
 
231
        <term><literal>--plugin-dir <replaceable>DIRECTORY</replaceable>
 
232
        </literal></term>
 
233
        <listitem>
 
234
          <para>
 
235
            Specify a different plugin directory
 
236
          </para>
 
237
        </listitem>
 
238
      </varlistentry>
 
239
      
 
240
      <varlistentry>
 
241
        <term><literal>--debug</literal></term>
 
242
        <listitem>
 
243
          <para>
 
244
            Debug mode
 
245
          </para>
 
246
        </listitem>
 
247
      </varlistentry>
 
248
      
 
249
      <varlistentry>
 
250
        <term><literal>-?</literal>, <literal>--help</literal></term>
 
251
        <listitem>
 
252
          <para>
 
253
            Gives a help message
 
254
          </para>
 
255
        </listitem>
 
256
      </varlistentry>
 
257
      
 
258
      <varlistentry>
 
259
        <term><literal>--usage</literal></term>
 
260
        <listitem>
 
261
          <para>
 
262
            Gives a short usage message
 
263
          </para>
 
264
        </listitem>
 
265
      </varlistentry>
 
266
 
 
267
      <varlistentry>
 
268
        <term><literal>-V</literal>, <literal>--version</literal></term>
 
269
        <listitem>
 
270
          <para>
 
271
            Prints the program version
302
272
          </para>
303
273
        </listitem>
304
274
      </varlistentry>
305
275
    </variablelist>
306
276
  </refsect1>
307
277
 
308
 
  <refsect1 id="overview">
309
 
    <title>OVERVIEW</title>
310
 
    <xi:include href="overview.xml"/>
311
 
    <para>
312
 
      This program will run on the client side in the initial
313
 
      <acronym>RAM</acronym> disk environment, and is responsible for
314
 
      getting a password.  It does this by running plugins, one of
315
 
      which will normally be the actual client program communicating
316
 
      with the server.
317
 
    </para>
318
 
  </refsect1>
319
 
  <refsect1 id="plugins">
320
 
    <title>PLUGINS</title>
321
 
    <para>
322
 
      This program will get a password by running a number of
323
 
      <firstterm>plugins</firstterm>, which are simply executable
324
 
      programs in a directory in the initial <acronym>RAM</acronym>
325
 
      disk environment.  The default directory is
326
 
      <filename>/lib/mandos/plugins.d</filename>, but this can be
327
 
      changed with the <option>--plugin-dir</option> option.  The
328
 
      plugins are started in parallel, and the first plugin to output
329
 
      a password and exit with a successful exit code will make this
330
 
      plugin-runner output that password, stop any other plugins, and
331
 
      exit.
332
 
    </para>
333
 
  </refsect1>
334
 
  
335
 
  <refsect1>
336
 
    <title>FALLBACK</title>
337
 
    <para>
338
 
    </para>
339
 
  </refsect1>
340
278
  <refsect1 id="exit_status">
341
279
    <title>EXIT STATUS</title>
342
280
    <para>