/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" [
171 by Teddy Hogeborn
Renamed "password-request" to "mandos-client".
4
<!ENTITY COMMANDNAME "mandos-client">
237.7.369 by Teddy Hogeborn
Add bug reporting information to manual pages
5
<!ENTITY TIMESTAMP "2016-03-05">
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>
217 by Teddy Hogeborn
* .bzrignore: Added "man" directory (created by "make install-html").
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.174 by Teddy Hogeborn
* Makefile (CFLAGS, LDFLAGS): Keep default flags from environment.
39
      <year>2013</year>
237.7.207 by Teddy Hogeborn
* debian/copyright: Change year to "2014".
40
      <year>2014</year>
237.25.2 by Teddy Hogeborn
mandos-client: Try to start a plugin to add and remove a local route.
41
      <year>2015</year>
237.7.355 by Teddy Hogeborn
Update copyright year.
42
      <year>2016</year>
128 by Teddy Hogeborn
* plugin-runner.xml (/refentry/refentryinfo/copyright): Split
43
      <holder>Teddy Hogeborn</holder>
44
      <holder>Björn Påhlsson</holder>
24.1.23 by Björn Påhlsson
Added manual pages for:
45
    </copyright>
131 by Teddy Hogeborn
* Makefile: Make all DocBook rules include legalnotice.xml as a
46
    <xi:include href="../legalnotice.xml"/>
24.1.23 by Björn Påhlsson
Added manual pages for:
47
  </refentryinfo>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
48
  
24.1.23 by Björn Påhlsson
Added manual pages for:
49
  <refmeta>
50
    <refentrytitle>&COMMANDNAME;</refentrytitle>
51
    <manvolnum>8mandos</manvolnum>
52
  </refmeta>
53
  
54
  <refnamediv>
55
    <refname><command>&COMMANDNAME;</command></refname>
56
    <refpurpose>
172 by Teddy Hogeborn
* plugins.d/mandos-client.xml (NAME, OVERVIEW, EXIT STATUS): Improved
57
      Client for <application>Mandos</application>
24.1.23 by Björn Påhlsson
Added manual pages for:
58
    </refpurpose>
59
  </refnamediv>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
60
  
24.1.23 by Björn Påhlsson
Added manual pages for:
61
  <refsynopsisdiv>
62
    <cmdsynopsis>
63
      <command>&COMMANDNAME;</command>
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
64
      <group>
65
	<arg choice="plain"><option>--connect
156 by Teddy Hogeborn
* mandos-clients.conf.xml (OPTIONS): Improved spelling.
66
	<replaceable>ADDRESS</replaceable><literal>:</literal
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
67
	><replaceable>PORT</replaceable></option></arg>
68
	<arg choice="plain"><option>-c
156 by Teddy Hogeborn
* mandos-clients.conf.xml (OPTIONS): Improved spelling.
69
	<replaceable>ADDRESS</replaceable><literal>:</literal
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
70
	><replaceable>PORT</replaceable></option></arg>
71
      </group>
72
      <sbr/>
237.22.4 by Teddy Hogeborn
* plugins.d/mandos-client.c (get_flags): Don't clobber errno.
73
      <group rep='repeat'>
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
74
	<arg choice="plain"><option>--interface
237.22.4 by Teddy Hogeborn
* plugins.d/mandos-client.c (get_flags): Don't clobber errno.
75
	<replaceable>NAME</replaceable><arg rep='repeat'
76
	>,<replaceable>NAME</replaceable></arg></option></arg>
77
	<arg choice="plain"><option>-i <replaceable>NAME</replaceable
78
	><arg rep='repeat'>,<replaceable>NAME</replaceable></arg
79
	></option></arg>
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
80
      </group>
81
      <sbr/>
82
      <group>
83
	<arg choice="plain"><option>--pubkey
84
	<replaceable>FILE</replaceable></option></arg>
85
	<arg choice="plain"><option>-p
86
	<replaceable>FILE</replaceable></option></arg>
87
      </group>
88
      <sbr/>
89
      <group>
90
	<arg choice="plain"><option>--seckey
91
	<replaceable>FILE</replaceable></option></arg>
92
	<arg choice="plain"><option>-s
93
	<replaceable>FILE</replaceable></option></arg>
94
      </group>
95
      <sbr/>
96
      <arg>
97
	<option>--priority <replaceable>STRING</replaceable></option>
98
      </arg>
99
      <sbr/>
100
      <arg>
101
	<option>--dh-bits <replaceable>BITS</replaceable></option>
102
      </arg>
103
      <sbr/>
104
      <arg>
237.7.310 by Teddy Hogeborn
mandos-client: Add --dh-params FILE option.
105
	<option>--dh-params <replaceable>FILE</replaceable></option>
106
      </arg>
107
      <sbr/>
108
      <arg>
24.1.124 by Björn Påhlsson
Added lower kernel loglevel to reduce clutter on system console.
109
	<option>--delay <replaceable>SECONDS</replaceable></option>
110
      </arg>
111
      <sbr/>
112
      <arg>
24.1.174 by Björn Påhlsson
* Makefile (CFLAGS): Added "-lrt" to include real time library.
113
	<option>--retry <replaceable>SECONDS</replaceable></option>
114
      </arg>
115
      <sbr/>
116
      <arg>
237.16.13 by Teddy Hogeborn
* debian/mandos-client.README.Debian: Document network hook facility.
117
	<option>--network-hook-dir
118
	<replaceable>DIR</replaceable></option>
237.16.5 by teddy at bsnet
* plugins.d/mandos-client.c (SYNOPSIS, OPTIONS): Document
119
      </arg>
120
      <sbr/>
121
      <arg>
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
122
	<option>--debug</option>
123
      </arg>
124
    </cmdsynopsis>
125
    <cmdsynopsis>
126
      <command>&COMMANDNAME;</command>
127
      <group choice="req">
129 by Teddy Hogeborn
* mandos-clients.conf.xml: Changed all single quotes to double quotes
128
	<arg choice="plain"><option>--help</option></arg>
129
	<arg choice="plain"><option>-?</option></arg>
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
130
      </group>
131
    </cmdsynopsis>
132
    <cmdsynopsis>
133
      <command>&COMMANDNAME;</command>
129 by Teddy Hogeborn
* mandos-clients.conf.xml: Changed all single quotes to double quotes
134
      <arg choice="plain"><option>--usage</option></arg>
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
135
    </cmdsynopsis>
136
    <cmdsynopsis>
137
      <command>&COMMANDNAME;</command>
138
      <group choice="req">
129 by Teddy Hogeborn
* mandos-clients.conf.xml: Changed all single quotes to double quotes
139
	<arg choice="plain"><option>--version</option></arg>
