/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-25 06:44:13 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080825064413-smqg5qwxfvhkeop4
* Makefile (DOCBOOKTOMAN): Only cd to one directory.

* mandos-options.xml (interface): Removed mention of a specific
                                  replaceable.
  (debug): Reworded slightly.

* mandos.conf.xml (OPTIONS): Renamed some replaceable names.

* mandos.xml (SYNOPSIS, OPTIONS): Renamed replaceable of "interface"
                                  from "IF" to "NAME".

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugin-runner.xml
1
 
<?xml version="1.0" encoding="UTF-8"?>
 
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"?>
2
4
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
5
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
 
6
<!ENTITY VERSION "1.0">
4
7
<!ENTITY COMMANDNAME "plugin-runner">
5
 
<!ENTITY TIMESTAMP "2019-07-26">
6
 
<!ENTITY % common SYSTEM "common.ent">
7
 
%common;
8
8
]>
9
9
 
10
 
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
 
10
<refentry>
11
11
  <refentryinfo>
12
 
    <title>Mandos Manual</title>
13
 
    <!-- Nwalsh’s docbook scripts use this to generate the footer: -->
14
 
    <productname>Mandos</productname>
15
 
    <productnumber>&version;</productnumber>
16
 
    <date>&TIMESTAMP;</date>
 
12
    <title>&COMMANDNAME;</title>
 
13
    <!-- NWalsh's docbook scripts use this to generate the footer: -->
 
14
    <productname>&COMMANDNAME;</productname>
 
15
    <productnumber>&VERSION;</productnumber>
17
16
    <authorgroup>
18
17
      <author>
19
18
        <firstname>Björn</firstname>
20
19
        <surname>Påhlsson</surname>
21
20
        <address>
22
 
          <email>belorn@recompile.se</email>
 
21
          <email>belorn@fukt.bsnet.se</email>
23
22
        </address>
24
23
      </author>
25
24
      <author>
26
25
        <firstname>Teddy</firstname>
27
26
        <surname>Hogeborn</surname>
28
27
        <address>
29
 
          <email>teddy@recompile.se</email>
 
28
          <email>teddy@fukt.bsnet.se</email>
30
29
        </address>
31
30
      </author>
32
31
    </authorgroup>
33
32
    <copyright>
34
33
      <year>2008</year>
35
 
      <year>2009</year>
36
 
      <year>2010</year>
37
 
      <year>2011</year>
38
 
      <year>2012</year>
39
 
      <year>2013</year>
40
 
      <year>2014</year>
41
 
      <year>2015</year>
42
 
      <year>2016</year>
43
 
      <year>2017</year>
44
 
      <year>2018</year>
45
 
      <year>2019</year>
46
 
      <holder>Teddy Hogeborn</holder>
47
 
      <holder>Björn Påhlsson</holder>
 
34
      <holder>Teddy Hogeborn &amp; Björn Påhlsson</holder>
48
35
    </copyright>
49
 
    <xi:include href="legalnotice.xml"/>
 
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>
50
59
  </refentryinfo>
51
 
  
 
60
 
52
61
  <refmeta>
53
62
    <refentrytitle>&COMMANDNAME;</refentrytitle>
54
63
    <manvolnum>8mandos</manvolnum>
57
66
  <refnamediv>
58
67
    <refname><command>&COMMANDNAME;</command></refname>
59
68
    <refpurpose>
60
 
      Run Mandos plugins, pass data from first to succeed.
 
69
      get password for encrypted rootdisk
61
70
    </refpurpose>
62
71
  </refnamediv>
63
 
  
 
72
 
64
73
  <refsynopsisdiv>
65
74
    <cmdsynopsis>
66
75
      <command>&COMMANDNAME;</command>
67
 
      <group rep="repeat">
68
 
        <arg choice="plain"><option>--global-env=<replaceable
69
 
        >ENV</replaceable><literal>=</literal><replaceable
70
 
        >value</replaceable></option></arg>
71
 
        <arg choice="plain"><option>-G
72
 
        <replaceable>ENV</replaceable><literal>=</literal><replaceable
73
 
        >value</replaceable> </option></arg>
74
 
      </group>
75
 
      <sbr/>
76
 
      <group rep="repeat">
77
 
        <arg choice="plain"><option>--env-for=<replaceable
78
 
        >PLUGIN</replaceable><literal>:</literal><replaceable
79
 
        >ENV</replaceable><literal>=</literal><replaceable
80
 
        >value</replaceable></option></arg>
81
 
        <arg choice="plain"><option>-E<replaceable>
