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
|
<?xml version='1.0' encoding='UTF-8'?>
<?xml-stylesheet type="text/xsl"
href="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl"?>
<!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-08-29">
]>
<refentry>
<refentryinfo>
<title>&COMMANDNAME;</title>
<!-- NWalsh's docbook scripts use this to generate the footer: -->
<productname>&COMMANDNAME;</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 & Björn Påhlsson</holder>
</copyright>
<legalnotice>
<para>
This manual page is free software: you can redistribute it
and/or modify it under the terms of the GNU General Public
License as published by the Free Software Foundation,
either version 3 of the License, or (at your option) any
later version.
</para>
<para>
This manual page is distributed in the hope that it will
be useful, but WITHOUT ANY WARRANTY; without even the
implied warranty of MERCHANTABILITY or FITNESS FOR A
PARTICULAR PURPOSE. See the GNU General Public License
for more details.
</para>
<para>
You should have received a copy of the GNU General Public
License along with this program; If not, see
<ulink url="http://www.gnu.org/licenses/"/>.
</para>
</legalnotice>
</refentryinfo>
<refmeta>
<refentrytitle>&COMMANDNAME;</refentrytitle>
<manvolnum>8mandos</manvolnum>
</refmeta>
<refnamediv>
<refname><command>&COMMANDNAME;</command></refname>
<refpurpose>
get password for encrypted rootdisk
</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>&COMMANDNAME;</command>
<arg choice='opt'>--global-options<arg choice='plain'>OPTIONS</arg></arg>
<arg choice='opt'>--options-for<arg choice='plain'>PLUGIN:OPTIONS</arg></arg>
<arg choice='opt'>--disable<arg choice='plain'>PLUGIN</arg></arg>
<arg choice='opt'>--groupid<arg choice='plain'>ID</arg></arg>
<arg choice='opt'>--userid<arg choice='plain'>ID</arg></arg>
<arg choice='opt'>--plugin-dir<arg choice='plain'>DIRECTORY</arg></arg>
<arg choice='opt'>--debug</arg>
</cmdsynopsis>
<cmdsynopsis>
<command>&COMMANDNAME;</command>
<arg choice='plain'>--help</arg>
</cmdsynopsis>
<cmdsynopsis>
<command>&COMMANDNAME;</command>
<arg choice='plain'>--usage</arg>
</cmdsynopsis>
<cmdsynopsis>
<command>&COMMANDNAME;</command>
<arg choice='plain'>--version</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1 id="description">
<title>DESCRIPTION</title>
<para>
<command>&COMMANDNAME;</command> is a plugin runner that waits
for any of its plugins to return sucessfull with a password, and
passes it to cryptsetup as stdout message. This command is not
meant to be invoked directly, but is instead meant to be run by
cryptsetup by being specified in /etc/crypttab as a keyscript
and subsequlently started in the initrd environment. See
<citerefentry><refentrytitle>crypttab</refentrytitle>
<manvolnum>5</manvolnum></citerefentry> for more information on
keyscripts.
</para>
<para>
plugins is looked for in the plugins directory which by default will be
/conf/conf.d/mandos/plugins.d if not changed by option --plugin-dir.
</para>
</refsect1>
<refsect1>
<title>OPTIONS</title>
<variablelist>
<varlistentry>
<term><literal>-g</literal>,<literal>--global-options
<replaceable>OPTIONS</replaceable></literal></term>
<listitem>
<para>
Global options given to all plugins as additional start
arguments. Options are specified with a -o flag followed
by a comma separated string of options.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>-o</literal>,<literal> --options-for
<replaceable>PLUGIN</replaceable>:<replaceable>OPTION</replaceable>
</literal></term>
<listitem>
<para>
Plugin specific options given to the plugin as additional
start arguments. Options are specified with a -o flag
followed by a comma separated string of options.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>-d</literal>,<literal> --disable
<replaceable>PLUGIN</replaceable>
</literal></term>
<listitem>
<para>
Disable a specific plugin
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>--groupid <replaceable>ID</replaceable>
</literal></term>
<listitem>
<para>
Group ID the plugins will run as
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>--userid <replaceable>ID</replaceable>
</literal></term>
<listitem>
<para>
User ID the plugins will run as
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>--plugin-dir <replaceable>DIRECTORY</replaceable>
</literal></term>
<listitem>
<para>
Specify a different plugin directory
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>--debug</literal></term>
<listitem>
<para>
Debug mode
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>-?</literal>, <literal>--help</literal></term>
<listitem>
<para>
Gives a help message
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>--usage</literal></term>
<listitem>
<para>
Gives a short usage message
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>-V</literal>, <literal>--version</literal></term>
<listitem>
<para>
Prints the program version
</para>
</listitem>
</varlistentry>
</variablelist>
</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>EXAMPLES</title>
<para>
</para>
</refsect1>
<refsect1 id="security">
<title>SECURITY</title>
<para>
</para>
</refsect1>
<refsect1 id="see_also">
<title>SEE ALSO</title>
<para>
<citerefentry><refentrytitle>mandos</refentrytitle>
<manvolnum>8</manvolnum></citerefentry>, <citerefentry>
<refentrytitle>password-request</refentrytitle>
<manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
<refentrytitle>password-prompt</refentrytitle>
<manvolnum>8mandos</manvolnum></citerefentry>, and
<citerefentry><refentrytitle>cryptsetup</refentrytitle>
<manvolnum>8</manvolnum></citerefentry>
</para>
</refsect1>
</refentry>
<!-- Local Variables: -->
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
<!-- time-stamp-end: "[\"']>" -->
<!-- time-stamp-format: "%:y-%02m-%02d" -->
<!-- End: -->
|