/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.7.325 by Teddy Hogeborn
Bug fix for GnuTLS 3: be compatible with old 2048-bit DSA keys.
5
<!ENTITY TIMESTAMP "2015-07-20">
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>
237.11.2 by Teddy Hogeborn
Change "fukt.bsnet.se" to "recompile.se" throughout.
22
	  <email>belorn@recompile.se</email>
24.1.23 by Björn Påhlsson
Added manual pages for:
23
	</address>
24
      </author>
25
      <author>
26
	<firstname>Teddy</firstname>
27
	<surname>Hogeborn</surname>
28
	<address>
237.11.2 by Teddy Hogeborn
Change "fukt.bsnet.se" to "recompile.se" throughout.
29
	  <email>teddy@recompile.se</email>
24.1.23 by Björn Påhlsson
Added manual pages for:
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>
237.2.207 by Teddy Hogeborn
Update copyright year to "2010" wherever appropriate.
36
      <year>2010</year>
237.7.14 by Teddy Hogeborn
Update copyright year to "2011" wherever appropriate.
37
      <year>2011</year>
237.7.92 by Teddy Hogeborn
Updated year in copyright notices.
38
      <year>2012</year>
237.7.174 by Teddy Hogeborn
* Makefile (CFLAGS, LDFLAGS): Keep default flags from environment.
39
      <year>2013</year>
