/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: Björn Påhlsson
  • Date: 2008-07-20 02:52:20 UTC
  • Revision ID: belorn@braxen-20080720025220-r5u0388uy9iu23h6
Added following support:
Pluginbased client handler
rewritten Mandos client
       Avahi instead of udp server discovery
       openpgp encrypted key support
Passprompt stand alone application for direct console input
Added logging for Mandos server

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugin-runner.xml
1
 
<?xml version="1.0" encoding="UTF-8"?>
2
 
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
 
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
 
<!ENTITY VERSION "1.0">
5
 
<!ENTITY COMMANDNAME "plugin-runner">
6
 
<!ENTITY TIMESTAMP "2008-09-01">
7
 
]>
8
 
 
9
 
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
10
 
  <refentryinfo>
11
 
    <title>Mandos Manual</title>
12
 
    <!-- Nwalsh’s docbook scripts use this to generate the footer: -->
13
 
    <productname>Mandos</productname>
14
 
    <productnumber>&VERSION;</productnumber>
15
 
    <date>&TIMESTAMP;</date>
16
 
    <authorgroup>
17
 
      <author>
18
 
        <firstname>Björn</firstname>
19
 
        <surname>Påhlsson</surname>
20
 
        <address>
21
 
          <email>belorn@fukt.bsnet.se</email>
22
 
        </address>
23
 
      </author>
24
 
      <author>
25
 
        <firstname>Teddy</firstname>
26
 
        <surname>Hogeborn</surname>
27
 
        <address>
28
 
          <email>teddy@fukt.bsnet.se</email>
29
 
        </address>
30
 
      </author>
31
 
    </authorgroup>
32
 
    <copyright>
33
 
      <year>2008</year>
34
 
      <holder>Teddy Hogeborn</holder>
35
 
      <holder>Björn Påhlsson</holder>
36
 
    </copyright>
37
 
    <xi:include href="legalnotice.xml"/>
38
 
  </refentryinfo>
39
 
 
40
 
  <refmeta>
41
 
    <refentrytitle>&COMMANDNAME;</refentrytitle>
42
 
    <manvolnum>8mandos</manvolnum>
43
 
  </refmeta>
44
 
  
45
 
  <refnamediv>
46
 
    <refname><command>&COMMANDNAME;</command></refname>
47
 
    <refpurpose>
48
 
      Run Mandos plugins.  Pass data from first succesful one.
49
 
    </refpurpose>
50
 
  </refnamediv>
51
 
 
52
 
  <refsynopsisdiv>
53
 
    <cmdsynopsis>
54
 
      <command>&COMMANDNAME;</command>
55
 
      <group rep="repeat">
56
 
        <arg choice="plain"><option>--global-env=<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>--env-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>
127
 
  </refsynopsisdiv>
128
 
  
129
 
  <refsect1 id="description">
130
 
    <title>DESCRIPTION</title>
131
 
    <para>
132
 
      <command>&COMMANDNAME;</command> is a program which is meant to
133
 
      be specified as <quote>keyscript</quote> in <citerefentry>
134
 
      <refentrytitle>crypttab</refentrytitle>
135
 
      <manvolnum>5</manvolnum></citerefentry> for the root disk.  The
136
 
      aim of this program is therefore to output a password, which
137
 
      then <citerefentry><refentrytitle>cryptsetup</refentrytitle>
138
 
      <manvolnum>8</manvolnum></citerefentry> will use to try and
139
 
      unlock the root disk.
140
 
    </para>
141
 
    <para>
142
 
      This program is not meant to be invoked directly, but can be in
143
 
      order to test it.  Note that any password obtained will simply
144
 
      be output on standard output.
145
 
    </para>
146
 
  </refsect1>
147
 
  
148
 
  <refsect1 id="purpose">
149
 
    <title>PURPOSE</title>
150
 
    <para>
151
 
      The purpose of this is to enable <emphasis>remote and unattended
152
 
      rebooting</emphasis> of client host computer with an