82
 
        PLUGIN</replaceable><literal>:</literal><replaceable
83
 
        >ENV</replaceable><literal>=</literal><replaceable
84
 
        >value</replaceable> </option></arg>
85
 
      </group>
86
 
      <sbr/>
87
 
      <group rep="repeat">
88
 
        <arg choice="plain"><option>--global-options=<replaceable
89
 
        >OPTIONS</replaceable></option></arg>
90
 
        <arg choice="plain"><option>-g<replaceable>
91
 
        OPTIONS</replaceable> </option></arg>
92
 
      </group>
93
 
      <sbr/>
94
 
      <group rep="repeat">
95
 
        <arg choice="plain"><option>--options-for=<replaceable
96
 
        >PLUGIN</replaceable><literal>:</literal><replaceable
97
 
        >OPTIONS</replaceable></option></arg>
98
 
        <arg choice="plain"><option>-o<replaceable>
99
 
        PLUGIN</replaceable><literal>:</literal><replaceable
100
 
        >OPTIONS</replaceable> </option></arg>
101
 
      </group>
102
 
      <sbr/>
103
 
      <group rep="repeat">
104
 
        <arg choice="plain"><option>--disable=<replaceable
105
 
        >PLUGIN</replaceable></option></arg>
106
 
        <arg choice="plain"><option>-d
107
 
        <replaceable>PLUGIN</replaceable> </option></arg>
108
 
      </group>
109
 
      <sbr/>
110
 
      <group rep="repeat">
111
 
        <arg choice="plain"><option>--enable=<replaceable
112
 
        >PLUGIN</replaceable></option></arg>
113
 
        <arg choice="plain"><option>-e
114
 
        <replaceable>PLUGIN</replaceable> </option></arg>
115
 
      </group>
116
 
      <sbr/>
117
 
      <arg><option>--groupid=<replaceable
118
 
      >ID</replaceable></option></arg>
119
 
      <sbr/>
120
 
      <arg><option>--userid=<replaceable
121
 
      >ID</replaceable></option></arg>
122
 
      <sbr/>
123
 
      <arg><option>--plugin-dir=<replaceable
124
 
      >DIRECTORY</replaceable></option></arg>
125
 
      <sbr/>
126
 
      <arg><option>--plugin-helper-dir=<replaceable
127
 
      >DIRECTORY</replaceable></option></arg>
128
 
      <sbr/>
129
 
      <arg><option>--config-file=<replaceable
130
 
      >FILE</replaceable></option></arg>
131
 
      <sbr/>
132
 
      <arg><option>--debug</option></arg>
133
 
    </cmdsynopsis>
134
 
    <cmdsynopsis>
135
 
      <command>&COMMANDNAME;</command>
136
 
      <group choice="req">
137
 
        <arg choice="plain"><option>--help</option></arg>
138
 
        <arg choice="plain"><option>-?</option></arg>
139
 
      </group>
140
 
    </cmdsynopsis>
141
 
    <cmdsynopsis>
142
 
      <command>&COMMANDNAME;</command>
143
 
      <arg choice="plain"><option>--usage</option></arg>
144
 
    </cmdsynopsis>
145
 
    <cmdsynopsis>
146
 
      <command>&COMMANDNAME;</command>
147
 
      <group choice="req">
148
 
        <arg choice="plain"><option>--version</option></arg>
149
 
        <arg choice="plain"><option>-V</option></arg>
150
 
      </group>
151
 
    </cmdsynopsis>
 
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'>--userid<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>    
152
96
  </refsynopsisdiv>
153
 
  
 
97
 
154
98
  <refsect1 id="description">
155
99
    <title>DESCRIPTION</title>
156
100
    <para>
157
 
      <command>&COMMANDNAME;</command> is a program which is meant to
158
 
      be specified as a <quote>keyscript</quote> for the root disk in
 
101
      <command>&COMMANDNAME;</command> is a plugin runner that waits
 
102
      for any of its plugins to return sucessfull with a password, and
 
103
      passes it to cryptsetup as stdout message. This command is not
 
104
      meant to be invoked directly, but is instead meant to be run by
 
105
      cryptsetup by being specified in /etc/crypttab as a keyscript
 
106
      and subsequlently started in the initrd environment. See
159
107
      <citerefentry><refentrytitle>crypttab</refentrytitle>
160
 
      <manvolnum>5</manvolnum></citerefentry>.  The aim of this
161
 
      program is therefore to output a password, which then
162
 
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
163
 
      <manvolnum>8</manvolnum></citerefentry> will use to unlock the
164
 
      root disk.