81 by Teddy Hogeborn
* Makefile (GNUTLS_CFLAGS, GNUTLS_LIBS, AVAHI_CFLAGS, AVAHI_LIBS,
40
      <holder>Teddy Hogeborn</holder>
41
      <holder>Björn Påhlsson</holder>
24.1.23 by Björn Påhlsson
Added manual pages for:
42
    </copyright>
131 by Teddy Hogeborn
* Makefile: Make all DocBook rules include legalnotice.xml as a
43
    <xi:include href="legalnotice.xml"/>
24.1.23 by Björn Påhlsson
Added manual pages for:
44
  </refentryinfo>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
45
  
24.1.23 by Björn Påhlsson
Added manual pages for:
46
  <refmeta>
47
    <refentrytitle>&COMMANDNAME;</refentrytitle>
24.1.24 by Björn Påhlsson
minor edits
48
    <manvolnum>8</manvolnum>
24.1.23 by Björn Påhlsson
Added manual pages for:
49
  </refmeta>
50
  
51
  <refnamediv>
52
    <refname><command>&COMMANDNAME;</command></refname>
53
    <refpurpose>
116 by Teddy Hogeborn
* mandos-options.xml (priority): Added <acronym> tags.
54
      Gives encrypted passwords to authenticated Mandos clients
24.1.23 by Björn Påhlsson
Added manual pages for:
55
    </refpurpose>
56
  </refnamediv>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
57
  
24.1.23 by Björn Påhlsson
Added manual pages for:
58
  <refsynopsisdiv>
59
    <cmdsynopsis>
60
      <command>&COMMANDNAME;</command>
120 by Teddy Hogeborn
* mandos.xml (SYNOPSIS): Use <option> and <replaceable> tags. Unify
61
      <group>
62
	<arg choice="plain"><option>--interface
63
	<replaceable>NAME</replaceable></option></arg>
64
	<arg choice="plain"><option>-i
65
	<replaceable>NAME</replaceable></option></arg>
66
      </group>
67
      <sbr/>
68
      <group>
69
	<arg choice="plain"><option>--address
70
	<replaceable>ADDRESS</replaceable></option></arg>
71
	<arg choice="plain"><option>-a
72
	<replaceable>ADDRESS</replaceable></option></arg>
73
      </group>
74
      <sbr/>
75
      <group>
76
	<arg choice="plain"><option>--port
77
	<replaceable>PORT</replaceable></option></arg>
78
	<arg choice="plain"><option>-p
79
	<replaceable>PORT</replaceable></option></arg>
80
      </group>
81
      <sbr/>
82
      <arg><option>--priority
83
      <replaceable>PRIORITY</replaceable></option></arg>
84
      <sbr/>
85
      <arg><option>--servicename
86
      <replaceable>NAME</replaceable></option></arg>
87
      <sbr/>
88
      <arg><option>--configdir
89
      <replaceable>DIRECTORY</replaceable></option></arg>
90
      <sbr/>
91
      <arg><option>--debug</option></arg>
237.2.34 by Teddy Hogeborn
Merge from release branch.
92
      <sbr/>
237.2.210 by teddy at bsnet
* mandos: Fixed "--help" output.
93
      <arg><option>--debuglevel
94
      <replaceable>LEVEL</replaceable></option></arg>
95
      <sbr/>
237.2.87 by Teddy Hogeborn
Merge from release branch.
96
      <arg><option>--no-dbus</option></arg>
97
      <sbr/>
237.2.77 by Teddy Hogeborn
Support not using IPv6 in server:
98
      <arg><option>--no-ipv6</option></arg>
237.12.1 by Björn Påhlsson
Persistent state: New feature. Client state is now stored when mandos
99
      <sbr/>
100
      <arg><option>--no-restore</option></arg>
237.14.2 by Teddy Hogeborn
Directory with persistent state can now be changed with the "statedir"
101
      <sbr/>
102
      <arg><option>--statedir
103
      <replaceable>DIRECTORY</replaceable></option></arg>
237.21.1 by Teddy Hogeborn
* mandos: Implement "--socket" option.
104
      <sbr/>
105
      <arg><option>--socket
106
      <replaceable>FD</replaceable></option></arg>
237.7.154 by Teddy Hogeborn
* mandos: New "--foreground" option.
107
      <sbr/>
108
      <arg><option>--foreground</option></arg>
237.7.255 by Teddy Hogeborn
mandos: New "--no-zeroconf" option. Also make "--socket=0" work.
109
      <sbr/>
110
      <arg><option>--no-zeroconf</option></arg>
85 by Teddy Hogeborn
* mandos.xml (SYNOPSIS): Removed unnecessary 'choice="opt"' from <arg>
111
    </cmdsynopsis>
112
    <cmdsynopsis>
113
      <command>&COMMANDNAME;</command>
114
      <group choice="req">
122 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Put long options before short.
115
	<arg choice="plain"><option>--help</option></arg>
120 by Teddy Hogeborn
* mandos.xml (SYNOPSIS): Use <option> and <replaceable> tags. Unify
116
	<arg choice="plain"><option>-h</option></arg>
85 by Teddy Hogeborn
* mandos.xml (SYNOPSIS): Removed unnecessary 'choice="opt"' from <arg>
117
      </group>
84 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Use the local manpages/docbook.xsl file, do
118
    </cmdsynopsis>
119
    <cmdsynopsis>
120
      <command>&COMMANDNAME;</command>
120 by Teddy Hogeborn
* mandos.xml (SYNOPSIS): Use <option> and <replaceable> tags. Unify
121
      <arg choice="plain"><option>--version</option></arg>
84 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Use the local manpages/docbook.xsl file, do
122
    </cmdsynopsis>
123
    <cmdsynopsis>
124
      <command>&COMMANDNAME;</command>
120 by Teddy Hogeborn
* mandos.xml (SYNOPSIS): Use <option> and <replaceable> tags. Unify
125
      <arg choice="plain"><option>--check</option></arg>
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
126
    </cmdsynopsis>
24.1.23 by Björn Påhlsson
Added manual pages for:
127
  </refsynopsisdiv>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
128
  
24.1.23 by Björn Påhlsson
Added manual pages for:
129
  <refsect1 id="description">
130
    <title>DESCRIPTION</title>
131
    <para>
81 by Teddy Hogeborn
* Makefile (GNUTLS_CFLAGS, GNUTLS_LIBS, AVAHI_CFLAGS, AVAHI_LIBS,
132
      <command>&COMMANDNAME;</command> is a server daemon which
133
      handles incoming request for passwords for a pre-defined list of
24.1.179 by Björn Påhlsson
New feature:
134
      client host computers. For an introduction, see
135
      <citerefentry><refentrytitle>intro</refentrytitle>
136
      <manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
137
      uses Zeroconf to announce itself on the local network, and uses
138
      TLS to communicate securely with and to authenticate the
139
      clients.  The Mandos server uses IPv6 to allow Mandos clients to
140
      use IPv6 link-local addresses, since the clients will probably
141
      not have any other addresses configured (see <xref
142
      linkend="overview"/>).  Any authenticated client is then given
143
      the stored pre-encrypted password for that specific client.
81 by Teddy Hogeborn
* Makefile (GNUTLS_CFLAGS, GNUTLS_LIBS, AVAHI_CFLAGS, AVAHI_LIBS,
144
    </para>
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
145
  </refsect1>
81 by Teddy Hogeborn
* Makefile (GNUTLS_CFLAGS, GNUTLS_LIBS, AVAHI_CFLAGS, AVAHI_LIBS,
146
  
147
  <refsect1 id="purpose">
148
    <title>PURPOSE</title>
149
    <para>
150
      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
151
      rebooting</emphasis> of client host computer with an
152
      <emphasis>encrypted root file system</emphasis>.  See <xref
153
      linkend="overview"/> for details.
81 by Teddy Hogeborn
* Makefile (GNUTLS_CFLAGS, GNUTLS_LIBS, AVAHI_CFLAGS, AVAHI_LIBS,
154
    </para>
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
155
  </refsect1>
24.1.55 by Björn Påhlsson
updated some partial manual pages
156
  
157
  <refsect1 id="options">
158
    <title>OPTIONS</title>
24.1.23 by Björn Påhlsson
Added manual pages for:
159
    <variablelist>
160
      <varlistentry>
124 by Teddy Hogeborn
* mandos.xml (OPTIONS): Moved long options before short. Use <option>
161
	<term><option>--help</option></term>
115 by Teddy Hogeborn
* mandos.xml (SYNOPSIS): Split <term> tags for the "--help" and
162
	<term><option>-h</option></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
163
	<listitem>
164
	  <para>
81 by Teddy Hogeborn
* Makefile (GNUTLS_CFLAGS, GNUTLS_LIBS, AVAHI_CFLAGS, AVAHI_LIBS,
165
	    Show a help message and exit
24.1.23 by Björn Påhlsson
Added manual pages for:
166
	  </para>
167
	</listitem>
168
      </varlistentry>
124 by Teddy Hogeborn
* mandos.xml (OPTIONS): Moved long options before short. Use <option>
169
      
24.1.23 by Björn Påhlsson
Added manual pages for:
170
      <varlistentry>
124 by Teddy Hogeborn
* mandos.xml (OPTIONS): Moved long options before short. Use <option>
171
	<term><option>--interface</option>
172
	<replaceable>NAME</replaceable></term>
115 by Teddy Hogeborn
* mandos.xml (SYNOPSIS): Split <term> tags for the "--help" and
173
	<term><option>-i</option>
174
	<replaceable>NAME</replaceable></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
175
	<listitem>
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
176
	  <xi:include href="mandos-options.xml" xpointer="interface"/>
24.1.23 by Björn Påhlsson
Added manual pages for:
177
	</listitem>
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
178
      </varlistentry>
124 by Teddy Hogeborn
* mandos.xml (OPTIONS): Moved long options before short. Use <option>
179
      
24.1.23 by Björn Påhlsson
Added manual pages for:
180
      <varlistentry>
124 by Teddy Hogeborn
* mandos.xml (OPTIONS): Moved long options before short. Use <option>
181
	<term><option>--address
182
	<replaceable>ADDRESS</replaceable></option></term>
183
	<term><option>-a
184
	<replaceable>ADDRESS</replaceable></option></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
185
	<listitem>
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
186
	  <xi:include href="mandos-options.xml" xpointer="address"/>
24.1.23 by Björn Påhlsson
Added manual pages for:
187
	</listitem>
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
188
      </varlistentry>
124 by Teddy Hogeborn
* mandos.xml (OPTIONS): Moved long options before short. Use <option>
189
      
24.1.23 by Björn Påhlsson
Added manual pages for:
190
      <varlistentry>
124 by Teddy Hogeborn
* mandos.xml (OPTIONS): Moved long options before short. Use <option>
191
	<term><option>--port
192
	<replaceable>PORT</replaceable></option></term>
193
	<term><option>-p
194
	<replaceable>PORT</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="port"/>
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>
124 by Teddy Hogeborn
* mandos.xml (OPTIONS): Moved long options before short. Use <option>
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>--check</option></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
202
	<listitem>
203
	  <para>
84 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Use the local manpages/docbook.xsl file, do
204
	    Run the server’s self-tests.  This includes any unit
81 by Teddy Hogeborn
* Makefile (GNUTLS_CFLAGS, GNUTLS_LIBS, AVAHI_CFLAGS, AVAHI_LIBS,
205
	    tests, etc.
24.1.23 by Björn Påhlsson
Added manual pages for:
206
	  </para>
207
	</listitem>
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
208
      </varlistentry>
124 by Teddy Hogeborn
* mandos.xml (OPTIONS): Moved long options before short. Use <option>
209
      
24.1.23 by Björn Påhlsson
Added manual pages for:
210
      <varlistentry>
124 by Teddy Hogeborn
* mandos.xml (OPTIONS): Moved long options before short. Use <option>
211
	<term><option>--debug</option></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
212
	<listitem>
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
213
	  <xi:include href="mandos-options.xml" xpointer="debug"/>
24.1.23 by Björn Påhlsson
Added manual pages for:
214
	</listitem>
215
      </varlistentry>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
216
      
24.1.23 by Björn Påhlsson
Added manual pages for:
217
      <varlistentry>
237.2.210 by teddy at bsnet
* mandos: Fixed "--help" output.
218
	<term><option>--debuglevel
219
	<replaceable>LEVEL</replaceable></option></term>
220
	<listitem>
221
	  <para>
222
	    Set the debugging log level.
223
	    <replaceable>LEVEL</replaceable> is a string, one of
224
	    <quote><literal>CRITICAL</literal></quote>,
225
	    <quote><literal>ERROR</literal></quote>,
226
	    <quote><literal>WARNING</literal></quote>,
227
	    <quote><literal>INFO</literal></quote>, or
228
	    <quote><literal>DEBUG</literal></quote>, in order of
229
	    increasing verbosity.  The default level is
230
	    <quote><literal>WARNING</literal></quote>.
231
	  </para>
232
	</listitem>
233
      </varlistentry>
234
      
235
      <varlistentry>
124 by Teddy Hogeborn
* mandos.xml (OPTIONS): Moved long options before short. Use <option>
236
	<term><option>--priority <replaceable>
237
	PRIORITY</replaceable></option></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
238
	<listitem>
237.7.325 by Teddy Hogeborn
Bug fix for GnuTLS 3: be compatible with old 2048-bit DSA keys.
239
	  <xi:include href="mandos-options.xml" xpointer="priority"/>
24.1.23 by Björn Påhlsson
Added manual pages for:
240
	</listitem>
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
241
      </varlistentry>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
242
      
24.1.23 by Björn Påhlsson
Added manual pages for:
243
      <varlistentry>
124 by Teddy Hogeborn
* mandos.xml (OPTIONS): Moved long options before short. Use <option>
244
	<term><option>--servicename
245
	<replaceable>NAME</replaceable></option></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
246
	<listitem>
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
247
	  <xi:include href="mandos-options.xml"
248
		      xpointer="servicename"/>
24.1.23 by Björn Påhlsson
Added manual pages for:
249
	</listitem>
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
250
      </varlistentry>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
251
      
24.1.23 by Björn Påhlsson
Added manual pages for:
252
      <varlistentry>
124 by Teddy Hogeborn
* mandos.xml (OPTIONS): Moved long options before short. Use <option>
253
	<term><option>--configdir
254
	<replaceable>DIRECTORY</replaceable></option></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
255
	<listitem>
256
	  <para>
81 by Teddy Hogeborn
* Makefile (GNUTLS_CFLAGS, GNUTLS_LIBS, AVAHI_CFLAGS, AVAHI_LIBS,
257
	    Directory to search for configuration files.  Default is
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
258
	    <quote><literal>/etc/mandos</literal></quote>.  See
259
	    <citerefentry><refentrytitle>mandos.conf</refentrytitle>
81 by Teddy Hogeborn
* Makefile (GNUTLS_CFLAGS, GNUTLS_LIBS, AVAHI_CFLAGS, AVAHI_LIBS,
260
	    <manvolnum>5</manvolnum></citerefentry> and <citerefentry>
261
	    <refentrytitle>mandos-clients.conf</refentrytitle>
262
	    <manvolnum>5</manvolnum></citerefentry>.
24.1.23 by Björn Påhlsson
Added manual pages for:
263
	  </para>
264
	</listitem>
265
      </varlistentry>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
266
      
24.1.35 by Björn Påhlsson
version 1.0
267
      <varlistentry>
124 by Teddy Hogeborn
* mandos.xml (OPTIONS): Moved long options before short. Use <option>
268
	<term><option>--version</option></term>
24.1.35 by Björn Påhlsson
version 1.0
269
	<listitem>
270
	  <para>
81 by Teddy Hogeborn
* Makefile (GNUTLS_CFLAGS, GNUTLS_LIBS, AVAHI_CFLAGS, AVAHI_LIBS,
271
	    Prints the program version and exit.
24.1.35 by Björn Påhlsson
version 1.0
272
	  </para>
273
	</listitem>
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
274
      </varlistentry>
237.2.34 by Teddy Hogeborn
Merge from release branch.
275
      
276
      <varlistentry>
237.2.87 by Teddy Hogeborn
Merge from release branch.
277
	<term><option>--no-dbus</option></term>
278
	<listitem>
279
	  <xi:include href="mandos-options.xml" xpointer="dbus"/>
280
	  <para>
281
	    See also <xref linkend="dbus_interface"/>.
282
	  </para>
283
	</listitem>
284
      </varlistentry>
285
      
286
      <varlistentry>
237.2.77 by Teddy Hogeborn
Support not using IPv6 in server:
287
	<term><option>--no-ipv6</option></term>
288
	<listitem>
289
	  <xi:include href="mandos-options.xml" xpointer="ipv6"/>
290
	</listitem>
291
      </varlistentry>
237.12.1 by Björn Påhlsson
Persistent state: New feature. Client state is now stored when mandos
292
      
293
      <varlistentry>
294
	<term><option>--no-restore</option></term>
295
	<listitem>
296
	  <xi:include href="mandos-options.xml" xpointer="restore"/>
237.7.94 by Teddy Hogeborn
* debian/rules (binary-common): Exclude network-hooks.d from
297
	  <para>
298
	    See also <xref linkend="persistent_state"/>.
299
	  </para>
237.12.1 by Björn Påhlsson
Persistent state: New feature. Client state is now stored when mandos
300
	</listitem>
301
      </varlistentry>
237.14.2 by Teddy Hogeborn
Directory with persistent state can now be changed with the "statedir"
302
      
303
      <varlistentry>
304
	<term><option>--statedir
305
	<replaceable>DIRECTORY</replaceable></option></term>
306
	<listitem>
307
	  <xi:include href="mandos-options.xml" xpointer="statedir"/>
308
	</listitem>
309
      </varlistentry>
237.21.1 by Teddy Hogeborn
* mandos: Implement "--socket" option.
310
      
311
      <varlistentry>
312
	<term><option>--socket
313
	<replaceable>FD</replaceable></option></term>
314
	<listitem>
315
	  <xi:include href="mandos-options.xml" xpointer="socket"/>
316
	</listitem>
317
      </varlistentry>
318
      
237.7.154 by Teddy Hogeborn
* mandos: New "--foreground" option.
319
      <varlistentry>
320
	<term><option>--foreground</option></term>
321
	<listitem>
322
	  <xi:include href="mandos-options.xml"
323
		      xpointer="foreground"/>
324
	</listitem>
325
      </varlistentry>
326
      
237.7.255 by Teddy Hogeborn
mandos: New "--no-zeroconf" option. Also make "--socket=0" work.
327
      <varlistentry>
328
	<term><option>--no-zeroconf</option></term>
329
	<listitem>
330
	  <xi:include href="mandos-options.xml" xpointer="zeroconf"/>
331
	</listitem>
332
      </varlistentry>
333
      
24.1.23 by Björn Påhlsson
Added manual pages for:
334
    </variablelist>
335
  </refsect1>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
336
  
84 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Use the local manpages/docbook.xsl file, do
337
  <refsect1 id="overview">
338
    <title>OVERVIEW</title>
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
339
    <xi:include href="overview.xml"/>
84 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Use the local manpages/docbook.xsl file, do
340
    <para>
341
      This program is the server part.  It is a normal server program
342
      and will run in a normal system environment, not in an initial
134 by Teddy Hogeborn
* mandos.xml: Enclose "RAM" with <acronym>.
343
      <acronym>RAM</acronym> disk environment.
84 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Use the local manpages/docbook.xsl file, do
344
    </para>
345
  </refsect1>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
346
  
81 by Teddy Hogeborn
* Makefile (GNUTLS_CFLAGS, GNUTLS_LIBS, AVAHI_CFLAGS, AVAHI_LIBS,
347
  <refsect1 id="protocol">
348
    <title>NETWORK PROTOCOL</title>
349
    <para>
350
      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".
351
      <quote><literal>_mandos._tcp</literal></quote>.  The Mandos
352
      client connects to the announced address and port, and sends a
353
      line of text where the first whitespace-separated field is the
354
      protocol version, which currently is
355
      <quote><literal>1</literal></quote>.  The client and server then
356
      start a TLS protocol handshake with a slight quirk: the Mandos
357
      server program acts as a TLS <quote>client</quote> while the
358
      connecting Mandos client acts as a TLS <quote>server</quote>.
359
      The Mandos client must supply an OpenPGP certificate, and the
360
      fingerprint of this certificate is used by the Mandos server to
361
      look up (in a list read from <filename>clients.conf</filename>
362
      at start time) which binary blob to give the client.  No other
363
      authentication or authorization is done by the server.
81 by Teddy Hogeborn
* Makefile (GNUTLS_CFLAGS, GNUTLS_LIBS, AVAHI_CFLAGS, AVAHI_LIBS,
364
    </para>
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
365
    <table>
366
      <title>Mandos Protocol (Version 1)</title><tgroup cols="3"><thead>
81 by Teddy Hogeborn
* Makefile (GNUTLS_CFLAGS, GNUTLS_LIBS, AVAHI_CFLAGS, AVAHI_LIBS,
367
      <row>
368
	<entry>Mandos Client</entry>
369
	<entry>Direction</entry>
370
	<entry>Mandos Server</entry>
371
      </row>
372
      </thead><tbody>
373
      <row>
374
	<entry>Connect</entry>
375
	<entry>-><!-- &rarr; --></entry>
376
      </row>
377
      <row>
91 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Include all DocBook-to-manpage-related
378
	<entry><quote><literal>1\r\n</literal></quote></entry>
81 by Teddy Hogeborn
* Makefile (GNUTLS_CFLAGS, GNUTLS_LIBS, AVAHI_CFLAGS, AVAHI_LIBS,
379
	<entry>-><!-- &rarr; --></entry>
380
      </row>
381
      <row>
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
382
	<entry>TLS handshake <emphasis>as TLS <quote>server</quote>
383
	</emphasis></entry>
81 by Teddy Hogeborn
* Makefile (GNUTLS_CFLAGS, GNUTLS_LIBS, AVAHI_CFLAGS, AVAHI_LIBS,
384
	<entry>&lt;-><!-- &xharr; --></entry>
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
385
	<entry>TLS handshake <emphasis>as TLS <quote>client</quote>
386
	</emphasis></entry>
81 by Teddy Hogeborn
* Makefile (GNUTLS_CFLAGS, GNUTLS_LIBS, AVAHI_CFLAGS, AVAHI_LIBS,
387
      </row>
388
      <row>
389
	<entry>OpenPGP public key (part of TLS handshake)</entry>
390
	<entry>-><!-- &rarr; --></entry>
391
      </row>
392
      <row>
393
	<entry/>
394
	<entry>&lt;-<!-- &larr; --></entry>
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
395
	<entry>Binary blob (client will assume OpenPGP data)</entry>
81 by Teddy Hogeborn
* Makefile (GNUTLS_CFLAGS, GNUTLS_LIBS, AVAHI_CFLAGS, AVAHI_LIBS,
396
      </row>
397
      <row>
398
	<entry/>
399
	<entry>&lt;-<!-- &larr; --></entry>
400
	<entry>Close</entry>
401
      </row>
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
402
    </tbody></tgroup></table>
403
  </refsect1>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
404
  
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
405
  <refsect1 id="checking">
406
    <title>CHECKING</title>
407
    <para>
408
      The server will, by default, continually check that the clients
409
      are still up.  If a client has not been confirmed as being up
410
      for some time, the client is assumed to be compromised and is no
237.2.130 by Teddy Hogeborn
* init.d-mandos: Bug fix: Correct the LSB header.
411
      longer eligible to receive the encrypted password.  (Manual
412
      intervention is required to re-enable a client.)  The timeout,
24.1.179 by Björn Påhlsson
New feature:
413
      extended timeout, checker program, and interval between checks
414
      can be configured both globally and per client; see
415
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
237.7.106 by Teddy Hogeborn
* mandos.xml (CHECKING): Don't claim that a successful secret request
416
      <manvolnum>5</manvolnum></citerefentry>.
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
417
    </para>
81 by Teddy Hogeborn
* Makefile (GNUTLS_CFLAGS, GNUTLS_LIBS, AVAHI_CFLAGS, AVAHI_LIBS,
418
  </refsect1>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
419
  
237.2.203 by Teddy Hogeborn
* mandos.xml (APPROVAL): New section.
420
  <refsect1 id="approval">
421
    <title>APPROVAL</title>
422
    <para>
423
      The server can be configured to require manual approval for a
424
      client before it is sent its secret.  The delay to wait for such
425
      approval and the default action (approve or deny) can be
426
      configured both globally and per client; see <citerefentry>
427
      <refentrytitle>mandos-clients.conf</refentrytitle>
428
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
429
      will be approved immediately without delay.
430
    </para>
431
    <para>
432
      This can be used to deny a client its secret if not manually
433
      approved within a specified time.  It can also be used to make
434
      the server delay before giving a client its secret, allowing
435
      optional manual denying of this specific client.
436
    </para>
437
    
438
  </refsect1>
439
  
81 by Teddy Hogeborn
* Makefile (GNUTLS_CFLAGS, GNUTLS_LIBS, AVAHI_CFLAGS, AVAHI_LIBS,
440
  <refsect1 id="logging">
441
    <title>LOGGING</title>
442
    <para>
91 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Include all DocBook-to-manpage-related
443
      The server will send log message with various severity levels to
237.13.1 by teddy at bsnet
* plugins.d/mandos-client.c (SYNOPSIS, OPTIONS): Document
444
      <filename class="devicefile">/dev/log</filename>.  With the
81 by Teddy Hogeborn
* Makefile (GNUTLS_CFLAGS, GNUTLS_LIBS, AVAHI_CFLAGS, AVAHI_LIBS,
445
      <option>--debug</option> option, it will log even more messages,
446
      and also show them on the console.
447
    </para>
448
  </refsect1>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
449
  
237.7.94 by Teddy Hogeborn
* debian/rules (binary-common): Exclude network-hooks.d from
450
  <refsect1 id="persistent_state">
451
    <title>PERSISTENT STATE</title>
452
    <para>
453
      Client settings, initially read from
454
      <filename>clients.conf</filename>, are persistent across
455
      restarts, and run-time changes will override settings in
456
      <filename>clients.conf</filename>.  However, if a setting is
457
      <emphasis>changed</emphasis> (or a client added, or removed) in
458
      <filename>clients.conf</filename>, this will take precedence.
459
    </para>
460
  </refsect1>
461
  
237.2.87 by Teddy Hogeborn
Merge from release branch.
462
  <refsect1 id="dbus_interface">
463
    <title>D-BUS INTERFACE</title>
464
    <para>
465
      The server will by default provide a D-Bus system bus interface.
466
      This interface will only be accessible by the root user or a
237.2.186 by Teddy Hogeborn
Documentation changes:
467
      Mandos-specific user, if such a user exists.  For documentation
468
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
237.2.87 by Teddy Hogeborn
Merge from release branch.
469
    </para>
470
  </refsect1>
471
  
24.1.55 by Björn Påhlsson
updated some partial manual pages
472
  <refsect1 id="exit_status">
473
    <title>EXIT STATUS</title>
474
    <para>
81 by Teddy Hogeborn
* Makefile (GNUTLS_CFLAGS, GNUTLS_LIBS, AVAHI_CFLAGS, AVAHI_LIBS,
475
      The server will exit with a non-zero exit status only when a
476
      critical error is encountered.
24.1.55 by Björn Påhlsson
updated some partial manual pages
477
    </para>
478
  </refsect1>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
479
  
85 by Teddy Hogeborn
* mandos.xml (SYNOPSIS): Removed unnecessary 'choice="opt"' from <arg>
480
  <refsect1 id="environment">
481
    <title>ENVIRONMENT</title>
482
    <variablelist>
483
      <varlistentry>
117 by Teddy Hogeborn
* mandos-keygen.xml (ENVIRONMENT): Replaced <varname> with <envar>.
484
	<term><envar>PATH</envar></term>
85 by Teddy Hogeborn
* mandos.xml (SYNOPSIS): Removed unnecessary 'choice="opt"' from <arg>
485
	<listitem>
486
	  <para>
487
	    To start the configured checker (see <xref
488
	    linkend="checking"/>), the server uses
489
	    <filename>/bin/sh</filename>, which in turn uses
490
	    <varname>PATH</varname> to search for matching commands if
491
	    an absolute path is not given.  See <citerefentry>
492
	    <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
91 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Include all DocBook-to-manpage-related
493
	    </citerefentry>.
85 by Teddy Hogeborn
* mandos.xml (SYNOPSIS): Removed unnecessary 'choice="opt"' from <arg>
494
	  </para>
495
	</listitem>
496
      </varlistentry>
497
    </variablelist>
498
  </refsect1>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
499
  
224 by Teddy Hogeborn
* mandos-keygen.xml (FILES): Fixed id to be "files", not "file".
500
  <refsect1 id="files">
24.1.55 by Björn Påhlsson
updated some partial manual pages
501
    <title>FILES</title>
502
    <para>
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
503
      Use the <option>--configdir</option> option to change where
504
      <command>&COMMANDNAME;</command> looks for its configurations
505
      files.  The default file names are listed here.
24.1.55 by Björn Påhlsson
updated some partial manual pages
506
    </para>
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
507
    <variablelist>
508
      <varlistentry>
509
	<term><filename>/etc/mandos/mandos.conf</filename></term>
510
	<listitem>
511
	  <para>
512
	    Server-global settings.  See
513
	    <citerefentry><refentrytitle>mandos.conf</refentrytitle>
514
	    <manvolnum>5</manvolnum></citerefentry> for details.
515
	  </para>
516
	</listitem>
517
      </varlistentry>
518
      <varlistentry>
519
	<term><filename>/etc/mandos/clients.conf</filename></term>
520
	<listitem>
521
	  <para>
522
	    List of clients and client-specific settings.  See
523
	    <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
524
	    <manvolnum>5</manvolnum></citerefentry> for details.
525
	  </para>
526
	</listitem>
527
      </varlistentry>
528
      <varlistentry>
237.7.174 by Teddy Hogeborn
* Makefile (CFLAGS, LDFLAGS): Keep default flags from environment.
529
	<term><filename>/run/mandos.pid</filename></term>
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
530
	<listitem>
531
	  <para>
237.2.202 by Teddy Hogeborn
* mandos: Do not write pid file if --debug is passed.
532
	    The file containing the process id of the
533
	    <command>&COMMANDNAME;</command> process started last.
237.7.184 by Teddy Hogeborn
Fall back to /var/run for pidfile if /run is not a directory.
534
	    <emphasis >Note:</emphasis> If the <filename
535
	    class="directory">/run</filename> directory does not
536
	    exist, <filename>/var/run/mandos.pid</filename> will be
537
	    used instead.
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
538
	  </para>
539
	</listitem>
540
      </varlistentry>
541
      <varlistentry>
237.13.1 by teddy at bsnet
* plugins.d/mandos-client.c (SYNOPSIS, OPTIONS): Document
542
	<term><filename class="devicefile">/dev/log</filename></term>
237.7.72 by Björn Påhlsson
Working persistant state
543
      </varlistentry>
544
      <varlistentry>
237.14.2 by Teddy Hogeborn
Directory with persistent state can now be changed with the "statedir"
545
	<term><filename
546
	class="directory">/var/lib/mandos</filename></term>
547
	<listitem>
548
	  <para>
549
	    Directory where persistent state will be saved.  Change
550
	    this with the <option>--statedir</option> option.  See
551
	    also the <option>--no-restore</option> option.
552
	  </para>
553
	</listitem>
554
      </varlistentry>
555
      <varlistentry>
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
556
	<term><filename>/dev/log</filename></term>
557
	<listitem>
558
	  <para>
559
	    The Unix domain socket to where local syslog messages are
560
	    sent.
561
	  </para>
562
	</listitem>
563
      </varlistentry>
85 by Teddy Hogeborn
* mandos.xml (SYNOPSIS): Removed unnecessary 'choice="opt"' from <arg>
564
      <varlistentry>
565
	<term><filename>/bin/sh</filename></term>
566
	<listitem>
567
	  <para>
568
	    This is used to start the configured checker command for
569
	    each client.  See <citerefentry>
570
	    <refentrytitle>mandos-clients.conf</refentrytitle>
571
	    <manvolnum>5</manvolnum></citerefentry> for details.
572
	  </para>
573
	</listitem>
574
      </varlistentry>
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
575
    </variablelist>
576
  </refsect1>
85 by Teddy Hogeborn
* mandos.xml (SYNOPSIS): Removed unnecessary 'choice="opt"' from <arg>
577
  
24.1.55 by Björn Påhlsson
updated some partial manual pages
578
  <refsect1 id="bugs">
579
    <title>BUGS</title>
580
    <para>
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
581
      This server might, on especially fatal errors, emit a Python
582
      backtrace.  This could be considered a feature.
24.1.55 by Björn Påhlsson
updated some partial manual pages
583
    </para>
85 by Teddy Hogeborn
* mandos.xml (SYNOPSIS): Removed unnecessary 'choice="opt"' from <arg>
584
    <para>
585
      There is no fine-grained control over logging and debug output.
586
    </para>
587
    <para>
149 by Teddy Hogeborn
* mandos-keygen.xml (BUGS): Commented out.
588
      This server does not check the expire time of clients’ OpenPGP
589
      keys.
590
    </para>
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
591
  </refsect1>
85 by Teddy Hogeborn
* mandos.xml (SYNOPSIS): Removed unnecessary 'choice="opt"' from <arg>
592
  
593
  <refsect1 id="example">
594
    <title>EXAMPLE</title>
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
595
    <informalexample>
596
      <para>
597
	Normal invocation needs no options:
598
      </para>
599
      <para>
110 by Teddy Hogeborn
* mandos.xml (EXAMPLE): Replaced all occurences of command name with
600
	<userinput>&COMMANDNAME;</userinput>
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
601
      </para>
602
    </informalexample>
603
    <informalexample>
604
      <para>
84 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Use the local manpages/docbook.xsl file, do
605
	Run the server in debug mode, read configuration files from
237.14.2 by Teddy Hogeborn
Directory with persistent state can now be changed with the "statedir"
606
	the <filename class="directory">~/mandos</filename> directory,
607
	and use the Zeroconf service name <quote>Test</quote> to not
608
	collide with any other official Mandos server on this host:
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
609
      </para>
610
      <para>
611
612
<!-- do not wrap this line -->
110 by Teddy Hogeborn
* mandos.xml (EXAMPLE): Replaced all occurences of command name with
613
<userinput>&COMMANDNAME; --debug --configdir ~/mandos --servicename Test</userinput>
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
614
615
      </para>
616
    </informalexample>
617
    <informalexample>
618
      <para>
619
	Run the server normally, but only listen to one interface and
620
	only on the link-local address on that interface:
621
      </para>
622
      <para>
623
624
<!-- do not wrap this line -->
110 by Teddy Hogeborn
* mandos.xml (EXAMPLE): Replaced all occurences of command name with
625
<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".
626
627
      </para>
628
    </informalexample>
24.1.55 by Björn Påhlsson
updated some partial manual pages
629
  </refsect1>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
630
  
24.1.55 by Björn Påhlsson
updated some partial manual pages
631
  <refsect1 id="security">
632
    <title>SECURITY</title>
224 by Teddy Hogeborn
* mandos-keygen.xml (FILES): Fixed id to be "files", not "file".
633
    <refsect2 id="server">
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
634
      <title>SERVER</title>
635
      <para>
85 by Teddy Hogeborn
* mandos.xml (SYNOPSIS): Removed unnecessary 'choice="opt"' from <arg>
636
	Running this <command>&COMMANDNAME;</command> server program
637
	should not in itself present any security risk to the host
163 by Teddy Hogeborn
* Makefile (PIDDIR, USER, GROUP): Removed.
638
	computer running it.  The program switches to a non-root user
639
	soon after startup.
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
640
      </para>
641
    </refsect2>
224 by Teddy Hogeborn
* mandos-keygen.xml (FILES): Fixed id to be "files", not "file".
642
    <refsect2 id="clients">
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
643
      <title>CLIENTS</title>
644
      <para>
645
	The server only gives out its stored data to clients which
646
	does have the OpenPGP key of the stored fingerprint.  This is
647
	guaranteed by the fact that the client sends its OpenPGP
648
	public key in the TLS handshake; this ensures it to be
649
	genuine.  The server computes the fingerprint of the key
650
	itself and looks up the fingerprint in its list of
651
	clients. The <filename>clients.conf</filename> file (see
652
	<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
84 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Use the local manpages/docbook.xsl file, do
653
	<manvolnum>5</manvolnum></citerefentry>)
654
	<emphasis>must</emphasis> be made non-readable by anyone
201 by Teddy Hogeborn
* mandos.xml (SECURITY): Minor wording improvement.
655
	except the user starting the server (usually root).
84 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Use the local manpages/docbook.xsl file, do
656
      </para>
657
      <para>
658
	As detailed in <xref linkend="checking"/>, the status of all
659
	client computers will continually be checked and be assumed
660
	compromised if they are gone for too long.
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
661
      </para>
662
      <para>
663
	For more details on client-side security, see
171 by Teddy Hogeborn
Renamed "password-request" to "mandos-client".
664
	<citerefentry><refentrytitle>mandos-client</refentrytitle>
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
665
	<manvolnum>8mandos</manvolnum></citerefentry>.
666
      </para>
667
    </refsect2>
24.1.55 by Björn Påhlsson
updated some partial manual pages
668
  </refsect1>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
669
  
24.1.55 by Björn Påhlsson
updated some partial manual pages
670
  <refsect1 id="see_also">
671
    <title>SEE ALSO</title>
92 by Teddy Hogeborn
* mandos-keygen.xml (SEE ALSO): Remove "and".
672
    <para>
237.7.41 by Teddy Hogeborn
* Makefile (DOCS): Added "intro.8mandos".
673
      <citerefentry><refentrytitle>intro</refentrytitle>
674
      <manvolnum>8mandos</manvolnum></citerefentry>,
675
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
676
      <manvolnum>5</manvolnum></citerefentry>,
677
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
678
      <manvolnum>5</manvolnum></citerefentry>,
679
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
680
      <manvolnum>8mandos</manvolnum></citerefentry>,
681
      <citerefentry><refentrytitle>sh</refentrytitle>
682
      <manvolnum>1</manvolnum></citerefentry>
92 by Teddy Hogeborn
* mandos-keygen.xml (SEE ALSO): Remove "and".
683
    </para>
84 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Use the local manpages/docbook.xsl file, do
684
    <variablelist>
685
      <varlistentry>
686
	<term>
687
	  <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
688
	</term>
689
	<listitem>
690
	  <para>
691
	    Zeroconf is the network protocol standard used by clients
692
	    for finding this Mandos server on the local network.
693
	  </para>
694
	</listitem>
695
      </varlistentry>
696
      <varlistentry>
697
	<term>
698
	  <ulink url="http://www.avahi.org/">Avahi</ulink>
699
	</term>
700
      <listitem>
701
	<para>
702
	  Avahi is the library this server calls to implement
703
	  Zeroconf service announcements.
704
	</para>
705
      </listitem>
706
      </varlistentry>
707
      <varlistentry>
708
	<term>
237.7.289 by Teddy Hogeborn
mandos.xml (SEE ALSO): Update links.
709
	  <ulink url="http://gnutls.org/">GnuTLS</ulink>
84 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Use the local manpages/docbook.xsl file, do
710
	</term>
711
      <listitem>
712
	<para>
713
	  GnuTLS is the library this server uses to implement TLS for
714
	  communicating securely with the client, and at the same time
715
	  confidently get the client’s public OpenPGP key.
716
	</para>
717
      </listitem>
718
      </varlistentry>
719
      <varlistentry>
720
	<term>
108 by Teddy Hogeborn
* mandos-options.xml (address): Refer to IPv4-mapped IPv6 address
721
	  RFC 4291: <citetitle>IP Version 6 Addressing
722
	  Architecture</citetitle>
84 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Use the local manpages/docbook.xsl file, do
723
	</term>
724
	<listitem>
108 by Teddy Hogeborn
* mandos-options.xml (address): Refer to IPv4-mapped IPv6 address
725
	  <variablelist>
726
	    <varlistentry>
727
	      <term>Section 2.2: <citetitle>Text Representation of
728
	      Addresses</citetitle></term>
729
	      <listitem><para/></listitem>
730
	    </varlistentry>
731
	    <varlistentry>
732
	      <term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
733
	      Address</citetitle></term>
734
	      <listitem><para/></listitem>
735
	    </varlistentry>
736
	    <varlistentry>
737
	    <term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
738
	    Addresses</citetitle></term>
739
	    <listitem>
740
	      <para>
741
		The clients use IPv6 link-local addresses, which are
742
		immediately usable since a link-local addresses is
743
		automatically assigned to a network interfaces when it
744
		is brought up.
745
	      </para>
746
	    </listitem>
747
	    </varlistentry>
748
	  </variablelist>
84 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Use the local manpages/docbook.xsl file, do
749
	</listitem>
750
      </varlistentry>
751
      <varlistentry>
752
	<term>
237.7.289 by Teddy Hogeborn
mandos.xml (SEE ALSO): Update links.
753
	  RFC 5246: <citetitle>The Transport Layer Security (TLS)
754
	  Protocol Version 1.2</citetitle>
84 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Use the local manpages/docbook.xsl file, do
755
	</term>
756
      <listitem>
757
	<para>
237.7.289 by Teddy Hogeborn
mandos.xml (SEE ALSO): Update links.
758
	  TLS 1.2 is the protocol implemented by GnuTLS.
84 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Use the local manpages/docbook.xsl file, do
759
	</para>
760
      </listitem>
761
      </varlistentry>
762
      <varlistentry>
763
	<term>
108 by Teddy Hogeborn
* mandos-options.xml (address): Refer to IPv4-mapped IPv6 address
764
	  RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
84 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Use the local manpages/docbook.xsl file, do
765
	</term>
766
      <listitem>
767
	<para>
768
	  The data sent to clients is binary encrypted OpenPGP data.
769
	</para>
770
      </listitem>
771
      </varlistentry>
772
      <varlistentry>
773
	<term>
237.7.289 by Teddy Hogeborn
mandos.xml (SEE ALSO): Update links.
774
	  RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
775
	  Security (TLS) Authentication</citetitle>
84 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Use the local manpages/docbook.xsl file, do
776
	</term>
777
      <listitem>
778
	<para>
779
	  This is implemented by GnuTLS and used by this server so
780
	  that OpenPGP keys can be used.
781
	</para>
782
      </listitem>
783
      </varlistentry>
784
    </variablelist>
24.1.55 by Björn Påhlsson
updated some partial manual pages
785
  </refsect1>
24.1.23 by Björn Påhlsson
Added manual pages for:
786
</refentry>
111 by Teddy Hogeborn
* mandos-clients.conf.xml (ENTITY TIMESTAMP): New. Automatically
787
<!-- Local Variables: -->
788
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
789
<!-- time-stamp-end: "[\"']>" -->
790
<!-- time-stamp-format: "%:y-%02m-%02d" -->
791
<!-- End: -->