/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.41 by Teddy Hogeborn
* Makefile (DOCS): Added "intro.8mandos".
5
<!ENTITY TIMESTAMP "2011-08-08">
217 by Teddy Hogeborn
* .bzrignore: Added "man" directory (created by "make install-html").
6
<!ENTITY % common SYSTEM "../common.ent">
7
%common;
24.1.23 by Björn Påhlsson
Added manual pages for:
8
]>
9
131 by Teddy Hogeborn
* Makefile: Make all DocBook rules include legalnotice.xml as a
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
24.1.23 by Björn Påhlsson
Added manual pages for:
11
  <refentryinfo>
112 by Teddy Hogeborn
* mandos-clients.conf.xml (/refentry/refentryinfo/title): Changed to
12
    <title>Mandos Manual</title>
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>
22
	  <email>belorn@fukt.bsnet.se</email>
23
	</address>
24
      </author>
25
      <author>
26
	<firstname>Teddy</firstname>
27
	<surname>Hogeborn</surname>
28
	<address>
29
	  <email>teddy@fukt.bsnet.se</email>
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.41 by Teddy Hogeborn
* Makefile (DOCS): Added "intro.8mandos".
36
      <year>2011</year>
128 by Teddy Hogeborn
* plugin-runner.xml (/refentry/refentryinfo/copyright): Split
37
      <holder>Teddy Hogeborn</holder>
38
      <holder>Björn Påhlsson</holder>
24.1.23 by Björn Påhlsson
Added manual pages for:
39
    </copyright>
131 by Teddy Hogeborn
* Makefile: Make all DocBook rules include legalnotice.xml as a
40
    <xi:include href="../legalnotice.xml"/>
24.1.23 by Björn Påhlsson
Added manual pages for:
41
  </refentryinfo>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
42
  
24.1.23 by Björn Påhlsson
Added manual pages for:
43
  <refmeta>
44
    <refentrytitle>&COMMANDNAME;</refentrytitle>
45
    <manvolnum>8mandos</manvolnum>
46
  </refmeta>
47
  
48
  <refnamediv>
49
    <refname><command>&COMMANDNAME;</command></refname>
50
    <refpurpose>
172 by Teddy Hogeborn
* plugins.d/mandos-client.xml (NAME, OVERVIEW, EXIT STATUS): Improved
51
      Client for <application>Mandos</application>
24.1.23 by Björn Påhlsson
Added manual pages for:
52
    </refpurpose>
53
  </refnamediv>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
54
  
24.1.23 by Björn Påhlsson
Added manual pages for:
55
  <refsynopsisdiv>
56
    <cmdsynopsis>
57
      <command>&COMMANDNAME;</command>
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
58
      <group>
59
	<arg choice="plain"><option>--connect
156 by Teddy Hogeborn
* mandos-clients.conf.xml (OPTIONS): Improved spelling.
60
	<replaceable>ADDRESS</replaceable><literal>:</literal
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
61
	><replaceable>PORT</replaceable></option></arg>
62
	<arg choice="plain"><option>-c
156 by Teddy Hogeborn
* mandos-clients.conf.xml (OPTIONS): Improved spelling.
63
	<replaceable>ADDRESS</replaceable><literal>:</literal
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
64
	><replaceable>PORT</replaceable></option></arg>
65
      </group>
66
      <sbr/>
67
      <group>
68
	<arg choice="plain"><option>--interface
69
	<replaceable>NAME</replaceable></option></arg>
70
	<arg choice="plain"><option>-i
71
	<replaceable>NAME</replaceable></option></arg>
72
      </group>
73
      <sbr/>
74
      <group>
75
	<arg choice="plain"><option>--pubkey
76
	<replaceable>FILE</replaceable></option></arg>
77
	<arg choice="plain"><option>-p
78
	<replaceable>FILE</replaceable></option></arg>
79
      </group>
80
      <sbr/>
81
      <group>
82
	<arg choice="plain"><option>--seckey
83
	<replaceable>FILE</replaceable></option></arg>
84
	<arg choice="plain"><option>-s
85
	<replaceable>FILE</replaceable></option></arg>
86
      </group>
87
      <sbr/>
88
      <arg>
89
	<option>--priority <replaceable>STRING</replaceable></option>
90
      </arg>
91
      <sbr/>
92
      <arg>
93
	<option>--dh-bits <replaceable>BITS</replaceable></option>
94
      </arg>
95
      <sbr/>
96
      <arg>
24.1.124 by Björn Påhlsson
Added lower kernel loglevel to reduce clutter on system console.
97
	<option>--delay <replaceable>SECONDS</replaceable></option>