140
	<arg choice="plain"><option>-V</option></arg>
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
141
      </group>
142
    </cmdsynopsis>
24.1.23 by Björn Påhlsson
Added manual pages for:
143
  </refsynopsisdiv>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
144
  
24.1.23 by Björn Påhlsson
Added manual pages for:
145
  <refsect1 id="description">
146
    <title>DESCRIPTION</title>
147
    <para>
142 by Teddy Hogeborn
* plugins.d/password-request.c (main): Change default GnuTLS priority
148
      <command>&COMMANDNAME;</command> is a client program that
149
      communicates with <citerefentry><refentrytitle
150
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>
237.2.48 by Teddy Hogeborn
* plugins.d/mandos-client.c (main): Use remove() instead of unlink(),
151
      to get a password.  In slightly more detail, this client program
237.22.4 by Teddy Hogeborn
* plugins.d/mandos-client.c (get_flags): Don't clobber errno.
152
      brings up network interfaces, uses the interfaces’ IPv6
153
      link-local addresses to get network connectivity, uses Zeroconf
154
      to find servers on the local network, and communicates with
155
      servers using TLS with an OpenPGP key to ensure authenticity and
237.2.48 by Teddy Hogeborn
* plugins.d/mandos-client.c (main): Use remove() instead of unlink(),
156
      confidentiality.  This client program keeps running, trying all
157
      servers on the network, until it receives a satisfactory reply
237.7.39 by teddy at bsnet
* plugins.d/mandos-client.c (avahi_loop_with_timeout): Fix warning.
158
      or a TERM signal.  After all servers have been tried, all
159
      servers are periodically retried.  If no servers are found it
160
      will wait indefinitely for new servers to appear.
142 by Teddy Hogeborn
* plugins.d/password-request.c (main): Change default GnuTLS priority
161
    </para>
162
    <para>
237.22.4 by Teddy Hogeborn
* plugins.d/mandos-client.c (get_flags): Don't clobber errno.
163
      The network interfaces are selected like this: If any interfaces
164
      are specified using the <option>--interface</option> option,
165
      those interface are used.  Otherwise,
166
      <command>&COMMANDNAME;</command> will use all interfaces that
167
      are not loopback interfaces, are not point-to-point interfaces,
168
      are capable of broadcasting and do not have the NOARP flag (see
237.16.13 by Teddy Hogeborn
* debian/mandos-client.README.Debian: Document network hook facility.
169
      <citerefentry><refentrytitle>netdevice</refentrytitle>
170
      <manvolnum>7</manvolnum></citerefentry>).  (If the
171
      <option>--connect</option> option is used, point-to-point
237.22.4 by Teddy Hogeborn
* plugins.d/mandos-client.c (get_flags): Don't clobber errno.
172
      interfaces and non-broadcast interfaces are accepted.)  If any
173
      used interfaces are not up and running, they are first taken up
174
      (and later taken down again on program exit).
237.16.13 by Teddy Hogeborn
* debian/mandos-client.README.Debian: Document network hook facility.
175
    </para>
176
    <para>
237.22.4 by Teddy Hogeborn
* plugins.d/mandos-client.c (get_flags): Don't clobber errno.
177
      Before network interfaces are selected, all <quote>network
237.16.13 by Teddy Hogeborn
* debian/mandos-client.README.Debian: Document network hook facility.
178
      hooks</quote> are run; see <xref linkend="network-hooks"/>.
179
    </para>
180
    <para>
142 by Teddy Hogeborn
* plugins.d/password-request.c (main): Change default GnuTLS priority
181
      This program is not meant to be run directly; it is really meant
182
      to run as a plugin of the <application>Mandos</application>
183
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
143 by Teddy Hogeborn
* Makefile (mandos.8): Add dependency on "overview.xml" and
184
      <manvolnum>8mandos</manvolnum></citerefentry>, which runs in the
185
      initial <acronym>RAM</acronym> disk environment because it is
186
      specified as a <quote>keyscript</quote> in the <citerefentry>
187
      <refentrytitle>crypttab</refentrytitle><manvolnum>5</manvolnum>
188
      </citerefentry> file.
142 by Teddy Hogeborn
* plugins.d/password-request.c (main): Change default GnuTLS priority
189
    </para>
190
  </refsect1>
191
  
192
  <refsect1 id="purpose">
193
    <title>PURPOSE</title>
194
    <para>
195
      The purpose of this is to enable <emphasis>remote and unattended
196
      rebooting</emphasis> of client host computer with an
197
      <emphasis>encrypted root file system</emphasis>.  See <xref
198
      linkend="overview"/> for details.
199
    </para>
200
  </refsect1>
201
  
24.1.55 by Björn Påhlsson
updated some partial manual pages
202
  <refsect1 id="options">
203
    <title>OPTIONS</title>
204
    <para>
142 by Teddy Hogeborn
* plugins.d/password-request.c (main): Change default GnuTLS priority
205
      This program is commonly not invoked from the command line; it
206
      is normally started by the <application>Mandos</application>
207
      plugin runner, see <citerefentry><refentrytitle
208
      >plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum>
209
      </citerefentry>.  Any command line options this program accepts
210
      are therefore normally provided by the plugin runner, and not
211
      directly.
24.1.55 by Björn Påhlsson
updated some partial manual pages
212
    </para>
142 by Teddy Hogeborn
* plugins.d/password-request.c (main): Change default GnuTLS priority
213
    
24.1.23 by Björn Påhlsson
Added manual pages for:
214
    <variablelist>
215
      <varlistentry>
127 by Teddy Hogeborn
* plugins.d/password-request.xml (OPTIONS): Make replaceables match
216
	<term><option>--connect=<replaceable
143 by Teddy Hogeborn
* Makefile (mandos.8): Add dependency on "overview.xml" and
217
	>ADDRESS</replaceable><literal>:</literal><replaceable
127 by Teddy Hogeborn
* plugins.d/password-request.xml (OPTIONS): Make replaceables match
218
	>PORT</replaceable></option></term>
219
	<term><option>-c
143 by Teddy Hogeborn
* Makefile (mandos.8): Add dependency on "overview.xml" and
220
	<replaceable>ADDRESS</replaceable><literal>:</literal
127 by Teddy Hogeborn
* plugins.d/password-request.xml (OPTIONS): Make replaceables match
221
	><replaceable>PORT</replaceable></option></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
222
	<listitem>
223
	  <para>
142 by Teddy Hogeborn
* plugins.d/password-request.c (main): Change default GnuTLS priority
224
	    Do not use Zeroconf to locate servers.  Connect directly
225
	    to only one specified <application>Mandos</application>
226
	    server.  Note that an IPv6 address has colon characters in