153
 
      <emphasis>encrypted root file system</emphasis>.  See <xref
154
 
      linkend="overview"/> for details.
155
 
    </para>
156
 
  </refsect1>
157
 
  
158
 
  <refsect1>
159
 
    <title>OPTIONS</title>
160
 
    <variablelist>
161
 
      <varlistentry>
162
 
        <term><option>--global-env
163
 
        <replaceable>VAR</replaceable><literal>=</literal><replaceable
164
 
        >value</replaceable></option></term>
165
 
        <term><option>-e
166
 
        <replaceable>VAR</replaceable><literal>=</literal><replaceable
167
 
        >value</replaceable></option></term>
168
 
        <listitem>
169
 
          <para>
170
 
            
171
 
          </para>
172
 
        </listitem>
173
 
      </varlistentry>
174
 
      
175
 
      <varlistentry>
176
 
        <term><option>--env-for
177
 
        <replaceable>PLUGIN</replaceable><literal>:</literal
178
 
        ><replaceable>ENV</replaceable><literal>=</literal
179
 
        ><replaceable>value</replaceable></option></term>
180
 
        <term><option>-f
181
 
        <replaceable>PLUGIN</replaceable><literal>:</literal
182
 
        ><replaceable>ENV</replaceable><literal>=</literal
183
 
        ><replaceable>value</replaceable></option></term>
184
 
        <listitem>
185
 
          <para>
186
 
          </para>
187
 
        </listitem>
188
 
      </varlistentry>
189
 
      
190
 
      <varlistentry>
191
 
        <term><option>--global-options
192
 
        <replaceable>OPTIONS</replaceable></option></term>
193
 
        <term><option>-g
194
 
        <replaceable>OPTIONS</replaceable></option></term>
195
 
        <listitem>
196
 
          <para>
197
 
            Pass some options to <emphasis>all</emphasis> plugins.
198
 
            <replaceable>OPTIONS</replaceable> is a comma separated
199
 
            list of options.  This is not a very useful option, except
200
 
            for specifying the <quote><option>--debug</option></quote>
201
 
            for all plugins.
202
 
          </para>
203
 
        </listitem>
204
 
      </varlistentry>
205
 
      
206
 
      <varlistentry>
207
 
        <term><option>--options-for
208
 
        <replaceable>PLUGIN</replaceable><literal>:</literal
209
 
        ><replaceable>OPTION</replaceable></option></term>
210
 
        <term><option>-o
211
 
        <replaceable>PLUGIN</replaceable><literal>:</literal
212
 
        ><replaceable>OPTION</replaceable></option></term>
213
 
        <listitem>
214
 
          <para>
215
 
            Pass some options to a specific plugin.  <replaceable
216
 
            >PLUGIN</replaceable> is the name (file basename) of a
217
 
            plugin, and <replaceable>OPTIONS</replaceable> is a comma
218
 
            separated list of options.
219
 
          </para>
220
 
          <para>
221
 
            Note that since options are not split on whitespace, the
222
 
            way to pass, to the plugin
223
 
            <quote><filename>foo</filename></quote>, the option
224
 
            <option>--bar</option> with the option argument
225
 
            <quote>baz</quote> is either
226
 
            <userinput>--options-for=foo:--bar=baz</userinput> or
227
 
            <userinput>--options-for=foo:--bar,baz</userinput>, but
228
 
            <emphasis>not</emphasis>
229
 
            <userinput>--options-for="foo:--bar baz"</userinput>.
230
 
          </para>
231
 
        </listitem>
232
 
      </varlistentry>
233
 
 
234
 
      <varlistentry>
235
 
        <term><option> --disable
236
 
        <replaceable>PLUGIN</replaceable></option></term>
237
 
        <term><option>-d
238
 
        <replaceable>PLUGIN</replaceable></option></term>
239
 
        <listitem>
240
 
          <para>
241
 
            Disable the plugin named
242
 
            <replaceable>PLUGIN</replaceable>.  The plugin will not be
243
 
            started.
