/mandos/release

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