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