/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.471 by Teddy Hogeborn
Update copyright year to 2018
5
<!ENTITY TIMESTAMP "2018-02-08">
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>
237.7.355 by Teddy Hogeborn
Update copyright year.
42
      <year>2016</year>
237.7.447 by Teddy Hogeborn
Update copyright year to 2017
43
      <year>2017</year>
237.7.471 by Teddy Hogeborn
Update copyright year to 2018
44
      <year>2018</year>
128 by Teddy Hogeborn
* plugin-runner.xml (/refentry/refentryinfo/copyright): Split
45
      <holder>Teddy Hogeborn</holder>
46
      <holder>Björn Påhlsson</holder>
24.1.23 by Björn Påhlsson
Added manual pages for:
47
    </copyright>
131 by Teddy Hogeborn
* Makefile: Make all DocBook rules include legalnotice.xml as a
48
    <xi:include href="legalnotice.xml"/>
24.1.23 by Björn Påhlsson
Added manual pages for:
49
  </refentryinfo>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
50
  
24.1.23 by Björn Påhlsson
Added manual pages for:
51
  <refmeta>
52
    <refentrytitle>&COMMANDNAME;</refentrytitle>
53
    <manvolnum>8mandos</manvolnum>
54
  </refmeta>
55
  
56
  <refnamediv>
57
    <refname><command>&COMMANDNAME;</command></refname>
58
    <refpurpose>
156 by Teddy Hogeborn
* mandos-clients.conf.xml (OPTIONS): Improved spelling.
59
      Run Mandos plugins, pass data from first to succeed.
24.1.23 by Björn Påhlsson
Added manual pages for:
60
    </refpurpose>
61
  </refnamediv>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
62
  
24.1.23 by Björn Påhlsson
Added manual pages for:
63
  <refsynopsisdiv>
64
    <cmdsynopsis>
65
      <command>&COMMANDNAME;</command>
121 by Teddy Hogeborn
* plugin-runner.xml (NAME): Improved wording.
66
      <group rep="repeat">
135 by Teddy Hogeborn
* plugin-runner.c (add_environment): Never insert existing environment
67
	<arg choice="plain"><option>--global-env=<replaceable
187 by Teddy Hogeborn
* debian/mandos-client.README.Debian: Document "eth0" default and how
68
	>ENV</replaceable><literal>=</literal><replaceable
121 by Teddy Hogeborn
* plugin-runner.xml (NAME): Improved wording.
69
	>value</replaceable></option></arg>
139 by Teddy Hogeborn
* plugin-runner.xml: Changed short option for "--global-env" to "-G",
70
	<arg choice="plain"><option>-G
187 by Teddy Hogeborn
* debian/mandos-client.README.Debian: Document "eth0" default and how
71
	<replaceable>ENV</replaceable><literal>=</literal><replaceable
121 by Teddy Hogeborn
* plugin-runner.xml (NAME): Improved wording.
72
	>value</replaceable> </option></arg>
73
      </group>
74
      <sbr/>
75
      <group rep="repeat">
135 by Teddy Hogeborn
* plugin-runner.c (add_environment): Never insert existing environment
76
	<arg choice="plain"><option>--env-for=<replaceable
121 by Teddy Hogeborn
* plugin-runner.xml (NAME): Improved wording.
77
	>PLUGIN</replaceable><literal>:</literal><replaceable
78
	>ENV</replaceable><literal>=</literal><replaceable
79
	>value</replaceable></option></arg>
139 by Teddy Hogeborn
* plugin-runner.xml: Changed short option for "--global-env" to "-G",
80
	<arg choice="plain"><option>-E<replaceable>
121 by Teddy Hogeborn
* plugin-runner.xml (NAME): Improved wording.
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>
139 by Teddy Hogeborn
* plugin-runner.xml: Changed short option for "--global-env" to "-G",
97
	<arg choice="plain"><option>-o<replaceable>
121 by Teddy Hogeborn
* plugin-runner.xml (NAME): Improved wording.
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/>
139 by Teddy Hogeborn
* plugin-runner.xml: Changed short option for "--global-env" to "-G",
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/>
121 by Teddy Hogeborn
* plugin-runner.xml (NAME): Improved wording.
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/>
237.25.1 by Teddy Hogeborn
Add a plugin helper directory, available to all plugins.
125
      <arg><option>--plugin-helper-dir=<replaceable
126
      >DIRECTORY</replaceable></option></arg>
127
      <sbr/>
