1
1
<?xml version="1.0" encoding="UTF-8"?>
2
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
3
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
<!ENTITY VERSION "1.0">
5
4
<!ENTITY CONFNAME "mandos-clients.conf">
6
5
<!ENTITY CONFPATH "<filename>/etc/mandos/clients.conf</filename>">
7
<!ENTITY TIMESTAMP "2008-09-12">
6
<!ENTITY TIMESTAMP "2011-08-08">
7
<!ENTITY % common SYSTEM "common.ent">
10
11
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
61
65
><refentrytitle>mandos</refentrytitle>
62
66
<manvolnum>8</manvolnum></citerefentry>, read by it at startup.
63
67
The file needs to list all clients that should be able to use
64
the service. All clients listed will be regarded as valid, even
65
if a client was declared invalid in a previous run of the
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.
69
72
The format starts with a <literal>[<replaceable>section
102
<term><option>timeout<literal> = </literal><replaceable
103
>TIME</replaceable></option></term>
106
This option is <emphasis>optional</emphasis>.
109
The timeout is how long the server will wait for a
110
successful checker run until a client is considered
111
invalid - that is, ineligible to get the data this server
112
holds. By default Mandos will use 1 hour.
115
The <replaceable>TIME</replaceable> is specified as a
116
space-separated number of values, each of which is a
117
number and a one-character suffix. The suffix must be one
118
of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
119
<quote>h</quote>, and <quote>w</quote> for days, seconds,
120
minutes, hours, and weeks, respectively. The values are
121
added together to give the total time value, so all of
122
<quote><literal>330s</literal></quote>,
123
<quote><literal>110s 110s 110s</literal></quote>, and
124
<quote><literal>5m 30s</literal></quote> will give a value
125
of five minutes and thirty seconds.
131
<term><option>interval<literal> = </literal><replaceable
132
>TIME</replaceable></option></term>
135
This option is <emphasis>optional</emphasis>.
138
How often to run the checker to confirm that a client is
139
still up. <emphasis>Note:</emphasis> a new checker will
140
not be started if an old one is still running. The server
141
will wait for a checker to complete until the above
142
<quote><varname>timeout</varname></quote> occurs, at which
143
time the client will be marked invalid, and any running
144
checker killed. The default interval is 5 minutes.
147
The format of <replaceable>TIME</replaceable> is the same
148
as for <varname>timeout</varname> above.
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>.
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 2 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>
198
265
<term><option>secret<literal> = </literal><replaceable
199
266
>BASE64_ENCODED_DATA</replaceable></option></term>
228
<term><option>secfile<literal> = </literal><replaceable
229
>FILENAME</replaceable></option></term>
295
<term><option>timeout<literal> = </literal><replaceable
296
>TIME</replaceable></option></term>
232
This option is only used if <option>secret</option> is not
233
specified, in which case this option is
234
<emphasis>required</emphasis>.
237
Similar to the <option>secret</option>, except the secret
238
data is in an external file. The contents of the file
239
should <emphasis>not</emphasis> be base64-encoded, but
240
will be sent to clients verbatim.
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 5 minutes.
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.
246
<term><option><literal>host = </literal><replaceable
247
>STRING</replaceable></option></term>
324
<term><option>extended_timeout<literal> = </literal><replaceable
325
>TIME</replaceable></option></term>
250
This option is <emphasis>optional</emphasis>, but highly
251
<emphasis>recommended</emphasis> unless the
252
<option>checker</option> option is modified to a
253
non-standard value without <quote>%(host)s</quote> in it.
256
Host name for this client. This is not used by the server
257
directly, but can be, and is by default, used by the
258
checker. See the <option>checker</option> option.
328
This option is <emphasis>optional</emphasis>.
331
Extended timeout is an added timeout that is given once
332
after a password has been sent sucessfully to a client.
333
The timeout is by default longer than the normal timeout,
334
and is used for handling the extra long downtime while a
335
matchine is booting up. Time to take into consideration
336
when changing this value is system file checks and quota
337
checks. The default value is 15 minutes.
340
The format of <replaceable>TIME</replaceable> is the same
341
as for <varname>timeout</varname> above.
298
381
<quote><literal>%%(<replaceable>foo</replaceable>)s</literal
299
382
></quote> will be replaced by the value of the attribute
300
383
<varname>foo</varname> of the internal
301
<quote><classname>Client</classname></quote> object. See the
302
source code for details, and let the authors know of any
303
attributes that are useful so they may be preserved to any new
304
versions of this software.
384
<quote><classname>Client</classname></quote> object in the
385
Mandos server. The currently allowed values for
386
<replaceable>foo</replaceable> are:
387
<quote><literal>approval_delay</literal></quote>,
388
<quote><literal>approval_duration</literal></quote>,
389
<quote><literal>created</literal></quote>,
390
<quote><literal>enabled</literal></quote>,
391
<quote><literal>fingerprint</literal></quote>,
392
<quote><literal>host</literal></quote>,
393
<quote><literal>interval</literal></quote>,
394
<quote><literal>last_approval_request</literal></quote>,
395
<quote><literal>last_checked_ok</literal></quote>,
396
<quote><literal>last_enabled</literal></quote>,
397
<quote><literal>name</literal></quote>,
398
<quote><literal>timeout</literal></quote>, and, if using
399
D-Bus, <quote><literal>dbus_object_path</literal></quote>.
400
See the source code for details. <emphasis role="strong"
401
>Currently, <emphasis>none</emphasis> of these attributes
402
except <quote><literal>host</literal></quote> are guaranteed
403
to be valid in future versions.</emphasis> Therefore, please
404
let the authors know of any attributes that are useful so they
405
may be preserved to any new versions of this software.
307
408
Note that this means that, in order to include an actual
added
removed
mandos-clients.conf.xml
