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 "2014-06-22">
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
173
179
><command>fping</command> <option>-q</option> <option
174
>--</option> %%(host)s</literal></quote>.
180
>--</option> %%(host)s</literal></quote>. Note that
181
<command>mandos-keygen</command>, when generating output
182
to be inserted into this file, normally looks for an SSH
183
server on the Mandos client, and, if it find one, outputs
184
a <option>checker</option> option to check for the
185
client’s key fingerprint – this is more secure against
177
189
In addition to normal start time expansion, this option
197
<term><option>extended_timeout<literal> = </literal><replaceable
198
>TIME</replaceable></option></term>
201
This option is <emphasis>optional</emphasis>.
204
Extended timeout is an added timeout that is given once
205
after a password has been sent successfully to a client.
206
The timeout is by default longer than the normal timeout,
207
and is used for handling the extra long downtime while a
208
machine is booting up. Time to take into consideration
209
when changing this value is file system checks and quota
210
checks. The default value is 15 minutes.
213
The format of <replaceable>TIME</replaceable> is the same
214
as for <varname>timeout</varname> below.
185
220
<term><option>fingerprint<literal> = </literal
186
221
><replaceable>HEXSTRING</replaceable></option></term>
229
264
will wait for a checker to complete until the below
230
265
<quote><varname>timeout</varname></quote> occurs, at which
231
266
time the client will be disabled, and any running checker
232
killed. The default interval is 5 minutes.
267
killed. The default interval is 2 minutes.
235
270
The format of <replaceable>TIME</replaceable> is the same
299
334
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.
337
The timeout is how long the server will wait, after a
338
successful checker run, until a client is disabled and not
339
allowed to get the data this server holds. By default
340
Mandos will use 5 minutes. See also the
341
<option>extended_timeout</option> option.
344
The <replaceable>TIME</replaceable> is specified as an RFC
345
3339 duration; for example
346
<quote><literal>P1Y2M3DT4H5M6S</literal></quote> meaning
347
one year, two months, three days, four hours, five
348
minutes, and six seconds. Some values can be omitted, see
349
RFC 3339 Appendix A for details.
355
<term><option>enabled<literal> = </literal>{ <literal
356
>1</literal> | <literal>yes</literal> | <literal>true</literal
357
> | <literal >on</literal> | <literal>0</literal> | <literal
358
>no</literal> | <literal>false</literal> | <literal
359
>off</literal> }</option></term>
362
Whether this client should be enabled by default. The
363
default is <quote>true</quote>.
365
410
<quote><literal>approval_duration</literal></quote>,
366
411
<quote><literal>created</literal></quote>,
367
412
<quote><literal>enabled</literal></quote>,
413
<quote><literal>expires</literal></quote>,
368
414
<quote><literal>fingerprint</literal></quote>,
369
415
<quote><literal>host</literal></quote>,
370
416
<quote><literal>interval</literal></quote>,
460
506
<refsect1 id="see_also">
461
507
<title>SEE ALSO</title>
509
<citerefentry><refentrytitle>intro</refentrytitle>
510
<manvolnum>8mandos</manvolnum></citerefentry>,
463
511
<citerefentry><refentrytitle>mandos-keygen</refentrytitle>
464
512
<manvolnum>8</manvolnum></citerefentry>,
465
513
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
466
514
<manvolnum>5</manvolnum></citerefentry>,
467
515
<citerefentry><refentrytitle>mandos</refentrytitle>
516
<manvolnum>8</manvolnum></citerefentry>,
517
<citerefentry><refentrytitle>fping</refentrytitle>
468
518
<manvolnum>8</manvolnum></citerefentry>
523
RFC 3339: <citetitle>Date and Time on the Internet:
524
Timestamps</citetitle>
528
The time intervals are in the "duration" format, as
529
specified in ABNF in Appendix A of RFC 3339.
472
536
<!-- Local Variables: -->
added
removed
mandos-clients.conf.xml
