/mandos/release

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