62
63
><refentrytitle>mandos</refentrytitle>
63
64
<manvolnum>8</manvolnum></citerefentry>, read by it at startup.
64
65
The file needs to list all clients that should be able to use
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
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
70
The format starts with a <literal>[<replaceable>section
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.
103
<term><option>approval_delay<literal> = </literal><replaceable
104
>TIME</replaceable></option></term>
107
This option is <emphasis>optional</emphasis>.
110
How long to wait for external approval before resorting to
111
use the <option>approved_by_default</option> value. The
112
default is <quote>0s</quote>, i.e. not to wait.
115
The format of <replaceable>TIME</replaceable> is the same
116
as for <varname>timeout</varname> below.
122
<term><option>approval_duration<literal> = </literal
123
><replaceable>TIME</replaceable></option></term>
126
This option is <emphasis>optional</emphasis>.
129
How long an external approval lasts. The default is 1
133
The format of <replaceable>TIME</replaceable> is the same
134
as for <varname>timeout</varname> below.
140
<term><option>approved_by_default<literal> = </literal
141
>{ <literal >1</literal> | <literal>yes</literal> | <literal
142
>true</literal> | <literal>on</literal> | <literal
143
>0</literal> | <literal>no</literal> | <literal
144
>false</literal> | <literal>off</literal> }</option></term>
147
Whether to approve a client by default after
148
the <option>approval_delay</option>. The default
149
is <quote>True</quote>.
199
<term><option><literal>host = </literal><replaceable
200
>STRING</replaceable></option></term>
203
This option is <emphasis>optional</emphasis>, but highly
204
<emphasis>recommended</emphasis> unless the
205
<option>checker</option> option is modified to a
206
non-standard value without <quote>%%(host)s</quote> in it.
209
Host name for this client. This is not used by the server
210
directly, but can be, and is by default, used by the
211
checker. See the <option>checker</option> option.
217
<term><option>interval<literal> = </literal><replaceable
218
>TIME</replaceable></option></term>
221
This option is <emphasis>optional</emphasis>.
224
How often to run the checker to confirm that a client is
225
still up. <emphasis>Note:</emphasis> a new checker will
226
not be started if an old one is still running. The server
227
will wait for a checker to complete until the below
228
<quote><varname>timeout</varname></quote> occurs, at which
229
time the client will be disabled, and any running checker
230
killed. The default interval is 5 minutes.
233
The format of <replaceable>TIME</replaceable> is the same
234
as for <varname>timeout</varname> below.
240
<term><option>secfile<literal> = </literal><replaceable
241
>FILENAME</replaceable></option></term>
244
This option is only used if <option>secret</option> is not
245
specified, in which case this option is
246
<emphasis>required</emphasis>.
249
Similar to the <option>secret</option>, except the secret
250
data is in an external file. The contents of the file
251
should <emphasis>not</emphasis> be base64-encoded, but
252
will be sent to clients verbatim.
255
File names of the form <filename>~user/foo/bar</filename>
256
and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
199
263
<term><option>secret<literal> = </literal><replaceable
200
264
>BASE64_ENCODED_DATA</replaceable></option></term>
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.
247
<term><option><literal>host = </literal><replaceable
248
>STRING</replaceable></option></term>
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.
293
<term><option>timeout<literal> = </literal><replaceable
294
>TIME</replaceable></option></term>
297
This option is <emphasis>optional</emphasis>.
300
The timeout is how long the server will wait (for either a
301
successful checker run or a client receiving its secret)
302
until a client is disabled and not allowed to get the data
303
this server holds. By default Mandos will use 1 hour.
306
The <replaceable>TIME</replaceable> is specified as a
307
space-separated number of values, each of which is a
308
number and a one-character suffix. The suffix must be one
309
of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
310
<quote>h</quote>, and <quote>w</quote> for days, seconds,
311
minutes, hours, and weeks, respectively. The values are
312
added together to give the total time value, so all of
313
<quote><literal>330s</literal></quote>,
314
<quote><literal>110s 110s 110s</literal></quote>, and
315
<quote><literal>5m 30s</literal></quote> will give a value
316
of five minutes and thirty seconds.
added
removed
mandos-clients.conf.xml