139 by Teddy Hogeborn
* plugin-runner.xml: Changed short option for "--global-env" to "-G",
128
      <arg><option>--config-file=<replaceable
129
      >FILE</replaceable></option></arg>
130
      <sbr/>
121 by Teddy Hogeborn
* plugin-runner.xml (NAME): Improved wording.
131
      <arg><option>--debug</option></arg>
132
    </cmdsynopsis>
133
    <cmdsynopsis>
134
      <command>&COMMANDNAME;</command>
135
      <group choice="req">
129 by Teddy Hogeborn
* mandos-clients.conf.xml: Changed all single quotes to double quotes
136
	<arg choice="plain"><option>--help</option></arg>
137
	<arg choice="plain"><option>-?</option></arg>
121 by Teddy Hogeborn
* plugin-runner.xml (NAME): Improved wording.
138
      </group>
139
    </cmdsynopsis>
140
    <cmdsynopsis>
141
      <command>&COMMANDNAME;</command>
129 by Teddy Hogeborn
* mandos-clients.conf.xml: Changed all single quotes to double quotes
142
      <arg choice="plain"><option>--usage</option></arg>
121 by Teddy Hogeborn
* plugin-runner.xml (NAME): Improved wording.
143
    </cmdsynopsis>
144
    <cmdsynopsis>
145
      <command>&COMMANDNAME;</command>
146
      <group choice="req">
129 by Teddy Hogeborn
* mandos-clients.conf.xml: Changed all single quotes to double quotes
147
	<arg choice="plain"><option>--version</option></arg>
148
	<arg choice="plain"><option>-V</option></arg>
121 by Teddy Hogeborn
* plugin-runner.xml (NAME): Improved wording.
149
      </group>
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
150
    </cmdsynopsis>
24.1.23 by Björn Påhlsson
Added manual pages for:
151
  </refsynopsisdiv>
134 by Teddy Hogeborn
* mandos.xml: Enclose "RAM" with <acronym>.
152
  
24.1.23 by Björn Påhlsson
Added manual pages for:
153
  <refsect1 id="description">
154
    <title>DESCRIPTION</title>
155
    <para>
134 by Teddy Hogeborn
* mandos.xml: Enclose "RAM" with <acronym>.
156
      <command>&COMMANDNAME;</command> is a program which is meant to
155 by Teddy Hogeborn
* README: Improved wording.
157
      be specified as a <quote>keyscript</quote> for the root disk in
158
      <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>
140 by Teddy Hogeborn
* plugin-runner.xml (PLUGINS/WRITING PLUGINS): New section.
162
      <manvolnum>8</manvolnum></citerefentry> will use to unlock the
163
      root disk.
134 by Teddy Hogeborn
* mandos.xml: Enclose "RAM" with <acronym>.
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
  
24.1.38 by Björn Påhlsson
changed description to better fit role
182
  <refsect1>
183
    <title>OPTIONS</title>
24.1.23 by Björn Påhlsson
Added manual pages for:
184
    <variablelist>
185
      <varlistentry>
135 by Teddy Hogeborn
* plugin-runner.c (add_environment): Never insert existing environment
186
	<term><option>--global-env
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>
140 by Teddy Hogeborn
* plugin-runner.xml (PLUGINS/WRITING PLUGINS): New section.
189
	<term><option>-G
187 by Teddy Hogeborn
* debian/mandos-client.README.Debian: Document "eth0" default and how
190
	<replaceable>ENV</replaceable><literal>=</literal><replaceable
135 by Teddy Hogeborn
* plugin-runner.c (add_environment): Never insert existing environment
191
	>value</replaceable></option></term>
192
	<listitem>
193
	  <para>
136 by Teddy Hogeborn
* plugin-runner.c (add_environment): Override existing environment
194
	    This option will add an environment variable setting to
195
	    all plugins.  This will override any inherited environment
196
	    variable.
135 by Teddy Hogeborn
* plugin-runner.c (add_environment): Never insert existing environment
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>
140 by Teddy Hogeborn
* plugin-runner.xml (PLUGINS/WRITING PLUGINS): New section.
206
	<term><option>-E
135 by Teddy Hogeborn
* plugin-runner.c (add_environment): Never insert existing environment
207
	<replaceable>PLUGIN</replaceable><literal>:</literal
208
	><replaceable>ENV</replaceable><literal>=</literal
209
	><replaceable>value</replaceable></option></term>
210
	<listitem>
211
	  <para>