98
      </arg>
99
      <sbr/>
100
      <arg>
24.1.174 by Björn Påhlsson
* Makefile (CFLAGS): Added "-lrt" to include real time library.
101
	<option>--retry <replaceable>SECONDS</replaceable></option>
102
      </arg>
103
      <sbr/>
104
      <arg>
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
105
	<option>--debug</option>
106
      </arg>
107
    </cmdsynopsis>
108
    <cmdsynopsis>
109
      <command>&COMMANDNAME;</command>
110
      <group choice="req">
129 by Teddy Hogeborn
* mandos-clients.conf.xml: Changed all single quotes to double quotes
111
	<arg choice="plain"><option>--help</option></arg>
112
	<arg choice="plain"><option>-?</option></arg>
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
113
      </group>
114
    </cmdsynopsis>
115
    <cmdsynopsis>
116
      <command>&COMMANDNAME;</command>
129 by Teddy Hogeborn
* mandos-clients.conf.xml: Changed all single quotes to double quotes
117
      <arg choice="plain"><option>--usage</option></arg>
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
118
    </cmdsynopsis>
119
    <cmdsynopsis>
120
      <command>&COMMANDNAME;</command>
121
      <group choice="req">
129 by Teddy Hogeborn
* mandos-clients.conf.xml: Changed all single quotes to double quotes
122
	<arg choice="plain"><option>--version</option></arg>
123
	<arg choice="plain"><option>-V</option></arg>
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
124
      </group>
125
    </cmdsynopsis>
24.1.23 by Björn Påhlsson
Added manual pages for:
126
  </refsynopsisdiv>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
127
  
24.1.23 by Björn Påhlsson
Added manual pages for:
128
  <refsect1 id="description">
129
    <title>DESCRIPTION</title>
130
    <para>
142 by Teddy Hogeborn
* plugins.d/password-request.c (main): Change default GnuTLS priority
131
      <command>&COMMANDNAME;</command> is a client program that
132
      communicates with <citerefentry><refentrytitle
133
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>
237.2.48 by Teddy Hogeborn
* plugins.d/mandos-client.c (main): Use remove() instead of unlink(),
134
      to get a password.  In slightly more detail, this client program
135
      brings up a network interface, uses the interface’s IPv6
136
      link-local address to get network connectivity, uses Zeroconf to
137
      find servers on the local network, and communicates with servers
138
      using TLS with an OpenPGP key to ensure authenticity and
139
      confidentiality.  This client program keeps running, trying all
140
      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.
141
      or a TERM signal.  After all servers have been tried, all
142
      servers are periodically retried.  If no servers are found it
143
      will wait indefinitely for new servers to appear.
142 by Teddy Hogeborn
* plugins.d/password-request.c (main): Change default GnuTLS priority
144
    </para>
145
    <para>
146
      This program is not meant to be run directly; it is really meant
147
      to run as a plugin of the <application>Mandos</application>
148
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
143 by Teddy Hogeborn
* Makefile (mandos.8): Add dependency on "overview.xml" and
149
      <manvolnum>8mandos</manvolnum></citerefentry>, which runs in the
150
      initial <acronym>RAM</acronym> disk environment because it is
151
      specified as a <quote>keyscript</quote> in the <citerefentry>
152
      <refentrytitle>crypttab</refentrytitle><manvolnum>5</manvolnum>
153
      </citerefentry> file.
142 by Teddy Hogeborn
* plugins.d/password-request.c (main): Change default GnuTLS priority
154
    </para>
155
  </refsect1>
156
  
157
  <refsect1 id="purpose">
158
    <title>PURPOSE</title>
159
    <para>
160
      The purpose of this is to enable <emphasis>remote and unattended
161
      rebooting</emphasis> of client host computer with an
162
      <emphasis>encrypted root file system</emphasis>.  See <xref
163
      linkend="overview"/> for details.
164
    </para>
165
  </refsect1>
166
  
24.1.55 by Björn Påhlsson
updated some partial manual pages
167
  <refsect1 id="options">
168
    <title>OPTIONS</title>
169
    <para>
142 by Teddy Hogeborn
* plugins.d/password-request.c (main): Change default GnuTLS priority
170
      This program is commonly not invoked from the command line; it
171
      is normally started by the <application>Mandos</application>
172
      plugin runner, see <citerefentry><refentrytitle
173
      >plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum>
174
      </citerefentry>.  Any command line options this program accepts
175
      are therefore normally provided by the plugin runner, and not
176
      directly.
