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