136 by Teddy Hogeborn
* plugin-runner.c (add_environment): Override existing environment
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>.
135 by Teddy Hogeborn
* plugin-runner.c (add_environment): Never insert existing environment
217
	  </para>
218
	</listitem>
219
      </varlistentry>
220
      
221
      <varlistentry>
125 by Teddy Hogeborn
* plugin-runner.xml (OPTIONS): Use <option> tags instead of
222
	<term><option>--global-options
223
	<replaceable>OPTIONS</replaceable></option></term>
224
	<term><option>-g
225
	<replaceable>OPTIONS</replaceable></option></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
226
	<listitem>
227
	  <para>
134 by Teddy Hogeborn
* mandos.xml: Enclose "RAM" with <acronym>.
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>
140 by Teddy Hogeborn
* plugin-runner.xml (PLUGINS/WRITING PLUGINS): New section.
232
	    option to all plugins.
134 by Teddy Hogeborn
* mandos.xml: Enclose "RAM" with <acronym>.
233
	  </para>
24.1.23 by Björn Påhlsson
Added manual pages for:
234
	</listitem>
235
      </varlistentry>
134 by Teddy Hogeborn
* mandos.xml: Enclose "RAM" with <acronym>.
236
      
24.1.23 by Björn Påhlsson
Added manual pages for:
237
      <varlistentry>
125 by Teddy Hogeborn
* plugin-runner.xml (OPTIONS): Use <option> tags instead of
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>
24.1.23 by Björn Påhlsson
Added manual pages for:
244
	<listitem>
245
	  <para>
134 by Teddy Hogeborn
* mandos.xml: Enclose "RAM" with <acronym>.
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
140 by Teddy Hogeborn
* plugin-runner.xml (PLUGINS/WRITING PLUGINS): New section.
258
	    <userinput>--options-for=foo:--bar,baz</userinput>.  Using
259
	    <userinput>--options-for="foo:--bar baz"</userinput>. will
260
	    <emphasis>not</emphasis> work.
134 by Teddy Hogeborn
* mandos.xml: Enclose "RAM" with <acronym>.
261
	  </para>
24.1.23 by Björn Påhlsson
Added manual pages for:
262
	</listitem>
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
263
      </varlistentry>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
264
      
24.1.23 by Björn Påhlsson
Added manual pages for:
265
      <varlistentry>
139 by Teddy Hogeborn
* plugin-runner.xml: Changed short option for "--global-env" to "-G",
266
	<term><option>--disable
125 by Teddy Hogeborn
* plugin-runner.xml (OPTIONS): Use <option> tags instead of
267
	<replaceable>PLUGIN</replaceable></option></term>
268
	<term><option>-d
269
	<replaceable>PLUGIN</replaceable></option></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
270
	<listitem>
271
	  <para>
134 by Teddy Hogeborn
* mandos.xml: Enclose "RAM" with <acronym>.
272
	    Disable the plugin named
273
	    <replaceable>PLUGIN</replaceable>.  The plugin will not be
274
	    started.
237.11.4 by Teddy Hogeborn
Removed superflous white space.
275
	  </para>
24.1.23 by Björn Påhlsson
Added manual pages for:
276
	</listitem>
277
      </varlistentry>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
278
      
24.1.23 by Björn Påhlsson
Added manual pages for:
279
      <varlistentry>
139 by Teddy Hogeborn
* plugin-runner.xml: Changed short option for "--global-env" to "-G",
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
156 by Teddy Hogeborn
* mandos-clients.conf.xml (OPTIONS): Improved spelling.
289
	    from the configuration file.
139 by Teddy Hogeborn
* plugin-runner.xml: Changed short option for "--global-env" to "-G",
290
	  </para>
291
	</listitem>
292
      </varlistentry>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
293
      
139 by Teddy Hogeborn
* plugin-runner.xml: Changed short option for "--global-env" to "-G",
294
      <varlistentry>
125 by Teddy Hogeborn
* plugin-runner.xml (OPTIONS): Use <option> tags instead of
295
	<term><option>--groupid
296
	<replaceable>ID</replaceable></option></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
297
	<listitem>
298
	  <para>
134 by Teddy Hogeborn
* mandos.xml: Enclose "RAM" with <acronym>.
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.
24.1.23 by Björn Påhlsson
Added manual pages for:
303
	  </para>
304
	</listitem>
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
305
      </varlistentry>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
306
      
24.1.23 by Björn Påhlsson
Added manual pages for:
307
      <varlistentry>
125 by Teddy Hogeborn
* plugin-runner.xml (OPTIONS): Use <option> tags instead of
308
	<term><option>--userid