24.1.55 by Björn Påhlsson
updated some partial manual pages
177
    </para>
142 by Teddy Hogeborn
* plugins.d/password-request.c (main): Change default GnuTLS priority
178
    
24.1.23 by Björn Påhlsson
Added manual pages for:
179
    <variablelist>
180
      <varlistentry>
127 by Teddy Hogeborn
* plugins.d/password-request.xml (OPTIONS): Make replaceables match
181
	<term><option>--connect=<replaceable
143 by Teddy Hogeborn
* Makefile (mandos.8): Add dependency on "overview.xml" and
182
	>ADDRESS</replaceable><literal>:</literal><replaceable
127 by Teddy Hogeborn
* plugins.d/password-request.xml (OPTIONS): Make replaceables match
183
	>PORT</replaceable></option></term>
184
	<term><option>-c
143 by Teddy Hogeborn
* Makefile (mandos.8): Add dependency on "overview.xml" and
185
	<replaceable>ADDRESS</replaceable><literal>:</literal
127 by Teddy Hogeborn
* plugins.d/password-request.xml (OPTIONS): Make replaceables match
186
	><replaceable>PORT</replaceable></option></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
187
	<listitem>
188
	  <para>
142 by Teddy Hogeborn
* plugins.d/password-request.c (main): Change default GnuTLS priority
189
	    Do not use Zeroconf to locate servers.  Connect directly
190
	    to only one specified <application>Mandos</application>
191
	    server.  Note that an IPv6 address has colon characters in
192
	    it, so the <emphasis>last</emphasis> colon character is
193
	    assumed to separate the address from the port number.
194
	  </para>
195
	  <para>
143 by Teddy Hogeborn
* Makefile (mandos.8): Add dependency on "overview.xml" and
196
	    This option is normally only useful for testing and
197
	    debugging.
24.1.23 by Björn Påhlsson
Added manual pages for:
198
	  </para>
199
	</listitem>
200
      </varlistentry>
142 by Teddy Hogeborn
* plugins.d/password-request.c (main): Change default GnuTLS priority
201
      
24.1.23 by Björn Påhlsson
Added manual pages for:
202
      <varlistentry>
237.2.67 by Teddy Hogeborn
Four new interrelated features:
203
	<term><option>--interface=<replaceable
204
	>NAME</replaceable></option></term>
127 by Teddy Hogeborn
* plugins.d/password-request.xml (OPTIONS): Make replaceables match
205
	<term><option>-i
206
	<replaceable>NAME</replaceable></option></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
207
	<listitem>
208
	  <para>
142 by Teddy Hogeborn
* plugins.d/password-request.c (main): Change default GnuTLS priority
209
	    Network interface that will be brought up and scanned for
269.1.1 by teddy at bsnet
* plugins.d/mandos-client.c: An empty interface name now means to
210
	    Mandos servers to connect to.  The default is the empty
211
	    string, which will automatically choose an appropriate
212
	    interface.
24.1.23 by Björn Påhlsson
Added manual pages for:
213
	  </para>
146 by Teddy Hogeborn
* plugins.d/password-request.xml (OPTIONS): Improved wording.
214
	  <para>
215
	    If the <option>--connect</option> option is used, this
216
	    specifies the interface to use to connect to the address
217
	    given.
218
	  </para>
237.2.48 by Teddy Hogeborn
* plugins.d/mandos-client.c (main): Use remove() instead of unlink(),
219
	  <para>
220
	    Note that since this program will normally run in the
221
	    initial RAM disk environment, the interface must be an
222
	    interface which exists at that stage.  Thus, the interface
223
	    can not be a pseudo-interface such as <quote>br0</quote>
224
	    or <quote>tun0</quote>; such interfaces will not exist
225
	    until much later in the boot process, and can not be used
226
	    by this program.
227
	  </para>
237.2.67 by Teddy Hogeborn
Four new interrelated features:
228
	  <para>
269.1.1 by teddy at bsnet
* plugins.d/mandos-client.c: An empty interface name now means to
229
	    <replaceable>NAME</replaceable> can be the string
230
	    <quote><literal>none</literal></quote>; this will not use
231
	    any specific interface, and will not bring up an interface
232
	    on startup.  This is not recommended, and only meant for
233
	    advanced users.
237.2.67 by Teddy Hogeborn
Four new interrelated features:
234
	  </para>
24.1.23 by Björn Påhlsson
Added manual pages for:
235
	</listitem>
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
236
      </varlistentry>
142 by Teddy Hogeborn
* plugins.d/password-request.c (main): Change default GnuTLS priority
237
      
