20
20
<firstname>Björn</firstname>
21
21
<surname>Påhlsson</surname>
23
<email>belorn@recompile.se</email>
23
<email>belorn@fukt.bsnet.se</email>
27
27
<firstname>Teddy</firstname>
28
28
<surname>Hogeborn</surname>
30
<email>teddy@recompile.se</email>
30
<email>teddy@fukt.bsnet.se</email>
40
36
<holder>Teddy Hogeborn</holder>
41
37
<holder>Björn Påhlsson</holder>
66
62
><refentrytitle>mandos</refentrytitle>
67
63
<manvolnum>8</manvolnum></citerefentry>, read by it at startup.
68
64
The file needs to list all clients that should be able to use
69
the service. All clients listed will be regarded as enabled,
70
even if a client was disabled in a previous run of the server.
65
the service. All clients listed will be regarded as valid, even
66
if a client was declared invalid in a previous run of the
73
70
The format starts with a <literal>[<replaceable>section
106
<term><option>approval_delay<literal> = </literal><replaceable
107
>TIME</replaceable></option></term>
110
This option is <emphasis>optional</emphasis>.
113
How long to wait for external approval before resorting to
114
use the <option>approved_by_default</option> value. The
115
default is <quote>0s</quote>, i.e. not to wait.
118
The format of <replaceable>TIME</replaceable> is the same
119
as for <varname>timeout</varname> below.
125
<term><option>approval_duration<literal> = </literal
126
><replaceable>TIME</replaceable></option></term>
129
This option is <emphasis>optional</emphasis>.
132
How long an external approval lasts. The default is 1
136
The format of <replaceable>TIME</replaceable> is the same
137
as for <varname>timeout</varname> below.
143
<term><option>approved_by_default<literal> = </literal
144
>{ <literal >1</literal> | <literal>yes</literal> | <literal
145
>true</literal> | <literal>on</literal> | <literal
146
>0</literal> | <literal>no</literal> | <literal
147
>false</literal> | <literal>off</literal> }</option></term>
150
Whether to approve a client by default after
151
the <option>approval_delay</option>. The default
152
is <quote>True</quote>.
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 a
111
successful checker run until a client is considered
112
invalid - that is, ineligible to get the data this server
113
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 marked invalid, and any running
145
checker killed. The default interval is 5 minutes.
148
The format of <replaceable>TIME</replaceable> is the same
149
as for <varname>timeout</varname> above.
186
<term><option>extended_timeout<literal> = </literal><replaceable
187
>TIME</replaceable></option></term>
190
This option is <emphasis>optional</emphasis>.
193
Extended timeout is an added timeout that is given once
194
after a password has been sent successfully to a client.
195
The timeout is by default longer than the normal timeout,
196
and is used for handling the extra long downtime while a
197
machine is booting up. Time to take into consideration
198
when changing this value is file system checks and quota
199
checks. The default value is 15 minutes.
202
The format of <replaceable>TIME</replaceable> is the same
203
as for <varname>timeout</varname> below.
209
183
<term><option>fingerprint<literal> = </literal
210
184
><replaceable>HEXSTRING</replaceable></option></term>
225
<term><option><literal>host = </literal><replaceable
226
>STRING</replaceable></option></term>
229
This option is <emphasis>optional</emphasis>, but highly
230
<emphasis>recommended</emphasis> unless the
231
<option>checker</option> option is modified to a
232
non-standard value without <quote>%%(host)s</quote> in it.
235
Host name for this client. This is not used by the server
236
directly, but can be, and is by default, used by the
237
checker. See the <option>checker</option> option.
243
<term><option>interval<literal> = </literal><replaceable
244
>TIME</replaceable></option></term>
247
This option is <emphasis>optional</emphasis>.
250
How often to run the checker to confirm that a client is
251
still up. <emphasis>Note:</emphasis> a new checker will
252
not be started if an old one is still running. The server
253
will wait for a checker to complete until the below
254
<quote><varname>timeout</varname></quote> occurs, at which
255
time the client will be disabled, and any running checker
256
killed. The default interval is 2 minutes.
259
The format of <replaceable>TIME</replaceable> is the same
260
as for <varname>timeout</varname> below.
266
<term><option>secfile<literal> = </literal><replaceable
267
>FILENAME</replaceable></option></term>
270
This option is only used if <option>secret</option> is not
271
specified, in which case this option is
272
<emphasis>required</emphasis>.
275
Similar to the <option>secret</option>, except the secret
276
data is in an external file. The contents of the file
277
should <emphasis>not</emphasis> be base64-encoded, but
278
will be sent to clients verbatim.
281
File names of the form <filename>~user/foo/bar</filename>
282
and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
289
199
<term><option>secret<literal> = </literal><replaceable
290
200
>BASE64_ENCODED_DATA</replaceable></option></term>
319
<term><option>timeout<literal> = </literal><replaceable
320
>TIME</replaceable></option></term>
229
<term><option>secfile<literal> = </literal><replaceable
230
>FILENAME</replaceable></option></term>
323
This option is <emphasis>optional</emphasis>.
326
The timeout is how long the server will wait, after a
327
successful checker run, until a client is disabled and not
328
allowed to get the data this server holds. By default
329
Mandos will use 5 minutes. See also the
330
<option>extended_timeout</option> option.
333
The <replaceable>TIME</replaceable> is specified as a
334
space-separated number of values, each of which is a
335
number and a one-character suffix. The suffix must be one
336
of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
337
<quote>h</quote>, and <quote>w</quote> for days, seconds,
338
minutes, hours, and weeks, respectively. The values are
339
added together to give the total time value, so all of
340
<quote><literal>330s</literal></quote>,
341
<quote><literal>110s 110s 110s</literal></quote>, and
342
<quote><literal>5m 30s</literal></quote> will give a value
343
of five minutes and thirty seconds.
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.
349
<term><option>enabled<literal> = </literal>{ <literal
350
>1</literal> | <literal>yes</literal> | <literal>true</literal
351
> | <literal >on</literal> | <literal>0</literal> | <literal
352
>no</literal> | <literal>false</literal> | <literal
353
>off</literal> }</option></term>
247
<term><option><literal>host = </literal><replaceable
248
>STRING</replaceable></option></term>
356
Whether this client should be enabled by default. The
357
default is <quote>true</quote>.
251
This option is <emphasis>optional</emphasis>, but highly
252
<emphasis>recommended</emphasis> unless the
253
<option>checker</option> option is modified to a
254
non-standard value without <quote>%(host)s</quote> in it.
257
Host name for this client. This is not used by the server
258
directly, but can be, and is by default, used by the
259
checker. See the <option>checker</option> option.
397
299
<quote><literal>%%(<replaceable>foo</replaceable>)s</literal
398
300
></quote> will be replaced by the value of the attribute
399
301
<varname>foo</varname> of the internal
400
<quote><classname>Client</classname></quote> object in the
401
Mandos server. The currently allowed values for
402
<replaceable>foo</replaceable> are:
403
<quote><literal>approval_delay</literal></quote>,
404
<quote><literal>approval_duration</literal></quote>,
405
<quote><literal>created</literal></quote>,
406
<quote><literal>enabled</literal></quote>,
407
<quote><literal>fingerprint</literal></quote>,
408
<quote><literal>host</literal></quote>,
409
<quote><literal>interval</literal></quote>,
410
<quote><literal>last_approval_request</literal></quote>,
411
<quote><literal>last_checked_ok</literal></quote>,
412
<quote><literal>last_enabled</literal></quote>,
413
<quote><literal>name</literal></quote>,
414
<quote><literal>timeout</literal></quote>, and, if using
415
D-Bus, <quote><literal>dbus_object_path</literal></quote>.
416
See the source code for details. <emphasis role="strong"
417
>Currently, <emphasis>none</emphasis> of these attributes
418
except <quote><literal>host</literal></quote> are guaranteed
419
to be valid in future versions.</emphasis> Therefore, please
420
let the authors know of any attributes that are useful so they
421
may be preserved to any new versions of this software.
302
<quote><classname>Client</classname></quote> object. See the
303
source code for details, and let the authors know of any
304
attributes that are useful so they may be preserved to any new
305
versions of this software.
424
308
Note that this means that, in order to include an actual
added
removed
mandos-clients.conf.xml
