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 "2010-09-26">
6
<!ENTITY TIMESTAMP "2016-06-23">
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>
64
70
><refentrytitle>mandos</refentrytitle>
65
71
<manvolnum>8</manvolnum></citerefentry>, read by it at startup.
66
72
The file needs to list all clients that should be able to use
67
the service. All clients listed will be regarded as enabled,
68
even if a client was disabled in a previous run of the server.
73
the service. The settings in this file can be overridden by
74
runtime changes to the server, which it saves across restarts.
75
(See the section called <quote>PERSISTENT STATE</quote> in
76
<citerefentry><refentrytitle>mandos</refentrytitle><manvolnum
77
>8</manvolnum></citerefentry>.) However, any <emphasis
78
>changes</emphasis> to this file (including adding and removing
79
clients) will, at startup, override changes done during runtime.
71
82
The format starts with a <literal>[<replaceable>section
111
122
How long to wait for external approval before resorting to
112
123
use the <option>approved_by_default</option> value. The
113
default is <quote>0s</quote>, i.e. not to wait.
124
default is <quote>PT0S</quote>, i.e. not to wait.
116
127
The format of <replaceable>TIME</replaceable> is the same
160
171
This option is <emphasis>optional</emphasis>.
163
This option allows you to override the default shell
164
command that the server will use to check if the client is
165
still up. Any output of the command will be ignored, only
166
the exit code is checked: If the exit code of the command
167
is zero, the client is considered up. The command will be
168
run using <quote><command><filename>/bin/sh</filename>
174
This option overrides the default shell command that the
175
server will use to check if the client is still up. Any
176
output of the command will be ignored, only the exit code
177
is checked: If the exit code of the command is zero, the
178
client is considered up. The command will be run using
179
<quote><command><filename>/bin/sh</filename>
169
180
<option>-c</option></command></quote>, so
170
181
<varname>PATH</varname> will be searched. The default
171
182
value for the checker command is <quote><literal
172
183
><command>fping</command> <option>-q</option> <option
173
>--</option> %%(host)s</literal></quote>.
184
>--</option> %%(host)s</literal></quote>. Note that
185
<command>mandos-keygen</command>, when generating output
186
to be inserted into this file, normally looks for an SSH
187
server on the Mandos client, and, if it find one, outputs
188
a <option>checker</option> option to check for the
189
client’s key fingerprint – this is more secure against
176
193
In addition to normal start time expansion, this option
201
<term><option>extended_timeout<literal> = </literal><replaceable
202
>TIME</replaceable></option></term>
205
This option is <emphasis>optional</emphasis>.
208
Extended timeout is an added timeout that is given once
209
after a password has been sent successfully to a client.
210
The timeout is by default longer than the normal timeout,
211
and is used for handling the extra long downtime while a
212
machine is booting up. Time to take into consideration
213
when changing this value is file system checks and quota
214
checks. The default value is 15 minutes.
217
The format of <replaceable>TIME</replaceable> is the same
218
as for <varname>timeout</varname> below.
184
224
<term><option>fingerprint<literal> = </literal
185
225
><replaceable>HEXSTRING</replaceable></option></term>
191
231
This option sets the OpenPGP fingerprint that identifies
192
232
the public key that clients authenticate themselves with
193
through TLS. The string needs to be in hexidecimal form,
233
through TLS. The string needs to be in hexadecimal form,
194
234
but spaces or upper/lower case are not significant.
228
268
will wait for a checker to complete until the below
229
269
<quote><varname>timeout</varname></quote> occurs, at which
230
270
time the client will be disabled, and any running checker
231
killed. The default interval is 5 minutes.
271
killed. The default interval is 2 minutes.
234
274
The format of <replaceable>TIME</replaceable> is the same
298
338
This option is <emphasis>optional</emphasis>.
301
The timeout is how long the server will wait (for either a
302
successful checker run or a client receiving its secret)
303
until a client is disabled and not allowed to get the data
304
this server holds. By default Mandos will use 1 hour.
307
The <replaceable>TIME</replaceable> is specified as a
308
space-separated number of values, each of which is a
309
number and a one-character suffix. The suffix must be one
310
of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
311
<quote>h</quote>, and <quote>w</quote> for days, seconds,
312
minutes, hours, and weeks, respectively. The values are
313
added together to give the total time value, so all of
314
<quote><literal>330s</literal></quote>,
315
<quote><literal>110s 110s 110s</literal></quote>, and
316
<quote><literal>5m 30s</literal></quote> will give a value
317
of five minutes and thirty seconds.
341
The timeout is how long the server will wait, after a
342
successful checker run, until a client is disabled and not
343
allowed to get the data this server holds. By default
344
Mandos will use 5 minutes. See also the
345
<option>extended_timeout</option> option.
348
The <replaceable>TIME</replaceable> is specified as an RFC
349
3339 duration; for example
350
<quote><literal>P1Y2M3DT4H5M6S</literal></quote> meaning
351
one year, two months, three days, four hours, five
352
minutes, and six seconds. Some values can be omitted, see
353
RFC 3339 Appendix A for details.
359
<term><option>enabled<literal> = </literal>{ <literal
360
>1</literal> | <literal>yes</literal> | <literal>true</literal
361
> | <literal >on</literal> | <literal>0</literal> | <literal
362
>no</literal> | <literal>false</literal> | <literal
363
>off</literal> }</option></term>
366
Whether this client should be enabled by default. The
367
default is <quote>true</quote>.
357
407
<quote><literal>%%(<replaceable>foo</replaceable>)s</literal
358
408
></quote> will be replaced by the value of the attribute
359
409
<varname>foo</varname> of the internal
360
<quote><classname>Client</classname></quote> object. See the
361
source code for details, and let the authors know of any
362
attributes that are useful so they may be preserved to any new
363
versions of this software.
410
<quote><classname>Client</classname></quote> object in the
411
Mandos server. The currently allowed values for
412
<replaceable>foo</replaceable> are:
413
<quote><literal>approval_delay</literal></quote>,
414
<quote><literal>approval_duration</literal></quote>,
415
<quote><literal>created</literal></quote>,
416
<quote><literal>enabled</literal></quote>,
417
<quote><literal>expires</literal></quote>,
418
<quote><literal>fingerprint</literal></quote>,
419
<quote><literal>host</literal></quote>,
420
<quote><literal>interval</literal></quote>,
421
<quote><literal>last_approval_request</literal></quote>,
422
<quote><literal>last_checked_ok</literal></quote>,
423
<quote><literal>last_enabled</literal></quote>,
424
<quote><literal>name</literal></quote>,
425
<quote><literal>timeout</literal></quote>, and, if using
426
D-Bus, <quote><literal>dbus_object_path</literal></quote>.
427
See the source code for details. <emphasis role="strong"
428
>Currently, <emphasis>none</emphasis> of these attributes
429
except <quote><literal>host</literal></quote> are guaranteed
430
to be valid in future versions.</emphasis> Therefore, please
431
let the authors know of any attributes that are useful so they
432
may be preserved to any new versions of this software.
366
435
Note that this means that, in order to include an actual
441
511
<refsect1 id="see_also">
442
512
<title>SEE ALSO</title>
514
<citerefentry><refentrytitle>intro</refentrytitle>
515
<manvolnum>8mandos</manvolnum></citerefentry>,
444
516
<citerefentry><refentrytitle>mandos-keygen</refentrytitle>
445
517
<manvolnum>8</manvolnum></citerefentry>,
446
518
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
447
519
<manvolnum>5</manvolnum></citerefentry>,
448
520
<citerefentry><refentrytitle>mandos</refentrytitle>
521
<manvolnum>8</manvolnum></citerefentry>,
522
<citerefentry><refentrytitle>fping</refentrytitle>
449
523
<manvolnum>8</manvolnum></citerefentry>
528
RFC 3339: <citetitle>Date and Time on the Internet:
529
Timestamps</citetitle>
533
The time intervals are in the "duration" format, as
534
specified in ABNF in Appendix A of RFC 3339.
453
541
<!-- Local Variables: -->
added
removed
mandos-clients.conf.xml