227
	    it, so the <emphasis>last</emphasis> colon character is
228
	    assumed to separate the address from the port number.
229
	  </para>
230
	  <para>
237.7.199 by Teddy Hogeborn
Documentation change to clarify support of --connect option.
231
	    Normally, Zeroconf would be used to locate Mandos servers,
232
	    in which case this option would only be used when testing
233
	    and debugging.
24.1.23 by Björn Påhlsson
Added manual pages for:
234
	  </para>
235
	</listitem>
236
      </varlistentry>
142 by Teddy Hogeborn
* plugins.d/password-request.c (main): Change default GnuTLS priority
237
      
24.1.23 by Björn Påhlsson
Added manual pages for:
238
      <varlistentry>
237.2.67 by Teddy Hogeborn
Four new interrelated features:
239
	<term><option>--interface=<replaceable
237.7.152 by Teddy Hogeborn
* plugins.d/mandos-client (start_mandos_communication): Bug fix; skip
240
	>NAME</replaceable><arg rep='repeat'>,<replaceable
241
	>NAME</replaceable></arg></option></term>
127 by Teddy Hogeborn
* plugins.d/password-request.xml (OPTIONS): Make replaceables match
242
	<term><option>-i
237.7.152 by Teddy Hogeborn
* plugins.d/mandos-client (start_mandos_communication): Bug fix; skip
243
	<replaceable>NAME</replaceable><arg rep='repeat'>,<replaceable
244
	>NAME</replaceable></arg></option></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
245
	<listitem>
246
	  <para>
237.22.4 by Teddy Hogeborn
* plugins.d/mandos-client.c (get_flags): Don't clobber errno.
247
	    Comma separated list of network interfaces that will be
248
	    brought up and scanned for Mandos servers to connect to.
249
	    The default is the empty string, which will automatically
250
	    use all appropriate interfaces.
24.1.23 by Björn Påhlsson
Added manual pages for:
251
	  </para>
146 by Teddy Hogeborn
* plugins.d/password-request.xml (OPTIONS): Improved wording.
252
	  <para>
237.7.152 by Teddy Hogeborn
* plugins.d/mandos-client (start_mandos_communication): Bug fix; skip
253
	    If the <option>--connect</option> option is used, and
254
	    exactly one interface name is specified (except
255
	    <quote><literal>none</literal></quote>), this specifies
256
	    the interface to use to connect to the address given.
146 by Teddy Hogeborn
* plugins.d/password-request.xml (OPTIONS): Improved wording.
257
	  </para>
237.2.48 by Teddy Hogeborn
* plugins.d/mandos-client.c (main): Use remove() instead of unlink(),
258
	  <para>
259
	    Note that since this program will normally run in the
260
	    initial RAM disk environment, the interface must be an
261
	    interface which exists at that stage.  Thus, the interface
237.22.4 by Teddy Hogeborn
* plugins.d/mandos-client.c (get_flags): Don't clobber errno.
262
	    can normally not be a pseudo-interface such as
263
	    <quote>br0</quote> or <quote>tun0</quote>; such interfaces
264
	    will not exist until much later in the boot process, and
265
	    can not be used by this program, unless created by a
266
	    <quote>network hook</quote>  see <xref
267
	    linkend="network-hooks"/>.
237.2.48 by Teddy Hogeborn
* plugins.d/mandos-client.c (main): Use remove() instead of unlink(),
268
	  </para>
237.2.67 by Teddy Hogeborn
Four new interrelated features:
269
	  <para>
269.1.1 by teddy at bsnet
* plugins.d/mandos-client.c: An empty interface name now means to
270
	    <replaceable>NAME</replaceable> can be the string
237.7.152 by Teddy Hogeborn
* plugins.d/mandos-client (start_mandos_communication): Bug fix; skip
271
	    <quote><literal>none</literal></quote>; this will make
237.7.214 by Teddy Hogeborn
Bug fix: Free all memory and give better messages when memory is full.
272
	    <command>&COMMANDNAME;</command> only bring up interfaces
273
	    specified <emphasis>before</emphasis> this string.  This
274
	    is not recommended, and only meant for advanced users.
237.2.67 by Teddy Hogeborn
Four new interrelated features:
275
	  </para>
24.1.23 by Björn Påhlsson
Added manual pages for:
276
	</listitem>
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
277
      </varlistentry>
142 by Teddy Hogeborn
* plugins.d/password-request.c (main): Change default GnuTLS priority
278
      
24.1.23 by Björn Påhlsson
Added manual pages for:
279
      <varlistentry>
127 by Teddy Hogeborn
* plugins.d/password-request.xml (OPTIONS): Make replaceables match
280
	<term><option>--pubkey=<replaceable
281
	>FILE</replaceable></option></term>
282
	<term><option>-p
283
	<replaceable>FILE</replaceable></option></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
284
	<listitem>
285
	  <para>
151 by Teddy Hogeborn
* plugins.d/password-request.xml (SYNOPSYS): Removed "--keydir".
286
	    OpenPGP public key file name.  The default name is
287
	    <quote><filename>/conf/conf.d/mandos/pubkey.txt</filename
288
	    ></quote>.
24.1.23 by Björn Påhlsson
Added manual pages for:
289
	  </para>
290
	</listitem>
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
291
      </varlistentry>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
292
      
24.1.23 by Björn Påhlsson
Added manual pages for:
293
      <varlistentry>
127 by Teddy Hogeborn
* plugins.d/password-request.xml (OPTIONS): Make replaceables match
294
	<term><option>--seckey=<replaceable
295
	>FILE</replaceable></option></term>
296
	<term><option>-s
297
	<replaceable>FILE</replaceable></option></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
298
	<listitem>
299
	  <para>
151 by Teddy Hogeborn
* plugins.d/password-request.xml (SYNOPSYS): Removed "--keydir".
300
	    OpenPGP secret key file name.  The default name is
301
	    <quote><filename>/conf/conf.d/mandos/seckey.txt</filename
302
	    ></quote>.
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>
24.1.23 by Björn Påhlsson
Added manual pages for:
306
      
307
      <varlistentry>
127 by Teddy Hogeborn
* plugins.d/password-request.xml (OPTIONS): Make replaceables match
308
	<term><option>--priority=<replaceable
309
	>STRING</replaceable></option></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
310
	<listitem>
143 by Teddy Hogeborn
* Makefile (mandos.8): Add dependency on "overview.xml" and
311
	  <xi:include href="../mandos-options.xml"
312
		      xpointer="priority"/>
24.1.23 by Björn Påhlsson
Added manual pages for:
313
	</listitem>
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
314
      </varlistentry>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
315
      
24.1.23 by Björn Påhlsson
Added manual pages for:
316
      <varlistentry>
