/mandos/trunk

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/trunk

« back to all changes in this revision

Viewing changes to plugin-runner.xml

  • Committer: Björn Påhlsson
  • Date: 2008-07-20 03:51:41 UTC
  • Revision ID: belorn@braxen-20080720035141-ta0y0be7fotdm4ks
Fixed a overbufferflow bug, thanks to a forgotten \0

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"?>
4
 
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
5
 
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
6
 
<!ENTITY VERSION "1.0">
7
 
<!ENTITY COMMANDNAME "plugin-runner">
8
 
<!ENTITY TIMESTAMP "2008-08-31">
9
 
]>
10
 
 
11
 
<refentry>
12
 
  <refentryinfo>
13
 
    <title>Mandos Manual</title>
14
 
    <!-- NWalsh's docbook scripts use this to generate the footer: -->
15
 
    <productname>Mandos</productname>
16
 
    <productnumber>&VERSION;</productnumber>
17
 
    <date>&TIMESTAMP;</date>
18
 
    <authorgroup>
19
 
      <author>
20
 
        <firstname>Björn</firstname>
21
 
        <surname>Påhlsson</surname>
22
 
        <address>
23
 
          <email>belorn@fukt.bsnet.se</email>
24
 
        </address>
25
 
      </author>
26
 
      <author>
27
 
        <firstname>Teddy</firstname>
28
 
        <surname>Hogeborn</surname>
29
 
        <address>
30
 
          <email>teddy@fukt.bsnet.se</email>
31
 
        </address>
32
 
      </author>
33
 
    </authorgroup>
34
 
    <copyright>
35
 
      <year>2008</year>
36
 
      <holder>Teddy Hogeborn &amp; Björn Påhlsson</holder>
37
 
    </copyright>
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>
61
 
  </refentryinfo>
62
 
 
63
 
  <refmeta>
64
 
    <refentrytitle>&COMMANDNAME;</refentrytitle>
65
 
    <manvolnum>8mandos</manvolnum>
66
 
  </refmeta>
67
 
  
68
 
  <refnamediv>
69
 
    <refname><command>&COMMANDNAME;</command></refname>
70
 
    <refpurpose>
71
 
      Run Mandos plugins.  Pass data from first succesful one.
72
 
    </refpurpose>
73
 
  </refnamediv>
74
 
 
75
 
  <refsynopsisdiv>
76
 
    <cmdsynopsis>
77
 
      <command>&COMMANDNAME;</command>
78
 
      <group rep="repeat">
79
 
        <arg choice="plain"><option>--global-envs=<replaceable
80
 
        >VAR</replaceable><literal>=</literal><replaceable
81
 
        >value</replaceable></option></arg>
82
 
        <arg choice="plain"><option>-e
83
 
        <replaceable>VAR</replaceable><literal>=</literal><replaceable
84
 
        >value</replaceable> </option></arg>
85
 
      </group>
86
 
      <sbr/>
87
 
      <group rep="repeat">
88
 
        <arg choice="plain"><option>--envs-for=<replaceable
89
 
        >PLUGIN</replaceable><literal>:</literal><replaceable
90
 
        >ENV</replaceable><literal>=</literal><replaceable
91
 
        >value</replaceable></option></arg>
92
 
        <arg choice="plain"><option>-f<replaceable>
93
 
        PLUGIN</replaceable><literal>:</literal><replaceable
94
 
        >ENV</replaceable><literal>=</literal><replaceable
95
 
        >value</replaceable> </option></arg>
96
 
      </group>
97
 
      <sbr/>
98
 
      <group rep="repeat">
99
 
        <arg choice="plain"><option>--global-options=<replaceable
100
 
        >OPTIONS</replaceable></option></arg>
101
 
        <arg choice="plain"><option>-g<replaceable>
102
 
        OPTIONS</replaceable> </option></arg>
103
 
      </group>
104
 
      <sbr/>
105
 
      <group rep="repeat">
106
 
        <arg choice="plain"><option>--options-for=<replaceable
107
 
        >PLUGIN</replaceable><literal>:</literal><replaceable
