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