127 by Teddy Hogeborn
* plugins.d/password-request.xml (OPTIONS): Make replaceables match
317
	<term><option>--dh-bits=<replaceable
318
	>BITS</replaceable></option></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
319
	<listitem>
320
	  <para>
142 by Teddy Hogeborn
* plugins.d/password-request.c (main): Change default GnuTLS priority
321
	    Sets the number of bits to use for the prime number in the
237.7.291 by Teddy Hogeborn
Automatically determine the number of DH bits in the TLS handshake.
322
	    TLS Diffie-Hellman key exchange.  The default value is
237.7.310 by Teddy Hogeborn
mandos-client: Add --dh-params FILE option.
323
	    selected automatically based on the OpenPGP key.  Note
324
	    that if the <option>--dh-params</option> option is used,
325
	    the values from that file will be used instead.
326
	  </para>
327
	</listitem>
328
      </varlistentry>
329
      
330
      <varlistentry>
331
	<term><option>--dh-params=<replaceable
332
	>FILE</replaceable></option></term>
333
	<listitem>
334
	  <para>
335
	    Specifies a PEM-encoded PKCS#3 file to read the parameters
336
	    needed by the TLS Diffie-Hellman key exchange from.  If
337
	    this option is not given, or if the file for some reason
338
	    could not be used, the parameters will be generated on
339
	    startup, which will take some time and processing power.
340
	    Those using servers running under time, power or processor
341
	    constraints may want to generate such a file in advance
342
	    and use this option.
24.1.23 by Björn Påhlsson
Added manual pages for:
343
	  </para>
344
	</listitem>
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
345
      </varlistentry>
24.1.124 by Björn Påhlsson
Added lower kernel loglevel to reduce clutter on system console.
346
347
      <varlistentry>
348
	<term><option>--delay=<replaceable
349
	>SECONDS</replaceable></option></term>
350
	<listitem>
351
	  <para>
237.22.4 by Teddy Hogeborn
* plugins.d/mandos-client.c (get_flags): Don't clobber errno.
352
	    After bringing a network interface up, the program waits
24.1.124 by Björn Påhlsson
Added lower kernel loglevel to reduce clutter on system console.
353
	    for the interface to arrive in a <quote>running</quote>
354
	    state before proceeding.  During this time, the kernel log
355
	    level will be lowered to reduce clutter on the system
356
	    console, alleviating any other plugins which might be
357
	    using the system console.  This option sets the upper
358
	    limit of seconds to wait.  The default is 2.5 seconds.
359
	  </para>
360
	</listitem>
361
      </varlistentry>
24.1.174 by Björn Påhlsson
* Makefile (CFLAGS): Added "-lrt" to include real time library.
362
363
      <varlistentry>
364
	<term><option>--retry=<replaceable
365
	>SECONDS</replaceable></option></term>
366
	<listitem>
367
	  <para>
237.7.39 by teddy at bsnet
* plugins.d/mandos-client.c (avahi_loop_with_timeout): Fix warning.
368
	    All Mandos servers are tried repeatedly until a password
369
	    is received.  This value specifies, in seconds, how long
370
	    between each successive try <emphasis>for the same
371
	    server</emphasis>.  The default is 10 seconds.
24.1.174 by Björn Påhlsson
* Makefile (CFLAGS): Added "-lrt" to include real time library.
372
	  </para>
373
	</listitem>
374
      </varlistentry>
237.16.5 by teddy at bsnet
* plugins.d/mandos-client.c (SYNOPSIS, OPTIONS): Document
375
376
      <varlistentry>
377
	<term><option>--network-hook-dir=<replaceable
378
	>DIR</replaceable></option></term>
379
	<listitem>
380
	  <para>
381
	    Network hook directory.  The default directory is
237.16.7 by teddy at bsnet
* initramfs-tools-hook: Install network hooks (and any required files)
382
	    <quote><filename class="directory"
383
	    >/lib/mandos/network-hooks.d</filename></quote>.
237.16.5 by teddy at bsnet
* plugins.d/mandos-client.c (SYNOPSIS, OPTIONS): Document
384
	  </para>
385
	</listitem>
386
      </varlistentry>
24.1.23 by Björn Påhlsson
Added manual pages for:
387
      
388
      <varlistentry>
127 by Teddy Hogeborn
* plugins.d/password-request.xml (OPTIONS): Make replaceables match
389
	<term><option>--debug</option></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
390
	<listitem>
391
	  <para>
142 by Teddy Hogeborn
* plugins.d/password-request.c (main): Change default GnuTLS priority
392
	    Enable debug mode.  This will enable a lot of output to
393
	    standard error about what the program is doing.  The
394
	    program will still perform all other functions normally.
395
	  </para>
396
	  <para>
397
	    It will also enable debug mode in the Avahi and GnuTLS
398
	    libraries, making them print large amounts of debugging
399
	    output.
24.1.23 by Björn Påhlsson
Added manual pages for:
400
	  </para>
401
	</listitem>
402
      </varlistentry>
403
      
404
      <varlistentry>
127 by Teddy Hogeborn
* plugins.d/password-request.xml (OPTIONS): Make replaceables match
405
	<term><option>--help</option></term>
406
	<term><option>-?</option></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
407
	<listitem>
408
	  <para>
142 by Teddy Hogeborn
* plugins.d/password-request.c (main): Change default GnuTLS priority
409
	    Gives a help message about options and their meanings.
24.1.23 by Björn Påhlsson
Added manual pages for:
410
	  </para>
411
	</listitem>
412
      </varlistentry>
413
      
414
      <varlistentry>
127 by Teddy Hogeborn
* plugins.d/password-request.xml (OPTIONS): Make replaceables match
415
	<term><option>--usage</option></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
416
	<listitem>
417
	  <para>
142 by Teddy Hogeborn
* plugins.d/password-request.c (main): Change default GnuTLS priority
418
	    Gives a short usage message.
24.1.23 by Björn Påhlsson
Added manual pages for:
419
	  </para>
420
	</listitem>
421
      </varlistentry>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
422
      
24.1.23 by Björn Påhlsson
Added manual pages for:
423
      <varlistentry>
127 by Teddy Hogeborn
* plugins.d/password-request.xml (OPTIONS): Make replaceables match
424
	<term><option>--version</option></term>
425
	<term><option>-V</option></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
426
	<listitem>
427
	  <para>
142 by Teddy Hogeborn
* plugins.d/password-request.c (main): Change default GnuTLS priority
428
	    Prints the program version.
24.1.23 by Björn Påhlsson
Added manual pages for:
429
	  </para>
430
	</listitem>
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
431
      </varlistentry>
24.1.23 by Björn Påhlsson
Added manual pages for:
432
    </variablelist>
