/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-24 07:42:14 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080824074214-odju7g3115le171c
* mandos-keygen: Bug fix: Recognize new options --subtype and
                 --sublength.  New option "--password" which prompts
                 for and encrypts a password with an already existing
                 key.

* mandos-keygen.xml (SYNOPSIS): Added separate synopsis for
                                "--password" option.
  (DESCRIPTION): Added text about password creation.
  (OPTIONS): Document default value for "--dir" option.  Document new
             "--password" option.

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