69
53
Configuration file for the Mandos server
58
<synopsis>&CONFPATH;</synopsis>
79
61
<refsect1 id="description">
80
62
<title>DESCRIPTION</title>
82
The file &CONFPATH; is the configuration file for <citerefentry
64
The file &CONFPATH; is a configuration file for <citerefentry
83
65
><refentrytitle>mandos</refentrytitle>
84
<manvolnum>8</manvolnum></citerefentry>, read by it at startup,
85
where each client that will be able to use the service needs to
86
be listed. All clients listed will be regarded as valid, even
87
if a client was declared invalid in a previous run of the
66
<manvolnum>8</manvolnum></citerefentry>, read by it at startup.
67
The file needs to list all clients that should be able to use
68
the service. All clients listed will be regarded as enabled,
69
even if a client was disabled in a previous run of the server.
91
The format starts with a section under [] which is either
72
The format starts with a <literal>[<replaceable>section
73
header</replaceable>]</literal> which is either
92
74
<literal>[DEFAULT]</literal> or <literal>[<replaceable>client
93
name</replaceable>]</literal>. Following the section is any
94
number of <quote><varname><replaceable>option</replaceable
75
name</replaceable>]</literal>. The <replaceable>client
76
name</replaceable> can be anything, and is not tied to a host
77
name. Following the section header is any number of
78
<quote><varname><replaceable>option</replaceable
95
79
></varname>=<replaceable>value</replaceable></quote> entries,
96
80
with continuations in the style of RFC 822. <quote><varname
97
81
><replaceable>option</replaceable></varname>: <replaceable
98
82
>value</replaceable></quote> is also accepted. Note that
99
83
leading whitespace is removed from values. Values can contain
100
84
format strings which refer to other values in the same section,
101
or values in the <quote>DEFAULT</quote> section. Lines
102
beginning with <quote>#</quote> or <quote>;</quote> are ignored
103
and may be used to provide comments.
85
or values in the <quote>DEFAULT</quote> section (see <xref
86
linkend="expansion"/>). Lines beginning with <quote>#</quote>
87
or <quote>;</quote> are ignored and may be used to provide
107
92
<refsect1 id="options">
108
93
<title>OPTIONS</title>
110
The possible options are:
95
<emphasis>Note:</emphasis> all option values are subject to
96
start time expansion, see <xref linkend="expansion"/>.
99
Unknown options are ignored. The used options are as follows:
116
<term><literal><varname>timeout</varname></literal></term>
118
<synopsis><literal>timeout = </literal><replaceable
122
The timeout is how long the server will wait for a
123
successful checker run until a client is considered
124
invalid - that is, ineligible to get the data this server
125
holds. By default Mandos will use 1 hour.
105
<term><option>approval_delay<literal> = </literal><replaceable
106
>TIME</replaceable></option></term>
109
This option is <emphasis>optional</emphasis>.
112
How long to wait for external approval before resorting to
113
use the <option>approved_by_default</option> value. The
114
default is <quote>0s</quote>, i.e. not to wait.
117
The format of <replaceable>TIME</replaceable> is the same
118
as for <varname>timeout</varname> below.
124
<term><option>approval_duration<literal> = </literal
125
><replaceable>TIME</replaceable></option></term>
128
This option is <emphasis>optional</emphasis>.
131
How long an external approval lasts. The default is 1
135
The format of <replaceable>TIME</replaceable> is the same
136
as for <varname>timeout</varname> below.
142
<term><option>approved_by_default<literal> = </literal
143
>{ <literal >1</literal> | <literal>yes</literal> | <literal
144
>true</literal> | <literal>on</literal> | <literal
145
>0</literal> | <literal>no</literal> | <literal
146
>false</literal> | <literal>off</literal> }</option></term>
149
Whether to approve a client by default after
150
the <option>approval_delay</option>. The default
151
is <quote>True</quote>.
157
<term><option>checker<literal> = </literal><replaceable
158
>COMMAND</replaceable></option></term>
161
This option is <emphasis>optional</emphasis>.
164
This option allows you to override the default shell
165
command that the server will use to check if the client is
166
still up. Any output of the command will be ignored, only
167
the exit code is checked: If the exit code of the command
168
is zero, the client is considered up. The command will be
169
run using <quote><command><filename>/bin/sh</filename>
170
<option>-c</option></command></quote>, so
171
<varname>PATH</varname> will be searched. The default
172
value for the checker command is <quote><literal
173
><command>fping</command> <option>-q</option> <option
174
>--</option> %%(host)s</literal></quote>.
177
In addition to normal start time expansion, this option
178
will also be subject to runtime expansion; see <xref
179
linkend="expansion"/>.
185
<term><option>fingerprint<literal> = </literal
186
><replaceable>HEXSTRING</replaceable></option></term>
189
This option is <emphasis>required</emphasis>.
192
This option sets the OpenPGP fingerprint that identifies
193
the public key that clients authenticate themselves with
194
through TLS. The string needs to be in hexidecimal form,
195
but spaces or upper/lower case are not significant.
201
<term><option><literal>host = </literal><replaceable
202
>STRING</replaceable></option></term>
205
This option is <emphasis>optional</emphasis>, but highly
206
<emphasis>recommended</emphasis> unless the
207
<option>checker</option> option is modified to a
208
non-standard value without <quote>%%(host)s</quote> in it.
211
Host name for this client. This is not used by the server
212
directly, but can be, and is by default, used by the
213
checker. See the <option>checker</option> option.
219
<term><option>interval<literal> = </literal><replaceable
220
>TIME</replaceable></option></term>
223
This option is <emphasis>optional</emphasis>.
226
How often to run the checker to confirm that a client is
227
still up. <emphasis>Note:</emphasis> a new checker will
228
not be started if an old one is still running. The server
229
will wait for a checker to complete until the below
230
<quote><varname>timeout</varname></quote> occurs, at which
231
time the client will be disabled, and any running checker
232
killed. The default interval is 5 minutes.
235
The format of <replaceable>TIME</replaceable> is the same
236
as for <varname>timeout</varname> below.
242
<term><option>secfile<literal> = </literal><replaceable
243
>FILENAME</replaceable></option></term>
246
This option is only used if <option>secret</option> is not
247
specified, in which case this option is
248
<emphasis>required</emphasis>.
251
Similar to the <option>secret</option>, except the secret
252
data is in an external file. The contents of the file
253
should <emphasis>not</emphasis> be base64-encoded, but
254
will be sent to clients verbatim.
257
File names of the form <filename>~user/foo/bar</filename>
258
and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
265
<term><option>secret<literal> = </literal><replaceable
266
>BASE64_ENCODED_DATA</replaceable></option></term>
269
If this option is not specified, the <option
270
>secfile</option> option is <emphasis>required</emphasis>
274
If present, this option must be set to a string of
275
base64-encoded binary data. It will be decoded and sent
276
to the client matching the above
277
<option>fingerprint</option>. This should, of course, be
278
OpenPGP encrypted data, decryptable only by the client.
279
The program <citerefentry><refentrytitle><command
280
>mandos-keygen</command></refentrytitle><manvolnum
281
>8</manvolnum></citerefentry> can, using its
282
<option>--password</option> option, be used to generate
286
Note: this value of this option will probably be very
287
long. A useful feature to avoid having unreadably-long
288
lines is that a line beginning with white space adds to
289
the value of the previous line, RFC 822-style.
295
<term><option>timeout<literal> = </literal><replaceable
296
>TIME</replaceable></option></term>
299
This option is <emphasis>optional</emphasis>.
302
The timeout is how long the server will wait (for either a
303
successful checker run or a client receiving its secret)
304
until a client is disabled and not allowed to get the data
305
this server holds. By default Mandos will use 1 hour.
128
308
The <replaceable>TIME</replaceable> is specified as a
144
<term><literal><varname>interval</varname></literal></term>
146
<synopsis><literal>interval = </literal><replaceable
150
How often to run the checker to confirm that a client is
151
still up. <emphasis>Note:</emphasis> a new checker will
152
not be started if an old one is still running. The server
153
will wait for a checker to complete until the above
154
<quote><varname>timeout</varname></quote> occurs, at which
155
time the client will be marked invalid, and any running
156
checker killed. The default interval is 5 minutes.
159
The format of <replaceable>TIME</replaceable> is the same
160
as for <varname>timeout</varname> above.
166
<term><literal>checker</literal></term>
169
This option allows you to override the default shell
170
command that the server will use to check up if the client
171
is still up. By default mandos will "fping -q -- %%(host)s"
177
<term><literal>fingerprint</literal></term>
180
This option sets the openpgp fingerprint that identifies
181
the public certificate that clients authenticates themself
182
through gnutls. The string need to be in hex-decimal form.
188
<term><literal>secret</literal></term>
191
Base 64 encoded OpenPGP encrypted password encrypted by
192
the clients openpgp certificate.
198
<term><literal>secfile</literal></term>
201
Base 64 encoded OpenPGP encrypted password encrypted by
202
the clients openpgp certificate as a binary file.
208
<term><literal>host</literal></term>
211
Host name that can be used in for checking that the client is up.
217
<term><literal>checker</literal></term>
220
Shell command that the server will use to check up if a
227
<term><literal>timeout</literal></term>
230
Duration that a client can be down whitout be removed from
239
326
<refsect1 id="expansion">
240
327
<title>EXPANSION</title>
271
358
<quote><literal>%%(<replaceable>foo</replaceable>)s</literal
272
359
></quote> will be replaced by the value of the attribute
273
360
<varname>foo</varname> of the internal
274
<quote><classname>Client</classname></quote> object. See the
275
source code for details, and let the authors know of any
276
attributes that are useful so they may be preserved to any new
277
versions of this software.
361
<quote><classname>Client</classname></quote> object in the
362
Mandos server. The currently allowed values for
363
<replaceable>foo</replaceable> are:
364
<quote><literal>approval_delay</literal></quote>,
365
<quote><literal>approval_duration</literal></quote>,
366
<quote><literal>created</literal></quote>,
367
<quote><literal>enabled</literal></quote>,
368
<quote><literal>fingerprint</literal></quote>,
369
<quote><literal>host</literal></quote>,
370
<quote><literal>interval</literal></quote>,
371
<quote><literal>last_approval_request</literal></quote>,
372
<quote><literal>last_checked_ok</literal></quote>,
373
<quote><literal>last_enabled</literal></quote>,
374
<quote><literal>name</literal></quote>,
375
<quote><literal>timeout</literal></quote>, and, if using
376
D-Bus, <quote><literal>dbus_object_path</literal></quote>.
377
See the source code for details. <emphasis role="strong"
378
>Currently, <emphasis>none</emphasis> of these attributes
379
except <quote><literal>host</literal></quote> are guaranteed
380
to be valid in future versions.</emphasis> Therefore, please
381
let the authors know of any attributes that are useful so they
382
may be preserved to any new versions of this software.
280
385
Note that this means that, in order to include an actual
281
386
percent character (<quote>%</quote>) in a
282
<varname>checker</varname> options, <emphasis>four</emphasis>
387
<varname>checker</varname> option, <emphasis>four</emphasis>
283
388
percent characters in a row (<quote>%%%%</quote>) must be
284
389
entered. Also, a bad format here will lead to an immediate
285
390
but <emphasis>silent</emphasis> run-time fatal exit; debug
286
mode is needed to track down an error of this kind.
391
mode is needed to expose an error of this kind.
292
397
<refsect1 id="files">
293
398
<title>FILES</title>