433
  </refsect1>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
434
  
143 by Teddy Hogeborn
* Makefile (mandos.8): Add dependency on "overview.xml" and
435
  <refsect1 id="overview">
436
    <title>OVERVIEW</title>
437
    <xi:include href="../overview.xml"/>
438
    <para>
439
      This program is the client part.  It is a plugin started by
440
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
441
      <manvolnum>8mandos</manvolnum></citerefentry> which will run in
442
      an initial <acronym>RAM</acronym> disk environment.
443
    </para>
444
    <para>
445
      This program could, theoretically, be used as a keyscript in
446
      <filename>/etc/crypttab</filename>, but it would then be
144 by Teddy Hogeborn
* plugins.d/password-request.xml (OVERVIEW): Improved wording.
447
      impossible to enter a password for the encrypted root disk at
448
      the console, since this program does not read from the console
172 by Teddy Hogeborn
* plugins.d/mandos-client.xml (NAME, OVERVIEW, EXIT STATUS): Improved
449
      at all.  This is why a separate plugin runner (<citerefentry>
450
      <refentrytitle>plugin-runner</refentrytitle>
451
      <manvolnum>8mandos</manvolnum></citerefentry>) is used to run
452
      both this program and others in in parallel,
237.16.13 by Teddy Hogeborn
* debian/mandos-client.README.Debian: Document network hook facility.
453
      <emphasis>one</emphasis> of which (<citerefentry>
454
      <refentrytitle>password-prompt</refentrytitle>
455
      <manvolnum>8mandos</manvolnum></citerefentry>) will prompt for
456
      passwords on the system console.
143 by Teddy Hogeborn
* Makefile (mandos.8): Add dependency on "overview.xml" and
457
    </para>
458
  </refsect1>
459
  
24.1.55 by Björn Påhlsson
updated some partial manual pages
460
  <refsect1 id="exit_status">
461
    <title>EXIT STATUS</title>
462
    <para>
142 by Teddy Hogeborn
* plugins.d/password-request.c (main): Change default GnuTLS priority
463
      This program will exit with a successful (zero) exit status if a
464
      server could be found and the password received from it could be
465
      successfully decrypted and output on standard output.  The
466
      program will exit with a non-zero exit status only if a critical
237.7.39 by teddy at bsnet
* plugins.d/mandos-client.c (avahi_loop_with_timeout): Fix warning.
467
      error occurs.  Otherwise, it will forever connect to any
468
      discovered <application>Mandos</application> servers, trying to
469
      get a decryptable password and print it.
142 by Teddy Hogeborn
* plugins.d/password-request.c (main): Change default GnuTLS priority
470
    </para>
471
  </refsect1>
472
  
143 by Teddy Hogeborn
* Makefile (mandos.8): Add dependency on "overview.xml" and
473
  <refsect1 id="environment">
474
    <title>ENVIRONMENT</title>
237.25.2 by Teddy Hogeborn
mandos-client: Try to start a plugin to add and remove a local route.
475
    <variablelist>
476
      <varlistentry>
477
	<term><envar>MANDOSPLUGINHELPERDIR</envar></term>
478
	<listitem>
479
	  <para>
480
	    This environment variable will be assumed to contain the
481
	    directory containing any helper executables.  The use and
482
	    nature of these helper executables, if any, is
483
	    purposefully not documented.
484
	</para>
485
	</listitem>
486
      </varlistentry>
487
    </variablelist>
143 by Teddy Hogeborn
* Makefile (mandos.8): Add dependency on "overview.xml" and
488
    <para>
237.25.2 by Teddy Hogeborn
mandos-client: Try to start a plugin to add and remove a local route.
489
      This program does not use any other environment variables, not
490
      even the ones provided by <citerefentry><refentrytitle
143 by Teddy Hogeborn
* Makefile (mandos.8): Add dependency on "overview.xml" and
491
      >cryptsetup</refentrytitle><manvolnum>8</manvolnum>
492
    </citerefentry>.
493
    </para>
494
  </refsect1>
142 by Teddy Hogeborn
* plugins.d/password-request.c (main): Change default GnuTLS priority
495
  
237.16.13 by Teddy Hogeborn
* debian/mandos-client.README.Debian: Document network hook facility.
496
  <refsect1 id="network-hooks">
497
    <title>NETWORK HOOKS</title>
498
    <para>
499
      If a network interface like a bridge or tunnel is required to
500
      find a Mandos server, this requires the interface to be up and
501
      running before <command>&COMMANDNAME;</command> starts looking
502
      for Mandos servers.  This can be accomplished by creating a
503
      <quote>network hook</quote> program, and placing it in a special
504
      directory.
505
    </para>
506
    <para>
507
      Before the network is used (and again before program exit), any
508
      runnable programs found in the network hook directory are run
509
      with the argument <quote><literal>start</literal></quote> or
510
      <quote><literal>stop</literal></quote>.  This should bring up or
511
      down, respectively, any network interface which
512
      <command>&COMMANDNAME;</command> should use.
513
    </para>
514
    <refsect2 id="hook-requirements">
515
      <title>REQUIREMENTS</title>
516
      <para>
517
	A network hook must be an executable file, and its name must
518
	consist entirely of upper and lower case letters, digits,
237.16.14 by teddy at bsnet
Hooks take new "modules" argument, and hook names can contain periods.
519
	underscores, periods, and hyphens.
237.16.13 by Teddy Hogeborn
* debian/mandos-client.README.Debian: Document network hook facility.
520
      </para>
521
      <para>
522
	A network hook will receive one argument, which can be one of
523
	the following:
524
      </para>
525
      <variablelist>
526
	<varlistentry>
527
	  <term><literal>start</literal></term>
528
	  <listitem>
529
	    <para>
530
	      This should make the network hook create (if necessary)
531
	      and bring up a network interface.
532
	    </para>
533
	  </listitem>
534
	</varlistentry>
535
	<varlistentry>
536
	  <term><literal>stop</literal></term>
537
	  <listitem>
538
	    <para>
539
	      This should make the network hook take down a network
540
	      interface, and delete it if it did not exist previously.
541
	    </para>
542
	  </listitem>
543
	</varlistentry>
544
	<varlistentry>
545
	  <term><literal>files</literal></term>
546
	  <listitem>
547
	    <para>
237.16.14 by teddy at bsnet
Hooks take new "modules" argument, and hook names can contain periods.
548
	      This should make the network hook print, <emphasis>one
549
	      file per line</emphasis>, all the files needed for it to
550
	      run.  (These files will be copied into the initial RAM
551
	      filesystem.)  Typical use is for a network hook which is
552
	      a shell script to print its needed binaries.
