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