244
 
          </para>       
245
 
        </listitem>
246
 
      </varlistentry>
247
 
 
248
 
      <varlistentry>
249
 
        <term><option>--groupid
250
 
        <replaceable>ID</replaceable></option></term>
251
 
        <listitem>
252
 
          <para>
253
 
            Change to group ID <replaceable>ID</replaceable> on
254
 
            startup.  The default is 65534.  All plugins will be
255
 
            started using this group ID.  <emphasis>Note:</emphasis>
256
 
            This must be a number, not a name.
257
 
          </para>
258
 
        </listitem>
259
 
      </varlistentry>
260
 
 
261
 
      <varlistentry>
262
 
        <term><option>--userid
263
 
        <replaceable>ID</replaceable></option></term>
264
 
        <listitem>
265
 
          <para>
266
 
            Change to user ID <replaceable>ID</replaceable> on
267
 
            startup.  The default is 65534.  All plugins will be
268
 
            started using this user ID.  <emphasis>Note:</emphasis>
269
 
            This must be a number, not a name.
270
 
          </para>
271
 
        </listitem>
272
 
      </varlistentry>
273
 
 
274
 
      <varlistentry>
275
 
        <term><option>--plugin-dir
276
 
        <replaceable>DIRECTORY</replaceable></option></term>
277
 
        <listitem>
278
 
          <para>
279
 
            Specify a different plugin directory.  The default is
280
 
            <filename>/lib/mandos/plugins.d</filename>, which will
281
 
            exist in the initial <acronym>RAM</acronym> disk
282
 
            environment.
283
 
          </para>
284
 
        </listitem>
285
 
      </varlistentry>
286
 
      
287
 
      <varlistentry>
288
 
        <term><option>--debug</option></term>
289
 
        <listitem>
290
 
          <para>
291
 
            Enable debug mode.  This will enable a lot of output to
292
 
            standard error about what the program is doing.  The
293
 
            program will still perform all other functions normally.
294
 
            The default is to <emphasis>not</emphasis> run in debug
295
 
            mode.
296
 
          </para>
297
 
          <para>
298
 
            The plugins will <emphasis>not</emphasis> be affected by
299
 
            this option.  Use
300
 
            <userinput><option>--global-options=--debug</option></userinput>
301
 
            if complete debugging eruption is desired.
302
 
          </para>
303
 
        </listitem>
304
 
      </varlistentry>
305
 
      
306
 
      <varlistentry>
307
 
        <term><option>--help</option></term>
308
 
        <term><option>-?</option></term>
309
 
        <listitem>
310
 
          <para>
311
 
            Gives a help message about options and their meanings.
312
 
          </para>
313
 
        </listitem>
314
 
      </varlistentry>
315
 
      
316
 
      <varlistentry>
317
 
        <term><option>--usage</option></term>
318
 
        <listitem>
319
 
          <para>
320
 
            Gives a short usage message.
321
 
          </para>
322
 
        </listitem>
323
 
      </varlistentry>
324
 
 
325
 
      <varlistentry>
326
 
        <term><option>--version</option></term>
327
 
        <term><option>-V</option></term>
328
 
        <listitem>
329
 
          <para>
330
 
            Prints the program version.
331
 
          </para>
332
 
        </listitem>
333
 
      </varlistentry>
334
 
    </variablelist>
335
 
  </refsect1>
336
 
 
337
 
  <refsect1 id="overview">
338
 
    <title>OVERVIEW</title>
339
 
    <xi:include href="overview.xml"/>
340
 
    <para>
341
 
      This program will run on the client side in the initial
342
 
      <acronym>RAM</acronym> disk environment, and is responsible for
343
 
      getting a password.  It does this by running plugins, one of
344
 
      which will normally be the actual client program communicating
345
 
      with the server.
346
 
    </para>
347
 
  </refsect1>
348
 
  <refsect1 id="plugins">
349
 
    <title>PLUGINS</title>
350
 
    <para>
351
 
      This program will get a password by running a number of