165
 
    </para>
166
 
    <para>
167
 
      This program is not meant to be invoked directly, but can be in
168
 
      order to test it.  Note that any password obtained will simply
169
 
      be output on standard output.
170
 
    </para>
171
 
  </refsect1>
172
 
  
173
 
  <refsect1 id="purpose">
174
 
    <title>PURPOSE</title>
175
 
    <para>
176
 
      The purpose of this is to enable <emphasis>remote and unattended
177
 
      rebooting</emphasis> of client host computer with an
178
 
      <emphasis>encrypted root file system</emphasis>.  See <xref
179
 
      linkend="overview"/> for details.
180
 
    </para>
181
 
  </refsect1>
182
 
  
 
108
      <manvolnum>5</manvolnum></citerefentry> for more information on
 
109
      keyscripts.    
 
110
    </para>
 
111
 
 
112
    <para>
 
113
      plugins is looked for in the plugins directory which by default will be
 
114
      /conf/conf.d/mandos/plugins.d if not changed by option --plugin-dir.
 
115
    </para>
 
116
  </refsect1>
183
117
  <refsect1>
184
118
    <title>OPTIONS</title>
185
119
    <variablelist>
186
120
      <varlistentry>
187
 
        <term><option>--global-env
188
 
        <replaceable>ENV</replaceable><literal>=</literal><replaceable
189
 
        >value</replaceable></option></term>
190
 
        <term><option>-G
191
 
        <replaceable>ENV</replaceable><literal>=</literal><replaceable
192
 
        >value</replaceable></option></term>
193
 
        <listitem>
194
 
          <para>
195
 
            This option will add an environment variable setting to
196
 
            all plugins.  This will override any inherited environment
197
 
            variable.
198
 
          </para>
199
 
        </listitem>
200
 
      </varlistentry>
201
 
      
202
 
      <varlistentry>
203
 
        <term><option>--env-for
204
 
        <replaceable>PLUGIN</replaceable><literal>:</literal
205
 
        ><replaceable>ENV</replaceable><literal>=</literal
206
 
        ><replaceable>value</replaceable></option></term>
207
 
        <term><option>-E
208
 
        <replaceable>PLUGIN</replaceable><literal>:</literal
209
 
        ><replaceable>ENV</replaceable><literal>=</literal
210
 
        ><replaceable>value</replaceable></option></term>
211
 
        <listitem>
212
 
          <para>
213
 
            This option will add an environment variable setting to
214
 
            the <replaceable>PLUGIN</replaceable> plugin.  This will
215
 
            override any inherited environment variables or
216
 
            environment variables specified using
217
 
            <option>--global-env</option>.
218
 
          </para>
219
 
        </listitem>
220
 
      </varlistentry>
221
 
      
222
 
      <varlistentry>
223
 
        <term><option>--global-options
224
 
        <replaceable>OPTIONS</replaceable></option></term>
225
 
        <term><option>-g
226
 
        <replaceable>OPTIONS</replaceable></option></term>
227
 
        <listitem>
228
 
          <para>
229
 
            Pass some options to <emphasis>all</emphasis> plugins.
230
 
            <replaceable>OPTIONS</replaceable> is a comma separated
231
 
            list of options.  This is not a very useful option, except
232
 
            for specifying the <quote><option>--debug</option></quote>
233
 
            option to all plugins.
234
 
          </para>
235
 
        </listitem>
236
 
      </varlistentry>
237
 
      
238
 
      <varlistentry>
239
 
        <term><option>--options-for
240
 
        <replaceable>PLUGIN</replaceable><literal>:</literal
241
 
        ><replaceable>OPTION</replaceable></option></term>
242
 
        <term><option>-o
243
 
        <replaceable>PLUGIN</replaceable><literal>:</literal
244
 
        ><replaceable>OPTION</replaceable></option></term>
245
 
        <listitem>
246
 
          <para>
247
 
            Pass some options to a specific plugin.  <replaceable
248
 
            >PLUGIN</replaceable> is the name (file basename) of a
249
 
            plugin, and <replaceable>OPTIONS</replaceable> is a comma
250
 
            separated list of options.
251
 
          </para>
252
 
          <para>
253
 
            Note that since options are not split on whitespace, the
254
 
            way to pass, to the plugin
255
 
            <quote><filename>foo</filename></quote>, the option
256
 
            <option>--bar</option> with the option argument
257
 
            <quote>baz</quote> is either
258
 
            <userinput>--options-for=foo:--bar=baz</userinput> or
259
 
            <userinput>--options-for=foo:--bar,baz</userinput>.  Using