24.1.23 by Björn Påhlsson
Added manual pages for:
238
      <varlistentry>
127 by Teddy Hogeborn
* plugins.d/password-request.xml (OPTIONS): Make replaceables match
239
	<term><option>--pubkey=<replaceable
240
	>FILE</replaceable></option></term>
241
	<term><option>-p
242
	<replaceable>FILE</replaceable></option></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
243
	<listitem>
244
	  <para>
151 by Teddy Hogeborn
* plugins.d/password-request.xml (SYNOPSYS): Removed "--keydir".
245
	    OpenPGP public key file name.  The default name is
246
	    <quote><filename>/conf/conf.d/mandos/pubkey.txt</filename
247
	    ></quote>.
24.1.23 by Björn Påhlsson
Added manual pages for:
248
	  </para>
249
	</listitem>
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
250
      </varlistentry>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
251
      
24.1.23 by Björn Påhlsson
Added manual pages for:
252
      <varlistentry>
127 by Teddy Hogeborn
* plugins.d/password-request.xml (OPTIONS): Make replaceables match
253
	<term><option>--seckey=<replaceable
254
	>FILE</replaceable></option></term>
255
	<term><option>-s
256
	<replaceable>FILE</replaceable></option></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
257
	<listitem>
258
	  <para>
151 by Teddy Hogeborn
* plugins.d/password-request.xml (SYNOPSYS): Removed "--keydir".
259
	    OpenPGP secret key file name.  The default name is
260
	    <quote><filename>/conf/conf.d/mandos/seckey.txt</filename
261
	    ></quote>.
24.1.23 by Björn Påhlsson
Added manual pages for:
262
	  </para>
263
	</listitem>
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
264
      </varlistentry>
24.1.23 by Björn Påhlsson
Added manual pages for:
265
      
266
      <varlistentry>
127 by Teddy Hogeborn
* plugins.d/password-request.xml (OPTIONS): Make replaceables match
267
	<term><option>--priority=<replaceable
268
	>STRING</replaceable></option></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
269
	<listitem>
143 by Teddy Hogeborn
* Makefile (mandos.8): Add dependency on "overview.xml" and
270
	  <xi:include href="../mandos-options.xml"
271
		      xpointer="priority"/>
24.1.23 by Björn Påhlsson
Added manual pages for:
272
	</listitem>
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
273
      </varlistentry>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
274
      
24.1.23 by Björn Påhlsson
Added manual pages for:
275
      <varlistentry>
127 by Teddy Hogeborn
* plugins.d/password-request.xml (OPTIONS): Make replaceables match
276
	<term><option>--dh-bits=<replaceable
277
	>BITS</replaceable></option></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
278
	<listitem>
279
	  <para>
142 by Teddy Hogeborn
* plugins.d/password-request.c (main): Change default GnuTLS priority
280
	    Sets the number of bits to use for the prime number in the
281
	    TLS Diffie-Hellman key exchange.  Default is 1024.
24.1.23 by Björn Påhlsson
Added manual pages for:
282
	  </para>
283
	</listitem>
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
284
      </varlistentry>
24.1.124 by Björn Påhlsson
Added lower kernel loglevel to reduce clutter on system console.
285
286
      <varlistentry>
287
	<term><option>--delay=<replaceable
288
	>SECONDS</replaceable></option></term>
289
	<listitem>
290
	  <para>
291
	    After bringing the network interface up, the program waits
292
	    for the interface to arrive in a <quote>running</quote>
293
	    state before proceeding.  During this time, the kernel log
294
	    level will be lowered to reduce clutter on the system
295
	    console, alleviating any other plugins which might be
296
	    using the system console.  This option sets the upper
297
	    limit of seconds to wait.  The default is 2.5 seconds.
298
	  </para>
299
	</listitem>
300
      </varlistentry>
24.1.174 by Björn Påhlsson
* Makefile (CFLAGS): Added "-lrt" to include real time library.
301
302
      <varlistentry>
303
	<term><option>--retry=<replaceable
304
	>SECONDS</replaceable></option></term>
305
	<listitem>
306
	  <para>
237.7.39 by teddy at bsnet
* plugins.d/mandos-client.c (avahi_loop_with_timeout): Fix warning.
307
	    All Mandos servers are tried repeatedly until a password
308
	    is received.  This value specifies, in seconds, how long
309
	    between each successive try <emphasis>for the same
310
	    server</emphasis>.  The default is 10 seconds.
24.1.174 by Björn Påhlsson
* Makefile (CFLAGS): Added "-lrt" to include real time library.
311
	  </para>
