/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 14:02:37 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080831140237-oz9knd88esz8cj4y
* plugin-runner.xml: Removed <?xml-stylesheet>.
* plugins.d/password-request.xml: - '' -

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-08-31">
8
7
]>
9
8
 
10
9
<refentry>
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
37
    <legalnotice>
37
38
      <para>
66
67
  <refnamediv>
67
68
    <refname><command>&COMMANDNAME;</command></refname>
68
69
    <refpurpose>
69
 
      get password for encrypted rootdisk
 
70
      Run Mandos plugins.  Pass data from first succesful one.
70
71
    </refpurpose>
71
72
  </refnamediv>
72
73
 
73
74
  <refsynopsisdiv>
74
75
    <cmdsynopsis>
75
76
      <command>&COMMANDNAME;</command>
76
 
      <arg choice='opt' rep='repeat'>OPTION</arg>
 
77
      <group rep="repeat">
 
78
        <arg choice="plain"><option>--global-envs=<replaceable
 
79
        >VAR</replaceable><literal>=</literal><replaceable
 
80
        >value</replaceable></option></arg>
 
81
        <arg choice="plain"><option>-e
 
82
        <replaceable>VAR</replaceable><literal>=</literal><replaceable
 
83
        >value</replaceable> </option></arg>
 
84
      </group>
 
85
      <sbr/>
 
86
      <group rep="repeat">
 
87
        <arg choice="plain"><option>--envs-for=<replaceable
 
88
        >PLUGIN</replaceable><literal>:</literal><replaceable
 
89
        >ENV</replaceable><literal>=</literal><replaceable
 
90
        >value</replaceable></option></arg>
 
91
        <arg choice="plain"><option>-f<replaceable>
 
92
        PLUGIN</replaceable><literal>:</literal><replaceable
 
93
        >ENV</replaceable><literal>=</literal><replaceable
 
94
        >value</replaceable> </option></arg>
 
95
      </group>
 
96
      <sbr/>
 
97
      <group rep="repeat">
 
98
        <arg choice="plain"><option>--global-options=<replaceable
 
99
        >OPTIONS</replaceable></option></arg>
 
100
        <arg choice="plain"><option>-g<replaceable>
 
101
        OPTIONS</replaceable> </option></arg>
 
102
      </group>
 
103
      <sbr/>
 
104
      <group rep="repeat">
 
105
        <arg choice="plain"><option>--options-for=<replaceable
 
106
        >PLUGIN</replaceable><literal>:</literal><replaceable
 
107
        >OPTIONS</replaceable></option></arg>
 
108
        <arg choice="plain"><option>-f<replaceable>
 
109
        PLUGIN</replaceable><literal>:</literal><replaceable
 
110
        >OPTIONS</replaceable> </option></arg>
 
111
      </group>
 
112
      <sbr/>
 
113
      <group rep="repeat">
 
114
        <arg choice="plain"><option>--disable=<replaceable
 
115
        >PLUGIN</replaceable></option></arg>
 
116
        <arg choice="plain"><option>-d
 
117
        <replaceable>PLUGIN</replaceable> </option></arg>
 
118
      </group>
 
119
      <sbr/>
 
120
      <arg><option>--groupid=<replaceable
 
121
      >ID</replaceable></option></arg>
 
122
      <sbr/>
 
123
      <arg><option>--userid=<replaceable
 
124
      >ID</replaceable></option></arg>
 
125
      <sbr/>
 
126
      <arg><option>--plugin-dir=<replaceable
 
127
      >DIRECTORY</replaceable></option></arg>
 
128
      <sbr/>
 
129
      <arg><option>--debug</option></arg>
 
130
    </cmdsynopsis>
 
131
    <cmdsynopsis>
 
132
      <command>&COMMANDNAME;</command>
 
133
      <group choice="req">
 
134
        <arg choice="plain"><option>--help</option></arg>
 
135
        <arg choice="plain"><option>-?</option></arg>
 
136
      </group>
 
137
    </cmdsynopsis>
 
138
    <cmdsynopsis>
 
139
      <command>&COMMANDNAME;</command>
 
140
      <arg choice="plain"><option>--usage</option></arg>
 
141
    </cmdsynopsis>
 
142
    <cmdsynopsis>
 
