/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-09-01 08:29:23 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080901082923-i2liq6t7warmu9xe
* mandos.xml: Enclose "RAM" with <acronym>.
* overview.xml: - '' -

* plugin-runner.xml (DESCRIPTION): Improved wording.
  (PURPOSE): New section.
  (OPTIONS): Improved wording.
  (OVERVIEW, PLUGINS): New section.
  (FALLBACK): New empty placeholder section.

* plugins.d/password-prompt.xml: Enclose "RAM" with <acronym>.

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugin-runner.xml
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"?>
 
1
<?xml version="1.0" encoding="UTF-8"?>
4
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
5
3
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
6
4
<!ENTITY VERSION "1.0">
7
 
<!ENTITY COMMANDNAME "mandos-client">
 
5
<!ENTITY COMMANDNAME "plugin-runner">
 
6
<!ENTITY TIMESTAMP "2008-09-01">
8
7
]>
9
8
 
10
 
<refentry>
 
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
11
10
  <refentryinfo>
12
 
    <title>&COMMANDNAME;</title>
13
 
    <!-- NWalsh's docbook scripts use this to generate the footer: -->
14
 
    <productname>&COMMANDNAME;</productname>
 
11
    <title>Mandos Manual</title>
 
12
    <!-- Nwalsh’s docbook scripts use this to generate the footer: -->
 
13
    <productname>Mandos</productname>
15
14
    <productnumber>&VERSION;</productnumber>
 
15
    <date>&TIMESTAMP;</date>
16
16
    <authorgroup>
17
17
      <author>
18
18
        <firstname>Björn</firstname>
31
31
    </authorgroup>
32
32
    <copyright>
33
33
      <year>2008</year>
34
 
      <holder>Teddy Hogeborn &amp; Björn Påhlsson</holder>
 
34
      <holder>Teddy Hogeborn</holder>
 
35
      <holder>Björn Påhlsson</holder>
35
36
    </copyright>
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>
 
37
    <xi:include href="legalnotice.xml"/>
59
38
  </refentryinfo>
60
39
 
61
40
  <refmeta>
66
45
  <refnamediv>
67
46
    <refname><command>&COMMANDNAME;</command></refname>
68
47
    <refpurpose>
69
 
      get password for encrypted rootdisk
 
48
      Run Mandos plugins.  Pass data from first succesful one.
70
49
    </refpurpose>
71
50
  </refnamediv>
72
51
 
73
52
  <refsynopsisdiv>
74
53
    <cmdsynopsis>
75
54
      <command>&COMMANDNAME;</command>
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>    
 
55
      <group rep="repeat">
 
56
        <arg choice="plain"><option>--global-envs=<replaceable
 
57
        >VAR</replaceable><literal>=</literal><replaceable
 
58
        >value</replaceable></option></arg>
 
59
        <arg choice="plain"><option>-e
 
60
        <replaceable>VAR</replaceable><literal>=</literal><replaceable
 
61
        >value</replaceable> </option></arg>
 
62
      </group>
 
63
      <sbr/>
 
64
      <group rep="repeat">
 
65
        <arg choice="plain"><option>--envs-for=<replaceable
 
66
        >PLUGIN</replaceable><literal>:</literal><replaceable
 
67
        >ENV</replaceable><literal>=</literal><replaceable
 
68
        >value</replaceable></option></arg>
 
69
        <arg choice="plain"><option>-f<replaceable>
 
70
        PLUGIN</replaceable><literal>:</literal><replaceable
 
71
        >ENV</replaceable><literal>=</literal><replaceable
 
72
        >value</replaceable> </option></arg>
 
73
      </group>
 
74
      <sbr/>
 
75
      <group rep="repeat">
 
76
        <arg choice="plain"><option>--global-options=<replaceable
 
77
        >OPTIONS</replaceable></option></arg>
 
78
        <arg choice="plain"><option>-g<replaceable>
 
79
        OPTIONS</replaceable> </option></arg>
 
80
      </group>
 
81
      <sbr/>
 
82
      <group rep="repeat">
 
83
        <arg choice="plain"><option>--options-for=<replaceable
 
84
        >PLUGIN</replaceable><literal>:</literal><replaceable
 
85
        >OPTIONS</replaceable></option></arg>
 
86
        <arg choice="plain"><option>-f<replaceable>
 
87
        PLUGIN</replaceable><literal>:</literal><replaceable
 
88
        >OPTIONS</replaceable> </option></arg>
 
89
      </group>
 
90
      <sbr/>
 
91
      <group rep="repeat">
 
92
        <arg choice="plain"><option>--disable=<replaceable
 