312
	</listitem>
313
      </varlistentry>
24.1.23 by Björn Påhlsson
Added manual pages for:
314
      
315
      <varlistentry>
127 by Teddy Hogeborn
* plugins.d/password-request.xml (OPTIONS): Make replaceables match
316
	<term><option>--debug</option></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
317
	<listitem>
318
	  <para>
142 by Teddy Hogeborn
* plugins.d/password-request.c (main): Change default GnuTLS priority
319
	    Enable debug mode.  This will enable a lot of output to
320
	    standard error about what the program is doing.  The
321
	    program will still perform all other functions normally.
322
	  </para>
323
	  <para>
324
	    It will also enable debug mode in the Avahi and GnuTLS
325
	    libraries, making them print large amounts of debugging
326
	    output.
24.1.23 by Björn Påhlsson
Added manual pages for:
327
	  </para>
328
	</listitem>
329
      </varlistentry>
330
      
331
      <varlistentry>
127 by Teddy Hogeborn
* plugins.d/password-request.xml (OPTIONS): Make replaceables match
332
	<term><option>--help</option></term>
333
	<term><option>-?</option></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
334
	<listitem>
335
	  <para>
142 by Teddy Hogeborn
* plugins.d/password-request.c (main): Change default GnuTLS priority
336
	    Gives a help message about options and their meanings.
24.1.23 by Björn Påhlsson
Added manual pages for:
337
	  </para>
338
	</listitem>
339
      </varlistentry>
340
      
341
      <varlistentry>
127 by Teddy Hogeborn
* plugins.d/password-request.xml (OPTIONS): Make replaceables match
342
	<term><option>--usage</option></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
343
	<listitem>
344
	  <para>
142 by Teddy Hogeborn
* plugins.d/password-request.c (main): Change default GnuTLS priority
345
	    Gives a short usage message.
24.1.23 by Björn Påhlsson
Added manual pages for:
346
	  </para>
347
	</listitem>
348
      </varlistentry>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
349
      
24.1.23 by Björn Påhlsson
Added manual pages for:
350
      <varlistentry>
127 by Teddy Hogeborn
* plugins.d/password-request.xml (OPTIONS): Make replaceables match
351
	<term><option>--version</option></term>
352
	<term><option>-V</option></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
353
	<listitem>
354
	  <para>
142 by Teddy Hogeborn
* plugins.d/password-request.c (main): Change default GnuTLS priority
355
	    Prints the program version.
24.1.23 by Björn Påhlsson
Added manual pages for:
356
	  </para>
357
	</listitem>
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
358
      </varlistentry>
24.1.23 by Björn Påhlsson
Added manual pages for:
359
    </variablelist>
360
  </refsect1>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
361
  
143 by Teddy Hogeborn
* Makefile (mandos.8): Add dependency on "overview.xml" and
362
  <refsect1 id="overview">
363
    <title>OVERVIEW</title>
364
    <xi:include href="../overview.xml"/>
365
    <para>
366
      This program is the client part.  It is a plugin started by
367
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
368
      <manvolnum>8mandos</manvolnum></citerefentry> which will run in
369
      an initial <acronym>RAM</acronym> disk environment.
370
    </para>
371
    <para>
372
      This program could, theoretically, be used as a keyscript in
373
      <filename>/etc/crypttab</filename>, but it would then be
144 by Teddy Hogeborn
* plugins.d/password-request.xml (OVERVIEW): Improved wording.
374
      impossible to enter a password for the encrypted root disk at
375
      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
376
      at all.  This is why a separate plugin runner (<citerefentry>
377
      <refentrytitle>plugin-runner</refentrytitle>
378
      <manvolnum>8mandos</manvolnum></citerefentry>) is used to run
379
      both this program and others in in parallel,
380
      <emphasis>one</emphasis> of which will prompt for passwords on
381
      the system console.
143 by Teddy Hogeborn
* Makefile (mandos.8): Add dependency on "overview.xml" and
382
    </para>
383
  </refsect1>
384
  
24.1.55 by Björn Påhlsson
updated some partial manual pages
385
  <refsect1 id="exit_status">
386
    <title>EXIT STATUS</title>
387
    <para>
142 by Teddy Hogeborn
* plugins.d/password-request.c (main): Change default GnuTLS priority
388
      This program will exit with a successful (zero) exit status if a
389
      server could be found and the password received from it could be
390
      successfully decrypted and output on standard output.  The
391
      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.
392
      error occurs.  Otherwise, it will forever connect to any