309
	<replaceable>ID</replaceable></option></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
310
	<listitem>
311
	  <para>
134 by Teddy Hogeborn
* mandos.xml: Enclose "RAM" with <acronym>.
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.
24.1.23 by Björn Påhlsson
Added manual pages for:
316
	  </para>
317
	</listitem>
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
318
      </varlistentry>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
319
      
24.1.23 by Björn Påhlsson
Added manual pages for:
320
      <varlistentry>
125 by Teddy Hogeborn
* plugin-runner.xml (OPTIONS): Use <option> tags instead of
321
	<term><option>--plugin-dir
322
	<replaceable>DIRECTORY</replaceable></option></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
323
	<listitem>
324
	  <para>
134 by Teddy Hogeborn
* mandos.xml: Enclose "RAM" with <acronym>.
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.
24.1.23 by Björn Påhlsson
Added manual pages for:
329
	  </para>
330
	</listitem>
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
331
      </varlistentry>
24.1.23 by Björn Påhlsson
Added manual pages for:
332
      
333
      <varlistentry>
237.25.1 by Teddy Hogeborn
Add a plugin helper directory, available to all plugins.
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>
139 by Teddy Hogeborn
* plugin-runner.xml: Changed short option for "--global-env" to "-G",
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>
125 by Teddy Hogeborn
* plugin-runner.xml (OPTIONS): Use <option> tags instead of
361
	<term><option>--debug</option></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
362
	<listitem>
363
	  <para>
134 by Teddy Hogeborn
* mandos.xml: Enclose "RAM" with <acronym>.
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.
24.1.23 by Björn Påhlsson
Added manual pages for:
375
	  </para>
376
	</listitem>
377
      </varlistentry>
378
      
379
      <varlistentry>
125 by Teddy Hogeborn
* plugin-runner.xml (OPTIONS): Use <option> tags instead of
380
	<term><option>--help</option></term>
381
	<term><option>-?</option></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
382
	<listitem>
383
	  <para>
134 by Teddy Hogeborn
* mandos.xml: Enclose "RAM" with <acronym>.
384
	    Gives a help message about options and their meanings.
24.1.23 by Björn Påhlsson
Added manual pages for:
385
	  </para>
386
	</listitem>
387
      </varlistentry>
388
      
389
      <varlistentry>
125 by Teddy Hogeborn
* plugin-runner.xml (OPTIONS): Use <option> tags instead of
390
	<term><option>--usage</option></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
391
	<listitem>
392
	  <para>
134 by Teddy Hogeborn
* mandos.xml: Enclose "RAM" with <acronym>.
393
	    Gives a short usage message.
24.1.23 by Björn Påhlsson
Added manual pages for:
394
	  </para>
395
	</listitem>
396
      </varlistentry>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
397
      
24.1.23 by Björn Påhlsson
Added manual pages for:
398
      <varlistentry>
125 by Teddy Hogeborn
* plugin-runner.xml (OPTIONS): Use <option> tags instead of
399
	<term><option>--version</option></term>
400
	<term><option>-V</option></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
401
	<listitem>
402
	  <para>
134 by Teddy Hogeborn
* mandos.xml: Enclose "RAM" with <acronym>.
403
	    Prints the program version.
24.1.23 by Björn Påhlsson
Added manual pages for:
404
	  </para>
405
	</listitem>
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
406
      </varlistentry>
24.1.23 by Björn Påhlsson
Added manual pages for:
407
    </variablelist>
408
  </refsect1>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
409
  
134 by Teddy Hogeborn
* mandos.xml: Enclose "RAM" with <acronym>.
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
135 by Teddy Hogeborn
* plugin-runner.c (add_environment): Never insert existing environment
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.
134 by Teddy Hogeborn
* mandos.xml: Enclose "RAM" with <acronym>.
434
    </para>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
435
    
140 by Teddy Hogeborn
* plugin-runner.xml (PLUGINS/WRITING PLUGINS): New section.
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>
168 by Teddy Hogeborn
* initramfs-tools-hook: Use long options where available. Use only
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>
140 by Teddy Hogeborn
* plugin-runner.xml (PLUGINS/WRITING PLUGINS): New section.
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
237.25.1 by Teddy Hogeborn
Add a plugin helper directory, available to all plugins.
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.
140 by Teddy Hogeborn
* plugin-runner.xml (PLUGINS/WRITING PLUGINS): New section.
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
155 by Teddy Hogeborn
* README: Improved wording.
469
	from the standard input, without knowing that no other plugin
