3
3
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
4
<!ENTITY CONFNAME "mandos-clients.conf">
5
5
<!ENTITY CONFPATH "<filename>/etc/mandos/clients.conf</filename>">
6
<!ENTITY TIMESTAMP "2011-02-27">
6
<!ENTITY TIMESTAMP "2013-10-15">
7
7
<!ENTITY % common SYSTEM "common.ent">
20
20
<firstname>Björn</firstname>
21
21
<surname>Påhlsson</surname>
23
<email>belorn@fukt.bsnet.se</email>
23
<email>belorn@recompile.se</email>
27
27
<firstname>Teddy</firstname>
28
28
<surname>Hogeborn</surname>
30
<email>teddy@fukt.bsnet.se</email>
30
<email>teddy@recompile.se</email>
65
66
><refentrytitle>mandos</refentrytitle>
66
67
<manvolnum>8</manvolnum></citerefentry>, read by it at startup.
67
68
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.
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.
72
78
The format starts with a <literal>[<replaceable>section
112
118
How long to wait for external approval before resorting to
113
119
use the <option>approved_by_default</option> value. The
114
default is <quote>0s</quote>, i.e. not to wait.
120
default is <quote>PT0S</quote>, i.e. not to wait.
117
123
The format of <replaceable>TIME</replaceable> is the same
161
167
This option is <emphasis>optional</emphasis>.
164
This option allows you to override the default shell
165
command that the server will use to check if the client is
166
still up. Any output of the command will be ignored, only
167
the exit code is checked: If the exit code of the command
168
is zero, the client is considered up. The command will be
169
run using <quote><command><filename>/bin/sh</filename>
170
This option overrides the default shell command that the
171
server will use to check if the client is still up. Any
172
output of the command will be ignored, only the exit code
173
is checked: If the exit code of the command is zero, the
174
client is considered up. The command will be run using
175
<quote><command><filename>/bin/sh</filename>
170
176
<option>-c</option></command></quote>, so
171
177
<varname>PATH</varname> will be searched. The default
172
178
value for the checker command is <quote><literal
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.
185
214
<term><option>fingerprint<literal> = </literal
186
215
><replaceable>HEXSTRING</replaceable></option></term>
229
258
will wait for a checker to complete until the below
230
259
<quote><varname>timeout</varname></quote> occurs, at which
231
260
time the client will be disabled, and any running checker
232
killed. The default interval is 5 minutes.
261
killed. The default interval is 2 minutes.
235
264
The format of <replaceable>TIME</replaceable> is the same
299
328
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.
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 an RFC
339
3339 duration; for example
340
<quote><literal>P1Y2M3DT4H5M6S</literal></quote> meaning
341
one year, two months, three days, four hours, five
342
minutes, and six seconds. Some values can be omitted, see
343
RFC 3339 Appendix A for details.
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>
356
Whether this client should be enabled by default. The
357
default is <quote>true</quote>.
365
404
<quote><literal>approval_duration</literal></quote>,
366
405
<quote><literal>created</literal></quote>,
367
406
<quote><literal>enabled</literal></quote>,
407
<quote><literal>expires</literal></quote>,
368
408
<quote><literal>fingerprint</literal></quote>,
369
409
<quote><literal>host</literal></quote>,
370
410
<quote><literal>interval</literal></quote>,
460
500
<refsect1 id="see_also">
461
501
<title>SEE ALSO</title>
503
<citerefentry><refentrytitle>intro</refentrytitle>
504
<manvolnum>8mandos</manvolnum></citerefentry>,
463
505
<citerefentry><refentrytitle>mandos-keygen</refentrytitle>
464
506
<manvolnum>8</manvolnum></citerefentry>,
465
507
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
466
508
<manvolnum>5</manvolnum></citerefentry>,
467
509
<citerefentry><refentrytitle>mandos</refentrytitle>
510
<manvolnum>8</manvolnum></citerefentry>,
511
<citerefentry><refentrytitle>fping</refentrytitle>
468
512
<manvolnum>8</manvolnum></citerefentry>
517
RFC 3339: <citetitle>Date and Time on the Internet:
518
Timestamps</citetitle>
522
The time intervals are in the "duration" format, as
523
specified in ABNF in Appendix A of RFC 3339.
472
530
<!-- Local Variables: -->
added
removed
mandos-clients.conf.xml
