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 "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>
65
70
><refentrytitle>mandos</refentrytitle>
66
71
<manvolnum>8</manvolnum></citerefentry>, read by it at startup.
67
72
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.
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.
72
82
The format starts with a <literal>[<replaceable>section
112
122
How long to wait for external approval before resorting to
113
123
use the <option>approved_by_default</option> value. The
114
default is <quote>0s</quote>, i.e. not to wait.
124
default is <quote>PT0S</quote>, i.e. not to wait.
117
127
The format of <replaceable>TIME</replaceable> is the same
161
171
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>
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>
170
180
<option>-c</option></command></quote>, so
171
181
<varname>PATH</varname> will be searched. The default
172
182
value for the checker command is <quote><literal
173
183
><command>fping</command> <option>-q</option> <option
174
>--</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
177
193
In addition to normal start time expansion, this option
192
208
Extended timeout is an added timeout that is given once
193
after a password has been sent sucessfully to a client.
209
after a password has been sent successfully to a client.
194
210
The timeout is by default longer than the normal timeout,
195
211
and is used for handling the extra long downtime while a
196
212
machine is booting up. Time to take into consideration
215
231
This option sets the OpenPGP fingerprint that identifies
216
232
the public key that clients authenticate themselves with
217
through TLS. The string needs to be in hexidecimal form,
233
through TLS. The string needs to be in hexadecimal form,
218
234
but spaces or upper/lower case are not significant.
322
338
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.
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>.
388
414
<quote><literal>approval_duration</literal></quote>,
389
415
<quote><literal>created</literal></quote>,
390
416
<quote><literal>enabled</literal></quote>,
417
<quote><literal>expires</literal></quote>,
391
418
<quote><literal>fingerprint</literal></quote>,
392
419
<quote><literal>host</literal></quote>,
393
420
<quote><literal>interval</literal></quote>,
490
518
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
491
519
<manvolnum>5</manvolnum></citerefentry>,
492
520
<citerefentry><refentrytitle>mandos</refentrytitle>
521
<manvolnum>8</manvolnum></citerefentry>,
522
<citerefentry><refentrytitle>fping</refentrytitle>
493
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.
497
541
<!-- Local Variables: -->
added
removed
mandos-clients.conf.xml