143
      <command>&COMMANDNAME;</command>
 
144
      <group choice="req">
 
145
        <arg choice="plain"><option>--version</option></arg>
 
146
        <arg choice="plain"><option>-V</option></arg>
 
147
      </group>
77
148
    </cmdsynopsis>
78
149
  </refsynopsisdiv>
79
150
 
82
153
    <para>
83
154
      <command>&COMMANDNAME;</command> is a plugin runner that waits
84
155
      for any of its plugins to return sucessfull with a password, and
85
 
      passes it to cryptsetup. plugins is defined as any executables
86
 
      in the plugins directory will by default will be
87
 
      /conf/conf.d/mandos/plugins.d.  to stdout.
 
156
      passes it to cryptsetup as stdout message. This command is not
 
157
      meant to be invoked directly, but is instead meant to be run by
 
158
      cryptsetup by being specified in /etc/crypttab as a keyscript
 
159
      and subsequlently started in the initrd environment. See
 
160
      <citerefentry><refentrytitle>crypttab</refentrytitle>
 
161
      <manvolnum>5</manvolnum></citerefentry> for more information on
 
162
      keyscripts.
88
163
    </para>
89
164
 
 
165
    <para>
 
166
      plugins is looked for in the plugins directory which by default will be
 
167
      /conf/conf.d/mandos/plugins.d if not changed by option --plugin-dir.
 
168
    </para>
 
169
  </refsect1>
 
170
  <refsect1>
 
171
    <title>OPTIONS</title>
90
172
    <variablelist>
91
173
      <varlistentry>
92
 
        <term><literal>-g</literal>,<literal>--global-options
93
 
        <replaceable>OPTIONS</replaceable></literal></term>
 
174
        <term><option>--global-options
 
175
        <replaceable>OPTIONS</replaceable></option></term>
 
176
        <term><option>-g
 
177
        <replaceable>OPTIONS</replaceable></option></term>
94
178
        <listitem>
95
179
          <para>
96
180
            Global options given to all plugins as additional start
97
181
            arguments.  Options are specified with a -o flag followed
98
182
            by a comma separated string of options.
99
 
          </para>         
 
183
          </para>       
100
184
        </listitem>
101
185
      </varlistentry>
102
186
 
103
187
      <varlistentry>
104
 
        <term><literal>-o</literal>,<literal> --options-for
105
 
        <replaceable>PLUGIN</replaceable>:<replaceable>OPTION</replaceable>
106
 
        </literal></term>
 
188
        <term><option>--options-for
 
189
        <replaceable>PLUGIN</replaceable><literal>:</literal
 
190
        ><replaceable>OPTION</replaceable></option></term>
 
191
        <term><option>-o
 
192
        <replaceable>PLUGIN</replaceable><literal>:</literal
 
193
        ><replaceable>OPTION</replaceable></option></term>
107
194
        <listitem>
108
195
          <para>
109
196
            Plugin specific options given to the plugin as additional
110
197
            start arguments.  Options are specified with a -o flag
111
198
            followed by a comma separated string of options.
112
 
          </para>         
 
199
          </para>       
113
200
        </listitem>
114
 
      </varlistentry>      
 
201
      </varlistentry>
115
202
 
116
203
      <varlistentry>
117
 
        <term><literal>-d</literal>,<literal> --disable
118
 
        <replaceable>PLUGIN</replaceable>
119
 
        </literal></term>
 
204
        <term><option> --disable
 
205
        <replaceable>PLUGIN</replaceable></option></term>
 
206
        <term><option>-d
 
207
        <replaceable>PLUGIN</replaceable></option></term>
120
208
        <listitem>
121
209
          <para>
122
210
            Disable a specific plugin
123
 
          </para>         
 
211
          </para>       
124
212
        </listitem>
125
213
      </varlistentry>
126
214
 
127
215
      <varlistentry>
128
 
        <term><literal>--groupid <replaceable>ID</replaceable>
129
 
        </literal></term>
 
216
        <term><option>--groupid
 
217
        <replaceable>ID</replaceable></option></term>
130
218
        <listitem>
131
219
          <para>
132
220
            Group ID the plugins will run as
133
221
          </para>
134
222
        </listitem>
135
 
      </varlistentry>      
 
