65
63
><refentrytitle>mandos</refentrytitle>
66
64
<manvolnum>8</manvolnum></citerefentry>, read by it at startup.
67
65
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.
66
the service. All clients listed will be regarded as valid, even
67
if a client was declared invalid in a previous run of the
72
71
The format starts with a <literal>[<replaceable>section
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>.
104
<term><option>timeout<literal> = </literal><replaceable
105
>TIME</replaceable></option></term>
108
This option is <emphasis>optional</emphasis>.
111
The timeout is how long the server will wait for a
112
successful checker run until a client is considered
113
invalid - that is, ineligible to get the data this server
114
holds. By default Mandos will use 1 hour.
117
The <replaceable>TIME</replaceable> is specified as a
118
space-separated number of values, each of which is a
119
number and a one-character suffix. The suffix must be one
120
of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
121
<quote>h</quote>, and <quote>w</quote> for days, seconds,
122
minutes, hours, and weeks, respectively. The values are
123
added together to give the total time value, so all of
124
<quote><literal>330s</literal></quote>,
125
<quote><literal>110s 110s 110s</literal></quote>, and
126
<quote><literal>5m 30s</literal></quote> will give a value
127
of five minutes and thirty seconds.
133
<term><option>interval<literal> = </literal><replaceable
134
>TIME</replaceable></option></term>
137
This option is <emphasis>optional</emphasis>.
140
How often to run the checker to confirm that a client is
141
still up. <emphasis>Note:</emphasis> a new checker will
142
not be started if an old one is still running. The server
143
will wait for a checker to complete until the above
144
<quote><varname>timeout</varname></quote> occurs, at which
145
time the client will be marked invalid, and any running
146
checker killed. The default interval is 5 minutes.
149
The format of <replaceable>TIME</replaceable> is the same
150
as for <varname>timeout</varname> above.
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
200
<term><option>secret<literal> = </literal><replaceable
266
201
>BASE64_ENCODED_DATA</replaceable></option></term>
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.
308
The <replaceable>TIME</replaceable> is specified as a
309
space-separated number of values, each of which is a
310
number and a one-character suffix. The suffix must be one
311
of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
312
<quote>h</quote>, and <quote>w</quote> for days, seconds,
313
minutes, hours, and weeks, respectively. The values are
314
added together to give the total time value, so all of
315
<quote><literal>330s</literal></quote>,
316
<quote><literal>110s 110s 110s</literal></quote>, and
317
<quote><literal>5m 30s</literal></quote> will give a value
318
of five minutes and thirty seconds.
230
<term><option>secfile<literal> = </literal><replaceable
231
>FILENAME</replaceable></option></term>
234
This option is only used if <option>secret</option> is not
235
specified, in which case this option is
236
<emphasis>required</emphasis>.
239
Similar to the <option>secret</option>, except the secret
240
data is in an external file. The contents of the file
241
should <emphasis>not</emphasis> be base64-encoded, but
242
will be sent to clients verbatim.
245
File names of the form <filename>~user/foo/bar</filename>
246
and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
253
<term><option><literal>host = </literal><replaceable
254
>STRING</replaceable></option></term>
257
This option is <emphasis>optional</emphasis>, but highly
258
<emphasis>recommended</emphasis> unless the
259
<option>checker</option> option is modified to a
260
non-standard value without <quote>%(host)s</quote> in it.
263
Host name for this client. This is not used by the server
264
directly, but can be, and is by default, used by the
265
checker. See the <option>checker</option> option.
358
305
<quote><literal>%%(<replaceable>foo</replaceable>)s</literal
359
306
></quote> will be replaced by the value of the attribute
360
307
<varname>foo</varname> of the internal
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.
308
<quote><classname>Client</classname></quote> object. See the
309
source code for details, and let the authors know of any
310
attributes that are useful so they may be preserved to any new
311
versions of this software.
385
314
Note that this means that, in order to include an actual
added
removed
mandos-clients.conf.xml
