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 "2019-02-10">
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>
47
<holder>Teddy Hogeborn</holder>
48
<holder>Björn Påhlsson</holder>
50
<xi:include href="legalnotice.xml"/>
54
<refentrytitle>&CONFNAME;</refentrytitle>
55
<manvolnum>5</manvolnum>
59
<refname><filename>&CONFNAME;</filename></refname>
61
Configuration file for the Mandos server
66
<synopsis>&CONFPATH;</synopsis>
69
<refsect1 id="description">
70
<title>DESCRIPTION</title>
72
The file &CONFPATH; is a configuration file for <citerefentry
73
><refentrytitle>mandos</refentrytitle>
74
<manvolnum>8</manvolnum></citerefentry>, read by it at startup.
75
The file needs to list all clients that should be able to use
76
the service. The settings in this file can be overridden by
77
runtime changes to the server, which it saves across restarts.
78
(See the section called <quote>PERSISTENT STATE</quote> in
79
<citerefentry><refentrytitle>mandos</refentrytitle><manvolnum
80
>8</manvolnum></citerefentry>.) However, any <emphasis
81
>changes</emphasis> to this file (including adding and removing
82
clients) will, at startup, override changes done during runtime.
85
The format starts with a <literal>[<replaceable>section
86
header</replaceable>]</literal> which is either
87
<literal>[DEFAULT]</literal> or <literal>[<replaceable>client
88
name</replaceable>]</literal>. The <replaceable>client
89
name</replaceable> can be anything, and is not tied to a host
90
name. Following the section header is any number of
91
<quote><varname><replaceable>option</replaceable
92
></varname>=<replaceable>value</replaceable></quote> entries,
93
with continuations in the style of RFC 822. <quote><varname
94
><replaceable>option</replaceable></varname>: <replaceable
95
>value</replaceable></quote> is also accepted. Note that
96
leading whitespace is removed from values. Values can contain
97
format strings which refer to other values in the same section,
98
or values in the <quote>DEFAULT</quote> section (see <xref
99
linkend="expansion"/>). Lines beginning with <quote>#</quote>
100
or <quote>;</quote> are ignored and may be used to provide
105
<refsect1 id="options">
106
<title>OPTIONS</title>
108
<emphasis>Note:</emphasis> all option values are subject to
109
start time expansion, see <xref linkend="expansion"/>.
112
Unknown options are ignored. The used options are as follows:
118
<term><option>approval_delay<literal> = </literal><replaceable
119
>TIME</replaceable></option></term>
122
This option is <emphasis>optional</emphasis>.
125
How long to wait for external approval before resorting to
126
use the <option>approved_by_default</option> value. The
127
default is <quote>PT0S</quote>, i.e. not to wait.
130
The format of <replaceable>TIME</replaceable> is the same
131
as for <varname>timeout</varname> below.
137
<term><option>approval_duration<literal> = </literal
138
><replaceable>TIME</replaceable></option></term>
141
This option is <emphasis>optional</emphasis>.
144
How long an external approval lasts. The default is 1
148
The format of <replaceable>TIME</replaceable> is the same
149
as for <varname>timeout</varname> below.
155
<term><option>approved_by_default<literal> = </literal
156
>{ <literal >1</literal> | <literal>yes</literal> | <literal
157
>true</literal> | <literal>on</literal> | <literal
158
>0</literal> | <literal>no</literal> | <literal
159
>false</literal> | <literal>off</literal> }</option></term>
162
Whether to approve a client by default after
163
the <option>approval_delay</option>. The default
164
is <quote>True</quote>.
170
<term><option>checker<literal> = </literal><replaceable
171
>COMMAND</replaceable></option></term>
174
This option is <emphasis>optional</emphasis>.
177
This option overrides the default shell command that the
178
server will use to check if the client is still up. Any
179
output of the command will be ignored, only the exit code
180
is checked: If the exit code of the command is zero, the
181
client is considered up. The command will be run using
182
<quote><command><filename>/bin/sh</filename>
183
<option>-c</option></command></quote>, so
184
<varname>PATH</varname> will be searched. The default
185
value for the checker command is <quote><literal
186
><command>fping</command> <option>-q</option> <option
187
>--</option> %%(host)s</literal></quote>. Note that
188
<command>mandos-keygen</command>, when generating output
189
to be inserted into this file, normally looks for an SSH
190
server on the Mandos client, and, if it finds one, outputs
191
a <option>checker</option> option to check for the
192
client’s SSH key fingerprint – this is more secure against
196
In addition to normal start time expansion, this option
197
will also be subject to runtime expansion; see <xref
198
linkend="expansion"/>.
204
<term><option>extended_timeout<literal> = </literal><replaceable
205
>TIME</replaceable></option></term>
208
This option is <emphasis>optional</emphasis>.
211
Extended timeout is an added timeout that is given once
212
after a password has been sent successfully to a client.
213
The timeout is by default longer than the normal timeout,
214
and is used for handling the extra long downtime while a
215
machine is booting up. Time to take into consideration
216
when changing this value is file system checks and quota
217
checks. The default value is 15 minutes.
220
The format of <replaceable>TIME</replaceable> is the same
221
as for <varname>timeout</varname> below.
227
<term><option>fingerprint<literal> = </literal
228
><replaceable>HEXSTRING</replaceable></option></term>
231
This option is <emphasis>required</emphasis> if the
232
<option>key_id</option> is not set, and
233
<emphasis>optional</emphasis> otherwise.
236
This option sets the OpenPGP fingerprint that (before
237
GnuTLS 3.6.0) identified the public key that clients
238
authenticate themselves with through TLS. The string
239
needs to be in hexadecimal form, but spaces or upper/lower
240
case are not significant.
246
<term><option>key_id<literal> = </literal
247
><replaceable>HEXSTRING</replaceable></option></term>
250
This option is <emphasis>required</emphasis> if the
251
<option>fingerprint</option> is not set, and
252
<emphasis>optional</emphasis> otherwise.
255
This option sets the certificate key ID that (with GnuTLS
256
3.6.6 or later) identifies the public key that clients
257
authenticate themselves with through TLS. The string
258
needs to be in hexadecimal form, but spaces or upper/lower
259
case are not significant.
265
<term><option><literal>host = </literal><replaceable
266
>STRING</replaceable></option></term>
269
This option is <emphasis>optional</emphasis>, but highly
270
<emphasis>recommended</emphasis> unless the
271
<option>checker</option> option is modified to a
272
non-standard value without <quote>%%(host)s</quote> in it.
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.
283
<term><option>interval<literal> = </literal><replaceable
284
>TIME</replaceable></option></term>
287
This option is <emphasis>optional</emphasis>.
290
How often to run the checker to confirm that a client is
291
still up. <emphasis>Note:</emphasis> a new checker will
292
not be started if an old one is still running. The server
293
will wait for a checker to complete until the below
294
<quote><varname>timeout</varname></quote> occurs, at which
295
time the client will be disabled, and any running checker
296
killed. The default interval is 2 minutes.
299
The format of <replaceable>TIME</replaceable> is the same
300
as for <varname>timeout</varname> below.
306
<term><option>secfile<literal> = </literal><replaceable
307
>FILENAME</replaceable></option></term>
310
This option is only used if <option>secret</option> is not
311
specified, in which case this option is
312
<emphasis>required</emphasis>.
315
Similar to the <option>secret</option>, except the secret
316
data is in an external file. The contents of the file
317
should <emphasis>not</emphasis> be base64-encoded, but
318
will be sent to clients verbatim.
321
File names of the form <filename>~user/foo/bar</filename>
322
and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
329
<term><option>secret<literal> = </literal><replaceable
330
>BASE64_ENCODED_DATA</replaceable></option></term>
333
If this option is not specified, the <option
334
>secfile</option> option is <emphasis>required</emphasis>
338
If present, this option must be set to a string of
339
base64-encoded binary data. It will be decoded and sent
340
to the client matching the above <option>key_id</option>
341
or <option>fingerprint</option>. This should, of course,
342
be OpenPGP encrypted data, decryptable only by the client.
343
The program <citerefentry><refentrytitle><command
344
>mandos-keygen</command></refentrytitle><manvolnum
345
>8</manvolnum></citerefentry> can, using its
346
<option>--password</option> option, be used to generate
350
Note: this value of this option will probably be very
351
long. A useful feature to avoid having unreadably-long
352
lines is that a line beginning with white space adds to
353
the value of the previous line, RFC 822-style.
359
<term><option>timeout<literal> = </literal><replaceable
360
>TIME</replaceable></option></term>
363
This option is <emphasis>optional</emphasis>.
366
The timeout is how long the server will wait, after a
367
successful checker run, until a client is disabled and not
368
allowed to get the data this server holds. By default
369
Mandos will use 5 minutes. See also the
370
<option>extended_timeout</option> option.
373
The <replaceable>TIME</replaceable> is specified as an RFC
374
3339 duration; for example
375
<quote><literal>P1Y2M3DT4H5M6S</literal></quote> meaning
376
one year, two months, three days, four hours, five
377
minutes, and six seconds. Some values can be omitted, see
378
RFC 3339 Appendix A for details.
384
<term><option>enabled<literal> = </literal>{ <literal
385
>1</literal> | <literal>yes</literal> | <literal>true</literal
386
> | <literal >on</literal> | <literal>0</literal> | <literal
387
>no</literal> | <literal>false</literal> | <literal
388
>off</literal> }</option></term>
391
Whether this client should be enabled by default. The
392
default is <quote>true</quote>.
400
<refsect1 id="expansion">
401
<title>EXPANSION</title>
403
There are two forms of expansion: Start time expansion and
406
<refsect2 id="start_time_expansion">
407
<title>START TIME EXPANSION</title>
409
Any string in an option value of the form
410
<quote><literal>%(<replaceable>foo</replaceable>)s</literal
411
></quote> will be replaced by the value of the option
412
<varname>foo</varname> either in the same section, or, if it
413
does not exist there, the <literal>[DEFAULT]</literal>
414
section. This is done at start time, when the configuration
418
Note that this means that, in order to include an actual
419
percent character (<quote>%</quote>) in an option value, two
420
percent characters in a row (<quote>%%</quote>) must be
424
<refsect2 id="runtime_expansion">
425
<title>RUNTIME EXPANSION</title>
427
This is currently only done for the <varname>checker</varname>
431
Any string in an option value of the form
432
<quote><literal>%%(<replaceable>foo</replaceable>)s</literal
433
></quote> will be replaced by the value of the attribute
434
<varname>foo</varname> of the internal
435
<quote><classname>Client</classname></quote> object in the
436
Mandos server. The currently allowed values for
437
<replaceable>foo</replaceable> are:
438
<quote><literal>approval_delay</literal></quote>,
439
<quote><literal>approval_duration</literal></quote>,
440
<quote><literal>created</literal></quote>,
441
<quote><literal>enabled</literal></quote>,
442
<quote><literal>expires</literal></quote>,
443
<quote><literal>key_id</literal></quote>,
444
<quote><literal>fingerprint</literal></quote>,
445
<quote><literal>host</literal></quote>,
446
<quote><literal>interval</literal></quote>,
447
<quote><literal>last_approval_request</literal></quote>,
448
<quote><literal>last_checked_ok</literal></quote>,
449
<quote><literal>last_enabled</literal></quote>,
450
<quote><literal>name</literal></quote>,
451
<quote><literal>timeout</literal></quote>, and, if using
452
D-Bus, <quote><literal>dbus_object_path</literal></quote>.
453
See the source code for details. <emphasis role="strong"
454
>Currently, <emphasis>none</emphasis> of these attributes
455
except <quote><literal>host</literal></quote> are guaranteed
456
to be valid in future versions.</emphasis> Therefore, please
457
let the authors know of any attributes that are useful so they
458
may be preserved to any new versions of this software.
461
Note that this means that, in order to include an actual
462
percent character (<quote>%</quote>) in a
463
<varname>checker</varname> option, <emphasis>four</emphasis>
464
percent characters in a row (<quote>%%%%</quote>) must be
465
entered. Also, a bad format here will lead to an immediate
466
but <emphasis>silent</emphasis> run-time fatal exit; debug
467
mode is needed to expose an error of this kind.
473
<refsect1 id="files">
476
The file described here is &CONFPATH;
483
The format for specifying times for <varname>timeout</varname>
484
and <varname>interval</varname> is not very good.
487
The difference between
488
<literal>%%(<replaceable>foo</replaceable>)s</literal> and
489
<literal>%(<replaceable>foo</replaceable>)s</literal> is
492
<xi:include href="bugs.xml"/>
495
<refsect1 id="example">
496
<title>EXAMPLE</title>
502
checker = fping -q -- %%(host)s
506
key_id = 788cd77115cd0bb7b2d5e0ae8496f6b48149d5e712c652076b1fd2d957ef7c1f
507
fingerprint = 7788 2722 5BA7 DE53 9C5A 7CFA 59CF F7CD BD9A 5920
509
hQIOA6QdEjBs2L/HEAf/TCyrDe5Xnm9esa+Pb/vWF9CUqfn4srzVgSu234
510
REJMVv7lBSrPE2132Lmd2gqF1HeLKDJRSVxJpt6xoWOChGHg+TMyXDxK+N
511
Xl89vGvdU1XfhKkVm9MDLOgT5ECDPysDGHFPDhqHOSu3Kaw2DWMV/iH9vz
512
3Z20erVNbdcvyBnuojcoWO/6yfB5EQO0BXp7kcyy00USA3CjD5FGZdoQGI
513
Tb8A/ar0tVA5crSQmaSotm6KmNLhrFnZ5BxX+TiE+eTUTqSloWRY6VAvqW
514
QHC7OASxK5E6RXPBuFH5IohUA2Qbk5AHt99pYvsIPX88j2rWauOokoiKZo
515
t/9leJ8VxO5l3wf/U64IH8bkPIoWmWZfd/nqh4uwGNbCgKMyT+AnvH7kMJ
516
3i7DivfWl2mKLV0PyPHUNva0VQxX6yYjcOhj1R6fCr/at8/NSLe2OhLchz
517
dC+Ls9h+kvJXgF8Sisv+Wk/1RadPLFmraRlqvJwt6Ww21LpiXqXHV2mIgq
518
WnR98YgSvUi3TJHrUQiNc9YyBzuRo0AjgG2C9qiE3FM+Y28+iQ/sR3+bFs
519
zYuZKVTObqiIslwXu7imO0cvvFRgJF/6u3HNFQ4LUTGhiM3FQmC6NNlF3/
520
vJM2hwRDMcJqDd54Twx90Wh+tYz0z7QMsK4ANXWHHWHR0JchnLWmenzbtW
521
5MHdW9AYsNJZAQSOpirE4Xi31CSlWAi9KV+cUCmWF5zOFy1x23P6PjdaRm
522
4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
524
host = foo.example.org
529
key_id = F90C7A81D72D1EA69A51031A91FF8885F36C8B46D155C8C58709A4C99AE9E361
530
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
531
secfile = /etc/mandos/bar-secret
533
approved_by_default = False
534
approval_delay = PT30S
539
<refsect1 id="see_also">
540
<title>SEE ALSO</title>
542
<citerefentry><refentrytitle>intro</refentrytitle>
543
<manvolnum>8mandos</manvolnum></citerefentry>,
544
<citerefentry><refentrytitle>mandos-keygen</refentrytitle>
545
<manvolnum>8</manvolnum></citerefentry>,
546
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
547
<manvolnum>5</manvolnum></citerefentry>,
548
<citerefentry><refentrytitle>mandos</refentrytitle>
549
<manvolnum>8</manvolnum></citerefentry>,
550
<citerefentry><refentrytitle>fping</refentrytitle>
551
<manvolnum>8</manvolnum></citerefentry>
556
RFC 3339: <citetitle>Date and Time on the Internet:
557
Timestamps</citetitle>
561
The time intervals are in the "duration" format, as
562
specified in ABNF in Appendix A of RFC 3339.
569
<!-- Local Variables: -->
570
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
571
<!-- time-stamp-end: "[\"']>" -->
572
<!-- time-stamp-format: "%:y-%02m-%02d" -->
added
removed
mandos-clients.conf.xml
