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 CONFNAME "mandos-clients.conf">
5
<!ENTITY CONFPATH "<filename>/etc/mandos/clients.conf</filename>">
6
<!ENTITY TIMESTAMP "2012-05-27">
7
<!ENTITY % common SYSTEM "common.ent">
11
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
13
<title>Mandos Manual</title>
14
<!-- NWalsh’s docbook scripts use this to generate the footer: -->
15
<productname>Mandos</productname>
16
<productnumber>&version;</productnumber>
17
<date>&TIMESTAMP;</date>
20
<firstname>Björn</firstname>
21
<surname>Påhlsson</surname>
23
<email>belorn@recompile.se</email>
27
<firstname>Teddy</firstname>
28
<surname>Hogeborn</surname>
30
<email>teddy@recompile.se</email>
40
<holder>Teddy Hogeborn</holder>
41
<holder>Björn Påhlsson</holder>
43
<xi:include href="legalnotice.xml"/>
47
<refentrytitle>&CONFNAME;</refentrytitle>
48
<manvolnum>5</manvolnum>
52
<refname><filename>&CONFNAME;</filename></refname>
54
Configuration file for the Mandos server
59
<synopsis>&CONFPATH;</synopsis>
62
<refsect1 id="description">
63
<title>DESCRIPTION</title>
65
The file &CONFPATH; is a configuration file for <citerefentry
66
><refentrytitle>mandos</refentrytitle>
67
<manvolnum>8</manvolnum></citerefentry>, read by it at startup.
68
The file needs to list all clients that should be able to use
69
the service. The settings in this file can be overridden by
70
runtime changes to the server, which it saves across restarts.
71
(See the section called <quote>PERSISTENT STATE</quote> in
72
<citerefentry><refentrytitle>mandos</refentrytitle><manvolnum
73
>8</manvolnum></citerefentry>.) However, any <emphasis
74
>changes</emphasis> to this file (including adding and removing
75
clients) will, at startup, override changes done during runtime.
78
The format starts with a <literal>[<replaceable>section
79
header</replaceable>]</literal> which is either
80
<literal>[DEFAULT]</literal> or <literal>[<replaceable>client
81
name</replaceable>]</literal>. The <replaceable>client
82
name</replaceable> can be anything, and is not tied to a host
83
name. Following the section header is any number of
84
<quote><varname><replaceable>option</replaceable
85
></varname>=<replaceable>value</replaceable></quote> entries,
86
with continuations in the style of RFC 822. <quote><varname
87
><replaceable>option</replaceable></varname>: <replaceable
88
>value</replaceable></quote> is also accepted. Note that
89
leading whitespace is removed from values. Values can contain
90
format strings which refer to other values in the same section,
91
or values in the <quote>DEFAULT</quote> section (see <xref
92
linkend="expansion"/>). Lines beginning with <quote>#</quote>
93
or <quote>;</quote> are ignored and may be used to provide
98
<refsect1 id="options">
99
<title>OPTIONS</title>
101
<emphasis>Note:</emphasis> all option values are subject to
102
start time expansion, see <xref linkend="expansion"/>.
105
Unknown options are ignored. The used options are as follows:
111
<term><option>approval_delay<literal> = </literal><replaceable
112
>TIME</replaceable></option></term>
115
This option is <emphasis>optional</emphasis>.
118
How long to wait for external approval before resorting to
119
use the <option>approved_by_default</option> value. The
120
default is <quote>0s</quote>, i.e. not to wait.
123
The format of <replaceable>TIME</replaceable> is the same
124
as for <varname>timeout</varname> below.
130
<term><option>approval_duration<literal> = </literal
131
><replaceable>TIME</replaceable></option></term>
134
This option is <emphasis>optional</emphasis>.
137
How long an external approval lasts. The default is 1
141
The format of <replaceable>TIME</replaceable> is the same
142
as for <varname>timeout</varname> below.
148
<term><option>approved_by_default<literal> = </literal
149
>{ <literal >1</literal> | <literal>yes</literal> | <literal
150
>true</literal> | <literal>on</literal> | <literal
151
>0</literal> | <literal>no</literal> | <literal
152
>false</literal> | <literal>off</literal> }</option></term>
155
Whether to approve a client by default after
156
the <option>approval_delay</option>. The default
157
is <quote>True</quote>.
163
<term><option>checker<literal> = </literal><replaceable
164
>COMMAND</replaceable></option></term>
167
This option is <emphasis>optional</emphasis>.
170
This option overrides the default shell command that the
171
server will use to check if the client is still up. Any
172
output of the command will be ignored, only the exit code
173
is checked: If the exit code of the command is zero, the
174
client is considered up. The command will be run using
175
<quote><command><filename>/bin/sh</filename>
176
<option>-c</option></command></quote>, so
177
<varname>PATH</varname> will be searched. The default
178
value for the checker command is <quote><literal
179
><command>fping</command> <option>-q</option> <option
180
>--</option> %%(host)s</literal></quote>.
183
In addition to normal start time expansion, this option
184
will also be subject to runtime expansion; see <xref
185
linkend="expansion"/>.
191
<term><option>extended_timeout<literal> = </literal><replaceable
192
>TIME</replaceable></option></term>
195
This option is <emphasis>optional</emphasis>.
198
Extended timeout is an added timeout that is given once
199
after a password has been sent successfully to a client.
200
The timeout is by default longer than the normal timeout,
201
and is used for handling the extra long downtime while a
202
machine is booting up. Time to take into consideration
203
when changing this value is file system checks and quota
204
checks. The default value is 15 minutes.
207
The format of <replaceable>TIME</replaceable> is the same
208
as for <varname>timeout</varname> below.
214
<term><option>fingerprint<literal> = </literal
215
><replaceable>HEXSTRING</replaceable></option></term>
218
This option is <emphasis>required</emphasis>.
221
This option sets the OpenPGP fingerprint that identifies
222
the public key that clients authenticate themselves with
223
through TLS. The string needs to be in hexidecimal form,
224
but spaces or upper/lower case are not significant.
230
<term><option><literal>host = </literal><replaceable
231
>STRING</replaceable></option></term>
234
This option is <emphasis>optional</emphasis>, but highly
235
<emphasis>recommended</emphasis> unless the
236
<option>checker</option> option is modified to a
237
non-standard value without <quote>%%(host)s</quote> in it.
240
Host name for this client. This is not used by the server
241
directly, but can be, and is by default, used by the
242
checker. See the <option>checker</option> option.
248
<term><option>interval<literal> = </literal><replaceable
249
>TIME</replaceable></option></term>
252
This option is <emphasis>optional</emphasis>.
255
How often to run the checker to confirm that a client is
256
still up. <emphasis>Note:</emphasis> a new checker will
257
not be started if an old one is still running. The server
258
will wait for a checker to complete until the below
259
<quote><varname>timeout</varname></quote> occurs, at which
260
time the client will be disabled, and any running checker
261
killed. The default interval is 2 minutes.
264
The format of <replaceable>TIME</replaceable> is the same
265
as for <varname>timeout</varname> below.
271
<term><option>secfile<literal> = </literal><replaceable
272
>FILENAME</replaceable></option></term>
275
This option is only used if <option>secret</option> is not
276
specified, in which case this option is
277
<emphasis>required</emphasis>.
280
Similar to the <option>secret</option>, except the secret
281
data is in an external file. The contents of the file
282
should <emphasis>not</emphasis> be base64-encoded, but
283
will be sent to clients verbatim.
286
File names of the form <filename>~user/foo/bar</filename>
287
and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
294
<term><option>secret<literal> = </literal><replaceable
295
>BASE64_ENCODED_DATA</replaceable></option></term>
298
If this option is not specified, the <option
299
>secfile</option> option is <emphasis>required</emphasis>
303
If present, this option must be set to a string of
304
base64-encoded binary data. It will be decoded and sent
305
to the client matching the above
306
<option>fingerprint</option>. This should, of course, be
307
OpenPGP encrypted data, decryptable only by the client.
308
The program <citerefentry><refentrytitle><command
309
>mandos-keygen</command></refentrytitle><manvolnum
310
>8</manvolnum></citerefentry> can, using its
311
<option>--password</option> option, be used to generate
315
Note: this value of this option will probably be very
316
long. A useful feature to avoid having unreadably-long
317
lines is that a line beginning with white space adds to
318
the value of the previous line, RFC 822-style.
324
<term><option>timeout<literal> = </literal><replaceable
325
>TIME</replaceable></option></term>
328
This option is <emphasis>optional</emphasis>.
331
The timeout is how long the server will wait, after a
332
successful checker run, until a client is disabled and not
333
allowed to get the data this server holds. By default
334
Mandos will use 5 minutes. See also the
335
<option>extended_timeout</option> option.
338
The <replaceable>TIME</replaceable> is specified as a
339
space-separated number of values, each of which is a
340
number and a one-character suffix. The suffix must be one
341
of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
342
<quote>h</quote>, and <quote>w</quote> for days, seconds,
343
minutes, hours, and weeks, respectively. The values are
344
added together to give the total time value, so all of
345
<quote><literal>330s</literal></quote>,
346
<quote><literal>110s 110s 110s</literal></quote>, and
347
<quote><literal>5m 30s</literal></quote> will give a value
348
of five minutes and thirty seconds.
354
<term><option>enabled<literal> = </literal>{ <literal
355
>1</literal> | <literal>yes</literal> | <literal>true</literal
356
> | <literal >on</literal> | <literal>0</literal> | <literal
357
>no</literal> | <literal>false</literal> | <literal
358
>off</literal> }</option></term>
361
Whether this client should be enabled by default. The
362
default is <quote>true</quote>.
370
<refsect1 id="expansion">
371
<title>EXPANSION</title>
373
There are two forms of expansion: Start time expansion and
376
<refsect2 id="start_time_expansion">
377
<title>START TIME EXPANSION</title>
379
Any string in an option value of the form
380
<quote><literal>%(<replaceable>foo</replaceable>)s</literal
381
></quote> will be replaced by the value of the option
382
<varname>foo</varname> either in the same section, or, if it
383
does not exist there, the <literal>[DEFAULT]</literal>
384
section. This is done at start time, when the configuration
388
Note that this means that, in order to include an actual
389
percent character (<quote>%</quote>) in an option value, two
390
percent characters in a row (<quote>%%</quote>) must be
394
<refsect2 id="runtime_expansion">
395
<title>RUNTIME EXPANSION</title>
397
This is currently only done for the <varname>checker</varname>
401
Any string in an option value of the form
402
<quote><literal>%%(<replaceable>foo</replaceable>)s</literal
403
></quote> will be replaced by the value of the attribute
404
<varname>foo</varname> of the internal
405
<quote><classname>Client</classname></quote> object in the
406
Mandos server. The currently allowed values for
407
<replaceable>foo</replaceable> are:
408
<quote><literal>approval_delay</literal></quote>,
409
<quote><literal>approval_duration</literal></quote>,
410
<quote><literal>created</literal></quote>,
411
<quote><literal>enabled</literal></quote>,
412
<quote><literal>expires</literal></quote>,
413
<quote><literal>fingerprint</literal></quote>,
414
<quote><literal>host</literal></quote>,
415
<quote><literal>interval</literal></quote>,
416
<quote><literal>last_approval_request</literal></quote>,
417
<quote><literal>last_checked_ok</literal></quote>,
418
<quote><literal>last_enabled</literal></quote>,
419
<quote><literal>name</literal></quote>,
420
<quote><literal>timeout</literal></quote>, and, if using
421
D-Bus, <quote><literal>dbus_object_path</literal></quote>.
422
See the source code for details. <emphasis role="strong"
423
>Currently, <emphasis>none</emphasis> of these attributes
424
except <quote><literal>host</literal></quote> are guaranteed
425
to be valid in future versions.</emphasis> Therefore, please
426
let the authors know of any attributes that are useful so they
427
may be preserved to any new versions of this software.
430
Note that this means that, in order to include an actual
431
percent character (<quote>%</quote>) in a
432
<varname>checker</varname> option, <emphasis>four</emphasis>
433
percent characters in a row (<quote>%%%%</quote>) must be
434
entered. Also, a bad format here will lead to an immediate
435
but <emphasis>silent</emphasis> run-time fatal exit; debug
436
mode is needed to expose an error of this kind.
442
<refsect1 id="files">
445
The file described here is &CONFPATH;
452
The format for specifying times for <varname>timeout</varname>
453
and <varname>interval</varname> is not very good.
456
The difference between
457
<literal>%%(<replaceable>foo</replaceable>)s</literal> and
458
<literal>%(<replaceable>foo</replaceable>)s</literal> is
463
<refsect1 id="example">
464
<title>EXAMPLE</title>
470
checker = fping -q -- %%(host)s
474
fingerprint = 7788 2722 5BA7 DE53 9C5A 7CFA 59CF F7CD BD9A 5920
476
hQIOA6QdEjBs2L/HEAf/TCyrDe5Xnm9esa+Pb/vWF9CUqfn4srzVgSu234
477
REJMVv7lBSrPE2132Lmd2gqF1HeLKDJRSVxJpt6xoWOChGHg+TMyXDxK+N
478
Xl89vGvdU1XfhKkVm9MDLOgT5ECDPysDGHFPDhqHOSu3Kaw2DWMV/iH9vz
479
3Z20erVNbdcvyBnuojcoWO/6yfB5EQO0BXp7kcyy00USA3CjD5FGZdoQGI
480
Tb8A/ar0tVA5crSQmaSotm6KmNLhrFnZ5BxX+TiE+eTUTqSloWRY6VAvqW
481
QHC7OASxK5E6RXPBuFH5IohUA2Qbk5AHt99pYvsIPX88j2rWauOokoiKZo
482
t/9leJ8VxO5l3wf/U64IH8bkPIoWmWZfd/nqh4uwGNbCgKMyT+AnvH7kMJ
483
3i7DivfWl2mKLV0PyPHUNva0VQxX6yYjcOhj1R6fCr/at8/NSLe2OhLchz
484
dC+Ls9h+kvJXgF8Sisv+Wk/1RadPLFmraRlqvJwt6Ww21LpiXqXHV2mIgq
485
WnR98YgSvUi3TJHrUQiNc9YyBzuRo0AjgG2C9qiE3FM+Y28+iQ/sR3+bFs
486
zYuZKVTObqiIslwXu7imO0cvvFRgJF/6u3HNFQ4LUTGhiM3FQmC6NNlF3/
487
vJM2hwRDMcJqDd54Twx90Wh+tYz0z7QMsK4ANXWHHWHR0JchnLWmenzbtW
488
5MHdW9AYsNJZAQSOpirE4Xi31CSlWAi9KV+cUCmWF5zOFy1x23P6PjdaRm
489
4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
491
host = foo.example.org
496
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
497
secfile = /etc/mandos/bar-secret
499
approved_by_default = False
505
<refsect1 id="see_also">
506
<title>SEE ALSO</title>
508
<citerefentry><refentrytitle>intro</refentrytitle>
509
<manvolnum>8mandos</manvolnum></citerefentry>,
510
<citerefentry><refentrytitle>mandos-keygen</refentrytitle>
511
<manvolnum>8</manvolnum></citerefentry>,
512
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
513
<manvolnum>5</manvolnum></citerefentry>,
514
<citerefentry><refentrytitle>mandos</refentrytitle>
515
<manvolnum>8</manvolnum></citerefentry>,
516
<citerefentry><refentrytitle>fping</refentrytitle>
517
<manvolnum>8</manvolnum></citerefentry>
521
<!-- Local Variables: -->
522
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
523
<!-- time-stamp-end: "[\"']>" -->
524
<!-- time-stamp-format: "%:y-%02m-%02d" -->