/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 16:04:47 UTC
  • mfrom: (24.1.77 mandos)
  • Revision ID: teddy@fukt.bsnet.se-20080831160447-2xte5k90onspphki
Merge.

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
 
<refentry>
 
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
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
 
    <legalnotice>
37
 
      <para>
38
 
        This manual page is free software: you can redistribute it
39
 
        and/or modify it under the terms of the GNU General Public
40
 
        License as published by the Free Software Foundation,
41
 
        either version 3 of the License, or (at your option) any
42
 
        later version.
43
 
      </para>
44
 
 
45
 
      <para>
46
 
        This manual page is distributed in the hope that it will
47
 
        be useful, but WITHOUT ANY WARRANTY; without even the
48
 
        implied warranty of MERCHANTABILITY or FITNESS FOR A
49
 
        PARTICULAR PURPOSE.  See the GNU General Public License
50
 
        for more details.
51
 
      </para>
52
 
 
53
 
      <para>
54
 
        You should have received a copy of the GNU General Public
55
 
        License along with this program; If not, see
56
 
        <ulink url="http://www.gnu.org/licenses/"/>.
57
 
      </para>
58
 
    </legalnotice>
 
37
    <xi:include href="legalnotice.xml"/>
59
38
  </refentryinfo>
60
39
 
61
40
  <refmeta>
66
45
  <refnamediv>
67
46
    <refname><command>&COMMANDNAME;</command></refname>
68
47
    <refpurpose>
69
 
      get password for encrypted rootdisk
 
48
      Run Mandos plugins.  Pass data from first succesful one.
70
49
    </refpurpose>
71
50
  </refnamediv>
72
51
 
73
52
  <refsynopsisdiv>
74
53
    <cmdsynopsis>
75
54
      <command>&COMMANDNAME;</command>
76
 
      <arg choice='opt'>--global-options<arg choice='plain'>OPTIONS</arg></arg>
77
 
      <arg choice='opt'>--options-for<arg choice='plain'>PLUGIN:OPTIONS</arg></arg>
78
 
      <arg choice='opt'>--disable<arg choice='plain'>PLUGIN</arg></arg>
79
 
      <arg choice='opt'>--groupid<arg choice='plain'>ID</arg></arg>
80
 
      <arg choice='opt'>--userpid<arg choice='plain'>ID</arg></arg>
81
 
      <arg choice='opt'>--plugin-dir<arg choice='plain'>DIRECTORY</arg></arg>
82
 
      <arg choice='opt'>--debug</arg>
83
 
    </cmdsynopsis>
84
 
    <cmdsynopsis>
85
 
      <command>&COMMANDNAME;</command>
86
 
      <arg choice='plain'>--help</arg>
87
 
    </cmdsynopsis>
88
 
    <cmdsynopsis>
89
 
      <command>&COMMANDNAME;</command>
90
 
      <arg choice='plain'>--usage</arg>
91
 
    </cmdsynopsis>
92
 
    <cmdsynopsis>
93
 
      <command>&COMMANDNAME;</command>
94
 
      <arg choice='plain'>--version</arg>
95
 
    </cmdsynopsis>    
 
55
      <group rep="repeat">
 
56
        <arg choice="plain"><option>--global-envs=<replaceable
 
57
        >VAR</replaceable><literal>=</literal><replaceable
 
58
        >value</replaceable></option></arg>
 
59
        <arg choice="plain"><option>-e
 
60
        <replaceable>VAR</replaceable><literal>=</literal><replaceable
 
61
        >value</replaceable> </option></arg>
 
62
      </group>
 
63
      <sbr/>
 
64
      <group rep="repeat">
 
65
        <arg choice="plain"><option>--envs-for=<replaceable
 
66
        >PLUGIN</replaceable><literal>:</literal><replaceable
 
67
        >ENV</replaceable><literal>=</literal><replaceable
 
68
        >value</replaceable></option></arg>
 
69
        <arg choice="plain"><option>-f<replaceable>
 
70
        PLUGIN</replaceable><literal>:</literal><replaceable
 
71
        >ENV</replaceable><literal>=</literal><replaceable
 
72
        >value</replaceable> </option></arg>
 
73
      </group>
 
74
      <sbr/>
 
75
      <group rep="repeat">
 
76
        <arg choice="plain"><option>--global-options=<replaceable
 
77
        >OPTIONS</replaceable></option></arg>
 
78
        <arg choice="plain"><option>-g<replaceable>
 
79
        OPTIONS</replaceable> </option></arg>
 
80
      </group>
 
81
      <sbr/>
 
82
      <group rep="repeat">
 
83
        <arg choice="plain"><option>--options-for=<replaceable
 
84
        >PLUGIN</replaceable><literal>:</literal><replaceable
 
85
        >OPTIONS</replaceable></option></arg>
 
86
        <arg choice="plain"><option>-f<replaceable>
 
87
        PLUGIN</replaceable><literal>:</literal><replaceable
 
88
        >OPTIONS</replaceable> </option></arg>
 
