1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
|
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY VERSION "1.0">
<!ENTITY COMMANDNAME "plugin-runner">
<!ENTITY TIMESTAMP "2008-09-01">
]>
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
<refentryinfo>
<title>Mandos Manual</title>
<!-- Nwalsh’s docbook scripts use this to generate the footer: -->
<productname>Mandos</productname>
<productnumber>&VERSION;</productnumber>
<date>&TIMESTAMP;</date>
<authorgroup>
<author>
<firstname>Björn</firstname>
<surname>Påhlsson</surname>
<address>
<email>belorn@fukt.bsnet.se</email>
</address>
</author>
<author>
<firstname>Teddy</firstname>
<surname>Hogeborn</surname>
<address>
<email>teddy@fukt.bsnet.se</email>
</address>
</author>
</authorgroup>
<copyright>
<year>2008</year>
<holder>Teddy Hogeborn</holder>
<holder>Björn Påhlsson</holder>
</copyright>
<xi:include href="legalnotice.xml"/>
</refentryinfo>
<refmeta>
<refentrytitle>&COMMANDNAME;</refentrytitle>
<manvolnum>8mandos</manvolnum>
</refmeta>
<refnamediv>
<refname><command>&COMMANDNAME;</command></refname>
<refpurpose>
Run Mandos plugins. Pass data from first succesful one.
</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>&COMMANDNAME;</command>
<group rep="repeat">
<arg choice="plain"><option>--global-envs=<replaceable
>VAR</replaceable><literal>=</literal><replaceable
>value</replaceable></option></arg>
<arg choice="plain"><option>-e
<replaceable>VAR</replaceable><literal>=</literal><replaceable
>value</replaceable> </option></arg>
</group>
<sbr/>
<group rep="repeat">
<arg choice="plain"><option>--envs-for=<replaceable
>PLUGIN</replaceable><literal>:</literal><replaceable
>ENV</replaceable><literal>=</literal><replaceable
>value</replaceable></option></arg>
<arg choice="plain"><option>-f<replaceable>
PLUGIN</replaceable><literal>:</literal><replaceable
>ENV</replaceable><literal>=</literal><replaceable
>value</replaceable> </option></arg>
</group>
<sbr/>
<group rep="repeat">
<arg choice="plain"><option>--global-options=<replaceable
>OPTIONS</replaceable></option></arg>
<arg choice="plain"><option>-g<replaceable>
OPTIONS</replaceable> </option></arg>
</group>
<sbr/>
<group rep="repeat">
<arg choice="plain"><option>--options-for=<replaceable
>PLUGIN</replaceable><literal>:</literal><replaceable
>OPTIONS</replaceable></option></arg>
<arg choice="plain"><option>-f<replaceable>
PLUGIN</replaceable><literal>:</literal><replaceable
>OPTIONS</replaceable> </option></arg>
</group>
<sbr/>
<group rep="repeat">
<arg choice="plain"><option>--disable=<replaceable
>PLUGIN</replaceable></option></arg>
<arg choice="plain"><option>-d
<replaceable>PLUGIN</replaceable> </option></arg>
</group>
<sbr/>
<arg><option>--groupid=<replaceable
>ID</replaceable></option></arg>
<sbr/>
<arg><option>--userid=<replaceable
>ID</replaceable></option></arg>
<sbr/>
<arg><option>--plugin-dir=<replaceable
>DIRECTORY</replaceable></option></arg>
<sbr/>
<arg><option>--debug</option></arg>
</cmdsynopsis>
<cmdsynopsis>
<command>&COMMANDNAME;</command>
<group choice="req">
<arg choice="plain"><option>--help</option></arg>
<arg choice="plain"><option>-?</option></arg>
</group>
</cmdsynopsis>
<cmdsynopsis>
<command>&COMMANDNAME;</command>
<arg choice="plain"><option>--usage</option></arg>
</cmdsynopsis>
<cmdsynopsis>
<command>&COMMANDNAME;</command>
<group choice="req">
<arg choice="plain"><option>--version</option></arg>
<arg choice="plain"><option>-V</option></arg>
</group>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1 id="description">
<title>DESCRIPTION</title>
<para>
<command>&COMMANDNAME;</command> is a program which is meant to
be specified as <quote>keyscript</quote> in <citerefentry>
<refentrytitle>crypttab</refentrytitle>
<manvolnum>5</manvolnum></citerefentry> for the root disk. The
aim of this program is therefore to output a password, which
then <citerefentry><refentrytitle>cryptsetup</refentrytitle>
<manvolnum>8</manvolnum></citerefentry> will use to try and
unlock the root disk.
</para>
<para>
This program is not meant to be invoked directly, but can be in
order to test it. Note that any password obtained will simply
be output on standard output.
</para>
</refsect1>
<refsect1 id="purpose">
<title>PURPOSE</title>
<para>
The purpose of this is to enable <emphasis>remote and unattended
rebooting</emphasis> of client host computer with an
<emphasis>encrypted root file system</emphasis>. See <xref
linkend="overview"/> for details.
</para>
</refsect1>
<refsect1>
<title>OPTIONS</title>
<variablelist>
<varlistentry>
<term><option>--global-options
<replaceable>OPTIONS</replaceable></option></term>
<term><option>-g
<replaceable>OPTIONS</replaceable></option></term>
<listitem>
<para>
Pass some options to <emphasis>all</emphasis> plugins.
<replaceable>OPTIONS</replaceable> is a comma separated
list of options. This is not a very useful option, except
for specifying the <quote><option>--debug</option></quote>
for all plugins.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--options-for
<replaceable>PLUGIN</replaceable><literal>:</literal
><replaceable>OPTION</replaceable></option></term>
<term><option>-o
<replaceable>PLUGIN</replaceable><literal>:</literal
><replaceable>OPTION</replaceable></option></term>
<listitem>
<para>
Pass some options to a specific plugin. <replaceable
>PLUGIN</replaceable> is the name (file basename) of a
plugin, and <replaceable>OPTIONS</replaceable> is a comma
separated list of options.
</para>
<para>
Note that since options are not split on whitespace, the
way to pass, to the plugin
<quote><filename>foo</filename></quote>, the option
<option>--bar</option> with the option argument
<quote>baz</quote> is either
<userinput>--options-for=foo:--bar=baz</userinput> or
<userinput>--options-for=foo:--bar,baz</userinput>, but
<emphasis>not</emphasis>
<userinput>--options-for="foo:--bar baz"</userinput>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option> --disable
<replaceable>PLUGIN</replaceable></option></term>
<term><option>-d
<replaceable>PLUGIN</replaceable></option></term>
<listitem>
<para>
Disable the plugin named
<replaceable>PLUGIN</replaceable>. The plugin will not be
started.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--groupid
<replaceable>ID</replaceable></option></term>
<listitem>
<para>
Change to group ID <replaceable>ID</replaceable> on
startup. The default is 65534. All plugins will be
started using this group ID. <emphasis>Note:</emphasis>
This must be a number, not a name.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--userid
<replaceable>ID</replaceable></option></term>
<listitem>
<para>
Change to user ID <replaceable>ID</replaceable> on
startup. The default is 65534. All plugins will be
started using this user ID. <emphasis>Note:</emphasis>
This must be a number, not a name.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--plugin-dir
<replaceable>DIRECTORY</replaceable></option></term>
<listitem>
<para>
Specify a different plugin directory. The default is
<filename>/lib/mandos/plugins.d</filename>, which will
exist in the initial <acronym>RAM</acronym> disk
environment.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--debug</option></term>
<listitem>
<para>
Enable debug mode. This will enable a lot of output to
standard error about what the program is doing. The
program will still perform all other functions normally.
The default is to <emphasis>not</emphasis> run in debug
mode.
</para>
<para>
The plugins will <emphasis>not</emphasis> be affected by
this option. Use
<userinput><option>--global-options=--debug</option></userinput>
if complete debugging eruption is desired.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--help</option></term>
<term><option>-?</option></term>
<listitem>
<para>
Gives a help message about options and their meanings.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--usage</option></term>
<listitem>
<para>
Gives a short usage message.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--version</option></term>
<term><option>-V</option></term>
<listitem>
<para>
Prints the program version.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 id="overview">
<title>OVERVIEW</title>
<xi:include href="overview.xml"/>
<para>
This program will run on the client side in the initial
<acronym>RAM</acronym> disk environment, and is responsible for
getting a password. It does this by running plugins, one of
which will normally be the actual client program communicating
with the server.
</para>
</refsect1>
<refsect1 id="plugins">
<title>PLUGINS</title>
<para>
This program will get a password by running a number of
<firstterm>plugins</firstterm>, which are simply executable
programs in a directory in the initial <acronym>RAM</acronym>
disk environment. The default directory is
<filename>/lib/mandos/plugins.d</filename>, but this can be
changed with the <option>--plugin-dir</option> option. The
plugins are started in parallel, and the first plugin to output
a password and exit with a successful exit code will make this
plugin-runner output that password, stop any other plugins, and
exit.
</para>
</refsect1>
<refsect1>
<title>FALLBACK</title>
<para>
</para>
</refsect1>
<refsect1 id="exit_status">
<title>EXIT STATUS</title>
<para>
</para>
</refsect1>
<refsect1 id="file">
<title>FILES</title>
<para>
</para>
</refsect1>
<refsect1 id="notes">
<title>NOTES</title>
<para>
</para>
</refsect1>
<refsect1 id="bugs">
<title>BUGS</title>
<para>
</para>
</refsect1>
<refsect1 id="examples">
<title>EXAMPLE</title>
<para>
</para>
</refsect1>
<refsect1 id="security">
<title>SECURITY</title>
<para>
</para>
</refsect1>
<refsect1 id="see_also">
<title>SEE ALSO</title>
<para>
<citerefentry><refentrytitle>cryptsetup</refentrytitle>
<manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>mandos</refentrytitle>
<manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>password-prompt</refentrytitle>
<manvolnum>8mandos</manvolnum></citerefentry>,
<citerefentry><refentrytitle>password-request</refentrytitle>
<manvolnum>8mandos</manvolnum></citerefentry>
</para>
</refsect1>
</refentry>
<!-- Local Variables: -->
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
<!-- time-stamp-end: "[\"']>" -->
<!-- time-stamp-format: "%:y-%02m-%02d" -->
<!-- End: -->
|