393
      discovered <application>Mandos</application> servers, trying to
394
      get a decryptable password and print it.
142 by Teddy Hogeborn
* plugins.d/password-request.c (main): Change default GnuTLS priority
395
    </para>
396
  </refsect1>
397
  
143 by Teddy Hogeborn
* Makefile (mandos.8): Add dependency on "overview.xml" and
398
  <refsect1 id="environment">
399
    <title>ENVIRONMENT</title>
400
    <para>
401
      This program does not use any environment variables, not even
402
      the ones provided by <citerefentry><refentrytitle
403
      >cryptsetup</refentrytitle><manvolnum>8</manvolnum>
404
    </citerefentry>.
405
    </para>
406
  </refsect1>
142 by Teddy Hogeborn
* plugins.d/password-request.c (main): Change default GnuTLS priority
407
  
224 by Teddy Hogeborn
* mandos-keygen.xml (FILES): Fixed id to be "files", not "file".
408
  <refsect1 id="files">
24.1.55 by Björn Påhlsson
updated some partial manual pages
409
    <title>FILES</title>
146 by Teddy Hogeborn
* plugins.d/password-request.xml (OPTIONS): Improved wording.
410
    <variablelist>
411
      <varlistentry>
412
	<term><filename>/conf/conf.d/mandos/pubkey.txt</filename
413
	></term>
414
	<term><filename>/conf/conf.d/mandos/seckey.txt</filename
415
	></term>
416
	<listitem>
417
	  <para>
418
	    OpenPGP public and private key files, in <quote>ASCII
419
	    Armor</quote> format.  These are the default file names,
420
	    they can be changed with the <option>--pubkey</option> and
421
	    <option>--seckey</option> options.
422
	  </para>
423
	</listitem>
424
      </varlistentry>
425
    </variablelist>
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
426
  </refsect1>
24.1.55 by Björn Påhlsson
updated some partial manual pages
427
  
146 by Teddy Hogeborn
* plugins.d/password-request.xml (OPTIONS): Improved wording.
428
<!--   <refsect1 id="bugs"> -->
429
<!--     <title>BUGS</title> -->
430
<!--     <para> -->
431
<!--     </para> -->
432
<!--   </refsect1> -->
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
433
  
87 by Teddy Hogeborn
* Makefile: Bug fix: fixed creation of man pages in "plugins.d".
434
  <refsect1 id="example">
435
    <title>EXAMPLE</title>
24.1.55 by Björn Påhlsson
updated some partial manual pages
436
    <para>
146 by Teddy Hogeborn
* plugins.d/password-request.xml (OPTIONS): Improved wording.
437
      Note that normally, command line options will not be given
438
      directly, but via options for the Mandos <citerefentry
439
      ><refentrytitle>plugin-runner</refentrytitle>
440
      <manvolnum>8mandos</manvolnum></citerefentry>.
24.1.55 by Björn Påhlsson
updated some partial manual pages
441
    </para>
146 by Teddy Hogeborn
* plugins.d/password-request.xml (OPTIONS): Improved wording.
442
    <informalexample>
443
      <para>
444
	Normal invocation needs no options, if the network interface
445
	is <quote>eth0</quote>:
446
      </para>
447
      <para>
448
	<userinput>&COMMANDNAME;</userinput>
449
      </para>
450
    </informalexample>
451
    <informalexample>
452
      <para>
158 by Teddy Hogeborn
* plugins.d/password-request.xml (EXAMPLE): Improved wording.
453
	Search for Mandos servers (and connect to them) using another
454
	interface:
146 by Teddy Hogeborn
* plugins.d/password-request.xml (OPTIONS): Improved wording.
455
      </para>
456
      <para>
457
	<!-- do not wrap this line -->
458
	<userinput>&COMMANDNAME; --interface eth1</userinput>
459
      </para>
460
    </informalexample>
461
    <informalexample>
462
      <para>
151 by Teddy Hogeborn
* plugins.d/password-request.xml (SYNOPSYS): Removed "--keydir".
463
	Run in debug mode, and use a custom key:
146 by Teddy Hogeborn
* plugins.d/password-request.xml (OPTIONS): Improved wording.
464
      </para>
465
      <para>
151 by Teddy Hogeborn
* plugins.d/password-request.xml (SYNOPSYS): Removed "--keydir".
466
467
<!-- do not wrap this line -->
468
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt</userinput>
469
146 by Teddy Hogeborn
* plugins.d/password-request.xml (OPTIONS): Improved wording.
470
      </para>
471
    </informalexample>
472
    <informalexample>
