68
49
<refname><filename>&CONFNAME;</filename></refname>
70
Configuration file for Mandos clients
51
Configuration file for the Mandos server
56
<synopsis>&CONFPATH;</synopsis>
80
59
<refsect1 id="description">
81
60
<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
62
The file &CONFPATH; is a configuration file for <citerefentry
63
><refentrytitle>mandos</refentrytitle>
64
<manvolnum>8</manvolnum></citerefentry>, read by it at startup.
65
The file needs to list all clients that should be able to use
66
the service. All clients listed will be regarded as enabled,
67
even if a client was disabled in a previous run of the server.
70
The format starts with a <literal>[<replaceable>section
71
header</replaceable>]</literal> which is either
72
<literal>[DEFAULT]</literal> or <literal>[<replaceable>client
73
name</replaceable>]</literal>. The <replaceable>client
74
name</replaceable> can be anything, and is not tied to a host
75
name. Following the section header is any number of
76
<quote><varname><replaceable>option</replaceable
77
></varname>=<replaceable>value</replaceable></quote> entries,
78
with continuations in the style of RFC 822. <quote><varname
79
><replaceable>option</replaceable></varname>: <replaceable
80
>value</replaceable></quote> is also accepted. Note that
81
leading whitespace is removed from values. Values can contain
82
format strings which refer to other values in the same section,
83
or values in the <quote>DEFAULT</quote> section (see <xref
84
linkend="expansion"/>). Lines beginning with <quote>#</quote>
85
or <quote>;</quote> are ignored and may be used to provide
94
<refsect1 id="default">
95
<title>DEFAULTS</title>
97
The paramters for <literal>[DEFAULT]</literal> are:
90
<refsect1 id="options">
91
<title>OPTIONS</title>
93
<emphasis>Note:</emphasis> all option values are subject to
94
start time expansion, see <xref linkend="expansion"/>.
97
Unknown options are ignored. The used options are as follows:
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>
103
<term><option>timeout<literal> = </literal><replaceable
104
>TIME</replaceable></option></term>
107
This option is <emphasis>optional</emphasis>.
110
The timeout is how long the server will wait (for either a
111
successful checker run or a client receiving its secret)
112
until a client is disabled and not allowed to get the data
113
this server holds. By default Mandos will use 1 hour.
116
The <replaceable>TIME</replaceable> is specified as a
117
space-separated number of values, each of which is a
118
number and a one-character suffix. The suffix must be one
119
of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
120
<quote>h</quote>, and <quote>w</quote> for days, seconds,
121
minutes, hours, and weeks, respectively. The values are
122
added together to give the total time value, so all of
123
<quote><literal>330s</literal></quote>,
124
<quote><literal>110s 110s 110s</literal></quote>, and
125
<quote><literal>5m 30s</literal></quote> will give a value
126
of five minutes and thirty seconds.
132
<term><option>interval<literal> = </literal><replaceable
133
>TIME</replaceable></option></term>
136
This option is <emphasis>optional</emphasis>.
139
How often to run the checker to confirm that a client is
140
still up. <emphasis>Note:</emphasis> a new checker will
141
not be started if an old one is still running. The server
142
will wait for a checker to complete until the above
143
<quote><varname>timeout</varname></quote> occurs, at which
144
time the client will be disabled, and any running checker
145
killed. The default interval is 5 minutes.
148
The format of <replaceable>TIME</replaceable> is the same
149
as for <varname>timeout</varname> above.
155
<term><option>checker<literal> = </literal><replaceable
156
>COMMAND</replaceable></option></term>
159
This option is <emphasis>optional</emphasis>.
127
162
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>
163
command that the server will use to check if the client is
164
still up. Any output of the command will be ignored, only
165
the exit code is checked: If the exit code of the command
166
is zero, the client is considered up. The command will be
167
run using <quote><command><filename>/bin/sh</filename>
168
<option>-c</option></command></quote>, so
169
<varname>PATH</varname> will be searched. The default
170
value for the checker command is <quote><literal
171
><command>fping</command> <option>-q</option> <option
172
>--</option> %%(host)s</literal></quote>.
175
In addition to normal start time expansion, this option
176
will also be subject to runtime expansion; see <xref
177
linkend="expansion"/>.
183
<term><option>fingerprint<literal> = </literal
184
><replaceable>HEXSTRING</replaceable></option></term>
187
This option is <emphasis>required</emphasis>.
190
This option sets the OpenPGP fingerprint that identifies
191
the public key that clients authenticate themselves with
192
through TLS. The string needs to be in hexidecimal form,
193
but spaces or upper/lower case are not significant.
199
<term><option>secret<literal> = </literal><replaceable
200
>BASE64_ENCODED_DATA</replaceable></option></term>
203
If this option is not specified, the <option
204
>secfile</option> option is <emphasis>required</emphasis>
208
If present, this option must be set to a string of
209
base64-encoded binary data. It will be decoded and sent
210
to the client matching the above
211
<option>fingerprint</option>. This should, of course, be
212
OpenPGP encrypted data, decryptable only by the client.
213
The program <citerefentry><refentrytitle><command
214
>mandos-keygen</command></refentrytitle><manvolnum
215
>8</manvolnum></citerefentry> can, using its
216
<option>--password</option> option, be used to generate
220
Note: this value of this option will probably be very
221
long. A useful feature to avoid having unreadably-long
222
lines is that a line beginning with white space adds to
223
the value of the previous line, RFC 822-style.
229
<term><option>secfile<literal> = </literal><replaceable
230
>FILENAME</replaceable></option></term>
233
This option is only used if <option>secret</option> is not
234
specified, in which case this option is
235
<emphasis>required</emphasis>.
238
Similar to the <option>secret</option>, except the secret
239
data is in an external file. The contents of the file
240
should <emphasis>not</emphasis> be base64-encoded, but
241
will be sent to clients verbatim.
244
File names of the form <filename>~user/foo/bar</filename>
245
and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
252
<term><option><literal>host = </literal><replaceable
253
>STRING</replaceable></option></term>
256
This option is <emphasis>optional</emphasis>, but highly
257
<emphasis>recommended</emphasis> unless the
258
<option>checker</option> option is modified to a
259
non-standard value without <quote>%%(host)s</quote> in it.
262
Host name for this client. This is not used by the server
263
directly, but can be, and is by default, used by the
264
checker. See the <option>checker</option> option.
270
<term><option>approved_by_default<literal> = </literal
271
>{ <literal >1</literal> | <literal>yes</literal> | <literal
272
>true</literal> | <literal>on</literal> | <literal
273
>0</literal> | <literal>no</literal> | <literal
274
>false</literal> | <literal>off</literal> }</option></term>
277
Whether to approve a client by default after
278
the <option>approval_delay</option>. The default
279
is <quote>True</quote>.
285
<term><option>approval_delay<literal> = </literal><replaceable
286
>TIME</replaceable></option></term>
289
This option is <emphasis>optional</emphasis>.
292
How long to wait for external approval before resorting to
293
use the <option>approved_by_default</option> value. The
294
default is <quote>0s</quote>, i.e. not to wait.
297
The format of <replaceable>TIME</replaceable> is the same
298
as for <varname>timeout</varname> above.
304
<term><option>approval_duration<literal> = </literal
305
><replaceable>TIME</replaceable></option></term>
308
This option is <emphasis>optional</emphasis>.
311
How long an external approval lasts. The default is 1
315
The format of <replaceable>TIME</replaceable> is the same
316
as for <varname>timeout</varname> above.
324
<refsect1 id="expansion">
325
<title>EXPANSION</title>
327
There are two forms of expansion: Start time expansion and
330
<refsect2 id="start_time_expansion">
331
<title>START TIME EXPANSION</title>
333
Any string in an option value of the form
334
<quote><literal>%(<replaceable>foo</replaceable>)s</literal
335
></quote> will be replaced by the value of the option
336
<varname>foo</varname> either in the same section, or, if it
337
does not exist there, the <literal>[DEFAULT]</literal>
338
section. This is done at start time, when the configuration
342
Note that this means that, in order to include an actual
343
percent character (<quote>%</quote>) in an option value, two
344
percent characters in a row (<quote>%%</quote>) must be
348
<refsect2 id="runtime_expansion">
349
<title>RUNTIME EXPANSION</title>
351
This is currently only done for the <varname>checker</varname>
355
Any string in an option value of the form
356
<quote><literal>%%(<replaceable>foo</replaceable>)s</literal
357
></quote> will be replaced by the value of the attribute
358
<varname>foo</varname> of the internal
359
<quote><classname>Client</classname></quote> object. See the
360
source code for details, and let the authors know of any
361
attributes that are useful so they may be preserved to any new
362
versions of this software.
365
Note that this means that, in order to include an actual
366
percent character (<quote>%</quote>) in a
367
<varname>checker</varname> option, <emphasis>four</emphasis>
368
percent characters in a row (<quote>%%%%</quote>) must be
369
entered. Also, a bad format here will lead to an immediate
370
but <emphasis>silent</emphasis> run-time fatal exit; debug
371
mode is needed to expose an error of this kind.
377
<refsect1 id="files">
380
The file described here is &CONFPATH;
387
The format for specifying times for <varname>timeout</varname>
388
and <varname>interval</varname> is not very good.
391
The difference between
392
<literal>%%(<replaceable>foo</replaceable>)s</literal> and
393
<literal>%(<replaceable>foo</replaceable>)s</literal> is
398
<refsect1 id="example">
399
<title>EXAMPLE</title>
210
400
<informalexample>