470
	is also using it.
140 by Teddy Hogeborn
* plugin-runner.xml (PLUGINS/WRITING PLUGINS): New section.
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>
134 by Teddy Hogeborn
* mandos.xml: Enclose "RAM" with <acronym>.
477
  </refsect1>
478
  
135 by Teddy Hogeborn
* plugin-runner.c (add_environment): Never insert existing environment
479
  <refsect1 id="fallback">
134 by Teddy Hogeborn
* mandos.xml: Enclose "RAM" with <acronym>.
480
    <title>FALLBACK</title>
481
    <para>
135 by Teddy Hogeborn
* plugin-runner.c (add_environment): Never insert existing environment
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.
134 by Teddy Hogeborn
* mandos.xml: Enclose "RAM" with <acronym>.
488
    </para>
489
  </refsect1>
135 by Teddy Hogeborn
* plugin-runner.c (add_environment): Never insert existing environment
490
  
24.1.39 by Björn Påhlsson
Added all sections needed for mandos-client manual page
491
  <refsect1 id="exit_status">
492
    <title>EXIT STATUS</title>
493
    <para>
135 by Teddy Hogeborn
* plugin-runner.c (add_environment): Never insert existing environment
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>
139 by Teddy Hogeborn
* plugin-runner.xml: Changed short option for "--global-env" to "-G",
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>
237.25.1 by Teddy Hogeborn
Add a plugin helper directory, available to all plugins.
508
      options.  Also, the <option>--plugin-helper-dir</option> option
509
      will affect the environment variable
510
      <envar>MANDOSPLUGINHELPERDIR</envar> for the plugins.
135 by Teddy Hogeborn
* plugin-runner.c (add_environment): Never insert existing environment
511
    </para>
512
  </refsect1>
513
  
139 by Teddy Hogeborn
* plugin-runner.xml: Changed short option for "--global-env" to "-G",
514
  <refsect1 id="files">
24.1.39 by Björn Påhlsson
Added all sections needed for mandos-client manual page
515
    <title>FILES</title>
516
    <para>
135 by Teddy Hogeborn
* plugin-runner.c (add_environment): Never insert existing environment
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>
136 by Teddy Hogeborn
* plugin-runner.c (add_environment): Override existing environment
531
	    <para>
139 by Teddy Hogeborn
* plugin-runner.xml: Changed short option for "--global-env" to "-G",
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>
136 by Teddy Hogeborn
* plugin-runner.c (add_environment): Override existing environment
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>
139 by Teddy Hogeborn
* plugin-runner.xml: Changed short option for "--global-env" to "-G",
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>
135 by Teddy Hogeborn
* plugin-runner.c (add_environment): Never insert existing environment
547
	  </listitem>
548
	</varlistentry>
237.7.383 by Teddy Hogeborn
Client: Document default directories more clearly
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>
135 by Teddy Hogeborn
* plugin-runner.c (add_environment): Never insert existing environment
569
      </variablelist>
24.1.55 by Björn Påhlsson
updated some partial manual pages
570
    </para>
24.1.39 by Björn Påhlsson
Added all sections needed for mandos-client manual page
571
  </refsect1>
572
  
157 by Teddy Hogeborn
* plugin-runner.xml (BUGS): Document the non-recursiveness of the
573
  <refsect1 id="bugs">
574
    <title>BUGS</title>
575
    <para>
576
      The <option>--config-file</option> option is ignored when
577
      specified from within a configuration file.
578
    </para>
237.7.369 by Teddy Hogeborn
Add bug reporting information to manual pages
579
    <xi:include href="bugs.xml"/>
157 by Teddy Hogeborn
* plugin-runner.xml (BUGS): Document the non-recursiveness of the
580
  </refsect1>
135 by Teddy Hogeborn
* plugin-runner.c (add_environment): Never insert existing environment
581
  
24.1.39 by Björn Påhlsson
Added all sections needed for mandos-client manual page
582
  <refsect1 id="examples">
113 by Teddy Hogeborn
* mandos-keygen.xml (EXAMPLE): Replaced all occurrences of command
583
    <title>EXAMPLE</title>
140 by Teddy Hogeborn
* plugin-runner.xml (PLUGINS/WRITING PLUGINS): New section.
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>
237.7.306 by Teddy Hogeborn
plugin-runner.xml (EXAMPLE): Use the /usr/lib/<arch> directory.
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
171 by Teddy Hogeborn
Renamed "password-request" to "mandos-client".
631
	<citerefentry><refentrytitle >mandos-client</refentrytitle>
