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-09-19">
6
<!ENTITY TIMESTAMP "2015-07-20">
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
69
><refentrytitle>mandos</refentrytitle>
66
70
<manvolnum>8</manvolnum></citerefentry>, read by it at startup.
67
71
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.
72
the service. The settings in this file can be overridden by
73
runtime changes to the server, which it saves across restarts.
74
(See the section called <quote>PERSISTENT STATE</quote> in
75
<citerefentry><refentrytitle>mandos</refentrytitle><manvolnum
76
>8</manvolnum></citerefentry>.) However, any <emphasis
77
>changes</emphasis> to this file (including adding and removing
78
clients) will, at startup, override changes done during runtime.
72
81
The format starts with a <literal>[<replaceable>section
112
121
How long to wait for external approval before resorting to
113
122
use the <option>approved_by_default</option> value. The
114
default is <quote>0s</quote>, i.e. not to wait.
123
default is <quote>PT0S</quote>, i.e. not to wait.
117
126
The format of <replaceable>TIME</replaceable> is the same
161
170
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>
173
This option overrides the default shell command that the
174
server will use to check if the client is still up. Any
175
output of the command will be ignored, only the exit code
176
is checked: If the exit code of the command is zero, the
177
client is considered up. The command will be run using
178
<quote><command><filename>/bin/sh</filename>
170
179
<option>-c</option></command></quote>, so
171
180
<varname>PATH</varname> will be searched. The default
172
181
value for the checker command is <quote><literal
173
182
><command>fping</command> <option>-q</option> <option
174
>--</option> %%(host)s</literal></quote>.
183
>--</option> %%(host)s</literal></quote>. Note that
184
<command>mandos-keygen</command>, when generating output
185
to be inserted into this file, normally looks for an SSH
186
server on the Mandos client, and, if it find one, outputs
187
a <option>checker</option> option to check for the
188
client’s key fingerprint – this is more secure against
177
192
In addition to normal start time expansion, this option
192
207
Extended timeout is an added timeout that is given once
193
after a password has been sent sucessfully to a client.
208
after a password has been sent successfully to a client.
194
209
The timeout is by default longer than the normal timeout,
195
210
and is used for handling the extra long downtime while a
196
211
machine is booting up. Time to take into consideration
322
337
This option is <emphasis>optional</emphasis>.
325
The timeout is how long the server will wait (for either a
326
successful checker run or a client receiving its secret)
327
until a client is disabled and not allowed to get the data
328
this server holds. By default Mandos will use 5 minutes.
331
The <replaceable>TIME</replaceable> is specified as a
332
space-separated number of values, each of which is a
333
number and a one-character suffix. The suffix must be one
334
of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
335
<quote>h</quote>, and <quote>w</quote> for days, seconds,
336
minutes, hours, and weeks, respectively. The values are
337
added together to give the total time value, so all of
338
<quote><literal>330s</literal></quote>,
339
<quote><literal>110s 110s 110s</literal></quote>, and
340
<quote><literal>5m 30s</literal></quote> will give a value
341
of five minutes and thirty seconds.
340
The timeout is how long the server will wait, after a
341
successful checker run, until a client is disabled and not
342
allowed to get the data this server holds. By default
343
Mandos will use 5 minutes. See also the
344
<option>extended_timeout</option> option.
347
The <replaceable>TIME</replaceable> is specified as an RFC
348
3339 duration; for example
349
<quote><literal>P1Y2M3DT4H5M6S</literal></quote> meaning
350
one year, two months, three days, four hours, five
351
minutes, and six seconds. Some values can be omitted, see
352
RFC 3339 Appendix A for details.
358
<term><option>enabled<literal> = </literal>{ <literal
359
>1</literal> | <literal>yes</literal> | <literal>true</literal
360
> | <literal >on</literal> | <literal>0</literal> | <literal
361
>no</literal> | <literal>false</literal> | <literal
362
>off</literal> }</option></term>
365
Whether this client should be enabled by default. The
366
default is <quote>true</quote>.
388
413
<quote><literal>approval_duration</literal></quote>,
389
414
<quote><literal>created</literal></quote>,
390
415
<quote><literal>enabled</literal></quote>,
416
<quote><literal>expires</literal></quote>,
391
417
<quote><literal>fingerprint</literal></quote>,
392
418
<quote><literal>host</literal></quote>,
393
419
<quote><literal>interval</literal></quote>,
490
516
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
491
517
<manvolnum>5</manvolnum></citerefentry>,
492
518
<citerefentry><refentrytitle>mandos</refentrytitle>
519
<manvolnum>8</manvolnum></citerefentry>,
520
<citerefentry><refentrytitle>fping</refentrytitle>
493
521
<manvolnum>8</manvolnum></citerefentry>
526
RFC 3339: <citetitle>Date and Time on the Internet:
527
Timestamps</citetitle>
531
The time intervals are in the "duration" format, as
532
specified in ABNF in Appendix A of RFC 3339.
497
539
<!-- Local Variables: -->
added
removed
mandos-clients.conf.xml
