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-08-30">
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>
40
This manual page is free software: you can redistribute it
41
and/or modify it under the terms of the GNU General Public
42
License as published by the Free Software Foundation,
43
either version 3 of the License, or (at your option) any
48
This manual page is distributed in the hope that it will
49
be useful, but WITHOUT ANY WARRANTY; without even the
50
implied warranty of MERCHANTABILITY or FITNESS FOR A
51
PARTICULAR PURPOSE. See the GNU General Public License
56
You should have received a copy of the GNU General Public
57
License along with this program; If not, see
58
<ulink url="http://www.gnu.org/licenses/"/>.
64
<refentrytitle>&CONFNAME;</refentrytitle>
65
<manvolnum>5</manvolnum>
69
<refname><filename>&CONFNAME;</filename></refname>
71
Configuration file for the Mandos server
81
<refsect1 id="description">
82
<title>DESCRIPTION</title>
84
The file &CONFPATH; is a configuration file for <citerefentry
85
><refentrytitle>mandos</refentrytitle>
86
<manvolnum>8</manvolnum></citerefentry>, read by it at startup.
87
The file needs to list all clients that should be able to use
88
the service. All clients listed will be regarded as valid, even
89
if a client was declared invalid in a previous run of the
93
The format starts with a <literal>[<replaceable>section
94
header</replaceable>]</literal> which is either
95
<literal>[DEFAULT]</literal> or <literal>[<replaceable>client
96
name</replaceable>]</literal>. The <replaceable>client
97
name</replaceable> can be anything, and is not tied to a host
98
name. Following the section header is any number of
99
<quote><varname><replaceable>option</replaceable
100
></varname>=<replaceable>value</replaceable></quote> entries,
101
with continuations in the style of RFC 822. <quote><varname
102
><replaceable>option</replaceable></varname>: <replaceable
103
>value</replaceable></quote> is also accepted. Note that
104
leading whitespace is removed from values. Values can contain
105
format strings which refer to other values in the same section,
106
or values in the <quote>DEFAULT</quote> section (see <xref
107
linkend="expansion"/>). Lines beginning with <quote>#</quote>
108
or <quote>;</quote> are ignored and may be used to provide
113
<refsect1 id="options">
114
<title>OPTIONS</title>
116
<emphasis>Note:</emphasis> all option values are subject to
117
start time expansion, see <xref linkend="expansion"/>.
120
Uknown options are ignored. The used options are as follows:
126
<term><literal><varname>timeout</varname></literal></term>
128
<synopsis><literal>timeout = </literal><replaceable
132
The timeout is how long the server will wait for a
133
successful checker run until a client is considered
134
invalid - that is, ineligible to get the data this server
135
holds. By default Mandos will use 1 hour.
138
The <replaceable>TIME</replaceable> is specified as a
139
space-separated number of values, each of which is a
140
number and a one-character suffix. The suffix must be one
141
of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
142
<quote>h</quote>, and <quote>w</quote> for days, seconds,
143
minutes, hours, and weeks, respectively. The values are
144
added together to give the total time value, so all of
145
<quote><literal>330s</literal></quote>,
146
<quote><literal>110s 110s 110s</literal></quote>, and
147
<quote><literal>5m 30s</literal></quote> will give a value
148
of five minutes and thirty seconds.
154
<term><literal><varname>interval</varname></literal></term>
156
<synopsis><literal>interval = </literal><replaceable
160
How often to run the checker to confirm that a client is
161
still up. <emphasis>Note:</emphasis> a new checker will
162
not be started if an old one is still running. The server
163
will wait for a checker to complete until the above
164
<quote><varname>timeout</varname></quote> occurs, at which
165
time the client will be marked invalid, and any running
166
checker killed. The default interval is 5 minutes.
169
The format of <replaceable>TIME</replaceable> is the same
170
as for <varname>timeout</varname> above.
176
<term><literal>checker</literal></term>
178
<synopsis><literal>checker = </literal><replaceable
179
>COMMAND</replaceable>
182
This option allows you to override the default shell
183
command that the server will use to check if the client is
184
still up. Any output of the command will be ignored, only
185
the exit code is checked: If the exit code of the command
186
is zero, the client is considered up. The command will be
187
run using <quote><command><filename>/bin/sh</filename>
188
<option>-c</option></command></quote>, so
189
<varname>PATH</varname> will be searched. The default
190
value for the checker command is <quote><literal
191
><command>fping</command> <option>-q</option> <option
192
>--</option> %(host)s</literal></quote>.
195
In addition to normal start time expansion, this option
196
will also be subject to runtime expansion; see <xref
197
linkend="expansion"/>.
203
<term><literal>fingerprint</literal></term>
205
<synopsis><literal>fingerprint = </literal><replaceable
206
>HEXSTRING</replaceable>
209
This option sets the OpenPGP fingerprint that identifies
210
the public key that clients authenticate themselves with
211
through TLS. The string needs to be in hexidecimal form,
212
but spaces or upper/lower case are not significant.
218
<term><literal>secret</literal></term>
220
<synopsis><literal>secret = </literal><replaceable
221
>BASE64_ENCODED_DATA</replaceable>
224
If present, this option must be set to a string of
225
base64-encoded binary data. It will be decoded and sent
226
to the client matching the above
227
<option>fingerprint</option>. This should, of course, be
228
OpenPGP encrypted data, decryptable only by the client.
229
The program <citerefentry><refentrytitle><command
230
>mandos-keygen</command></refentrytitle><manvolnum
231
>8</manvolnum></citerefentry> can, using its
232
<option>--password</option> option, be used to generate
236
Note: this value of this option will probably be very
237
long. A useful feature to avoid having unreadably-long
238
lines is that a line beginning with white space adds to
239
the value of the previous line, RFC 822-style.
242
If this option is not specified, the <option
243
>secfile</option> option is used instead, but one of them
244
<emphasis>must</emphasis> be present.
250
<term><literal>secfile</literal></term>
252
<synopsis><literal>secfile = </literal><replaceable
253
>FILENAME</replaceable>
256
The same as <option>secret</option>, but the secret data
257
is in an external file. The contents of the file should
258
<emphasis>not</emphasis> be base64-encoded, but will be
259
sent to clients verbatim.
262
This option is only used, and <emphasis>must</emphasis> be
263
present, if <option>secret</option> is not specified.
269
<term><literal>host</literal></term>
271
<synopsis><literal>host = </literal><replaceable
272
>STRING</replaceable>
275
Host name for this client. This is not used by the server
276
directly, but can be, and is by default, used by the
277
checker. See the <option>checker</option> option.
285
<refsect1 id="expansion">
286
<title>EXPANSION</title>
288
There are two forms of expansion: Start time expansion and
291
<refsect2 id="start_time_expansion">
292
<title>START TIME EXPANSION</title>
294
Any string in an option value of the form
295
<quote><literal>%(<replaceable>foo</replaceable>)s</literal
296
></quote> will be replaced by the value of the option
297
<varname>foo</varname> either in the same section, or, if it
298
does not exist there, the <literal>[DEFAULT]</literal>
299
section. This is done at start time, when the configuration
303
Note that this means that, in order to include an actual
304
percent character (<quote>%</quote>) in an option value, two
305
percent characters in a row (<quote>%%</quote>) must be
309
<refsect2 id="runtime_expansion">
310
<title>RUNTIME EXPANSION</title>
312
This is currently only done for the <varname>checker</varname>
316
Any string in an option value of the form
317
<quote><literal>%%(<replaceable>foo</replaceable>)s</literal
318
></quote> will be replaced by the value of the attribute
319
<varname>foo</varname> of the internal
320
<quote><classname>Client</classname></quote> object. See the
321
source code for details, and let the authors know of any
322
attributes that are useful so they may be preserved to any new
323
versions of this software.
326
Note that this means that, in order to include an actual
327
percent character (<quote>%</quote>) in a
328
<varname>checker</varname> option, <emphasis>four</emphasis>
329
percent characters in a row (<quote>%%%%</quote>) must be
330
entered. Also, a bad format here will lead to an immediate
331
but <emphasis>silent</emphasis> run-time fatal exit; debug
332
mode is needed to track down an error of this kind.
338
<refsect1 id="files">
341
The file described here is &CONFPATH;
348
The format for specifying times for <varname>timeout</varname>
349
and <varname>interval</varname> is not very good.
352
The difference between
353
<literal>%%(<replaceable>foo</replaceable>)s</literal> and
354
<literal>%(<replaceable>foo</replaceable>)s</literal> is
359
<refsect1 id="example">
360
<title>EXAMPLE</title>
366
checker = fping -q -- %(host)s
370
fingerprint = 7788 2722 5BA7 DE53 9C5A 7CFA 59CF F7CD BD9A 5920
372
hQIOA6QdEjBs2L/HEAf/TCyrDe5Xnm9esa+Pb/vWF9CUqfn4srzVgSu234
373
REJMVv7lBSrPE2132Lmd2gqF1HeLKDJRSVxJpt6xoWOChGHg+TMyXDxK+N
374
Xl89vGvdU1XfhKkVm9MDLOgT5ECDPysDGHFPDhqHOSu3Kaw2DWMV/iH9vz
375
3Z20erVNbdcvyBnuojcoWO/6yfB5EQO0BXp7kcyy00USA3CjD5FGZdoQGI
376
Tb8A/ar0tVA5crSQmaSotm6KmNLhrFnZ5BxX+TiE+eTUTqSloWRY6VAvqW
377
QHC7OASxK5E6RXPBuFH5IohUA2Qbk5AHt99pYvsIPX88j2rWauOokoiKZo
378
t/9leJ8VxO5l3wf/U64IH8bkPIoWmWZfd/nqh4uwGNbCgKMyT+AnvH7kMJ
379
3i7DivfWl2mKLV0PyPHUNva0VQxX6yYjcOhj1R6fCr/at8/NSLe2OhLchz
380
dC+Ls9h+kvJXgF8Sisv+Wk/1RadPLFmraRlqvJwt6Ww21LpiXqXHV2mIgq
381
WnR98YgSvUi3TJHrUQiNc9YyBzuRo0AjgG2C9qiE3FM+Y28+iQ/sR3+bFs
382
zYuZKVTObqiIslwXu7imO0cvvFRgJF/6u3HNFQ4LUTGhiM3FQmC6NNlF3/
383
vJM2hwRDMcJqDd54Twx90Wh+tYz0z7QMsK4ANXWHHWHR0JchnLWmenzbtW
384
5MHdW9AYsNJZAQSOpirE4Xi31CSlWAi9KV+cUCmWF5zOFy1x23P6PjdaRm
385
4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
387
host = foo.example.org
392
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
393
secfile = /etc/mandos/bar-secret
400
<refsect1 id="see_also">
401
<title>SEE ALSO</title>
403
<citerefentry><refentrytitle>mandos-keygen</refentrytitle>
404
<manvolnum>8</manvolnum></citerefentry>,
405
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
406
<manvolnum>5</manvolnum></citerefentry>,
407
<citerefentry><refentrytitle>mandos</refentrytitle>
408
<manvolnum>8</manvolnum></citerefentry>
412
<!-- Local Variables: -->
413
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
414
<!-- time-stamp-end: "[\"']>" -->
415
<!-- time-stamp-format: "%:y-%02m-%02d" -->