260
 
            <userinput>--options-for="foo:--bar baz"</userinput>. will
261
 
            <emphasis>not</emphasis> work.
262
 
          </para>
263
 
        </listitem>
264
 
      </varlistentry>
265
 
      
266
 
      <varlistentry>
267
 
        <term><option>--disable
268
 
        <replaceable>PLUGIN</replaceable></option></term>
269
 
        <term><option>-d
270
 
        <replaceable>PLUGIN</replaceable></option></term>
271
 
        <listitem>
272
 
          <para>
273
 
            Disable the plugin named
274
 
            <replaceable>PLUGIN</replaceable>.  The plugin will not be
275
 
            started.
276
 
          </para>
277
 
        </listitem>
278
 
      </varlistentry>
279
 
      
280
 
      <varlistentry>
281
 
        <term><option>--enable
282
 
        <replaceable>PLUGIN</replaceable></option></term>
283
 
        <term><option>-e
284
 
        <replaceable>PLUGIN</replaceable></option></term>
285
 
        <listitem>
286
 
          <para>
287
 
            Re-enable the plugin named
288
 
            <replaceable>PLUGIN</replaceable>.  This is only useful to
289
 
            undo a previous <option>--disable</option> option, maybe
290
 
            from the configuration file.
291
 
          </para>
292
 
        </listitem>
293
 
      </varlistentry>
294
 
      
295
 
      <varlistentry>
296
 
        <term><option>--groupid
297
 
        <replaceable>ID</replaceable></option></term>
298
 
        <listitem>
299
 
          <para>
300
 
            Change to group ID <replaceable>ID</replaceable> on
301
 
            startup.  The default is 65534.  All plugins will be
302
 
            started using this group ID.  <emphasis>Note:</emphasis>
303
 
            This must be a number, not a name.
304
 
          </para>
305
 
        </listitem>
306
 
      </varlistentry>
307
 
      
308
 
      <varlistentry>
309
 
        <term><option>--userid
310
 
        <replaceable>ID</replaceable></option></term>
311
 
        <listitem>
312
 
          <para>
313
 
            Change to user ID <replaceable>ID</replaceable> on
314
 
            startup.  The default is 65534.  All plugins will be
315
 
            started using this user ID.  <emphasis>Note:</emphasis>
316
 
            This must be a number, not a name.
317
 
          </para>
318
 
        </listitem>
319
 
      </varlistentry>
320
 
      
321
 
      <varlistentry>
322
 
        <term><option>--plugin-dir
323
 
        <replaceable>DIRECTORY</replaceable></option></term>
324
 
        <listitem>
325
 
          <para>
326
 
            Specify a different plugin directory.  The default is
327
 
            <filename>/lib/mandos/plugins.d</filename>, which will
328
 
            exist in the initial <acronym>RAM</acronym> disk
329
 
            environment.
330
 
          </para>
331
 
        </listitem>
332
 
      </varlistentry>
333
 
      
334
 
      <varlistentry>
335
 
        <term><option>--plugin-helper-dir
336
 
        <replaceable>DIRECTORY</replaceable></option></term>
337
 
        <listitem>
338
 
          <para>
339
 
            Specify a different plugin helper directory.  The default
340
 
            is <filename>/lib/mandos/plugin-helpers</filename>, which
341
 
            will exist in the initial <acronym>RAM</acronym> disk
342
 
            environment.  (This will simply be passed to all plugins
343
 
            via the <envar>MANDOSPLUGINHELPERDIR</envar> environment
344
 
            variable.  See <xref linkend="writing_plugins"/>)
345
 
          </para>
346
 
        </listitem>
347
 
      </varlistentry>
348
 
      
349
 
      <varlistentry>
350
 
        <term><option>--config-file
351
 
        <replaceable>FILE</replaceable></option></term>
352
 
        <listitem>
353
 
          <para>
354
 
            Specify a different file to read additional options from.
355
 
            See <xref linkend="files"/>.  Other command line options
356
 
            will override options specified in the file.
357
 
          </para>
358
 
        </listitem>
359
 
      </varlistentry>
360
 
      
361
 
      <varlistentry>
362
 
        <term><option>--debug</option></term>
363
 
        <listitem>
364
 
          <para>
365
 
            Enable debug mode.  This will enable a lot of output to
366
 
            standard error about what the program is doing.  The
367
 
            program will still perform all other functions normally.
368
 
            The default is to <emphasis>not</emphasis> run in debug
369
 
            mode.
370
 
          </para>
371
 
          <para>
