/mandos/trunk

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/trunk
84 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Use the local manpages/docbook.xsl file, do
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"
84 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Use the local manpages/docbook.xsl file, do
3
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
24.1.23 by Björn Påhlsson
Added manual pages for:
4
<!ENTITY VERSION "1.0">
5
<!ENTITY COMMANDNAME "mandos">
122 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Put long options before short.
6
<!ENTITY TIMESTAMP "2008-08-31">
24.1.23 by Björn Påhlsson
Added manual pages for:
7
]>
8
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
24.1.23 by Björn Påhlsson
Added manual pages for:
10
  <refentryinfo>
112 by Teddy Hogeborn
* mandos-clients.conf.xml (/refentry/refentryinfo/title): Changed to
11
    <title>Mandos Manual</title>
84 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Use the local manpages/docbook.xsl file, do
12
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
112 by Teddy Hogeborn
* mandos-clients.conf.xml (/refentry/refentryinfo/title): Changed to
13
    <productname>Mandos</productname>
24.1.23 by Björn Påhlsson
Added manual pages for:
14
    <productnumber>&VERSION;</productnumber>
111 by Teddy Hogeborn
* mandos-clients.conf.xml (ENTITY TIMESTAMP): New. Automatically
15
    <date>&TIMESTAMP;</date>
24.1.23 by Björn Påhlsson
Added manual pages for:
16
    <authorgroup>
17
      <author>
18
	<firstname>Björn</firstname>
19
	<surname>Påhlsson</surname>
20
	<address>
21
	  <email>belorn@fukt.bsnet.se</email>
22
	</address>
23
      </author>
24
      <author>
25
	<firstname>Teddy</firstname>
26
	<surname>Hogeborn</surname>
27
	<address>
28
	  <email>teddy@fukt.bsnet.se</email>
29
	</address>
30
      </author>
31
    </authorgroup>
32
    <copyright>
33
      <year>2008</year>
