68
55
<refname><filename>&CONFNAME;</filename></refname>
70
Configuration file for Mandos clients
57
Configuration file for the Mandos server
62
<synopsis>&CONFPATH;</synopsis>
80
65
<refsect1 id="description">
81
66
<title>DESCRIPTION</title>
83
The file &CONFPATH; is the configuration file for mandos where
84
each client that will be abel to use the service need to be
85
specified. The configuration file is looked on at the startup of
86
the service, so to reenable timedout clients one need to only
87
restart the server. The format starts with a section under []
88
which is eather <literal>[DEFAULT]</literal> or a client
89
name. Values is set through the use of VAR = VALUE pair. Values
94
<refsect1 id="default">
95
<title>DEFAULTS</title>
97
The paramters for <literal>[DEFAULT]</literal> are:
103
<term><literal>timeout</literal></term>
106
This option allows you to override the default timeout
107
that clients will get. By default mandos will use 1hr.
113
<term><literal>interval</literal></term>
116
This option allows you to override the default interval
117
used between checkups for disconnected clients. By default
124
<term><literal>checker</literal></term>
127
This option allows you to override the default shell
128
command that the server will use to check up if the client
129
is still up. By default mandos will "fping -q -- %%(host)s"
137
<refsect1 id="clients">
138
<title>CLIENTS</title>
140
The paramters for clients are:
146
<term><literal>fingerprint</literal></term>
149
This option sets the openpgp fingerprint that identifies
150
the public certificate that clients authenticates themself
151
through gnutls. The string need to be in hex-decimal form.
157
<term><literal>secret</literal></term>
160
Base 64 encoded OpenPGP encrypted password encrypted by
161
the clients openpgp certificate.
167
<term><literal>secfile</literal></term>
170
Base 64 encoded OpenPGP encrypted password encrypted by
171
the clients openpgp certificate as a binary file.
177
<term><literal>host</literal></term>
180
Host name that can be used in for checking that the client is up.
186
<term><literal>checker</literal></term>
189
Shell command that the server will use to check up if a
196
<term><literal>timeout</literal></term>
199
Duration that a client can be down whitout be removed from
208
<refsect1 id="examples">
209
<title>EXAMPLES</title>
68
The file &CONFPATH; is a configuration file for <citerefentry
69
><refentrytitle>mandos</refentrytitle>
70
<manvolnum>8</manvolnum></citerefentry>, read by it at startup.
71
The file needs to list all clients that should be able to use
72
the service. The settings in this file can be overridden by
73
runtime changes to the server, which it saves across restarts.
74
(See the section called <quote>PERSISTENT STATE</quote> in
75
<citerefentry><refentrytitle>mandos</refentrytitle><manvolnum
76
>8</manvolnum></citerefentry>.) However, any <emphasis
77
>changes</emphasis> to this file (including adding and removing
78
clients) will, at startup, override changes done during runtime.
81
The format starts with a <literal>[<replaceable>section
82
header</replaceable>]</literal> which is either
83
<literal>[DEFAULT]</literal> or <literal>[<replaceable>client
84
name</replaceable>]</literal>. The <replaceable>client
85
name</replaceable> can be anything, and is not tied to a host
86
name. Following the section header is any number of
87
<quote><varname><replaceable>option</replaceable
88
></varname>=<replaceable>value</replaceable></quote> entries,
89
with continuations in the style of RFC 822. <quote><varname
90
><replaceable>option</replaceable></varname>: <replaceable
91
>value</replaceable></quote> is also accepted. Note that
92
leading whitespace is removed from values. Values can contain
93
format strings which refer to other values in the same section,
94
or values in the <quote>DEFAULT</quote> section (see <xref
95
linkend="expansion"/>). Lines beginning with <quote>#</quote>
96
or <quote>;</quote> are ignored and may be used to provide
101
<refsect1 id="options">
102
<title>OPTIONS</title>
104
<emphasis>Note:</emphasis> all option values are subject to
105
start time expansion, see <xref linkend="expansion"/>.
108
Unknown options are ignored. The used options are as follows:
114
<term><option>approval_delay<literal> = </literal><replaceable
115
>TIME</replaceable></option></term>
118
This option is <emphasis>optional</emphasis>.
121
How long to wait for external approval before resorting to
122
use the <option>approved_by_default</option> value. The
123
default is <quote>PT0S</quote>, i.e. not to wait.
126
The format of <replaceable>TIME</replaceable> is the same
127
as for <varname>timeout</varname> below.
133
<term><option>approval_duration<literal> = </literal
134
><replaceable>TIME</replaceable></option></term>
137
This option is <emphasis>optional</emphasis>.
140
How long an external approval lasts. The default is 1
144
The format of <replaceable>TIME</replaceable> is the same
145
as for <varname>timeout</varname> below.
151
<term><option>approved_by_default<literal> = </literal
152
>{ <literal >1</literal> | <literal>yes</literal> | <literal
153
>true</literal> | <literal>on</literal> | <literal
154
>0</literal> | <literal>no</literal> | <literal
155
>false</literal> | <literal>off</literal> }</option></term>
158
Whether to approve a client by default after
159
the <option>approval_delay</option>. The default
160
is <quote>True</quote>.
166
<term><option>checker<literal> = </literal><replaceable
167
>COMMAND</replaceable></option></term>
170
This option is <emphasis>optional</emphasis>.
173
This option overrides the default shell command that the
174
server will use to check if the client is still up. Any
175
output of the command will be ignored, only the exit code
176
is checked: If the exit code of the command is zero, the
177
client is considered up. The command will be run using
178
<quote><command><filename>/bin/sh</filename>
179
<option>-c</option></command></quote>, so
180
<varname>PATH</varname> will be searched. The default
181
value for the checker command is <quote><literal
182
><command>fping</command> <option>-q</option> <option
183
>--</option> %%(host)s</literal></quote>. Note that
184
<command>mandos-keygen</command>, when generating output
185
to be inserted into this file, normally looks for an SSH
186
server on the Mandos client, and, if it find one, outputs
187
a <option>checker</option> option to check for the
188
client’s key fingerprint – this is more secure against
192
In addition to normal start time expansion, this option
193
will also be subject to runtime expansion; see <xref
194
linkend="expansion"/>.
200
<term><option>extended_timeout<literal> = </literal><replaceable
201
>TIME</replaceable></option></term>
204
This option is <emphasis>optional</emphasis>.
207
Extended timeout is an added timeout that is given once
208
after a password has been sent successfully to a client.
209
The timeout is by default longer than the normal timeout,
210
and is used for handling the extra long downtime while a
211
machine is booting up. Time to take into consideration
212
when changing this value is file system checks and quota
213
checks. The default value is 15 minutes.
216
The format of <replaceable>TIME</replaceable> is the same
217
as for <varname>timeout</varname> below.
223
<term><option>fingerprint<literal> = </literal
224
><replaceable>HEXSTRING</replaceable></option></term>
227
This option is <emphasis>required</emphasis>.
230
This option sets the OpenPGP fingerprint that identifies
231
the public key that clients authenticate themselves with
232
through TLS. The string needs to be in hexidecimal form,
233
but spaces or upper/lower case are not significant.
239
<term><option><literal>host = </literal><replaceable
240
>STRING</replaceable></option></term>
243
This option is <emphasis>optional</emphasis>, but highly
244
<emphasis>recommended</emphasis> unless the
245
<option>checker</option> option is modified to a
246
non-standard value without <quote>%%(host)s</quote> in it.
249
Host name for this client. This is not used by the server
250
directly, but can be, and is by default, used by the
251
checker. See the <option>checker</option> option.
257
<term><option>interval<literal> = </literal><replaceable
258
>TIME</replaceable></option></term>
261
This option is <emphasis>optional</emphasis>.
264
How often to run the checker to confirm that a client is
265
still up. <emphasis>Note:</emphasis> a new checker will
266
not be started if an old one is still running. The server
267
will wait for a checker to complete until the below
268
<quote><varname>timeout</varname></quote> occurs, at which
269
time the client will be disabled, and any running checker
270
killed. The default interval is 2 minutes.
273
The format of <replaceable>TIME</replaceable> is the same
274
as for <varname>timeout</varname> below.
280
<term><option>secfile<literal> = </literal><replaceable
281
>FILENAME</replaceable></option></term>
284
This option is only used if <option>secret</option> is not
285
specified, in which case this option is
286
<emphasis>required</emphasis>.
289
Similar to the <option>secret</option>, except the secret
290
data is in an external file. The contents of the file
291
should <emphasis>not</emphasis> be base64-encoded, but
292
will be sent to clients verbatim.
295
File names of the form <filename>~user/foo/bar</filename>
296
and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
303
<term><option>secret<literal> = </literal><replaceable
304
>BASE64_ENCODED_DATA</replaceable></option></term>
307
If this option is not specified, the <option
308
>secfile</option> option is <emphasis>required</emphasis>
312
If present, this option must be set to a string of
313
base64-encoded binary data. It will be decoded and sent
314
to the client matching the above
315
<option>fingerprint</option>. This should, of course, be
316
OpenPGP encrypted data, decryptable only by the client.
317
The program <citerefentry><refentrytitle><command
318
>mandos-keygen</command></refentrytitle><manvolnum
319
>8</manvolnum></citerefentry> can, using its
320
<option>--password</option> option, be used to generate
324
Note: this value of this option will probably be very
325
long. A useful feature to avoid having unreadably-long
326
lines is that a line beginning with white space adds to
327
the value of the previous line, RFC 822-style.
333
<term><option>timeout<literal> = </literal><replaceable
334
>TIME</replaceable></option></term>
337
This option is <emphasis>optional</emphasis>.
340
The timeout is how long the server will wait, after a
341
successful checker run, until a client is disabled and not
342
allowed to get the data this server holds. By default
343
Mandos will use 5 minutes. See also the
344
<option>extended_timeout</option> option.
347
The <replaceable>TIME</replaceable> is specified as an RFC
348
3339 duration; for example
349
<quote><literal>P1Y2M3DT4H5M6S</literal></quote> meaning
350
one year, two months, three days, four hours, five
351
minutes, and six seconds. Some values can be omitted, see
352
RFC 3339 Appendix A for details.
358
<term><option>enabled<literal> = </literal>{ <literal
359
>1</literal> | <literal>yes</literal> | <literal>true</literal
360
> | <literal >on</literal> | <literal>0</literal> | <literal
361
>no</literal> | <literal>false</literal> | <literal
362
>off</literal> }</option></term>
365
Whether this client should be enabled by default. The
366
default is <quote>true</quote>.
374
<refsect1 id="expansion">
375
<title>EXPANSION</title>
377
There are two forms of expansion: Start time expansion and
380
<refsect2 id="start_time_expansion">
381
<title>START TIME EXPANSION</title>
383
Any string in an option value of the form
384
<quote><literal>%(<replaceable>foo</replaceable>)s</literal
385
></quote> will be replaced by the value of the option
386
<varname>foo</varname> either in the same section, or, if it
387
does not exist there, the <literal>[DEFAULT]</literal>
388
section. This is done at start time, when the configuration
392
Note that this means that, in order to include an actual
393
percent character (<quote>%</quote>) in an option value, two
394
percent characters in a row (<quote>%%</quote>) must be
398
<refsect2 id="runtime_expansion">
399
<title>RUNTIME EXPANSION</title>
401
This is currently only done for the <varname>checker</varname>
405
Any string in an option value of the form
406
<quote><literal>%%(<replaceable>foo</replaceable>)s</literal
407
></quote> will be replaced by the value of the attribute
408
<varname>foo</varname> of the internal
409
<quote><classname>Client</classname></quote> object in the
410
Mandos server. The currently allowed values for
411
<replaceable>foo</replaceable> are:
412
<quote><literal>approval_delay</literal></quote>,
413
<quote><literal>approval_duration</literal></quote>,
414
<quote><literal>created</literal></quote>,
415
<quote><literal>enabled</literal></quote>,
416
<quote><literal>expires</literal></quote>,
417
<quote><literal>fingerprint</literal></quote>,
418
<quote><literal>host</literal></quote>,
419
<quote><literal>interval</literal></quote>,
420
<quote><literal>last_approval_request</literal></quote>,
421
<quote><literal>last_checked_ok</literal></quote>,
422
<quote><literal>last_enabled</literal></quote>,
423
<quote><literal>name</literal></quote>,
424
<quote><literal>timeout</literal></quote>, and, if using
425
D-Bus, <quote><literal>dbus_object_path</literal></quote>.
426
See the source code for details. <emphasis role="strong"
427
>Currently, <emphasis>none</emphasis> of these attributes
428
except <quote><literal>host</literal></quote> are guaranteed
429
to be valid in future versions.</emphasis> Therefore, please
430
let the authors know of any attributes that are useful so they
431
may be preserved to any new versions of this software.
434
Note that this means that, in order to include an actual
435
percent character (<quote>%</quote>) in a
436
<varname>checker</varname> option, <emphasis>four</emphasis>
437
percent characters in a row (<quote>%%%%</quote>) must be
438
entered. Also, a bad format here will lead to an immediate
439
but <emphasis>silent</emphasis> run-time fatal exit; debug
440
mode is needed to expose an error of this kind.
446
<refsect1 id="files">
449
The file described here is &CONFPATH;
456
The format for specifying times for <varname>timeout</varname>
457
and <varname>interval</varname> is not very good.
460
The difference between
461
<literal>%%(<replaceable>foo</replaceable>)s</literal> and
462
<literal>%(<replaceable>foo</replaceable>)s</literal> is
467
<refsect1 id="example">
468
<title>EXAMPLE</title>
210
469
<informalexample>
215
474
checker = fping -q -- %%(host)s
218
478
fingerprint = 7788 2722 5BA7 DE53 9C5A 7CFA 59CF F7CD BD9A 5920
221
480
hQIOA6QdEjBs2L/HEAf/TCyrDe5Xnm9esa+Pb/vWF9CUqfn4srzVgSu234
222
481
REJMVv7lBSrPE2132Lmd2gqF1HeLKDJRSVxJpt6xoWOChGHg+TMyXDxK+N
added
removed
mandos-clients.conf.xml