108
 
        >OPTIONS</replaceable></option></arg>
109
 
        <arg choice="plain"><option>-f<replaceable>
110
 
        PLUGIN</replaceable><literal>:</literal><replaceable
111
 
        >OPTIONS</replaceable> </option></arg>
112
 
      </group>
113
 
      <sbr/>
114
 
      <group rep="repeat">
115
 
        <arg choice="plain"><option>--disable=<replaceable
116
 
        >PLUGIN</replaceable></option></arg>
117
 
        <arg choice="plain"><option>-d
118
 
        <replaceable>PLUGIN</replaceable> </option></arg>
119
 
      </group>
120
 
      <sbr/>
121
 
      <arg><option>--groupid=<replaceable
122
 
      >ID</replaceable></option></arg>
123
 
      <sbr/>
124
 
      <arg><option>--userid=<replaceable
125
 
      >ID</replaceable></option></arg>
126
 
      <sbr/>
127
 
      <arg><option>--plugin-dir=<replaceable
128
 
      >DIRECTORY</replaceable></option></arg>
129
 
      <sbr/>
130
 
      <arg><option>--debug</option></arg>
131
 
    </cmdsynopsis>
132
 
    <cmdsynopsis>
133
 
      <command>&COMMANDNAME;</command>
134
 
      <group choice="req">
135
 
        <arg choice='plain'><option>--help</option></arg>
136
 
        <arg choice='plain'><option>-?</option></arg>
137
 
      </group>
138
 
    </cmdsynopsis>
139
 
    <cmdsynopsis>
140
 
      <command>&COMMANDNAME;</command>
141
 
      <arg choice='plain'><option>--usage</option></arg>
142
 
    </cmdsynopsis>
143
 
    <cmdsynopsis>
144
 
      <command>&COMMANDNAME;</command>
145
 
      <group choice="req">
146
 
        <arg choice='plain'><option>--version</option></arg>
147
 
        <arg choice='plain'><option>-V</option></arg>
148
 
      </group>
149
 
    </cmdsynopsis>
150
 
  </refsynopsisdiv>
151
 
 
152
 
  <refsect1 id="description">
153
 
    <title>DESCRIPTION</title>
154
 
    <para>
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>
171
 
  <refsect1>
172
 
    <title>OPTIONS</title>
173
 
    <variablelist>
174
 
      <varlistentry>
175
 
        <term><option>--global-options
176
 
        <replaceable>OPTIONS</replaceable></option></term>
177
 
        <term><option>-g
178
 
        <replaceable>OPTIONS</replaceable></option></term>
179
 
        <listitem>
180
 
          <para>
181
 
            Global options given to all plugins as additional start
182
 
            arguments.  Options are specified with a -o flag followed
183
 
            by a comma separated string of options.
184
 
          </para>       
185
 
        </listitem>
186
 
      </varlistentry>
187
 
 
188
 
      <varlistentry>
189
 
        <term><option>--options-for
190
 
        <replaceable>PLUGIN</replaceable><literal>:</literal
191
 
        ><replaceable>OPTION</replaceable></option></term>
192
 
        <term><option>-o
193
 
        <replaceable>PLUGIN</replaceable><literal>:</literal
194
 
        ><replaceable>OPTION</replaceable></option></term>
195
 
        <listitem>
196
 
          <para>
197
 
            Plugin specific options given to the plugin as additional
198
 
            start arguments.  Options are specified with a -o flag
199
 
            followed by a comma separated string of options.
200
 
          </para>       
201
 
        </listitem>
202
 
      </varlistentry>
203
 
 
204
 
      <varlistentry>
205
 
        <term><option> --disable
206
 
        <replaceable>PLUGIN</replaceable></option></term>
207
 
        <term><option>-d
208
 
        <replaceable>PLUGIN</replaceable></option></term>
209
 
        <listitem>
210
 
          <para>
211
 
            Disable a specific plugin
212
 
          </para>       
213
 
        </listitem>
214
 
      </varlistentry>
215
 
 
216
 
      <varlistentry>