81 by Teddy Hogeborn
* Makefile (GNUTLS_CFLAGS, GNUTLS_LIBS, AVAHI_CFLAGS, AVAHI_LIBS,
34
      <holder>Teddy Hogeborn</holder>
35
      <holder>Björn Påhlsson</holder>
24.1.23 by Björn Påhlsson
Added manual pages for:
36
    </copyright>
37
    <legalnotice>
38
      <para>
39
	This manual page is free software: you can redistribute it
40
	and/or modify it under the terms of the GNU General Public
41
	License as published by the Free Software Foundation,
42
	either version 3 of the License, or (at your option) any
43
	later version.
44
      </para>
45
46
      <para>
47
	This manual page is distributed in the hope that it will
48
	be useful, but WITHOUT ANY WARRANTY; without even the
49
	implied warranty of MERCHANTABILITY or FITNESS FOR A
50
	PARTICULAR PURPOSE.  See the GNU General Public License
51
	for more details.
52
      </para>
53
54
      <para>
55
	You should have received a copy of the GNU General Public
56
	License along with this program; If not, see
57
	<ulink url="http://www.gnu.org/licenses/"/>.
58
      </para>
59
    </legalnotice>
60
  </refentryinfo>
61
62
  <refmeta>
63
    <refentrytitle>&COMMANDNAME;</refentrytitle>
24.1.24 by Björn Påhlsson
minor edits
64
    <manvolnum>8</manvolnum>
24.1.23 by Björn Påhlsson
Added manual pages for:
65
  </refmeta>
66
  
67
  <refnamediv>
68
    <refname><command>&COMMANDNAME;</command></refname>
69
    <refpurpose>
116 by Teddy Hogeborn
* mandos-options.xml (priority): Added <acronym> tags.
70
      Gives encrypted passwords to authenticated Mandos clients
24.1.23 by Björn Påhlsson
Added manual pages for:
71
    </refpurpose>
72
  </refnamediv>
73
74
  <refsynopsisdiv>
75
    <cmdsynopsis>
76
      <command>&COMMANDNAME;</command>
120 by Teddy Hogeborn
* mandos.xml (SYNOPSIS): Use <option> and <replaceable> tags. Unify
77
      <group>
78
	<arg choice="plain"><option>--interface
79
	<replaceable>NAME</replaceable></option></arg>
80
	<arg choice="plain"><option>-i
81
	<replaceable>NAME</replaceable></option></arg>
82
      </group>
83
      <sbr/>
84
      <group>
85
	<arg choice="plain"><option>--address
86
	<replaceable>ADDRESS</replaceable></option></arg>
87
	<arg choice="plain"><option>-a
88
	<replaceable>ADDRESS</replaceable></option></arg>
89
      </group>
90
      <sbr/>
91
      <group>
92
	<arg choice="plain"><option>--port
93
	<replaceable>PORT</replaceable></option></arg>
94
	<arg choice="plain"><option>-p
95
	<replaceable>PORT</replaceable></option></arg>
96
      </group>
97
      <sbr/>
98
      <arg><option>--priority
99
      <replaceable>PRIORITY</replaceable></option></arg>
100
      <sbr/>
101
      <arg><option>--servicename
102
      <replaceable>NAME</replaceable></option></arg>
103
      <sbr/>
104
      <arg><option>--configdir
105
      <replaceable>DIRECTORY</replaceable></option></arg>
106
      <sbr/>
107
      <arg><option>--debug</option></arg>
85 by Teddy Hogeborn
* mandos.xml (SYNOPSIS): Removed unnecessary 'choice="opt"' from <arg>
108
    </cmdsynopsis>
109
    <cmdsynopsis>
110
      <command>&COMMANDNAME;</command>
111
      <group choice="req">
122 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Put long options before short.
112
	<arg choice="plain"><option>--help</option></arg>
120 by Teddy Hogeborn
* mandos.xml (SYNOPSIS): Use <option> and <replaceable> tags. Unify
113
	<arg choice="plain"><option>-h</option></arg>
85 by Teddy Hogeborn
* mandos.xml (SYNOPSIS): Removed unnecessary 'choice="opt"' from <arg>
114
      </group>
84 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Use the local manpages/docbook.xsl file, do
115
    </cmdsynopsis>
116
    <cmdsynopsis>
117
      <command>&COMMANDNAME;</command>
120 by Teddy Hogeborn
* mandos.xml (SYNOPSIS): Use <option> and <replaceable> tags. Unify
118
      <arg choice="plain"><option>--version</option></arg>
84 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Use the local manpages/docbook.xsl file, do
119
    </cmdsynopsis>
120
    <cmdsynopsis>
121
      <command>&COMMANDNAME;</command>
120 by Teddy Hogeborn
* mandos.xml (SYNOPSIS): Use <option> and <replaceable> tags. Unify
122
      <arg choice="plain"><option>--check</option></arg>
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
123
    </cmdsynopsis>
24.1.23 by Björn Påhlsson
Added manual pages for:
124
  </refsynopsisdiv>
125
126
  <refsect1 id="description">
127
    <title>DESCRIPTION</title>
128
    <para>
81 by Teddy Hogeborn
* Makefile (GNUTLS_CFLAGS, GNUTLS_LIBS, AVAHI_CFLAGS, AVAHI_LIBS,
129
      <command>&COMMANDNAME;</command> is a server daemon which
130
      handles incoming request for passwords for a pre-defined list of
131
      client host computers.  The Mandos server uses Zeroconf to
84 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Use the local manpages/docbook.xsl file, do
132
      announce itself on the local network, and uses TLS to
133
      communicate securely with and to authenticate the clients.  The
134
      Mandos server uses IPv6 to allow Mandos clients to use IPv6
135
      link-local addresses, since the clients will probably not have
136
      any other addresses configured (see <xref linkend="overview"/>).
137
      Any authenticated client is then given the stored pre-encrypted
138
      password for that specific client.
81 by Teddy Hogeborn
* Makefile (GNUTLS_CFLAGS, GNUTLS_LIBS, AVAHI_CFLAGS, AVAHI_LIBS,
139
    </para>
140
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
141
  </refsect1>
81 by Teddy Hogeborn
* Makefile (GNUTLS_CFLAGS, GNUTLS_LIBS, AVAHI_CFLAGS, AVAHI_LIBS,
142
  
143
  <refsect1 id="purpose">
144
    <title>PURPOSE</title>
145
146
    <para>
147
      The purpose of this is to enable <emphasis>remote and unattended
84 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Use the local manpages/docbook.xsl file, do
148
      rebooting</emphasis> of client host computer with an
149
      <emphasis>encrypted root file system</emphasis>.  See <xref
150
      linkend="overview"/> for details.
81 by Teddy Hogeborn
* Makefile (GNUTLS_CFLAGS, GNUTLS_LIBS, AVAHI_CFLAGS, AVAHI_LIBS,
151
    </para>
124 by Teddy Hogeborn
* mandos.xml (OPTIONS): Moved long options before short. Use <option>
152
    
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
153
  </refsect1>
24.1.55 by Björn Påhlsson
updated some partial manual pages
154
  
155
  <refsect1 id="options">
156
    <title>OPTIONS</title>
124 by Teddy Hogeborn
* mandos.xml (OPTIONS): Moved long options before short. Use <option>
157
    
24.1.23 by Björn Påhlsson
Added manual pages for:
158
    <variablelist>
159
      <varlistentry>
124 by Teddy Hogeborn
* mandos.xml (OPTIONS): Moved long options before short. Use <option>
160
	<term><option>--help</option></term>
115 by Teddy Hogeborn
* mandos.xml (SYNOPSIS): Split <term> tags for the "--help" and
161
	<term><option>-h</option></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
162
	<listitem>
163
	  <para>
81 by Teddy Hogeborn
* Makefile (GNUTLS_CFLAGS, GNUTLS_LIBS, AVAHI_CFLAGS, AVAHI_LIBS,
164
	    Show a help message and exit
24.1.23 by Björn Påhlsson
Added manual pages for:
165
	  </para>
166
	</listitem>
167
      </varlistentry>
124 by Teddy Hogeborn
* mandos.xml (OPTIONS): Moved long options before short. Use <option>
168
      
24.1.23 by Björn Påhlsson
Added manual pages for:
169
      <varlistentry>
124 by Teddy Hogeborn
* mandos.xml (OPTIONS): Moved long options before short. Use <option>
170
	<term><option>--interface</option>
171
	<replaceable>NAME</replaceable></term>
115 by Teddy Hogeborn
* mandos.xml (SYNOPSIS): Split <term> tags for the "--help" and
172
	<term><option>-i</option>
173
	<replaceable>NAME</replaceable></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
174
	<listitem>
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
175
	  <xi:include href="mandos-options.xml" xpointer="interface"/>
24.1.23 by Björn Påhlsson
Added manual pages for:
176
	</listitem>
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
177
      </varlistentry>
124 by Teddy Hogeborn
* mandos.xml (OPTIONS): Moved long options before short. Use <option>
178
      
24.1.23 by Björn Påhlsson
Added manual pages for:
179
      <varlistentry>
124 by Teddy Hogeborn
* mandos.xml (OPTIONS): Moved long options before short. Use <option>
180
	<term><option>--address
181
	<replaceable>ADDRESS</replaceable></option></term>
182
	<term><option>-a
183
	<replaceable>ADDRESS</replaceable></option></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
184
	<listitem>
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
185
	  <xi:include href="mandos-options.xml" xpointer="address"/>
24.1.23 by Björn Påhlsson
Added manual pages for:
186
	</listitem>
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
187
      </varlistentry>
124 by Teddy Hogeborn
* mandos.xml (OPTIONS): Moved long options before short. Use <option>
188
      
24.1.23 by Björn Påhlsson
Added manual pages for:
189
      <varlistentry>
124 by Teddy Hogeborn
* mandos.xml (OPTIONS): Moved long options before short. Use <option>
190
	<term><option>--port
191
	<replaceable>PORT</replaceable></option></term>
192
	<term><option>-p
193
	<replaceable>PORT</replaceable></option></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
194
	<listitem>
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
195
	  <xi:include href="mandos-options.xml" xpointer="port"/>
24.1.23 by Björn Påhlsson
Added manual pages for:
196
	</listitem>
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
197
      </varlistentry>
124 by Teddy Hogeborn
* mandos.xml (OPTIONS): Moved long options before short. Use <option>
198
      
24.1.23 by Björn Påhlsson
Added manual pages for:
199
      <varlistentry>
124 by Teddy Hogeborn
* mandos.xml (OPTIONS): Moved long options before short. Use <option>
200
	<term><option>--check</option></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
201
	<listitem>
202
	  <para>
84 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Use the local manpages/docbook.xsl file, do
203
	    Run the server’s self-tests.  This includes any unit
81 by Teddy Hogeborn
* Makefile (GNUTLS_CFLAGS, GNUTLS_LIBS, AVAHI_CFLAGS, AVAHI_LIBS,
204
	    tests, etc.
24.1.23 by Björn Påhlsson
Added manual pages for:
205
	  </para>
206
	</listitem>
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
207
      </varlistentry>
124 by Teddy Hogeborn
* mandos.xml (OPTIONS): Moved long options before short. Use <option>
208
      
24.1.23 by Björn Påhlsson
Added manual pages for:
209
      <varlistentry>
124 by Teddy Hogeborn
* mandos.xml (OPTIONS): Moved long options before short. Use <option>
210
	<term><option>--debug</option></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
211
	<listitem>
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
212
	  <xi:include href="mandos-options.xml" xpointer="debug"/>
24.1.23 by Björn Påhlsson
Added manual pages for:
213
	</listitem>
214
      </varlistentry>
215
216
      <varlistentry>
124 by Teddy Hogeborn
* mandos.xml (OPTIONS): Moved long options before short. Use <option>
217
	<term><option>--priority <replaceable>
218
	PRIORITY</replaceable></option></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
219
	<listitem>
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
220
	  <xi:include href="mandos-options.xml" xpointer="priority"/>
24.1.23 by Björn Påhlsson
Added manual pages for:
221
	</listitem>
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
222
      </varlistentry>
24.1.23 by Björn Påhlsson
Added manual pages for:
223
224
      <varlistentry>
124 by Teddy Hogeborn
* mandos.xml (OPTIONS): Moved long options before short. Use <option>
225
	<term><option>--servicename
226
	<replaceable>NAME</replaceable></option></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
227
	<listitem>
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
228
	  <xi:include href="mandos-options.xml"
229
		      xpointer="servicename"/>
24.1.23 by Björn Påhlsson
Added manual pages for:
230
	</listitem>
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
231
      </varlistentry>
24.1.23 by Björn Påhlsson
Added manual pages for:
232
233
      <varlistentry>
124 by Teddy Hogeborn
* mandos.xml (OPTIONS): Moved long options before short. Use <option>
234
	<term><option>--configdir
235
	<replaceable>DIRECTORY</replaceable></option></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
236
	<listitem>
237
	  <para>
81 by Teddy Hogeborn
* Makefile (GNUTLS_CFLAGS, GNUTLS_LIBS, AVAHI_CFLAGS, AVAHI_LIBS,
238
	    Directory to search for configuration files.  Default is
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
239
	    <quote><literal>/etc/mandos</literal></quote>.  See
240
	    <citerefentry><refentrytitle>mandos.conf</refentrytitle>
81 by Teddy Hogeborn
* Makefile (GNUTLS_CFLAGS, GNUTLS_LIBS, AVAHI_CFLAGS, AVAHI_LIBS,
241
	    <manvolnum>5</manvolnum></citerefentry> and <citerefentry>
242
	    <refentrytitle>mandos-clients.conf</refentrytitle>
243
	    <manvolnum>5</manvolnum></citerefentry>.
24.1.23 by Björn Påhlsson
Added manual pages for:
244
	  </para>
245
	</listitem>
246
      </varlistentry>
24.1.35 by Björn Påhlsson
version 1.0
247
248
      <varlistentry>
124 by Teddy Hogeborn
* mandos.xml (OPTIONS): Moved long options before short. Use <option>
249
	<term><option>--version</option></term>
24.1.35 by Björn Påhlsson
version 1.0
250
	<listitem>
251
	  <para>
81 by Teddy Hogeborn
* Makefile (GNUTLS_CFLAGS, GNUTLS_LIBS, AVAHI_CFLAGS, AVAHI_LIBS,
252
	    Prints the program version and exit.
24.1.35 by Björn Påhlsson
version 1.0
253
	  </para>
254
	</listitem>
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
255
      </varlistentry>
24.1.23 by Björn Påhlsson
Added manual pages for:
256
    </variablelist>
257
  </refsect1>
24.1.55 by Björn Påhlsson
updated some partial manual pages
258
84 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Use the local manpages/docbook.xsl file, do
259
  <refsect1 id="overview">
260
    <title>OVERVIEW</title>
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
261
    <xi:include href="overview.xml"/>
84 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Use the local manpages/docbook.xsl file, do
262
    <para>
263
      This program is the server part.  It is a normal server program
264
      and will run in a normal system environment, not in an initial
265
      RAM disk environment.
266
    </para>
267
  </refsect1>
268
81 by Teddy Hogeborn
* Makefile (GNUTLS_CFLAGS, GNUTLS_LIBS, AVAHI_CFLAGS, AVAHI_LIBS,
269
  <refsect1 id="protocol">
270
    <title>NETWORK PROTOCOL</title>
271
    <para>
272
      The Mandos server announces itself as a Zeroconf service of type
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
273
      <quote><literal>_mandos._tcp</literal></quote>.  The Mandos
274
      client connects to the announced address and port, and sends a
275
      line of text where the first whitespace-separated field is the
276
      protocol version, which currently is
277
      <quote><literal>1</literal></quote>.  The client and server then
278
      start a TLS protocol handshake with a slight quirk: the Mandos
279
      server program acts as a TLS <quote>client</quote> while the
280
      connecting Mandos client acts as a TLS <quote>server</quote>.
281
      The Mandos client must supply an OpenPGP certificate, and the
282
      fingerprint of this certificate is used by the Mandos server to
283
      look up (in a list read from <filename>clients.conf</filename>
284
      at start time) which binary blob to give the client.  No other
285
      authentication or authorization is done by the server.
81 by Teddy Hogeborn
* Makefile (GNUTLS_CFLAGS, GNUTLS_LIBS, AVAHI_CFLAGS, AVAHI_LIBS,
286
    </para>
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
287
    <table>
288
      <title>Mandos Protocol (Version 1)</title><tgroup cols="3"><thead>
81 by Teddy Hogeborn
* Makefile (GNUTLS_CFLAGS, GNUTLS_LIBS, AVAHI_CFLAGS, AVAHI_LIBS,
289
      <row>
290
	<entry>Mandos Client</entry>
291
	<entry>Direction</entry>
292
	<entry>Mandos Server</entry>
293
      </row>
294
      </thead><tbody>
295
      <row>
296
	<entry>Connect</entry>
297
	<entry>-><!-- &rarr; --></entry>
298
      </row>
299
      <row>
91 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Include all DocBook-to-manpage-related
300
	<entry><quote><literal>1\r\n</literal></quote></entry>
81 by Teddy Hogeborn
* Makefile (GNUTLS_CFLAGS, GNUTLS_LIBS, AVAHI_CFLAGS, AVAHI_LIBS,
301
	<entry>-><!-- &rarr; --></entry>
302
      </row>
303
      <row>
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
304
	<entry>TLS handshake <emphasis>as TLS <quote>server</quote>
305
	</emphasis></entry>
81 by Teddy Hogeborn
* Makefile (GNUTLS_CFLAGS, GNUTLS_LIBS, AVAHI_CFLAGS, AVAHI_LIBS,
306
	<entry>&lt;-><!-- &xharr; --></entry>
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
307
	<entry>TLS handshake <emphasis>as TLS <quote>client</quote>
308
	</emphasis></entry>
81 by Teddy Hogeborn
* Makefile (GNUTLS_CFLAGS, GNUTLS_LIBS, AVAHI_CFLAGS, AVAHI_LIBS,
309
      </row>
310
      <row>
311
	<entry>OpenPGP public key (part of TLS handshake)</entry>
312
	<entry>-><!-- &rarr; --></entry>
313
      </row>
314
      <row>
315
	<entry/>
316
	<entry>&lt;-<!-- &larr; --></entry>
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
317
	<entry>Binary blob (client will assume OpenPGP data)</entry>
81 by Teddy Hogeborn
* Makefile (GNUTLS_CFLAGS, GNUTLS_LIBS, AVAHI_CFLAGS, AVAHI_LIBS,
318
      </row>
319
      <row>
320
	<entry/>
321
	<entry>&lt;-<!-- &larr; --></entry>
322
	<entry>Close</entry>
323
      </row>
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
324
    </tbody></tgroup></table>
325
  </refsect1>
326
327
  <refsect1 id="checking">
328
    <title>CHECKING</title>
329
    <para>
330
      The server will, by default, continually check that the clients
331
      are still up.  If a client has not been confirmed as being up
332
      for some time, the client is assumed to be compromised and is no
333
      longer eligible to receive the encrypted password.  The timeout,
84 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Use the local manpages/docbook.xsl file, do
334
      checker program, and interval between checks can be configured
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
335
      both globally and per client; see <citerefentry>
336
      <refentrytitle>mandos-clients.conf</refentrytitle>
337
      <manvolnum>5</manvolnum></citerefentry>.
338
    </para>
81 by Teddy Hogeborn
* Makefile (GNUTLS_CFLAGS, GNUTLS_LIBS, AVAHI_CFLAGS, AVAHI_LIBS,
339
  </refsect1>
340
341
  <refsect1 id="logging">
342
    <title>LOGGING</title>
343
    <para>
91 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Include all DocBook-to-manpage-related
344
      The server will send log message with various severity levels to
345
      <filename>/dev/log</filename>.  With the
81 by Teddy Hogeborn
* Makefile (GNUTLS_CFLAGS, GNUTLS_LIBS, AVAHI_CFLAGS, AVAHI_LIBS,
346
      <option>--debug</option> option, it will log even more messages,
347
      and also show them on the console.
348
    </para>
349
  </refsect1>
350
24.1.55 by Björn Påhlsson
updated some partial manual pages
351
  <refsect1 id="exit_status">
352
    <title>EXIT STATUS</title>
353
    <para>
81 by Teddy Hogeborn
* Makefile (GNUTLS_CFLAGS, GNUTLS_LIBS, AVAHI_CFLAGS, AVAHI_LIBS,
354
      The server will exit with a non-zero exit status only when a
355
      critical error is encountered.
24.1.55 by Björn Påhlsson
updated some partial manual pages
356
    </para>
357
  </refsect1>
358
85 by Teddy Hogeborn
* mandos.xml (SYNOPSIS): Removed unnecessary 'choice="opt"' from <arg>
359
  <refsect1 id="environment">
360
    <title>ENVIRONMENT</title>
361
    <variablelist>
362
      <varlistentry>
117 by Teddy Hogeborn
* mandos-keygen.xml (ENVIRONMENT): Replaced <varname> with <envar>.
363
	<term><envar>PATH</envar></term>
85 by Teddy Hogeborn
* mandos.xml (SYNOPSIS): Removed unnecessary 'choice="opt"' from <arg>
364
	<listitem>
365
	  <para>
366
	    To start the configured checker (see <xref
367
	    linkend="checking"/>), the server uses
368
	    <filename>/bin/sh</filename>, which in turn uses
369
	    <varname>PATH</varname> to search for matching commands if
370
	    an absolute path is not given.  See <citerefentry>
371
	    <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
91 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Include all DocBook-to-manpage-related
372
	    </citerefentry>.
85 by Teddy Hogeborn
* mandos.xml (SYNOPSIS): Removed unnecessary 'choice="opt"' from <arg>
373
	  </para>
374
	</listitem>
375
      </varlistentry>
376
    </variablelist>
377
  </refsect1>
378
24.1.55 by Björn Påhlsson
updated some partial manual pages
379
  <refsect1 id="file">
380
    <title>FILES</title>
381
    <para>
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
382
      Use the <option>--configdir</option> option to change where
383
      <command>&COMMANDNAME;</command> looks for its configurations
384
      files.  The default file names are listed here.
24.1.55 by Björn Påhlsson
updated some partial manual pages
385
    </para>
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
386
    <variablelist>
387
      <varlistentry>
388
	<term><filename>/etc/mandos/mandos.conf</filename></term>
389
	<listitem>
390
	  <para>
391
	    Server-global settings.  See
392
	    <citerefentry><refentrytitle>mandos.conf</refentrytitle>
393
	    <manvolnum>5</manvolnum></citerefentry> for details.
394
	  </para>
395
	</listitem>
396
      </varlistentry>
397
      <varlistentry>
398
	<term><filename>/etc/mandos/clients.conf</filename></term>
399
	<listitem>
400
	  <para>
401
	    List of clients and client-specific settings.  See
402
	    <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
403
	    <manvolnum>5</manvolnum></citerefentry> for details.
404
	  </para>
405
	</listitem>
406
      </varlistentry>
407
      <varlistentry>
408
	<term><filename>/var/run/mandos/mandos.pid</filename></term>
409
	<listitem>
410
	  <para>
411
	    The file containing the process id of
412
	    <command>&COMMANDNAME;</command>.
413
	  </para>
414
	</listitem>
415
      </varlistentry>
416
      <varlistentry>
417
	<term><filename>/dev/log</filename></term>
418
	<listitem>
419
	  <para>
420
	    The Unix domain socket to where local syslog messages are
421
	    sent.
422
	  </para>
423
	</listitem>
424
      </varlistentry>
85 by Teddy Hogeborn
* mandos.xml (SYNOPSIS): Removed unnecessary 'choice="opt"' from <arg>
425
      <varlistentry>
426
	<term><filename>/bin/sh</filename></term>
427
	<listitem>
428
	  <para>
429
	    This is used to start the configured checker command for
430
	    each client.  See <citerefentry>
431
	    <refentrytitle>mandos-clients.conf</refentrytitle>
432
	    <manvolnum>5</manvolnum></citerefentry> for details.
433
	  </para>
434
	</listitem>
435
      </varlistentry>
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
436
    </variablelist>
437
  </refsect1>
85 by Teddy Hogeborn
* mandos.xml (SYNOPSIS): Removed unnecessary 'choice="opt"' from <arg>
438
  
24.1.55 by Björn Påhlsson
updated some partial manual pages
439
  <refsect1 id="bugs">
440
    <title>BUGS</title>
441
    <para>
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
442
      This server might, on especially fatal errors, emit a Python
443
      backtrace.  This could be considered a feature.
24.1.55 by Björn Påhlsson
updated some partial manual pages
444
    </para>
85 by Teddy Hogeborn
* mandos.xml (SYNOPSIS): Removed unnecessary 'choice="opt"' from <arg>
445
    <para>
446
      Currently, if a client is declared <quote>invalid</quote> due to
447
      having timed out, the server does not record this fact onto
448
      permanent storage.  This has some security implications, see
449
      <xref linkend="CLIENTS"/>.
450
    </para>
451
    <para>
452
      There is currently no way of querying the server of the current
453
      status of clients, other than analyzing its <systemitem
454
      class="service">syslog</systemitem> output.
455
    </para>
456
    <para>
457
      There is no fine-grained control over logging and debug output.
458
    </para>
459
    <para>
460
      Debug mode is conflated with running in the foreground.
461
    </para>
462
    <para>
463
      The console log messages does not show a timestamp.
464
    </para>
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
465
  </refsect1>
85 by Teddy Hogeborn
* mandos.xml (SYNOPSIS): Removed unnecessary 'choice="opt"' from <arg>
466
  
467
  <refsect1 id="example">
468
    <title>EXAMPLE</title>
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
469
    <informalexample>
470
      <para>
471
	Normal invocation needs no options:
472
      </para>
473
      <para>
110 by Teddy Hogeborn
* mandos.xml (EXAMPLE): Replaced all occurences of command name with
474
	<userinput>&COMMANDNAME;</userinput>
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
475
      </para>
476
    </informalexample>
477
    <informalexample>
478
      <para>
84 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Use the local manpages/docbook.xsl file, do
479
	Run the server in debug mode, read configuration files from
480
	the <filename>~/mandos</filename> directory, and use the
481
	Zeroconf service name <quote>Test</quote> to not collide with
482
	any other official Mandos server on this host:
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
483
      </para>
484
      <para>
485
486
<!-- do not wrap this line -->
110 by Teddy Hogeborn
* mandos.xml (EXAMPLE): Replaced all occurences of command name with
487
<userinput>&COMMANDNAME; --debug --configdir ~/mandos --servicename Test</userinput>
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
488
489
      </para>
490
    </informalexample>
491
    <informalexample>
492
      <para>
493
	Run the server normally, but only listen to one interface and
494
	only on the link-local address on that interface:
495
      </para>
496
      <para>
497
498
<!-- do not wrap this line -->
110 by Teddy Hogeborn
* mandos.xml (EXAMPLE): Replaced all occurences of command name with
499
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
500
501
      </para>
502
    </informalexample>
24.1.55 by Björn Påhlsson
updated some partial manual pages
503
  </refsect1>
504
505
  <refsect1 id="security">
506
    <title>SECURITY</title>
85 by Teddy Hogeborn
* mandos.xml (SYNOPSIS): Removed unnecessary 'choice="opt"' from <arg>
507
    <refsect2 id="SERVER">
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
508
      <title>SERVER</title>
509
      <para>
85 by Teddy Hogeborn
* mandos.xml (SYNOPSIS): Removed unnecessary 'choice="opt"' from <arg>
510
	Running this <command>&COMMANDNAME;</command> server program
511
	should not in itself present any security risk to the host
512
	computer running it.  The program does not need any special
513
	privileges to run, and is designed to run as a non-root user.
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
514
      </para>
515
    </refsect2>
85 by Teddy Hogeborn
* mandos.xml (SYNOPSIS): Removed unnecessary 'choice="opt"' from <arg>
516
    <refsect2 id="CLIENTS">
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
517
      <title>CLIENTS</title>
518
      <para>
519
	The server only gives out its stored data to clients which
520
	does have the OpenPGP key of the stored fingerprint.  This is
521
	guaranteed by the fact that the client sends its OpenPGP
522
	public key in the TLS handshake; this ensures it to be
523
	genuine.  The server computes the fingerprint of the key
524
	itself and looks up the fingerprint in its list of
525
	clients. The <filename>clients.conf</filename> file (see
526
	<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
84 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Use the local manpages/docbook.xsl file, do
527
	<manvolnum>5</manvolnum></citerefentry>)
528
	<emphasis>must</emphasis> be made non-readable by anyone
529
	except the user running the server.
530
      </para>
531
      <para>
532
	As detailed in <xref linkend="checking"/>, the status of all
533
	client computers will continually be checked and be assumed
534
	compromised if they are gone for too long.
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
535
      </para>
536
      <para>
85 by Teddy Hogeborn
* mandos.xml (SYNOPSIS): Removed unnecessary 'choice="opt"' from <arg>
537
	If a client is compromised, its downtime should be duly noted
538
	by the server which would therefore declare the client
539
	invalid.  But if the server was ever restarted, it would
540
	re-read its client list from its configuration file and again
541
	regard all clients therein as valid, and hence eligible to
542
	receive their passwords.  Therefore, be careful when
86 by Teddy Hogeborn
* mandos-keygen.xml: Removed <?xml-stylesheet>. New entity
543
	restarting servers if it is suspected that a client has, in
544
	fact, been compromised by parties who may now be running a
545
	fake Mandos client with the keys from the non-encrypted
546
	initial RAM image of the client host.  What should be done in
547
	that case (if restarting the server program really is
548
	necessary) is to stop the server program, edit the
549
	configuration file to omit any suspect clients, and restart
550
	the server program.
85 by Teddy Hogeborn
* mandos.xml (SYNOPSIS): Removed unnecessary 'choice="opt"' from <arg>
551
      </para>
552
      <para>
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
553
	For more details on client-side security, see
554
	<citerefentry><refentrytitle>password-request</refentrytitle>
555
	<manvolnum>8mandos</manvolnum></citerefentry>.
556
      </para>
557
    </refsect2>
24.1.55 by Björn Påhlsson
updated some partial manual pages
558
  </refsect1>
559
560
  <refsect1 id="see_also">
561
    <title>SEE ALSO</title>
92 by Teddy Hogeborn
* mandos-keygen.xml (SEE ALSO): Remove "and".
562
    <para>
563
      <citerefentry>
114 by Teddy Hogeborn
* mandos-clients.conf.xml (SEE ALSO): Alphabetized, as per
564
	<refentrytitle>mandos-clients.conf</refentrytitle>
565
	<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
92 by Teddy Hogeborn
* mandos-keygen.xml (SEE ALSO): Remove "and".
566
	<refentrytitle>mandos.conf</refentrytitle>
567
	<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
568
	<refentrytitle>password-request</refentrytitle>
569
	<manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
570
	<refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
571
      </citerefentry>
572
    </para>
84 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Use the local manpages/docbook.xsl file, do
573
    <variablelist>
574
      <varlistentry>
575
	<term>
576
	  <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
577
	</term>
578
	<listitem>
579
	  <para>
580
	    Zeroconf is the network protocol standard used by clients
581
	    for finding this Mandos server on the local network.
582
	  </para>
583
	</listitem>
584
      </varlistentry>
585
      <varlistentry>
586
	<term>
587
	  <ulink url="http://www.avahi.org/">Avahi</ulink>
588
	</term>
589
      <listitem>
590
	<para>
591
	  Avahi is the library this server calls to implement
592
	  Zeroconf service announcements.
593
	</para>
594
      </listitem>
595
      </varlistentry>
596
      <varlistentry>
597
	<term>
108 by Teddy Hogeborn
* mandos-options.xml (address): Refer to IPv4-mapped IPv6 address
598
	  <ulink url="http://www.gnu.org/software/gnutls/"
599
	  >GnuTLS</ulink>
84 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Use the local manpages/docbook.xsl file, do
600
	</term>
601
      <listitem>
602
	<para>
603
	  GnuTLS is the library this server uses to implement TLS for
604
	  communicating securely with the client, and at the same time
605
	  confidently get the client’s public OpenPGP key.
606
	</para>
607
      </listitem>
608
      </varlistentry>
609
      <varlistentry>
610
	<term>
108 by Teddy Hogeborn
* mandos-options.xml (address): Refer to IPv4-mapped IPv6 address
611
	  RFC 4291: <citetitle>IP Version 6 Addressing
612
	  Architecture</citetitle>
84 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Use the local manpages/docbook.xsl file, do
613
	</term>
614
	<listitem>
108 by Teddy Hogeborn
* mandos-options.xml (address): Refer to IPv4-mapped IPv6 address
615
	  <variablelist>
616
	    <varlistentry>
617
	      <term>Section 2.2: <citetitle>Text Representation of
618
	      Addresses</citetitle></term>
619
	      <listitem><para/></listitem>
620
	    </varlistentry>
621
	    <varlistentry>
622
	      <term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
623
	      Address</citetitle></term>
624
	      <listitem><para/></listitem>
625
	    </varlistentry>
626
	    <varlistentry>
627
	    <term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
628
	    Addresses</citetitle></term>
629
	    <listitem>
630
	      <para>
631
		The clients use IPv6 link-local addresses, which are
632
		immediately usable since a link-local addresses is
633
		automatically assigned to a network interfaces when it
634
		is brought up.
635
	      </para>
636
	    </listitem>
637
	    </varlistentry>
638
	  </variablelist>
84 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Use the local manpages/docbook.xsl file, do
639
	</listitem>
640
      </varlistentry>
641
      <varlistentry>
642
	<term>
108 by Teddy Hogeborn
* mandos-options.xml (address): Refer to IPv4-mapped IPv6 address
643
	  RFC 4346: <citetitle>The Transport Layer Security (TLS)
644
	  Protocol Version 1.1</citetitle>
84 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Use the local manpages/docbook.xsl file, do
645
	</term>
646
      <listitem>
647
	<para>
648
	  TLS 1.1 is the protocol implemented by GnuTLS.
649
	</para>
650
      </listitem>
651
      </varlistentry>
652
      <varlistentry>
653
	<term>
108 by Teddy Hogeborn
* mandos-options.xml (address): Refer to IPv4-mapped IPv6 address
654
	  RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
84 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Use the local manpages/docbook.xsl file, do
655
	</term>
656
      <listitem>
657
	<para>
658
	  The data sent to clients is binary encrypted OpenPGP data.
659
	</para>
660
      </listitem>
661
      </varlistentry>
662
      <varlistentry>
663
	<term>
108 by Teddy Hogeborn
* mandos-options.xml (address): Refer to IPv4-mapped IPv6 address
664
	  RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
665
	  Security</citetitle>
84 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Use the local manpages/docbook.xsl file, do
666
	</term>
667
      <listitem>
668
	<para>
669
	  This is implemented by GnuTLS and used by this server so
670
	  that OpenPGP keys can be used.
671
	</para>
672
      </listitem>
673
      </varlistentry>
674
    </variablelist>
24.1.55 by Björn Påhlsson
updated some partial manual pages
675
  </refsect1>
24.1.23 by Björn Påhlsson
Added manual pages for:
676
</refentry>
111 by Teddy Hogeborn
* mandos-clients.conf.xml (ENTITY TIMESTAMP): New. Automatically
677
<!-- Local Variables: -->
678
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
679
<!-- time-stamp-end: "[\"']>" -->
680
<!-- time-stamp-format: "%:y-%02m-%02d" -->
681
<!-- End: -->