140 by Teddy Hogeborn
* plugin-runner.xml (PLUGINS/WRITING PLUGINS): New section.
632
	<manvolnum>8mandos</manvolnum></citerefentry> plugin:
633
      </para>
634
      <para>
635
636
<!-- do not wrap this line -->
237.7.306 by Teddy Hogeborn
plugin-runner.xml (EXAMPLE): Use the /usr/lib/<arch> directory.
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>
140 by Teddy Hogeborn
* plugin-runner.xml (PLUGINS/WRITING PLUGINS): New section.
638
639
      </para>
640
    </informalexample>
24.1.39 by Björn Påhlsson
Added all sections needed for mandos-client manual page
641
  </refsect1>
642
  <refsect1 id="security">
643
    <title>SECURITY</title>
644
    <para>
140 by Teddy Hogeborn
* plugin-runner.xml (PLUGINS/WRITING PLUGINS): New section.
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
164 by Teddy Hogeborn
* mandos: Open the PID file before daemonizing, but write to it
651
      set on the plugin executable file (see <citerefentry>
140 by Teddy Hogeborn
* plugin-runner.xml (PLUGINS/WRITING PLUGINS): New section.
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>
156 by Teddy Hogeborn
* mandos-clients.conf.xml (OPTIONS): Improved spelling.
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
140 by Teddy Hogeborn
* plugin-runner.xml (PLUGINS/WRITING PLUGINS): New section.
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"/>).
24.1.55 by Björn Påhlsson
updated some partial manual pages
669
    </para>
24.1.39 by Björn Påhlsson
Added all sections needed for mandos-client manual page
670
  </refsect1>
135 by Teddy Hogeborn
* plugin-runner.c (add_environment): Never insert existing environment
671
  
24.1.39 by Björn Påhlsson
Added all sections needed for mandos-client manual page
672
  <refsect1 id="see_also">
673
    <title>SEE ALSO</title>
674
    <para>
237.7.41 by Teddy Hogeborn
* Makefile (DOCS): Added "intro.8mandos".
675
      <citerefentry><refentrytitle>intro</refentrytitle>
676
      <manvolnum>8mandos</manvolnum></citerefentry>,
114 by Teddy Hogeborn
* mandos-clients.conf.xml (SEE ALSO): Alphabetized, as per
677
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
678
      <manvolnum>8</manvolnum></citerefentry>,
140 by Teddy Hogeborn
* plugin-runner.xml (PLUGINS/WRITING PLUGINS): New section.
679
      <citerefentry><refentrytitle>crypttab</refentrytitle>
680
      <manvolnum>5</manvolnum></citerefentry>,
681
      <citerefentry><refentrytitle>execve</refentrytitle>
682
      <manvolnum>2</manvolnum></citerefentry>,
24.1.41 by Björn Påhlsson
updated mandos-client sections and added see also stuff
683
      <citerefentry><refentrytitle>mandos</refentrytitle>
114 by Teddy Hogeborn
* mandos-clients.conf.xml (SEE ALSO): Alphabetized, as per
684
      <manvolnum>8</manvolnum></citerefentry>,
685
      <citerefentry><refentrytitle>password-prompt</refentrytitle>
113 by Teddy Hogeborn
* mandos-keygen.xml (EXAMPLE): Replaced all occurrences of command
686
      <manvolnum>8mandos</manvolnum></citerefentry>,
171 by Teddy Hogeborn
Renamed "password-request" to "mandos-client".
687
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
114 by Teddy Hogeborn
* mandos-clients.conf.xml (SEE ALSO): Alphabetized, as per
688
      <manvolnum>8mandos</manvolnum></citerefentry>
24.1.41 by Björn Påhlsson
updated mandos-client sections and added see also stuff
689
    </para>
24.1.39 by Björn Påhlsson
Added all sections needed for mandos-client manual page
690
  </refsect1>
135 by Teddy Hogeborn
* plugin-runner.c (add_environment): Never insert existing environment
691
  
24.1.23 by Björn Påhlsson
Added manual pages for:
692
</refentry>
111 by Teddy Hogeborn
* mandos-clients.conf.xml (ENTITY TIMESTAMP): New. Automatically
693
<!-- Local Variables: -->
694
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
695
<!-- time-stamp-end: "[\"']>" -->
696
<!-- time-stamp-format: "%:y-%02m-%02d" -->
697
<!-- End: -->