473
      <para>
151 by Teddy Hogeborn
* plugins.d/password-request.xml (SYNOPSYS): Removed "--keydir".
474
	Run in debug mode, with a custom key, and do not use Zeroconf
237.2.67 by Teddy Hogeborn
Four new interrelated features:
475
	to locate a server; connect directly to the IPv6 link-local
476
	address <quote><systemitem class="ipaddress"
477
	>fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
478
	using interface eth2:
146 by Teddy Hogeborn
* plugins.d/password-request.xml (OPTIONS): Improved wording.
479
      </para>
480
      <para>
481
482
<!-- do not wrap this line -->
237.2.67 by Teddy Hogeborn
Four new interrelated features:
483
<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.
484
485
      </para>
486
    </informalexample>
24.1.55 by Björn Påhlsson
updated some partial manual pages
487
  </refsect1>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
488
  
24.1.55 by Björn Påhlsson
updated some partial manual pages
489
  <refsect1 id="security">
490
    <title>SECURITY</title>
491
    <para>
147 by Teddy Hogeborn
* plugins.d/password-request.c (init_gnutls_global): Improved wording
492
      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
493
      original (and presumably non-privileged) user and group after
494
      bringing up the network interface.
147 by Teddy Hogeborn
* plugins.d/password-request.c (init_gnutls_global): Improved wording
495
    </para>
496
    <para>
497
      To use this program for its intended purpose (see <xref
498
      linkend="purpose"/>), the password for the root file system will
499
      have to be given out to be stored in a server computer, after
500
      having been encrypted using an OpenPGP key.  This encrypted data
501
      which will be stored in a server can only be decrypted by the
502
      OpenPGP key, and the data will only be given out to those
503
      clients who can prove they actually have that key.  This key,
504
      however, is stored unencrypted on the client side in its initial
505
      <acronym>RAM</acronym> disk image file system.  This is normally
506
      readable by all, but this is normally fixed during installation
507
      of this program; file permissions are set so that no-one is able
508
      to read that file.
509
    </para>
510
    <para>
511
      The only remaining weak point is that someone with physical
512
      access to the client hard drive might turn off the client
513
      computer, read the OpenPGP keys directly from the hard drive,
216 by Teddy Hogeborn
* Makefile: Add HTML rules for manual pages.
514
      and communicate with the server.  To safeguard against this, the
515
      server is supposed to notice the client disappearing and stop
516
      giving out the encrypted data.  Therefore, it is important to
517
      set the timeout and checker interval values tightly on the
518
      server.  See <citerefentry><refentrytitle
147 by Teddy Hogeborn
* plugins.d/password-request.c (init_gnutls_global): Improved wording
519
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
520
    </para>
521
    <para>
148 by Teddy Hogeborn
* plugins.d/password-request.xml (OVERVIEW): Refer to
522
      It will also help if the checker program on the server is
523
      configured to request something from the client which can not be
524
      spoofed by someone else on the network, unlike unencrypted
525
      <acronym>ICMP</acronym> echo (<quote>ping</quote>) replies.
526
    </para>
527
    <para>
528
      <emphasis>Note</emphasis>: This makes it completely insecure to
529
      have <application >Mandos</application> clients which dual-boot
530
      to another operating system which is <emphasis>not</emphasis>
531
      trusted to keep the initial <acronym>RAM</acronym> disk image
532
      confidential.
24.1.55 by Björn Påhlsson
updated some partial manual pages
533
    </para>
534
  </refsect1>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
535
  
24.1.55 by Björn Påhlsson
updated some partial manual pages
536
  <refsect1 id="see_also">
537
    <title>SEE ALSO</title>
114 by Teddy Hogeborn
* mandos-clients.conf.xml (SEE ALSO): Alphabetized, as per
538
    <para>
237.7.41 by Teddy Hogeborn
* Makefile (DOCS): Added "intro.8mandos".
539
      <citerefentry><refentrytitle>intro</refentrytitle>
540
      <manvolnum>8mandos</manvolnum></citerefentry>,
148 by Teddy Hogeborn
* plugins.d/password-request.xml (OVERVIEW): Refer to
541
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
542
      <manvolnum>8</manvolnum></citerefentry>,
543
      <citerefentry><refentrytitle>crypttab</refentrytitle>
544
      <manvolnum>5</manvolnum></citerefentry>,
114 by Teddy Hogeborn
* mandos-clients.conf.xml (SEE ALSO): Alphabetized, as per
545
      <citerefentry><refentrytitle>mandos</refentrytitle>
