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