89
      </group>
 
90
      <sbr/>
 
91
      <group rep="repeat">
 
92
        <arg choice="plain"><option>--disable=<replaceable
 
93
        >PLUGIN</replaceable></option></arg>
 
94
        <arg choice="plain"><option>-d
 
95
        <replaceable>PLUGIN</replaceable> </option></arg>
 
96
      </group>
 
97
      <sbr/>
 
98
      <arg><option>--groupid=<replaceable
 
99
      >ID</replaceable></option></arg>
 
100
      <sbr/>
 
101
      <arg><option>--userid=<replaceable
 
102
      >ID</replaceable></option></arg>
 
103
      <sbr/>
 
104
      <arg><option>--plugin-dir=<replaceable
 
105
      >DIRECTORY</replaceable></option></arg>
 
106
      <sbr/>
 
107
      <arg><option>--debug</option></arg>
 
108
    </cmdsynopsis>
 
109
    <cmdsynopsis>
 
110
      <command>&COMMANDNAME;</command>
 
111
      <group choice="req">
 
112
        <arg choice="plain"><option>--help</option></arg>
 
113
        <arg choice="plain"><option>-?</option></arg>
 
114
      </group>
 
115
    </cmdsynopsis>
 
116
    <cmdsynopsis>
 
117
      <command>&COMMANDNAME;</command>
 
118
      <arg choice="plain"><option>--usage</option></arg>
 
119
    </cmdsynopsis>
 
120
    <cmdsynopsis>
 
121
      <command>&COMMANDNAME;</command>
 
122
      <group choice="req">
 
123
        <arg choice="plain"><option>--version</option></arg>
 
124
        <arg choice="plain"><option>-V</option></arg>
 
125
      </group>
 
126
    </cmdsynopsis>
96
127
  </refsynopsisdiv>
97
128
 
98
129
  <refsect1 id="description">
100
131
    <para>
101
132
      <command>&COMMANDNAME;</command> is a plugin runner that waits
102
133
      for any of its plugins to return sucessfull with a password, and
103
 
      passes it to cryptsetup. plugins is defined as any executables
104
 
      in the plugins directory will by default will be
105
 
      /conf/conf.d/mandos/plugins.d.  to stdout.
 
134
      passes it to cryptsetup as stdout message. This command is not
 
135
      meant to be invoked directly, but is instead meant to be run by
 
136
      cryptsetup by being specified in /etc/crypttab as a keyscript
 
137
      and subsequlently started in the initrd environment. See
 
138
      <citerefentry><refentrytitle>crypttab</refentrytitle>
 
139
      <manvolnum>5</manvolnum></citerefentry> for more information on
 
140
      keyscripts.
106
141
    </para>
107
142
 
 
143
    <para>
 
144
      plugins is looked for in the plugins directory which by default will be
 
145
      /conf/conf.d/mandos/plugins.d if not changed by option --plugin-dir.
 
146
    </para>
 
147
  </refsect1>
 
148
  <refsect1>
 
149
    <title>OPTIONS</title>
108
150
    <variablelist>
109
151
      <varlistentry>
110
 
        <term><literal>-g</literal>,<literal>--global-options
111
 
        <replaceable>OPTIONS</replaceable></literal></term>
 
152
        <term><option>--global-options
 
153
        <replaceable>OPTIONS</replaceable></option></term>
 
154
        <term><option>-g
 
155
        <replaceable>OPTIONS</replaceable></option></term>
112
156
        <listitem>
113
157
          <para>
114
158
            Global options given to all plugins as additional start
115
159
            arguments.  Options are specified with a -o flag followed
116
160
            by a comma separated string of options.
117
 
          </para>         
 
161
          </para>       
118
162
        </listitem>
119
163
      </varlistentry>
120
164
 
121
165
      <varlistentry>
122
 
        <term><literal>-o</literal>,<literal> --options-for
123
 
        <replaceable>PLUGIN</replaceable>:<replaceable>OPTION</replaceable>
124
 
        </literal></term>
 
166
        <term><option>--options-for
 
167
        <replaceable>PLUGIN</replaceable><literal>:</literal
 
168
        ><replaceable>OPTION</replaceable></option></term>
 
169
        <term><option>-o
 
170
        <replaceable>PLUGIN</replaceable><literal>:</literal
 
171
        ><replaceable>OPTION</replaceable></option></term>
125
172
        <listitem>
126
173
          <para>
127
174
            Plugin specific options given to the plugin as additional
128
175
            start arguments.  Options are specified with a -o flag
129
176
            followed by a comma separated string of options.
130
 
          </para>         
 
177
          </para>       
131
178
        </listitem>
132
 
      </varlistentry>      
 
179
      </varlistentry>
133
180
 
134
181
      <varlistentry>
135
 
        <term><literal>-d</literal>,<literal> --disable
136
 
        <replaceable>PLUGIN</replaceable>
137
 
        </literal></term>
 
182
        <term><option> --disable
 
183
        <replaceable>PLUGIN</replaceable></option></term>
 
