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 "2018-02-08">
6
<!ENTITY TIMESTAMP "2010-09-26">
7
7
<!ENTITY % common SYSTEM "common.ent">
20
20
<firstname>Björn</firstname>
21
21
<surname>Påhlsson</surname>
23
<email>belorn@recompile.se</email>
23
<email>belorn@fukt.bsnet.se</email>
27
27
<firstname>Teddy</firstname>
28
28
<surname>Hogeborn</surname>
30
<email>teddy@recompile.se</email>
30
<email>teddy@fukt.bsnet.se</email>
72
64
><refentrytitle>mandos</refentrytitle>
73
65
<manvolnum>8</manvolnum></citerefentry>, read by it at startup.
74
66
The file needs to list all clients that should be able to use
75
the service. The settings in this file can be overridden by
76
runtime changes to the server, which it saves across restarts.
77
(See the section called <quote>PERSISTENT STATE</quote> in
78
<citerefentry><refentrytitle>mandos</refentrytitle><manvolnum
79
>8</manvolnum></citerefentry>.) However, any <emphasis
80
>changes</emphasis> to this file (including adding and removing
81
clients) will, at startup, override changes done during runtime.
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.
84
71
The format starts with a <literal>[<replaceable>section
124
111
How long to wait for external approval before resorting to
125
112
use the <option>approved_by_default</option> value. The
126
default is <quote>PT0S</quote>, i.e. not to wait.
113
default is <quote>0s</quote>, i.e. not to wait.
129
116
The format of <replaceable>TIME</replaceable> is the same
173
160
This option is <emphasis>optional</emphasis>.
176
This option overrides the default shell command that the
177
server will use to check if the client is still up. Any
178
output of the command will be ignored, only the exit code
179
is checked: If the exit code of the command is zero, the
180
client is considered up. The command will be run using
181
<quote><command><filename>/bin/sh</filename>
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>
182
169
<option>-c</option></command></quote>, so
183
170
<varname>PATH</varname> will be searched. The default
184
171
value for the checker command is <quote><literal
185
172
><command>fping</command> <option>-q</option> <option
186
>--</option> %%(host)s</literal></quote>. Note that
187
<command>mandos-keygen</command>, when generating output
188
to be inserted into this file, normally looks for an SSH
189
server on the Mandos client, and, if it find one, outputs
190
a <option>checker</option> option to check for the
191
client’s key fingerprint – this is more secure against
173
>--</option> %%(host)s</literal></quote>.
195
176
In addition to normal start time expansion, this option
203
<term><option>extended_timeout<literal> = </literal><replaceable
204
>TIME</replaceable></option></term>
207
This option is <emphasis>optional</emphasis>.
210
Extended timeout is an added timeout that is given once
211
after a password has been sent successfully to a client.
212
The timeout is by default longer than the normal timeout,
213
and is used for handling the extra long downtime while a
214
machine is booting up. Time to take into consideration
215
when changing this value is file system checks and quota
216
checks. The default value is 15 minutes.
219
The format of <replaceable>TIME</replaceable> is the same
220
as for <varname>timeout</varname> below.
226
184
<term><option>fingerprint<literal> = </literal
227
185
><replaceable>HEXSTRING</replaceable></option></term>
233
191
This option sets the OpenPGP fingerprint that identifies
234
192
the public key that clients authenticate themselves with
235
through TLS. The string needs to be in hexadecimal form,
193
through TLS. The string needs to be in hexidecimal form,
236
194
but spaces or upper/lower case are not significant.
270
228
will wait for a checker to complete until the below
271
229
<quote><varname>timeout</varname></quote> occurs, at which
272
230
time the client will be disabled, and any running checker
273
killed. The default interval is 2 minutes.
231
killed. The default interval is 5 minutes.
276
234
The format of <replaceable>TIME</replaceable> is the same
340
298
This option is <emphasis>optional</emphasis>.
343
The timeout is how long the server will wait, after a
344
successful checker run, until a client is disabled and not
345
allowed to get the data this server holds. By default
346
Mandos will use 5 minutes. See also the
347
<option>extended_timeout</option> option.
350
The <replaceable>TIME</replaceable> is specified as an RFC
351
3339 duration; for example
352
<quote><literal>P1Y2M3DT4H5M6S</literal></quote> meaning
353
one year, two months, three days, four hours, five
354
minutes, and six seconds. Some values can be omitted, see
355
RFC 3339 Appendix A for details.
361
<term><option>enabled<literal> = </literal>{ <literal
362
>1</literal> | <literal>yes</literal> | <literal>true</literal
363
> | <literal >on</literal> | <literal>0</literal> | <literal
364
>no</literal> | <literal>false</literal> | <literal
365
>off</literal> }</option></term>
368
Whether this client should be enabled by default. The
369
default is <quote>true</quote>.
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.
416
364
<quote><literal>approval_duration</literal></quote>,
417
365
<quote><literal>created</literal></quote>,
418
366
<quote><literal>enabled</literal></quote>,
419
<quote><literal>expires</literal></quote>,
420
367
<quote><literal>fingerprint</literal></quote>,
421
368
<quote><literal>host</literal></quote>,
422
369
<quote><literal>interval</literal></quote>,
513
459
<refsect1 id="see_also">
514
460
<title>SEE ALSO</title>
516
<citerefentry><refentrytitle>intro</refentrytitle>
517
<manvolnum>8mandos</manvolnum></citerefentry>,
518
462
<citerefentry><refentrytitle>mandos-keygen</refentrytitle>
519
463
<manvolnum>8</manvolnum></citerefentry>,
520
464
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
521
465
<manvolnum>5</manvolnum></citerefentry>,
522
466
<citerefentry><refentrytitle>mandos</refentrytitle>
523
<manvolnum>8</manvolnum></citerefentry>,
524
<citerefentry><refentrytitle>fping</refentrytitle>
525
467
<manvolnum>8</manvolnum></citerefentry>
530
RFC 3339: <citetitle>Date and Time on the Internet:
531
Timestamps</citetitle>
535
The time intervals are in the "duration" format, as
536
specified in ABNF in Appendix A of RFC 3339.
543
471
<!-- Local Variables: -->
added
removed
mandos-clients.conf.xml