93
        >PLUGIN</replaceable></option></arg>
 
94
        <arg choice="plain"><option>-d
 
95
        <replaceable>PLUGIN</replaceable> </option></arg>
 
96
      </group>
 
97
      <sbr/>
 
98
      <arg><option>--groupid=<replaceable
 
99
      >ID</replaceable></option></arg>
 
100
      <sbr/>
 
101
      <arg><option>--userid=<replaceable
 
102
      >ID</replaceable></option></arg>
 
103
      <sbr/>
 
104
      <arg><option>--plugin-dir=<replaceable
 
105
      >DIRECTORY</replaceable></option></arg>
 
106
      <sbr/>
 
107
      <arg><option>--debug</option></arg>
 
108
    </cmdsynopsis>
 
109
    <cmdsynopsis>
 
110
      <command>&COMMANDNAME;</command>
 
111
      <group choice="req">
 
112
        <arg choice="plain"><option>--help</option></arg>
 
113
        <arg choice="plain"><option>-?</option></arg>
 
114
      </group>
 
115
    </cmdsynopsis>
 
116
    <cmdsynopsis>
 
117
      <command>&COMMANDNAME;</command>
 
118
      <arg choice="plain"><option>--usage</option></arg>
 
119
    </cmdsynopsis>
 
120
    <cmdsynopsis>
 
121
      <command>&COMMANDNAME;</command>
 
122
      <group choice="req">
 
123
        <arg choice="plain"><option>--version</option></arg>
 
124
        <arg choice="plain"><option>-V</option></arg>
 
125
      </group>
 
126
    </cmdsynopsis>
96
127
  </refsynopsisdiv>
97
 
 
 
128
  
98
129
  <refsect1 id="description">
99
130
    <title>DESCRIPTION</title>
100
131
    <para>
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
107
 
      <citerefentry><refentrytitle>crypttab</refentrytitle>
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>
 
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
  
117
158
  <refsect1>
118
159
    <title>OPTIONS</title>
119
160
    <variablelist>
120
161
      <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>            
 
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.
 
302
          </para>
 
303
        </listitem>
 
304
      </varlistentry>
221
305
    </variablelist>
222
306
  </refsect1>
223
307
 
 
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>
224
340
  <refsect1 id="exit_status">
225
341
    <title>EXIT STATUS</title>
226
342
    <para>
230
346
  <refsect1 id="file">
231
347
    <title>FILES</title>
232
348
    <para>
233
 
      </para>
234
 
  </refsect1>  
 
349
    </para>
 
350
  </refsect1>
235
351
 
236
352
  <refsect1 id="notes">
237
353
    <title>NOTES</title>
238
354
    <para>
239
 
      </para>
 
355
    </para>
240
356
  </refsect1>
241
357
  
242
358
  <refsect1 id="bugs">
243
359
    <title>BUGS</title>
244
360
    <para>
245
 
      </para>
246
 
  </refsect1>  
 
361
    </para>
 
362
  </refsect1>
247
363
 
248
364
  <refsect1 id="examples">
249
 
    <title>EXAMPLES</title>
 
365
    <title>EXAMPLE</title>
250
366
    <para>
251
 
      </para>
 
367
    </para>
252
368
  </refsect1>
253
369
 
254
370
  <refsect1 id="security">
255
371
    <title>SECURITY</title>
256
372
    <para>
257
 
      </para>
 
373
    </para>
258
374
  </refsect1>
259
375
 
260
376
  <refsect1 id="see_also">
261
377
    <title>SEE ALSO</title>
262
378
    <para>
 
379
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
 
380
      <manvolnum>8</manvolnum></citerefentry>,
263
381
      <citerefentry><refentrytitle>mandos</refentrytitle>
264
 
      <manvolnum>8</manvolnum></citerefentry>, <citerefentry>
265
 
      <refentrytitle>password-request</refentrytitle>
266
 
      <manvolnum>8mandos</manvolnum></citerefentry> and <citerefentry>
267
 
      <refentrytitle>password-prompt</refentrytitle>
 
382
      <manvolnum>8</manvolnum></citerefentry>,
 
383
      <citerefentry><refentrytitle>password-prompt</refentrytitle>
 
384
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
385
      <citerefentry><refentrytitle>password-request</refentrytitle>
268
386
      <manvolnum>8mandos</manvolnum></citerefentry>
269
387
    </para>
270
388
  </refsect1>
271
389
 
272
390
</refentry>
 
391
<!-- Local Variables: -->
 
392
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
393
<!-- time-stamp-end: "[\"']>" -->
 
394
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
395
<!-- End: -->