1
<?xml version="1.0" encoding="UTF-8"?>
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
<!ENTITY VERSION "1.0">
5
<!ENTITY CONFNAME "mandos-clients.conf">
6
<!ENTITY CONFPATH "<filename>/etc/mandos/clients.conf</filename>">
7
<!ENTITY TIMESTAMP "2008-09-12">
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
12
<title>Mandos Manual</title>
13
<!-- NWalsh’s docbook scripts use this to generate the footer: -->
14
<productname>Mandos</productname>
15
<productnumber>&VERSION;</productnumber>
16
<date>&TIMESTAMP;</date>
19
<firstname>Björn</firstname>
20
<surname>Påhlsson</surname>
22
<email>belorn@fukt.bsnet.se</email>
26
<firstname>Teddy</firstname>
27
<surname>Hogeborn</surname>
29
<email>teddy@fukt.bsnet.se</email>
35
<holder>Teddy Hogeborn</holder>
36
<holder>Björn Påhlsson</holder>
38
<xi:include href="legalnotice.xml"/>
42
<refentrytitle>&CONFNAME;</refentrytitle>
43
<manvolnum>5</manvolnum>
47
<refname><filename>&CONFNAME;</filename></refname>
49
Configuration file for the Mandos server
54
<synopsis>&CONFPATH;</synopsis>
57
<refsect1 id="description">
58
<title>DESCRIPTION</title>
60
The file &CONFPATH; is a configuration file for <citerefentry
61
><refentrytitle>mandos</refentrytitle>
62
<manvolnum>8</manvolnum></citerefentry>, read by it at startup.
63
The file needs to list all clients that should be able to use
64
the service. All clients listed will be regarded as valid, even
65
if a client was declared invalid in a previous run of the
69
The format starts with a <literal>[<replaceable>section
70
header</replaceable>]</literal> which is either
71
<literal>[DEFAULT]</literal> or <literal>[<replaceable>client
72
name</replaceable>]</literal>. The <replaceable>client
73
name</replaceable> can be anything, and is not tied to a host
74
name. Following the section header is any number of
75
<quote><varname><replaceable>option</replaceable
76
></varname>=<replaceable>value</replaceable></quote> entries,
77
with continuations in the style of RFC 822. <quote><varname
78
><replaceable>option</replaceable></varname>: <replaceable
79
>value</replaceable></quote> is also accepted. Note that
80
leading whitespace is removed from values. Values can contain
81
format strings which refer to other values in the same section,
82
or values in the <quote>DEFAULT</quote> section (see <xref
83
linkend="expansion"/>). Lines beginning with <quote>#</quote>
84
or <quote>;</quote> are ignored and may be used to provide
89
<refsect1 id="options">
90
<title>OPTIONS</title>
92
<emphasis>Note:</emphasis> all option values are subject to
93
start time expansion, see <xref linkend="expansion"/>.
96
Unknown options are ignored. The used options are as follows:
102
<term><option>timeout<literal> = </literal><replaceable
103
>TIME</replaceable></option></term>
106
This option is <emphasis>optional</emphasis>.
109
The timeout is how long the server will wait for a
110
successful checker run until a client is considered
111
invalid - that is, ineligible to get the data this server
112
holds. By default Mandos will use 1 hour.
115
The <replaceable>TIME</replaceable> is specified as a
116
space-separated number of values, each of which is a
117
number and a one-character suffix. The suffix must be one
118
of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
119
<quote>h</quote>, and <quote>w</quote> for days, seconds,
120
minutes, hours, and weeks, respectively. The values are
121
added together to give the total time value, so all of
122
<quote><literal>330s</literal></quote>,
123
<quote><literal>110s 110s 110s</literal></quote>, and
124
<quote><literal>5m 30s</literal></quote> will give a value
125
of five minutes and thirty seconds.
131
<term><option>interval<literal> = </literal><replaceable
132
>TIME</replaceable></option></term>
135
This option is <emphasis>optional</emphasis>.
138
How often to run the checker to confirm that a client is
139
still up. <emphasis>Note:</emphasis> a new checker will
140
not be started if an old one is still running. The server
141
will wait for a checker to complete until the above
142
<quote><varname>timeout</varname></quote> occurs, at which
143
time the client will be marked invalid, and any running
144
checker killed. The default interval is 5 minutes.
147
The format of <replaceable>TIME</replaceable> is the same
148
as for <varname>timeout</varname> above.
154
<term><option>checker<literal> = </literal><replaceable
155
>COMMAND</replaceable></option></term>
158
This option is <emphasis>optional</emphasis>.
161
This option allows you to override the default shell
162
command that the server will use to check if the client is
163
still up. Any output of the command will be ignored, only
164
the exit code is checked: If the exit code of the command
165
is zero, the client is considered up. The command will be
166
run using <quote><command><filename>/bin/sh</filename>
167
<option>-c</option></command></quote>, so
168
<varname>PATH</varname> will be searched. The default
169
value for the checker command is <quote><literal
170
><command>fping</command> <option>-q</option> <option
171
>--</option> %(host)s</literal></quote>.
174
In addition to normal start time expansion, this option
175
will also be subject to runtime expansion; see <xref
176
linkend="expansion"/>.
182
<term><option>fingerprint<literal> = </literal
183
><replaceable>HEXSTRING</replaceable></option></term>
186
This option is <emphasis>required</emphasis>.
189
This option sets the OpenPGP fingerprint that identifies
190
the public key that clients authenticate themselves with
191
through TLS. The string needs to be in hexidecimal form,
192
but spaces or upper/lower case are not significant.
198
<term><option>secret<literal> = </literal><replaceable
199
>BASE64_ENCODED_DATA</replaceable></option></term>
202
If this option is not specified, the <option
203
>secfile</option> option is <emphasis>required</emphasis>
207
If present, this option must be set to a string of
208
base64-encoded binary data. It will be decoded and sent
209
to the client matching the above
210
<option>fingerprint</option>. This should, of course, be
211
OpenPGP encrypted data, decryptable only by the client.
212
The program <citerefentry><refentrytitle><command
213
>mandos-keygen</command></refentrytitle><manvolnum
214
>8</manvolnum></citerefentry> can, using its
215
<option>--password</option> option, be used to generate
219
Note: this value of this option will probably be very
220
long. A useful feature to avoid having unreadably-long
221
lines is that a line beginning with white space adds to
222
the value of the previous line, RFC 822-style.
228
<term><option>secfile<literal> = </literal><replaceable
229
>FILENAME</replaceable></option></term>
232
This option is only used if <option>secret</option> is not
233
specified, in which case this option is
234
<emphasis>required</emphasis>.
237
Similar to the <option>secret</option>, except the secret
238
data is in an external file. The contents of the file
239
should <emphasis>not</emphasis> be base64-encoded, but
240
will be sent to clients verbatim.
246
<term><option><literal>host = </literal><replaceable
247
>STRING</replaceable></option></term>
250
This option is <emphasis>optional</emphasis>, but highly
251
<emphasis>recommended</emphasis> unless the
252
<option>checker</option> option is modified to a
253
non-standard value without <quote>%(host)s</quote> in it.
256
Host name for this client. This is not used by the server
257
directly, but can be, and is by default, used by the
258
checker. See the <option>checker</option> option.
266
<refsect1 id="expansion">
267
<title>EXPANSION</title>
269
There are two forms of expansion: Start time expansion and
272
<refsect2 id="start_time_expansion">
273
<title>START TIME EXPANSION</title>
275
Any string in an option value of the form
276
<quote><literal>%(<replaceable>foo</replaceable>)s</literal
277
></quote> will be replaced by the value of the option
278
<varname>foo</varname> either in the same section, or, if it
279
does not exist there, the <literal>[DEFAULT]</literal>
280
section. This is done at start time, when the configuration
284
Note that this means that, in order to include an actual
285
percent character (<quote>%</quote>) in an option value, two
286
percent characters in a row (<quote>%%</quote>) must be
290
<refsect2 id="runtime_expansion">
291
<title>RUNTIME EXPANSION</title>
293
This is currently only done for the <varname>checker</varname>
297
Any string in an option value of the form
298
<quote><literal>%%(<replaceable>foo</replaceable>)s</literal
299
></quote> will be replaced by the value of the attribute
300
<varname>foo</varname> of the internal
301
<quote><classname>Client</classname></quote> object. See the
302
source code for details, and let the authors know of any
303
attributes that are useful so they may be preserved to any new
304
versions of this software.
307
Note that this means that, in order to include an actual
308
percent character (<quote>%</quote>) in a
309
<varname>checker</varname> option, <emphasis>four</emphasis>
310
percent characters in a row (<quote>%%%%</quote>) must be
311
entered. Also, a bad format here will lead to an immediate
312
but <emphasis>silent</emphasis> run-time fatal exit; debug
313
mode is needed to expose an error of this kind.
319
<refsect1 id="files">
322
The file described here is &CONFPATH;
329
The format for specifying times for <varname>timeout</varname>
330
and <varname>interval</varname> is not very good.
333
The difference between
334
<literal>%%(<replaceable>foo</replaceable>)s</literal> and
335
<literal>%(<replaceable>foo</replaceable>)s</literal> is
340
<refsect1 id="example">
341
<title>EXAMPLE</title>
347
checker = fping -q -- %(host)s
351
fingerprint = 7788 2722 5BA7 DE53 9C5A 7CFA 59CF F7CD BD9A 5920
353
hQIOA6QdEjBs2L/HEAf/TCyrDe5Xnm9esa+Pb/vWF9CUqfn4srzVgSu234
354
REJMVv7lBSrPE2132Lmd2gqF1HeLKDJRSVxJpt6xoWOChGHg+TMyXDxK+N
355
Xl89vGvdU1XfhKkVm9MDLOgT5ECDPysDGHFPDhqHOSu3Kaw2DWMV/iH9vz
356
3Z20erVNbdcvyBnuojcoWO/6yfB5EQO0BXp7kcyy00USA3CjD5FGZdoQGI
357
Tb8A/ar0tVA5crSQmaSotm6KmNLhrFnZ5BxX+TiE+eTUTqSloWRY6VAvqW
358
QHC7OASxK5E6RXPBuFH5IohUA2Qbk5AHt99pYvsIPX88j2rWauOokoiKZo
359
t/9leJ8VxO5l3wf/U64IH8bkPIoWmWZfd/nqh4uwGNbCgKMyT+AnvH7kMJ
360
3i7DivfWl2mKLV0PyPHUNva0VQxX6yYjcOhj1R6fCr/at8/NSLe2OhLchz
361
dC+Ls9h+kvJXgF8Sisv+Wk/1RadPLFmraRlqvJwt6Ww21LpiXqXHV2mIgq
362
WnR98YgSvUi3TJHrUQiNc9YyBzuRo0AjgG2C9qiE3FM+Y28+iQ/sR3+bFs
363
zYuZKVTObqiIslwXu7imO0cvvFRgJF/6u3HNFQ4LUTGhiM3FQmC6NNlF3/
364
vJM2hwRDMcJqDd54Twx90Wh+tYz0z7QMsK4ANXWHHWHR0JchnLWmenzbtW
365
5MHdW9AYsNJZAQSOpirE4Xi31CSlWAi9KV+cUCmWF5zOFy1x23P6PjdaRm
366
4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
368
host = foo.example.org
373
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
374
secfile = /etc/mandos/bar-secret
380
<refsect1 id="see_also">
381
<title>SEE ALSO</title>
383
<citerefentry><refentrytitle>mandos-keygen</refentrytitle>
384
<manvolnum>8</manvolnum></citerefentry>,
385
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
386
<manvolnum>5</manvolnum></citerefentry>,
387
<citerefentry><refentrytitle>mandos</refentrytitle>
388
<manvolnum>8</manvolnum></citerefentry>
392
<!-- Local Variables: -->
393
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
394
<!-- time-stamp-end: "[\"']>" -->
395
<!-- time-stamp-format: "%:y-%02m-%02d" -->