/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: Teddy Hogeborn
  • Date: 2008-08-31 13:55:04 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080831135504-2ka1cccglsghslxy
* plugin-runner.xml (/refentry/refentryinfo/copyright): Split
                                                        copyright
                                                        holders.
* plugins.d/password-request.xml (/refentry/refentryinfo/copyright):
                                 Split copyright holders.

Show diffs side-by-side

added added

removed removed

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