184
        <term><option>-d
 
185
        <replaceable>PLUGIN</replaceable></option></term>
138
186
        <listitem>
139
187
          <para>
140
188
            Disable a specific plugin
141
 
          </para>         
 
189
          </para>       
142
190
        </listitem>
143
191
      </varlistentry>
144
192
 
145
193
      <varlistentry>
146
 
        <term><literal>--groupid <replaceable>ID</replaceable>
147
 
        </literal></term>
 
194
        <term><option>--groupid
 
195
        <replaceable>ID</replaceable></option></term>
148
196
        <listitem>
149
197
          <para>
150
198
            Group ID the plugins will run as
151
199
          </para>
152
200
        </listitem>
153
 
      </varlistentry>      
 
201
      </varlistentry>
154
202
 
155
203
      <varlistentry>
156
 
        <term><literal>--userid <replaceable>ID</replaceable>
157
 
        </literal></term>
 
204
        <term><option>--userid
 
205
        <replaceable>ID</replaceable></option></term>
158
206
        <listitem>
159
207
          <para>
160
208
            User ID the plugins will run as
161
209
          </para>
162
210
        </listitem>
163
 
      </varlistentry>      
 
211
      </varlistentry>
164
212
 
165
213
      <varlistentry>
166
 
        <term><literal>--plugin-dir <replaceable>DIRECTORY</replaceable>
167
 
        </literal></term>
 
214
        <term><option>--plugin-dir
 
215
        <replaceable>DIRECTORY</replaceable></option></term>
168
216
        <listitem>
169
217
          <para>
170
218
            Specify a different plugin directory
171
219
          </para>
172
220
        </listitem>
173
 
      </varlistentry>       
 
221
      </varlistentry>
174
222
      
175
223
      <varlistentry>
176
 
        <term><literal>--debug</literal></term>
 
224
        <term><option>--debug</option></term>
177
225
        <listitem>
178
226
          <para>
179
227
            Debug mode
182
230
      </varlistentry>
183
231
      
184
232
      <varlistentry>
185
 
        <term><literal>-?</literal>, <literal>--help</literal></term>
 
233
        <term><option>--help</option></term>
 
234
        <term><option>-?</option></term>
186
235
        <listitem>
187
236
          <para>
188
237
            Gives a help message
191
240
      </varlistentry>
192
241
      
193
242
      <varlistentry>
194
 
        <term><literal>--usage</literal></term>
 
243
        <term><option>--usage</option></term>
195
244
        <listitem>
196
245
          <para>
197
246
            Gives a short usage message
200
249
      </varlistentry>
201
250
 
202
251
      <varlistentry>
203
 
        <term><literal>-V</literal>, <literal>--version</literal></term>
 
252
        <term><option>--version</option></term>
 
253
        <term><option>-V</option></term>
204
254
        <listitem>
205
255
          <para>
206
256
            Prints the program version
207
257
          </para>
208
258
        </listitem>
209
 
      </varlistentry>            
 
259
      </varlistentry>
210
260
    </variablelist>
211
261
  </refsect1>
 
262
 
 
263
  <refsect1 id="exit_status">
 
264
    <title>EXIT STATUS</title>
 
265
    <para>
 
266
    </para>
 
267
  </refsect1>
 
268
 
 
269
  <refsect1 id="file">
 
270
    <title>FILES</title>
 
271
    <para>
 
272
    </para>
 
273
  </refsect1>
 
274
 
 
275
  <refsect1 id="notes">
 
276
    <title>NOTES</title>
 
277
    <para>
 
278
    </para>
 
279
  </refsect1>
 
280
  
 
281
  <refsect1 id="bugs">
 
282
    <title>BUGS</title>
 
283
    <para>
 
284
    </para>
 
285
  </refsect1>
 
286
 
 
287
  <refsect1 id="examples">
 
288
    <title>EXAMPLE</title>
 
289
    <para>
 
290
    </para>
 
291
  </refsect1>
 
292
 
 
293
  <refsect1 id="security">
 
294
    <title>SECURITY</title>
 
295
    <para>
 
296
    </para>
 
297
  </refsect1>
 
298
 
 
299
  <refsect1 id="see_also">
 
300
    <title>SEE ALSO</title>
 
301
    <para>
 
302
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
 
303
      <manvolnum>8</manvolnum></citerefentry>,
 
304
      <citerefentry><refentrytitle>mandos</refentrytitle>
 
305
      <manvolnum>8</manvolnum></citerefentry>,
 
306
      <citerefentry><refentrytitle>password-prompt</refentrytitle>
 
307
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
308
      <citerefentry><refentrytitle>password-request</refentrytitle>
 
309
      <manvolnum>8mandos</manvolnum></citerefentry>
 
310
    </para>
 
311
  </refsect1>
 
312
 
212
313
</refentry>
 
314
<!-- Local Variables: -->
 
315
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
316
<!-- time-stamp-end: "[\"']>" -->
 
317
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
318
<!-- End: -->