372
 
            The plugins will <emphasis>not</emphasis> be affected by
373
 
            this option.  Use
374
 
            <userinput><option>--global-options=--debug</option></userinput>
375
 
            if complete debugging eruption is desired.
376
 
          </para>
377
 
        </listitem>
378
 
      </varlistentry>
379
 
      
380
 
      <varlistentry>
381
 
        <term><option>--help</option></term>
382
 
        <term><option>-?</option></term>
383
 
        <listitem>
384
 
          <para>
385
 
            Gives a help message about options and their meanings.
386
 
          </para>
387
 
        </listitem>
388
 
      </varlistentry>
389
 
      
390
 
      <varlistentry>
391
 
        <term><option>--usage</option></term>
392
 
        <listitem>
393
 
          <para>
394
 
            Gives a short usage message.
395
 
          </para>
396
 
        </listitem>
397
 
      </varlistentry>
398
 
      
399
 
      <varlistentry>
400
 
        <term><option>--version</option></term>
401
 
        <term><option>-V</option></term>
402
 
        <listitem>
403
 
          <para>
404
 
            Prints the program version.
405
 
          </para>
406
 
        </listitem>
407
 
      </varlistentry>
 
121
        <term><literal>-g</literal>,<literal>--global-options
 
122
        <replaceable>OPTIONS</replaceable></literal></term>
 
123
        <listitem>
 
124
          <para>
 
125
            Global options given to all plugins as additional start
 
126
            arguments.  Options are specified with a -o flag followed
 
127
            by a comma separated string of options.
 
128
          </para>         
 
129
        </listitem>
 
130
      </varlistentry>
 
131
 
 
132
      <varlistentry>
 
133
        <term><literal>-o</literal>,<literal> --options-for
 
134
        <replaceable>PLUGIN</replaceable>:<replaceable>OPTION</replaceable>
 
135
        </literal></term>
 
136
        <listitem>
 
137
          <para>
 
138
            Plugin specific options given to the plugin as additional
 
139
            start arguments.  Options are specified with a -o flag
 
140
            followed by a comma separated string of options.
 
141
          </para>         
 
142
        </listitem>
 
143
      </varlistentry>      
 
144
 
 
145
      <varlistentry>
 
146
        <term><literal>-d</literal>,<literal> --disable
 
147
        <replaceable>PLUGIN</replaceable>
 
148
        </literal></term>
 
149
        <listitem>
 
150
          <para>
 
151
            Disable a specific plugin
 
152
          </para>         
 
153
        </listitem>
 
154
      </varlistentry>
 
155
 
 
156
      <varlistentry>
 
157
        <term><literal>--groupid <replaceable>ID</replaceable>
 
158
        </literal></term>
 
159
        <listitem>
 
160
          <para>
 
161
            Group ID the plugins will run as
 
162
          </para>
 
163
        </listitem>
 
164
      </varlistentry>      
 
165
 
 
166
      <varlistentry>
 
167
        <term><literal>--userid <replaceable>ID</replaceable>
 
168
        </literal></term>
 
169
        <listitem>
 
170
          <para>
 
171
            User ID the plugins will run as
 
172
          </para>
 
173
        </listitem>
 
174
      </varlistentry>      
 
175
 
 
176
      <varlistentry>
 
177
        <term><literal>--plugin-dir <replaceable>DIRECTORY</replaceable>
 
178
        </literal></term>
 
179
        <listitem>
 
180
          <para>
 
181
            Specify a different plugin directory
 
182
          </para>
 
183
        </listitem>
 
184
      </varlistentry>       
 
185
      
 
186
      <varlistentry>
 
187
        <term><literal>--debug</literal></term>
 
188
        <listitem>
 
189
          <para>
 
190
            Debug mode
 
191
          </para>
 
192
        </listitem>
 
193
      </varlistentry>
 
194
      
 
195
      <varlistentry>
 
196
        <term><literal>-?</literal>, <literal>--help</literal></term>
 
197
        <listitem>
 
198
          <para>
 
199
            Gives a help message
 
200
          </para>
 
201
        </listitem>
 
202
      </varlistentry>
 
203
      
 
204
      <varlistentry>
 
205
        <term><literal>--usage</literal></term>
 
206
        <listitem>
 
207
          <para>
 
208
            Gives a short usage message
 
209
          </para>
 
210
        </listitem>
 
211
      </varlistentry>
 
212
 
 
213
      <varlistentry>
 
214
        <term><literal>-V</literal>, <literal>--version</literal></term>
 
215
        <listitem>
 
216
          <para>
 
217
            Prints the program version
 
