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