352
 
      <firstterm>plugins</firstterm>, which are simply executable
353
 
      programs in a directory in the initial <acronym>RAM</acronym>
354
 
      disk environment.  The default directory is
355
 
      <filename>/lib/mandos/plugins.d</filename>, but this can be
356
 
      changed with the <option>--plugin-dir</option> option.  The
357
 
      plugins are started in parallel, and the first plugin to output
358
 
      a password <emphasis>and</emphasis> exit with a successful exit
359
 
      code will make this plugin-runner output the password from that
360
 
      plugin, stop any other plugins, and exit.
361
 
    </para>
362
 
  </refsect1>
363
 
  
364
 
  <refsect1 id="fallback">
365
 
    <title>FALLBACK</title>
366
 
    <para>
367
 
      If no plugins succeed, this program will, as a fallback, ask for
368
 
      a password on the console using <citerefentry><refentrytitle
369
 
      >getpass</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
370
 
      and output it.  This is not meant to be the normal mode of
371
 
      operation, as there is a separate plugin for getting a password
372
 
      from the console.
373
 
    </para>
374
 
  </refsect1>
375
 
  
376
 
  <refsect1 id="exit_status">
377
 
    <title>EXIT STATUS</title>
378
 
    <para>
379
 
      Exit status of this program is zero if no errors were
380
 
      encountered, and otherwise not.  The fallback (see <xref
381
 
      linkend="fallback"/>) may or may not have succeeded in either
382
 
      case.
383
 
    </para>
384
 
  </refsect1>
385
 
  
386
 
  <refsect1 id="environment">
387
 
    <title>ENVIRONMENT</title>
388
 
    <para>
389
 
      
390
 
    </para>
391
 
  </refsect1>
392
 
  
393
 
  <refsect1 id="file">
394
 
    <title>FILES</title>
395
 
    <para>
396
 
      <variablelist>
397
 
        <varlistentry>
398
 
          <term><filename
399
 
          >/conf/conf.d/mandos/plugin-runner.conf</filename></term>
400
 
          <listitem>
401
 
            <para>
402
 
              Since this program will be run as a keyscript, there is
403
 
              little to no opportunity to pass command line arguments
404
 
              to it.  Therefore, it will <emphasis>also</emphasis>
405
 
              read this file and use its contents as
406
 
              whitespace-separated command line options.  Also,
407
 
              everything from a <quote>#</quote> character to the end
408
 
              of a line is ignored.
409
 
            </para>
410
 
          </listitem>
411
 
        </varlistentry>
412
 
      </variablelist>
413
 
    </para>
414
 
  </refsect1>
415
 
  
416
 
  <refsect1 id="bugs">
417
 
    <title>BUGS</title>
418
 
    <para>
419
 
    </para>
420
 
  </refsect1>
421
 
  
422
 
  <refsect1 id="examples">
423
 
    <title>EXAMPLE</title>
424
 
    <para>
425
 
    </para>
426
 
  </refsect1>
427
 
  
428
 
  <refsect1 id="security">
429
 
    <title>SECURITY</title>
430
 
    <para>
431
 
    </para>
432
 
  </refsect1>
433
 
  
434
 
  <refsect1 id="see_also">
435
 
    <title>SEE ALSO</title>
436
 
    <para>
437
 
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
438
 
      <manvolnum>8</manvolnum></citerefentry>,
439
 
      <citerefentry><refentrytitle>mandos</refentrytitle>
440
 
      <manvolnum>8</manvolnum></citerefentry>,
441
 
      <citerefentry><refentrytitle>password-prompt</refentrytitle>
442
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
443
 
      <citerefentry><refentrytitle>password-request</refentrytitle>
444
 
      <manvolnum>8mandos</manvolnum></citerefentry>
445
 
    </para>
446
 
  </refsect1>
447
 
  
448
 
</refentry>
449
 
<!-- Local Variables: -->
450
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
451
 
<!-- time-stamp-end: "[\"']>" -->
452
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
453
 
<!-- End: -->