237.16.13 by Teddy Hogeborn
* debian/mandos-client.README.Debian: Document network hook facility.
553
	    </para>
554
	    <para>
555
	      It is not necessary to print any non-executable files
556
	      already in the network hook directory, these will be
557
	      copied implicitly if they otherwise satisfy the name
237.7.161 by Teddy Hogeborn
* plugins.d/mandos-client.xml: Fix minor grammar.
558
	      requirements.
237.16.13 by Teddy Hogeborn
* debian/mandos-client.README.Debian: Document network hook facility.
559
	    </para>
560
	  </listitem>
561
	</varlistentry>
237.16.14 by teddy at bsnet
Hooks take new "modules" argument, and hook names can contain periods.
562
	<varlistentry>
563
	  <term><literal>modules</literal></term>
564
	  <listitem>
565
	    <para>
566
	      This should make the network hook print, <emphasis>on
567
	      separate lines</emphasis>, all the kernel modules needed
568
	      for it to run.  (These modules will be copied into the
569
	      initial RAM filesystem.)  For instance, a tunnel
570
	      interface needs the
571
	      <quote><literal>tun</literal></quote> module.
572
	    </para>
573
	  </listitem>
574
	</varlistentry>
237.16.13 by Teddy Hogeborn
* debian/mandos-client.README.Debian: Document network hook facility.
575
      </variablelist>
576
      <para>
577
	The network hook will be provided with a number of environment
578
	variables:
579
      </para>
580
      <variablelist>
581
	<varlistentry>
582
	  <term><envar>MANDOSNETHOOKDIR</envar></term>
583
	  <listitem>
584
	    <para>
585
	      The network hook directory, specified to
586
	      <command>&COMMANDNAME;</command> by the
587
	      <option>--network-hook-dir</option> option.  Note: this
588
	      should <emphasis>always</emphasis> be used by the
237.16.14 by teddy at bsnet
Hooks take new "modules" argument, and hook names can contain periods.
589
	      network hook to refer to itself or any files in the hook
590
	      directory it may require.
237.16.13 by Teddy Hogeborn
* debian/mandos-client.README.Debian: Document network hook facility.
591
	    </para>
592
	  </listitem>
593
	</varlistentry>
594
	<varlistentry>
595
	  <term><envar>DEVICE</envar></term>
596
	  <listitem>
597
	    <para>
237.22.4 by Teddy Hogeborn
* plugins.d/mandos-client.c (get_flags): Don't clobber errno.
598
	      The network interfaces, as specified to
237.16.13 by Teddy Hogeborn
* debian/mandos-client.README.Debian: Document network hook facility.
599
	      <command>&COMMANDNAME;</command> by the
237.22.4 by Teddy Hogeborn
* plugins.d/mandos-client.c (get_flags): Don't clobber errno.
600
	      <option>--interface</option> option, combined to one
601
	      string and separated by commas.  If this is set, and
602
	      does not contain the interface a hook will bring up,
603
	      there is no reason for a hook to continue.
237.16.13 by Teddy Hogeborn
* debian/mandos-client.README.Debian: Document network hook facility.
604
	    </para>
605
	  </listitem>
606
	</varlistentry>
607
	<varlistentry>
608
	  <term><envar>MODE</envar></term>
609
	  <listitem>
610
	    <para>
611
	      This will be the same as the first argument;
612
	      i.e. <quote><literal>start</literal></quote>,
237.16.14 by teddy at bsnet
Hooks take new "modules" argument, and hook names can contain periods.
613
	      <quote><literal>stop</literal></quote>,
614
	      <quote><literal>files</literal></quote>, or
615
	      <quote><literal>modules</literal></quote>.
237.16.13 by Teddy Hogeborn
* debian/mandos-client.README.Debian: Document network hook facility.
616
	    </para>
617
	  </listitem>
618
	</varlistentry>
619
	<varlistentry>
620
	  <term><envar>VERBOSITY</envar></term>
621
	  <listitem>
622
	    <para>
623
	      This will be the <quote><literal>1</literal></quote> if
624
	      the <option>--debug</option> option is passed to
625
	      <command>&COMMANDNAME;</command>, otherwise
626
	      <quote><literal>0</literal></quote>.
627
	    </para>
628
	  </listitem>
629
	</varlistentry>
630
	<varlistentry>
631
	  <term><envar>DELAY</envar></term>
632
	  <listitem>
633
	    <para>
634
	      This will be the same as the <option>--delay</option>
237.17.1 by teddy at recompile
Add wireless network hook
635
	      option passed to <command>&COMMANDNAME;</command>.  Is
636
	      only set if <envar>MODE</envar> is
637
	      <quote><literal>start</literal></quote> or
638
	      <quote><literal>stop</literal></quote>.
639
	    </para>
640
	  </listitem>
641
	</varlistentry>
642
	<varlistentry>
643
	  <term><envar>CONNECT</envar></term>
644
	  <listitem>
645
	    <para>
646
	      This will be the same as the <option>--connect</option>
647
	      option passed to <command>&COMMANDNAME;</command>.  Is
648
	      only set if <option>--connect</option> is passed and
649
	      <envar>MODE</envar> is
650
	      <quote><literal>start</literal></quote> or
651
	      <quote><literal>stop</literal></quote>.
237.16.13 by Teddy Hogeborn
* debian/mandos-client.README.Debian: Document network hook facility.
652
	    </para>
653
	  </listitem>
654
	</varlistentry>
655
      </variablelist>
656
      <para>
657
	A hook may not read from standard input, and should be
658
	restrictive in printing to standard output or standard error
659
	unless <varname>VERBOSITY</varname> is
660
	<quote><literal>1</literal></quote>.
661
      </para>
662
    </refsect2>
663
  </refsect1>
664
  
224 by Teddy Hogeborn
* mandos-keygen.xml (FILES): Fixed id to be "files", not "file".
665
  <refsect1 id="files">
24.1.55 by Björn Påhlsson
updated some partial manual pages
666
    <title>FILES</title>
146 by Teddy Hogeborn
* plugins.d/password-request.xml (OPTIONS): Improved wording.
667
    <variablelist>
668
      <varlistentry>
669
	<term><filename>/conf/conf.d/mandos/pubkey.txt</filename
670
	></term>
671
	<term><filename>/conf/conf.d/mandos/seckey.txt</filename
672
	></term>
673
	<listitem>
674
	  <para>
675
	    OpenPGP public and private key files, in <quote>ASCII
676
	    Armor</quote> format.  These are the default file names,
677
	    they can be changed with the <option>--pubkey</option> and
678
	    <option>--seckey</option> options.
679
	  </para>
680
	</listitem>
681
      </varlistentry>