218
          </para>
 
219
        </listitem>
 
220
      </varlistentry>            
408
221
    </variablelist>
409
222
  </refsect1>
410
 
  
411
 
  <refsect1 id="overview">
412
 
    <title>OVERVIEW</title>
413
 
    <xi:include href="overview.xml"/>
414
 
    <para>
415
 
      This program will run on the client side in the initial
416
 
      <acronym>RAM</acronym> disk environment, and is responsible for
417
 
      getting a password.  It does this by running plugins, one of
418
 
      which will normally be the actual client program communicating
419
 
      with the server.
420
 
    </para>
421
 
  </refsect1>
422
 
  <refsect1 id="plugins">
423
 
    <title>PLUGINS</title>
424
 
    <para>
425
 
      This program will get a password by running a number of
426
 
      <firstterm>plugins</firstterm>, which are simply executable
427
 
      programs in a directory in the initial <acronym>RAM</acronym>
428
 
      disk environment.  The default directory is
429
 
      <filename>/lib/mandos/plugins.d</filename>, but this can be
430
 
      changed with the <option>--plugin-dir</option> option.  The
431
 
      plugins are started in parallel, and the first plugin to output
432
 
      a password <emphasis>and</emphasis> exit with a successful exit
433
 
      code will make this plugin-runner output the password from that
434
 
      plugin, stop any other plugins, and exit.
435
 
    </para>
436
 
    
437
 
    <refsect2 id="writing_plugins">
438
 
      <title>WRITING PLUGINS</title>
439
 
      <para>
440
 
        A plugin is simply a program which prints a password to its
441
 
        standard output and then exits with a successful (zero) exit
442
 
        status.  If the exit status is not zero, any output on
443
 
        standard output will be ignored by the plugin runner.  Any
444
 
        output on its standard error channel will simply be passed to
445
 
        the standard error of the plugin runner, usually the system
446
 
        console.
447
 
      </para>
448
 
      <para>
449
 
        If the password is a single-line, manually entered passprase,
450
 
        a final trailing newline character should
451
 
        <emphasis>not</emphasis> be printed.
452
 
      </para>
453
 
      <para>
454
 
        The plugin will run in the initial RAM disk environment, so
455
 
        care must be taken not to depend on any files or running
456
 
        services not available there.  Any helper executables required
457
 
        by the plugin (which are not in the <envar>PATH</envar>) can
458
 
        be placed in the plugin helper directory, the name of which
459
 
        will be made available to the plugin via the
460
 
        <envar>MANDOSPLUGINHELPERDIR</envar> environment variable.
461
 
      </para>
462
 
      <para>
463
 
        The plugin must exit cleanly and free all allocated resources
464
 
        upon getting the TERM signal, since this is what the plugin
465
 
        runner uses to stop all other plugins when one plugin has
466
 
        output a password and exited cleanly.
467
 
      </para>
468
 
      <para>
469
 
        The plugin must not use resources, like for instance reading
470
 
        from the standard input, without knowing that no other plugin
471
 
        is also using it.
472
 
      </para>
473
 
      <para>
474
 
        It is useful, but not required, for the plugin to take the
475
 
        <option>--debug</option> option.
476
 
      </para>
477
 
    </refsect2>
478
 
  </refsect1>
479
 
  
480
 
  <refsect1 id="fallback">
481
 
    <title>FALLBACK</title>
482
 
    <para>
483
 
      If no plugins succeed, this program will, as a fallback, ask for
484
 
      a password on the console using <citerefentry><refentrytitle
485
 
      >getpass</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
486
 
      and output it.  This is not meant to be the normal mode of
487
 
      operation, as there is a separate plugin for getting a password
488
 
      from the console.
489
 
    </para>
490
 
  </refsect1>
491
 
  
 
223
 
492
224
  <refsect1 id="exit_status">
493
225
    <title>EXIT STATUS</title>
494
226
    <para>
495
 
      Exit status of this program is zero if no errors were
496
 
      encountered, and otherwise not.  The fallback (see <xref
497
 
      linkend="fallback"/>) may or may not have succeeded in either
498
 
      case.
499
 
    </para>
500
 
  </refsect1>
501
 
  
502
 
  <refsect1 id="environment">
503
 
    <title>ENVIRONMENT</title>
504
 
    <para>
505
 
      This program does not use any environment variables itself, it
506
 
      only passes on its environment to all the plugins.  The
507
 
      environment passed to plugins can be modified using the
508
 
      <option>--global-env</option> and <option>--env-for</option>
