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