217
 
        <term><option>--groupid
218
 
        <replaceable>ID</replaceable></option></term>
219
 
        <listitem>
220
 
          <para>
221
 
            Group ID the plugins will run as
222
 
          </para>
223
 
        </listitem>
224
 
      </varlistentry>
225
 
 
226
 
      <varlistentry>
227
 
        <term><option>--userid
228
 
        <replaceable>ID</replaceable></option></term>
229
 
        <listitem>
230
 
          <para>
231
 
            User ID the plugins will run as
232
 
          </para>
233
 
        </listitem>
234
 
      </varlistentry>
235
 
 
236
 
      <varlistentry>
237
 
        <term><option>--plugin-dir
238
 
        <replaceable>DIRECTORY</replaceable></option></term>
239
 
        <listitem>
240
 
          <para>
241
 
            Specify a different plugin directory
242
 
          </para>
243
 
        </listitem>
244
 
      </varlistentry>
245
 
      
246
 
      <varlistentry>
247
 
        <term><option>--debug</option></term>
248
 
        <listitem>
249
 
          <para>
250
 
            Debug mode
251
 
          </para>
252
 
        </listitem>
253
 
      </varlistentry>
254
 
      
255
 
      <varlistentry>
256
 
        <term><option>--help</option></term>
257
 
        <term><option>-?</option></term>
258
 
        <listitem>
259
 
          <para>
260
 
            Gives a help message
261
 
          </para>
262
 
        </listitem>
263
 
      </varlistentry>
264
 
      
265
 
      <varlistentry>
266
 
        <term><option>--usage</option></term>
267
 
        <listitem>
268
 
          <para>
269
 
            Gives a short usage message
270
 
          </para>
271
 
        </listitem>
272
 
      </varlistentry>
273
 
 
274
 
      <varlistentry>
275
 
        <term><option>--version</option></term>
276
 
        <term><option>-V</option></term>
277
 
        <listitem>
278
 
          <para>
279
 
            Prints the program version
280
 
          </para>
281
 
        </listitem>
282
 
      </varlistentry>
283
 
    </variablelist>
284
 
  </refsect1>
285
 
 
286
 
  <refsect1 id="exit_status">
287
 
    <title>EXIT STATUS</title>
288
 
    <para>
289
 
    </para>
290
 
  </refsect1>
291
 
 
292
 
  <refsect1 id="file">
293
 
    <title>FILES</title>
294
 
    <para>
295
 
    </para>
296
 
  </refsect1>
297
 
 
298
 
  <refsect1 id="notes">
299
 
    <title>NOTES</title>
300
 
    <para>
301
 
    </para>
302
 
  </refsect1>
303
 
  
304
 
  <refsect1 id="bugs">
305
 
    <title>BUGS</title>
306
 
    <para>
307
 
    </para>
308
 
  </refsect1>
309
 
 
310
 
  <refsect1 id="examples">
311
 
    <title>EXAMPLE</title>
312
 
    <para>
313
 
    </para>
314
 
  </refsect1>
315
 
 
316
 
  <refsect1 id="security">
317
 
    <title>SECURITY</title>
318
 
    <para>
319
 
    </para>
320
 
  </refsect1>
321
 
 
322
 
  <refsect1 id="see_also">
323
 
    <title>SEE ALSO</title>
324
 
    <para>
325
 
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
326
 
      <manvolnum>8</manvolnum></citerefentry>,
327
 
      <citerefentry><refentrytitle>mandos</refentrytitle>
328
 
      <manvolnum>8</manvolnum></citerefentry>,
329
 
      <citerefentry><refentrytitle>password-prompt</refentrytitle>
330
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
331
 
      <citerefentry><refentrytitle>password-request</refentrytitle>
332
 
      <manvolnum>8mandos</manvolnum></citerefentry>
333
 
    </para>
334
 
  </refsect1>
335
 
 
336
 
</refentry>
337
 
<!-- Local Variables: -->
338
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
339
 
<!-- time-stamp-end: "[\"']>" -->
340
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
341
 
<!-- End: -->