509
 
      options.  Also, the <option>--plugin-helper-dir</option> option
510
 
      will affect the environment variable
511
 
      <envar>MANDOSPLUGINHELPERDIR</envar> for the plugins.
512
 
    </para>
513
 
  </refsect1>
514
 
  
515
 
  <refsect1 id="files">
 
227
    </para>
 
228
  </refsect1>
 
229
 
 
230
  <refsect1 id="file">
516
231
    <title>FILES</title>
517
232
    <para>
518
 
      <variablelist>
519
 
        <varlistentry>
520
 
          <term><filename
521
 
          >/conf/conf.d/mandos/plugin-runner.conf</filename></term>
522
 
          <listitem>
523
 
            <para>
524
 
              Since this program will be run as a keyscript, there is
525
 
              little to no opportunity to pass command line arguments
526
 
              to it.  Therefore, it will <emphasis>also</emphasis>
527
 
              read this file and use its contents as
528
 
              whitespace-separated command line options.  Also,
529
 
              everything from a <quote>#</quote> character to the end
530
 
              of a line is ignored.
531
 
            </para>
532
 
            <para>
533
 
              This program is meant to run in the initial RAM disk
534
 
              environment, so that is where this file is assumed to
535
 
              exist.  The file does not need to exist in the normal
536
 
              file system.
537
 
            </para>
538
 
            <para>
539
 
              This file will be processed <emphasis>before</emphasis>
540
 
              the normal command line options, so the latter can
541
 
              override the former, if need be.
542
 
            </para>
543
 
            <para>
544
 
              This file name is the default; the file to read for
545
 
              arguments can be changed using the
546
 
              <option>--config-file</option> option.
547
 
            </para>
548
 
          </listitem>
549
 
        </varlistentry>
550
 
        <varlistentry>
551
 
          <term><filename class="directory"
552
 
          >/lib/mandos/plugins.d</filename></term>
553
 
          <listitem>
554
 
            <para>
555
 
              The default plugin directory; can be changed by the
556
 
              <option>--plugin-dir</option> option.
557
 
            </para>
558
 
          </listitem>
559
 
        </varlistentry>
560
 
        <varlistentry>
561
 
          <term><filename class="directory"
562
 
          >/lib/mandos/plugin-helpers</filename></term>
563
 
          <listitem>
564
 
            <para>
565
 
              The default plugin helper directory; can be changed by
566
 
              the <option>--plugin-helper-dir</option> option.
567
 
            </para>
568
 
          </listitem>
569
 
        </varlistentry>
570
 
      </variablelist>
 
233
    </para>
 
234
  </refsect1>  
 
235
 
 
236
  <refsect1 id="notes">
 
237
    <title>NOTES</title>
 
238
    <para>
571
239
    </para>
572
240
  </refsect1>
573
241
  
574
242
  <refsect1 id="bugs">
575
243
    <title>BUGS</title>
576
244
    <para>
577
 
      The <option>--config-file</option> option is ignored when
578
 
      specified from within a configuration file.
579
245
    </para>
580
 
    <xi:include href="bugs.xml"/>
581
 
  </refsect1>
582
 
  
 
246
  </refsect1>  
 
247
 
583
248
  <refsect1 id="examples">
584
 
    <title>EXAMPLE</title>
585
 
    <informalexample>
586
 
      <para>
587
 
        Normal invocation needs no options:
588
 
      </para>
589
 
      <para>
590
 
        <userinput>&COMMANDNAME;</userinput>
591
 
      </para>
592
 
    </informalexample>
593
 
    <informalexample>
594
 
      <para>
595
 
        Run the program, but not the plugins, in debug mode:
596
 
      </para>
597
 
      <para>
598
 
        
599
 
        <!-- do not wrap this line -->
600
 
        <userinput>&COMMANDNAME; --debug</userinput>
601
 
        
602
 
      </para>
603
 
    </informalexample>
604
 
    <informalexample>
605
 
      <para>
606
 
        Run all plugins, but run the <quote>foo</quote> plugin in
607
 
        debug mode:
608
 
      </para>
609
 
      <para>
610
 
        
611
 
        <!-- do not wrap this line -->
612
 
        <userinput>&COMMANDNAME; --options-for=foo:--debug</userinput>
613
 
        
614
 
      </para>
615
 
    </informalexample>
616
 
    <informalexample>
617
 
      <para>
618
 
        Run all plugins, but not the program, in debug mode:
619
 
      </para>
620
 
      <para>
621
 
        
622
 
        <!-- do not wrap this line -->
623
 
        <userinput>&COMMANDNAME; --global-options=--debug</userinput>