223
      </varlistentry>
136
224
 
137
225
      <varlistentry>
138
 
        <term><literal>--userid <replaceable>ID</replaceable>
139
 
        </literal></term>
 
226
        <term><option>--userid
 
227
        <replaceable>ID</replaceable></option></term>
140
228
        <listitem>
141
229
          <para>
142
230
            User ID the plugins will run as
143
231
          </para>
144
232
        </listitem>
145
 
      </varlistentry>      
 
233
      </varlistentry>
146
234
 
147
235
      <varlistentry>
148
 
        <term><literal>--plugin-dir <replaceable>DIRECTORY</replaceable>
149
 
        </literal></term>
 
236
        <term><option>--plugin-dir
 
237
        <replaceable>DIRECTORY</replaceable></option></term>
150
238
        <listitem>
151
239
          <para>
152
240
            Specify a different plugin directory
153
241
          </para>
154
242
        </listitem>
155
 
      </varlistentry>       
 
243
      </varlistentry>
156
244
      
157
245
      <varlistentry>
158
 
        <term><literal>--debug</literal></term>
 
246
        <term><option>--debug</option></term>
159
247
        <listitem>
160
248
          <para>
161
249
            Debug mode
164
252
      </varlistentry>
165
253
      
166
254
      <varlistentry>
167
 
        <term><literal>-?</literal>, <literal>--help</literal></term>
 
255
        <term><option>--help</option></term>
 
256
        <term><option>-?</option></term>
168
257
        <listitem>
169
258
          <para>
170
259
            Gives a help message
173
262
      </varlistentry>
174
263
      
175
264
      <varlistentry>
176
 
        <term><literal>--usage</literal></term>
 
265
        <term><option>--usage</option></term>
177
266
        <listitem>
178
267
          <para>
179
268
            Gives a short usage message
182
271
      </varlistentry>
183
272
 
184
273
      <varlistentry>
185
 
        <term><literal>-V</literal>, <literal>--version</literal></term>
 
274
        <term><option>--version</option></term>
 
275
        <term><option>-V</option></term>
186
276
        <listitem>
187
277
          <para>
188
278
            Prints the program version
189
279
          </para>
190
280
        </listitem>
191
 
      </varlistentry>            
 
281
      </varlistentry>
192
282
    </variablelist>
193
283
  </refsect1>
 
284
 
 
285
  <refsect1 id="exit_status">
 
286
    <title>EXIT STATUS</title>
 
287
    <para>
 
288
    </para>
 
289
  </refsect1>
 
290
 
 
291
  <refsect1 id="file">
 
292
    <title>FILES</title>
 
293
    <para>
 
294
    </para>
 
295
  </refsect1>
 
296
 
 
297
  <refsect1 id="notes">
 
298
    <title>NOTES</title>
 
299
    <para>
 
300
    </para>
 
301
  </refsect1>
 
302
  
 
303
  <refsect1 id="bugs">
 
304
    <title>BUGS</title>
 
305
    <para>
 
306
    </para>
 
307
  </refsect1>
 
308
 
 
309
  <refsect1 id="examples">
 
310
    <title>EXAMPLE</title>
 
311
    <para>
 
312
    </para>
 
313
  </refsect1>
 
314
 
 
315
  <refsect1 id="security">
 
316
    <title>SECURITY</title>
 
317
    <para>
 
318
    </para>
 
319
  </refsect1>
 
320
 
 
321
  <refsect1 id="see_also">
 
322
    <title>SEE ALSO</title>
 
323
    <para>
 
324
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
 
325
      <manvolnum>8</manvolnum></citerefentry>,
 
326
      <citerefentry><refentrytitle>mandos</refentrytitle>
 
327
      <manvolnum>8</manvolnum></citerefentry>,
 
328
      <citerefentry><refentrytitle>password-prompt</refentrytitle>
 
329
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
330
      <citerefentry><refentrytitle>password-request</refentrytitle>
 
331
      <manvolnum>8mandos</manvolnum></citerefentry>
 
332
    </para>
 
333
  </refsect1>
 
334
 
194
335
</refentry>
 
336
<!-- Local Variables: -->
 
337
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
338
<!-- time-stamp-end: "[\"']>" -->
 
339
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
340
<!-- End: -->