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