12
13
<title>Mandos Manual</title>
13
14
<!-- NWalsh’s docbook scripts use this to generate the footer: -->
14
15
<productname>Mandos</productname>
15
<productnumber>&VERSION;</productnumber>
16
<productnumber>&version;</productnumber>
16
17
<date>&TIMESTAMP;</date>
19
20
<firstname>Björn</firstname>
20
21
<surname>Påhlsson</surname>
22
<email>belorn@fukt.bsnet.se</email>
23
<email>belorn@recompile.se</email>
26
27
<firstname>Teddy</firstname>
27
28
<surname>Hogeborn</surname>
29
<email>teddy@fukt.bsnet.se</email>
30
<email>teddy@recompile.se</email>
35
40
<holder>Teddy Hogeborn</holder>
36
41
<holder>Björn Påhlsson</holder>
38
43
<xi:include href="legalnotice.xml"/>
42
47
<refentrytitle>&CONFNAME;</refentrytitle>
43
48
<manvolnum>5</manvolnum>
61
66
><refentrytitle>mandos</refentrytitle>
62
67
<manvolnum>8</manvolnum></citerefentry>, read by it at startup.
63
68
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
69
the service. The settings in this file can be overridden by
70
runtime changes to the server, which it saves across restarts.
71
(See the section called <quote>PERSISTENT STATE</quote> in
72
<citerefentry><refentrytitle>mandos</refentrytitle><manvolnum
73
>8</manvolnum></citerefentry>.) However, any <emphasis
74
>changes</emphasis> to this file (including adding and removing
75
clients) will, at startup, override changes done during runtime.
69
78
The format starts with a <literal>[<replaceable>section
96
105
Unknown options are ignored. The used options are as follows:
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.
111
<term><option>approval_delay<literal> = </literal><replaceable
112
>TIME</replaceable></option></term>
115
This option is <emphasis>optional</emphasis>.
118
How long to wait for external approval before resorting to
119
use the <option>approved_by_default</option> value. The
120
default is <quote>0s</quote>, i.e. not to wait.
123
The format of <replaceable>TIME</replaceable> is the same
124
as for <varname>timeout</varname> below.
130
<term><option>approval_duration<literal> = </literal
131
><replaceable>TIME</replaceable></option></term>
134
This option is <emphasis>optional</emphasis>.
137
How long an external approval lasts. The default is 1
141
The format of <replaceable>TIME</replaceable> is the same
142
as for <varname>timeout</varname> below.
148
<term><option>approved_by_default<literal> = </literal
149
>{ <literal >1</literal> | <literal>yes</literal> | <literal
150
>true</literal> | <literal>on</literal> | <literal
151
>0</literal> | <literal>no</literal> | <literal
152
>false</literal> | <literal>off</literal> }</option></term>
155
Whether to approve a client by default after
156
the <option>approval_delay</option>. The default
157
is <quote>True</quote>.
154
163
<term><option>checker<literal> = </literal><replaceable
155
164
>COMMAND</replaceable></option></term>
191
<term><option>extended_timeout<literal> = </literal><replaceable
192
>TIME</replaceable></option></term>
195
This option is <emphasis>optional</emphasis>.
198
Extended timeout is an added timeout that is given once
199
after a password has been sent successfully to a client.
200
The timeout is by default longer than the normal timeout,
201
and is used for handling the extra long downtime while a
202
machine is booting up. Time to take into consideration
203
when changing this value is file system checks and quota
204
checks. The default value is 15 minutes.
207
The format of <replaceable>TIME</replaceable> is the same
208
as for <varname>timeout</varname> below.
182
214
<term><option>fingerprint<literal> = </literal
183
215
><replaceable>HEXSTRING</replaceable></option></term>
230
<term><option><literal>host = </literal><replaceable
231
>STRING</replaceable></option></term>
234
This option is <emphasis>optional</emphasis>, but highly
235
<emphasis>recommended</emphasis> unless the
236
<option>checker</option> option is modified to a
237
non-standard value without <quote>%%(host)s</quote> in it.
240
Host name for this client. This is not used by the server
241
directly, but can be, and is by default, used by the
242
checker. See the <option>checker</option> option.
248
<term><option>interval<literal> = </literal><replaceable
249
>TIME</replaceable></option></term>
252
This option is <emphasis>optional</emphasis>.
255
How often to run the checker to confirm that a client is
256
still up. <emphasis>Note:</emphasis> a new checker will
257
not be started if an old one is still running. The server
258
will wait for a checker to complete until the below
259
<quote><varname>timeout</varname></quote> occurs, at which
260
time the client will be disabled, and any running checker
261
killed. The default interval is 2 minutes.
264
The format of <replaceable>TIME</replaceable> is the same
265
as for <varname>timeout</varname> below.
271
<term><option>secfile<literal> = </literal><replaceable
272
>FILENAME</replaceable></option></term>
275
This option is only used if <option>secret</option> is not
276
specified, in which case this option is
277
<emphasis>required</emphasis>.
280
Similar to the <option>secret</option>, except the secret
281
data is in an external file. The contents of the file
282
should <emphasis>not</emphasis> be base64-encoded, but
283
will be sent to clients verbatim.
286
File names of the form <filename>~user/foo/bar</filename>
287
and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
198
294
<term><option>secret<literal> = </literal><replaceable
199
295
>BASE64_ENCODED_DATA</replaceable></option></term>
228
<term><option>secfile<literal> = </literal><replaceable
229
>FILENAME</replaceable></option></term>
324
<term><option>timeout<literal> = </literal><replaceable
325
>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.
328
This option is <emphasis>optional</emphasis>.
331
The timeout is how long the server will wait, after a
332
successful checker run, until a client is disabled and not
333
allowed to get the data this server holds. By default
334
Mandos will use 5 minutes. See also the
335
<option>extended_timeout</option> option.
338
The <replaceable>TIME</replaceable> is specified as a
339
space-separated number of values, each of which is a
340
number and a one-character suffix. The suffix must be one
341
of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
342
<quote>h</quote>, and <quote>w</quote> for days, seconds,
343
minutes, hours, and weeks, respectively. The values are
344
added together to give the total time value, so all of
345
<quote><literal>330s</literal></quote>,
346
<quote><literal>110s 110s 110s</literal></quote>, and
347
<quote><literal>5m 30s</literal></quote> will give a value
348
of five minutes and thirty seconds.
246
<term><option><literal>host = </literal><replaceable
247
>STRING</replaceable></option></term>
354
<term><option>enabled<literal> = </literal>{ <literal
355
>1</literal> | <literal>yes</literal> | <literal>true</literal
356
> | <literal >on</literal> | <literal>0</literal> | <literal
357
>no</literal> | <literal>false</literal> | <literal
358
>off</literal> }</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.
361
Whether this client should be enabled by default. The
362
default is <quote>true</quote>.
298
402
<quote><literal>%%(<replaceable>foo</replaceable>)s</literal
299
403
></quote> will be replaced by the value of the attribute
300
404
<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.
405
<quote><classname>Client</classname></quote> object in the
406
Mandos server. The currently allowed values for
407
<replaceable>foo</replaceable> are:
408
<quote><literal>approval_delay</literal></quote>,
409
<quote><literal>approval_duration</literal></quote>,
410
<quote><literal>created</literal></quote>,
411
<quote><literal>enabled</literal></quote>,
412
<quote><literal>fingerprint</literal></quote>,
413
<quote><literal>host</literal></quote>,
414
<quote><literal>interval</literal></quote>,
415
<quote><literal>last_approval_request</literal></quote>,
416
<quote><literal>last_checked_ok</literal></quote>,
417
<quote><literal>last_enabled</literal></quote>,
418
<quote><literal>name</literal></quote>,
419
<quote><literal>timeout</literal></quote>, and, if using
420
D-Bus, <quote><literal>dbus_object_path</literal></quote>.
421
See the source code for details. <emphasis role="strong"
422
>Currently, <emphasis>none</emphasis> of these attributes
423
except <quote><literal>host</literal></quote> are guaranteed
424
to be valid in future versions.</emphasis> Therefore, please
425
let the authors know of any attributes that are useful so they
426
may be preserved to any new versions of this software.
307
429
Note that this means that, in order to include an actual
added
removed
mandos-clients.conf.xml