546
      <manvolnum>8</manvolnum></citerefentry>,
547
      <citerefentry><refentrytitle>password-prompt</refentrytitle>
548
      <manvolnum>8mandos</manvolnum></citerefentry>,
549
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
550
      <manvolnum>8mandos</manvolnum></citerefentry>
551
    </para>
148 by Teddy Hogeborn
* plugins.d/password-request.xml (OVERVIEW): Refer to
552
    <variablelist>
553
      <varlistentry>
554
	<term>
555
	  <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
556
	</term>
557
	<listitem>
558
	  <para>
559
	    Zeroconf is the network protocol standard used for finding
560
	    Mandos servers on the local network.
561
	  </para>
562
	</listitem>
563
      </varlistentry>
564
      <varlistentry>
565
	<term>
566
	  <ulink url="http://www.avahi.org/">Avahi</ulink>
567
	</term>
568
      <listitem>
569
	<para>
570
	  Avahi is the library this program calls to find Zeroconf
571
	  services.
572
	</para>
573
      </listitem>
574
      </varlistentry>
575
      <varlistentry>
576
	<term>
577
	  <ulink url="http://www.gnu.org/software/gnutls/"
578
	  >GnuTLS</ulink>
579
	</term>
580
      <listitem>
581
	<para>
582
	  GnuTLS is the library this client uses to implement TLS for
583
	  communicating securely with the server, and at the same time
584
	  send the public OpenPGP key to the server.
585
	</para>
586
      </listitem>
587
      </varlistentry>
588
      <varlistentry>
589
	<term>
590
	  <ulink url="http://www.gnupg.org/related_software/gpgme/"
591
		 >GPGME</ulink>
592
	</term>
593
	<listitem>
594
	  <para>
595
	    GPGME is the library used to decrypt the OpenPGP data sent
596
	    by the server.
597
	  </para>
598
	</listitem>
599
      </varlistentry>
600
      <varlistentry>
601
	<term>
602
	  RFC 4291: <citetitle>IP Version 6 Addressing
603
	  Architecture</citetitle>
604
	</term>
605
	<listitem>
606
	  <variablelist>
607
	    <varlistentry>
608
	      <term>Section 2.2: <citetitle>Text Representation of
609
	      Addresses</citetitle></term>
610
	      <listitem><para/></listitem>
611
	    </varlistentry>
612
	    <varlistentry>
613
	      <term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
614
	      Address</citetitle></term>
615
	      <listitem><para/></listitem>
616
	    </varlistentry>
617
	    <varlistentry>
618
	    <term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
619
	    Addresses</citetitle></term>
620
	    <listitem>
621
	      <para>
622
		This client uses IPv6 link-local addresses, which are
623
		immediately usable since a link-local addresses is
624
		automatically assigned to a network interfaces when it
625
		is brought up.
626
	      </para>
627
	    </listitem>
628
	    </varlistentry>
629
	  </variablelist>
630
	</listitem>
631
      </varlistentry>
632
      <varlistentry>
633
	<term>
634
	  RFC 4346: <citetitle>The Transport Layer Security (TLS)
635
	  Protocol Version 1.1</citetitle>
636
	</term>
637
      <listitem>
638
	<para>
639
	  TLS 1.1 is the protocol implemented by GnuTLS.
640
	</para>
641
      </listitem>
642
      </varlistentry>
643
      <varlistentry>
644
	<term>
645
	  RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
646
	</term>
647
      <listitem>
648
	<para>
649
	  The data received from the server is binary encrypted
650
	  OpenPGP data.
651
	</para>
652
      </listitem>
653
      </varlistentry>
654
      <varlistentry>
655
	<term>
656
	  RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
657
	  Security</citetitle>
658
	</term>
659
      <listitem>
660
	<para>
661
	  This is implemented by GnuTLS and used by this program so
662
	  that OpenPGP keys can be used.
663
	</para>
664
      </listitem>
665
      </varlistentry>
666
    </variablelist>
81 by Teddy Hogeborn
* Makefile (GNUTLS_CFLAGS, GNUTLS_LIBS, AVAHI_CFLAGS, AVAHI_LIBS,
667
  </refsect1>
24.1.23 by Björn Påhlsson
Added manual pages for:
668
</refentry>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
669
111 by Teddy Hogeborn
* mandos-clients.conf.xml (ENTITY TIMESTAMP): New. Automatically
670
<!-- Local Variables: -->
671
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
672
<!-- time-stamp-end: "[\"']>" -->
673
<!-- time-stamp-format: "%:y-%02m-%02d" -->
674
<!-- End: -->