237.16.13 by Teddy Hogeborn
* debian/mandos-client.README.Debian: Document network hook facility.
682
      <varlistentry>
683
	<term><filename
684
	class="directory">/lib/mandos/network-hooks.d</filename></term>
685
	<listitem>
686
	  <para>
687
	    Directory where network hooks are located.  Change this
688
	    with the <option>--network-hook-dir</option> option.  See
689
	    <xref linkend="network-hooks"/>.
690
	  </para>
691
	</listitem>
692
      </varlistentry>
146 by Teddy Hogeborn
* plugins.d/password-request.xml (OPTIONS): Improved wording.
693
    </variablelist>
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
694
  </refsect1>
24.1.55 by Björn Påhlsson
updated some partial manual pages
695
  
237.7.369 by Teddy Hogeborn
Add bug reporting information to manual pages
696
  <refsect1 id="bugs">
697
    <title>BUGS</title>
698
    <xi:include href="../bugs.xml"/>
699
  </refsect1>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
700
  
87 by Teddy Hogeborn
* Makefile: Bug fix: fixed creation of man pages in "plugins.d".
701
  <refsect1 id="example">
702
    <title>EXAMPLE</title>
24.1.55 by Björn Påhlsson
updated some partial manual pages
703
    <para>
146 by Teddy Hogeborn
* plugins.d/password-request.xml (OPTIONS): Improved wording.
704
      Note that normally, command line options will not be given
705
      directly, but via options for the Mandos <citerefentry
706
      ><refentrytitle>plugin-runner</refentrytitle>
707
      <manvolnum>8mandos</manvolnum></citerefentry>.
24.1.55 by Björn Påhlsson
updated some partial manual pages
708
    </para>
146 by Teddy Hogeborn
* plugins.d/password-request.xml (OPTIONS): Improved wording.
709
    <informalexample>
710
      <para>
237.7.166 by Teddy Hogeborn
* mandos: Bug fix: Make boolean options work from the config file
711
	Normal invocation needs no options, if the network interfaces
237.7.140 by Teddy Hogeborn
* plugins.d/mandos-client.xml (EXAMPLE): Doc fix: Network interface is
712
	can be automatically determined:
146 by Teddy Hogeborn
* plugins.d/password-request.xml (OPTIONS): Improved wording.
713
      </para>
714
      <para>
715
	<userinput>&COMMANDNAME;</userinput>
716
      </para>
717
    </informalexample>
718
    <informalexample>
719
      <para>
237.7.166 by Teddy Hogeborn
* mandos: Bug fix: Make boolean options work from the config file
720
	Search for Mandos servers (and connect to them) using one
721
	specific interface:
146 by Teddy Hogeborn
* plugins.d/password-request.xml (OPTIONS): Improved wording.
722
      </para>
723
      <para>
724
	<!-- do not wrap this line -->
725
	<userinput>&COMMANDNAME; --interface eth1</userinput>
726
      </para>
727
    </informalexample>
728
    <informalexample>
729
      <para>
151 by Teddy Hogeborn
* plugins.d/password-request.xml (SYNOPSYS): Removed "--keydir".
730
	Run in debug mode, and use a custom key:
146 by Teddy Hogeborn
* plugins.d/password-request.xml (OPTIONS): Improved wording.
731
      </para>
732
      <para>
151 by Teddy Hogeborn
* plugins.d/password-request.xml (SYNOPSYS): Removed "--keydir".
733
734
<!-- do not wrap this line -->
735
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt</userinput>
736
146 by Teddy Hogeborn
* plugins.d/password-request.xml (OPTIONS): Improved wording.
737
      </para>
738
    </informalexample>
739
    <informalexample>
740
      <para>
151 by Teddy Hogeborn
* plugins.d/password-request.xml (SYNOPSYS): Removed "--keydir".
741
	Run in debug mode, with a custom key, and do not use Zeroconf
237.2.67 by Teddy Hogeborn
Four new interrelated features:
742
	to locate a server; connect directly to the IPv6 link-local
743
	address <quote><systemitem class="ipaddress"
744
	>fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
745
	using interface eth2:
146 by Teddy Hogeborn
* plugins.d/password-request.xml (OPTIONS): Improved wording.
746
      </para>
747
      <para>
748
749
<!-- do not wrap this line -->
237.2.67 by Teddy Hogeborn
Four new interrelated features:
750
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect fe80::aede:48ff:fe71:f6f2:4711 --interface eth2</userinput>
146 by Teddy Hogeborn
* plugins.d/password-request.xml (OPTIONS): Improved wording.
751
752
      </para>
753
    </informalexample>
24.1.55 by Björn Påhlsson
updated some partial manual pages
754
  </refsect1>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
755
  
24.1.55 by Björn Påhlsson
updated some partial manual pages
756
  <refsect1 id="security">
757
    <title>SECURITY</title>
758
    <para>
147 by Teddy Hogeborn
* plugins.d/password-request.c (init_gnutls_global): Improved wording
759
      This program is set-uid to root, but will switch back to the
148 by Teddy Hogeborn
* plugins.d/password-request.xml (OVERVIEW): Refer to
760
      original (and presumably non-privileged) user and group after
761
      bringing up the network interface.
147 by Teddy Hogeborn
* plugins.d/password-request.c (init_gnutls_global): Improved wording
762
    </para>
763
    <para>
764
      To use this program for its intended purpose (see <xref
765
      linkend="purpose"/>), the password for the root file system will
766
      have to be given out to be stored in a server computer, after
767
      having been encrypted using an OpenPGP key.  This encrypted data
768
      which will be stored in a server can only be decrypted by the
769
      OpenPGP key, and the data will only be given out to those
770
      clients who can prove they actually have that key.  This key,
771
      however, is stored unencrypted on the client side in its initial
772
      <acronym>RAM</acronym> disk image file system.  This is normally
773
      readable by all, but this is normally fixed during installation
774
      of this program; file permissions are set so that no-one is able
775
      to read that file.
776
    </para>
777
    <para>
778
      The only remaining weak point is that someone with physical
779
      access to the client hard drive might turn off the client
780
      computer, read the OpenPGP keys directly from the hard drive,
216 by Teddy Hogeborn
* Makefile: Add HTML rules for manual pages.
781
      and communicate with the server.  To safeguard against this, the
782
      server is supposed to notice the client disappearing and stop
783
      giving out the encrypted data.  Therefore, it is important to
784
      set the timeout and checker interval values tightly on the
785
      server.  See <citerefentry><refentrytitle
147 by Teddy Hogeborn
* plugins.d/password-request.c (init_gnutls_global): Improved wording
786
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
787
    </para>
788
    <para>
148 by Teddy Hogeborn
* plugins.d/password-request.xml (OVERVIEW): Refer to
789
      It will also help if the checker program on the server is