624
 
        
625
 
      </para>
626
 
    </informalexample>
627
 
    <informalexample>
628
 
      <para>
629
 
        Read a different configuration file, run plugins from a
630
 
        different directory, specify an alternate plugin helper
631
 
        directory and add four options to the
632
 
        <citerefentry><refentrytitle >mandos-client</refentrytitle>
633
 
        <manvolnum>8mandos</manvolnum></citerefentry> plugin:
634
 
      </para>
635
 
      <para>
636
 
 
637
 
<!-- do not wrap this line -->
638
 
<userinput>cd /etc/keys/mandos; &COMMANDNAME;  --config-file=/etc/mandos/plugin-runner.conf --plugin-dir /usr/lib/x86_64-linux-gnu/mandos/plugins.d --plugin-helper-dir /usr/lib/x86_64-linux-gnu/mandos/plugin-helpers --options-for=mandos-client:--pubkey=pubkey.txt,&#x200b;--seckey=seckey.txt,&#x200b;--tls-pubkey=tls-pubkey.pem,&#x200b;--tls-privkey=tls-privkey.pem</userinput>
639
 
 
640
 
      </para>
641
 
    </informalexample>
 
249
    <title>EXAMPLES</title>
 
250
    <para>
 
251
    </para>
642
252
  </refsect1>
 
253
 
643
254
  <refsect1 id="security">
644
255
    <title>SECURITY</title>
645
256
    <para>
646
 
      This program will, when starting, try to switch to another user.
647
 
      If it is started as root, it will succeed, and will by default
648
 
      switch to user and group 65534, which are assumed to be
649
 
      non-privileged.  This user and group is then what all plugins
650
 
      will be started as.  Therefore, the only way to run a plugin as
651
 
      a privileged user is to have the set-user-ID or set-group-ID bit
652
 
      set on the plugin executable file (see <citerefentry>
653
 
      <refentrytitle>execve</refentrytitle><manvolnum>2</manvolnum>
654
 
      </citerefentry>).
655
 
    </para>
656
 
    <para>
657
 
      If this program is used as a keyscript in <citerefentry
658
 
      ><refentrytitle>crypttab</refentrytitle><manvolnum>5</manvolnum>
659
 
      </citerefentry>, there is a slight risk that if this program
660
 
      fails to work, there might be no way to boot the system except
661
 
      for booting from another media and editing the initial RAM disk
662
 
      image to not run this program.  This is, however, unlikely,
663
 
      since the <citerefentry><refentrytitle
664
 
      >password-prompt</refentrytitle><manvolnum>8mandos</manvolnum>
665
 
      </citerefentry> plugin will read a password from the console in
666
 
      case of failure of the other plugins, and this plugin runner
667
 
      will also, in case of catastrophic failure, itself fall back to
668
 
      asking and outputting a password on the console (see <xref
669
 
      linkend="fallback"/>).
670
257
    </para>
671
258
  </refsect1>
672
 
  
 
259
 
673
260
  <refsect1 id="see_also">
674
261
    <title>SEE ALSO</title>
675
262
    <para>
676
 
      <citerefentry><refentrytitle>intro</refentrytitle>
677
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
678
 
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
679
 
      <manvolnum>8</manvolnum></citerefentry>,
680
 
      <citerefentry><refentrytitle>crypttab</refentrytitle>
681
 
      <manvolnum>5</manvolnum></citerefentry>,
682
 
      <citerefentry><refentrytitle>execve</refentrytitle>
683
 
      <manvolnum>2</manvolnum></citerefentry>,
684
263
      <citerefentry><refentrytitle>mandos</refentrytitle>
685
 
      <manvolnum>8</manvolnum></citerefentry>,
686
 
      <citerefentry><refentrytitle>password-prompt</refentrytitle>
687
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
688
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
689
 
      <manvolnum>8mandos</manvolnum></citerefentry>
 
264
      <manvolnum>8</manvolnum></citerefentry>, <citerefentry>
 
265
      <refentrytitle>password-request</refentrytitle>
 
266
      <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
 
267
      <refentrytitle>password-prompt</refentrytitle>
 
268
      <manvolnum>8mandos</manvolnum></citerefentry>, and
 
269
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
 
270
      <manvolnum>8</manvolnum></citerefentry>
690
271
    </para>
691
272
  </refsect1>
692
 
  
 
273
 
693
274
</refentry>
694
 
<!-- Local Variables: -->
695
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
696
 
<!-- time-stamp-end: "[\"']>" -->
697
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
698
 
<!-- End: -->