/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: Teddy Hogeborn
  • Date: 2017-08-20 14:08:59 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 360.
  • Revision ID: teddy@recompile.se-20170820140859-6niaa0ebf6bdovfn
Use || instead of -o in shell scripts.

* mandos-keygen: Use || instead of -o.
* network-hooks.d/bridge: - '' -

Show diffs side-by-side

added added

removed removed

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