790
      configured to request something from the client which can not be
237.7.256 by Teddy Hogeborn
mandos-keygen: Generate "checker" option to use SSH fingerprints.
791
      spoofed by someone else on the network, like SSH server key
792
      fingerprints, and unlike unencrypted <acronym>ICMP</acronym>
793
      echo (<quote>ping</quote>) replies.
148 by Teddy Hogeborn
* plugins.d/password-request.xml (OVERVIEW): Refer to
794
    </para>
795
    <para>
796
      <emphasis>Note</emphasis>: This makes it completely insecure to
797
      have <application >Mandos</application> clients which dual-boot
798
      to another operating system which is <emphasis>not</emphasis>
799
      trusted to keep the initial <acronym>RAM</acronym> disk image
800
      confidential.
24.1.55 by Björn Påhlsson
updated some partial manual pages
801
    </para>
802
  </refsect1>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
803
  
24.1.55 by Björn Påhlsson
updated some partial manual pages
804
  <refsect1 id="see_also">
805
    <title>SEE ALSO</title>
114 by Teddy Hogeborn
* mandos-clients.conf.xml (SEE ALSO): Alphabetized, as per
806
    <para>
237.7.41 by Teddy Hogeborn
* Makefile (DOCS): Added "intro.8mandos".
807
      <citerefentry><refentrytitle>intro</refentrytitle>
808
      <manvolnum>8mandos</manvolnum></citerefentry>,
148 by Teddy Hogeborn
* plugins.d/password-request.xml (OVERVIEW): Refer to
809
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
810
      <manvolnum>8</manvolnum></citerefentry>,
811
      <citerefentry><refentrytitle>crypttab</refentrytitle>
812
      <manvolnum>5</manvolnum></citerefentry>,
114 by Teddy Hogeborn
* mandos-clients.conf.xml (SEE ALSO): Alphabetized, as per
813
      <citerefentry><refentrytitle>mandos</refentrytitle>
814
      <manvolnum>8</manvolnum></citerefentry>,
815
      <citerefentry><refentrytitle>password-prompt</refentrytitle>
816
      <manvolnum>8mandos</manvolnum></citerefentry>,
817
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
818
      <manvolnum>8mandos</manvolnum></citerefentry>
819
    </para>
148 by Teddy Hogeborn
* plugins.d/password-request.xml (OVERVIEW): Refer to
820
    <variablelist>
821
      <varlistentry>
822
	<term>
823
	  <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
824
	</term>
825
	<listitem>
826
	  <para>
827
	    Zeroconf is the network protocol standard used for finding
828
	    Mandos servers on the local network.
829
	  </para>
830
	</listitem>
831
      </varlistentry>
832
      <varlistentry>
833
	<term>
834
	  <ulink url="http://www.avahi.org/">Avahi</ulink>
835
	</term>
836
      <listitem>
837
	<para>
838
	  Avahi is the library this program calls to find Zeroconf
839
	  services.
840
	</para>
841
      </listitem>
842
      </varlistentry>
843
      <varlistentry>
844
	<term>
845
	  <ulink url="http://www.gnu.org/software/gnutls/"
846
	  >GnuTLS</ulink>
847
	</term>
848
      <listitem>
849
	<para>
850
	  GnuTLS is the library this client uses to implement TLS for
851
	  communicating securely with the server, and at the same time
852
	  send the public OpenPGP key to the server.
853
	</para>
854
      </listitem>
855
      </varlistentry>
856
      <varlistentry>
857
	<term>
858
	  <ulink url="http://www.gnupg.org/related_software/gpgme/"
859
		 >GPGME</ulink>
860
	</term>
861
	<listitem>
862
	  <para>
863
	    GPGME is the library used to decrypt the OpenPGP data sent
864
	    by the server.
865
	  </para>
866
	</listitem>
867
      </varlistentry>
868
      <varlistentry>
869
	<term>
870
	  RFC 4291: <citetitle>IP Version 6 Addressing
871
	  Architecture</citetitle>
872
	</term>
873
	<listitem>
874
	  <variablelist>
875
	    <varlistentry>
876
	      <term>Section 2.2: <citetitle>Text Representation of
877
	      Addresses</citetitle></term>
878
	      <listitem><para/></listitem>
879
	    </varlistentry>
880
	    <varlistentry>
881
	      <term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
882
	      Address</citetitle></term>
883
	      <listitem><para/></listitem>
884
	    </varlistentry>
885
	    <varlistentry>
886
	    <term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
887
	    Addresses</citetitle></term>
888
	    <listitem>
889
	      <para>
890
		This client uses IPv6 link-local addresses, which are
891
		immediately usable since a link-local addresses is
237.7.161 by Teddy Hogeborn
* plugins.d/mandos-client.xml: Fix minor grammar.
892
		automatically assigned to a network interface when it
148 by Teddy Hogeborn
* plugins.d/password-request.xml (OVERVIEW): Refer to
893
		is brought up.
894
	      </para>
895
	    </listitem>
896
	    </varlistentry>
897
	  </variablelist>
898
	</listitem>
899
      </varlistentry>
900
      <varlistentry>
901
	<term>
902
	  RFC 4346: <citetitle>The Transport Layer Security (TLS)
903
	  Protocol Version 1.1</citetitle>
904
	</term>
905
      <listitem>
906
	<para>
907
	  TLS 1.1 is the protocol implemented by GnuTLS.
908
	</para>
909
      </listitem>
910
      </varlistentry>
911
      <varlistentry>
912
	<term>
913
	  RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
914
	</term>
915
      <listitem>
916
	<para>
917
	  The data received from the server is binary encrypted
918
	  OpenPGP data.
919
	</para>
920
      </listitem>
921
      </varlistentry>
922
      <varlistentry>
923
	<term>
924
	  RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
925
	  Security</citetitle>
926
	</term>
927
      <listitem>
928
	<para>
929
	  This is implemented by GnuTLS and used by this program so
930
	  that OpenPGP keys can be used.
931
	</para>
932
      </listitem>
933
      </varlistentry>
934
    </variablelist>
81 by Teddy Hogeborn
* Makefile (GNUTLS_CFLAGS, GNUTLS_LIBS, AVAHI_CFLAGS, AVAHI_LIBS,
935
  </refsect1>
24.1.23 by Björn Påhlsson
Added manual pages for:
936
</refentry>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
937
111 by Teddy Hogeborn
* mandos-clients.conf.xml (ENTITY TIMESTAMP): New. Automatically
938
<!-- Local Variables: -->
939
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
940
<!-- time-stamp-end: "[\"']>" -->
941
<!-- time-stamp-format: "%:y-%02m-%02d" -->
942
<!-- End: -->