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 "2019-02-10">
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
73
><refentrytitle>mandos</refentrytitle>
65
74
<manvolnum>8</manvolnum></citerefentry>, read by it at startup.
66
75
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.
76
the service. The settings in this file can be overridden by
77
runtime changes to the server, which it saves across restarts.
78
(See the section called <quote>PERSISTENT STATE</quote> in
79
<citerefentry><refentrytitle>mandos</refentrytitle><manvolnum
80
>8</manvolnum></citerefentry>.) However, any <emphasis
81
>changes</emphasis> to this file (including adding and removing
82
clients) will, at startup, override changes done during runtime.
71
85
The format starts with a <literal>[<replaceable>section
111
125
How long to wait for external approval before resorting to
112
126
use the <option>approved_by_default</option> value. The
113
default is <quote>0s</quote>, i.e. not to wait.
127
default is <quote>PT0S</quote>, i.e. not to wait.
116
130
The format of <replaceable>TIME</replaceable> is the same
160
174
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>
177
This option overrides the default shell command that the
178
server will use to check if the client is still up. Any
179
output of the command will be ignored, only the exit code
180
is checked: If the exit code of the command is zero, the
181
client is considered up. The command will be run using
182
<quote><command><filename>/bin/sh</filename>
169
183
<option>-c</option></command></quote>, so
170
184
<varname>PATH</varname> will be searched. The default
171
185
value for the checker command is <quote><literal
172
186
><command>fping</command> <option>-q</option> <option
173
>--</option> %%(host)s</literal></quote>.
187
>--</option> %%(host)s</literal></quote>. Note that
188
<command>mandos-keygen</command>, when generating output
189
to be inserted into this file, normally looks for an SSH
190
server on the Mandos client, and, if it finds one, outputs
191
a <option>checker</option> option to check for the
192
client’s SSH key fingerprint – this is more secure against
176
196
In addition to normal start time expansion, this option
204
<term><option>extended_timeout<literal> = </literal><replaceable
205
>TIME</replaceable></option></term>
208
This option is <emphasis>optional</emphasis>.
211
Extended timeout is an added timeout that is given once
212
after a password has been sent successfully to a client.
213
The timeout is by default longer than the normal timeout,
214
and is used for handling the extra long downtime while a
215
machine is booting up. Time to take into consideration
216
when changing this value is file system checks and quota
217
checks. The default value is 15 minutes.
220
The format of <replaceable>TIME</replaceable> is the same
221
as for <varname>timeout</varname> below.
184
227
<term><option>fingerprint<literal> = </literal
185
228
><replaceable>HEXSTRING</replaceable></option></term>
191
234
This option sets the OpenPGP fingerprint that identifies
192
235
the public key that clients authenticate themselves with
193
through TLS. The string needs to be in hexidecimal form,
236
through TLS. The string needs to be in hexadecimal form,
237
but spaces or upper/lower case are not significant.
243
<term><option>key_id<literal> = </literal
244
><replaceable>HEXSTRING</replaceable></option></term>
247
This option is <emphasis>optional</emphasis>.
250
This option sets the certificate key ID that identifies
251
the public key that clients authenticate themselves with
252
through TLS. The string needs to be in hexadecimal form,
194
253
but spaces or upper/lower case are not significant.
228
287
will wait for a checker to complete until the below
229
288
<quote><varname>timeout</varname></quote> occurs, at which
230
289
time the client will be disabled, and any running checker
231
killed. The default interval is 5 minutes.
290
killed. The default interval is 2 minutes.
234
293
The format of <replaceable>TIME</replaceable> is the same
273
332
If present, this option must be set to a string of
274
333
base64-encoded binary data. It will be decoded and sent
275
to the client matching the above
276
<option>fingerprint</option>. This should, of course, be
277
OpenPGP encrypted data, decryptable only by the client.
334
to the client matching the above <option>key_id</option>
335
or <option>fingerprint</option>. This should, of course,
336
be OpenPGP encrypted data, decryptable only by the client.
278
337
The program <citerefentry><refentrytitle><command
279
338
>mandos-keygen</command></refentrytitle><manvolnum
280
339
>8</manvolnum></citerefentry> can, using its
298
357
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.
360
The timeout is how long the server will wait, after a
361
successful checker run, until a client is disabled and not
362
allowed to get the data this server holds. By default
363
Mandos will use 5 minutes. See also the
364
<option>extended_timeout</option> option.
367
The <replaceable>TIME</replaceable> is specified as an RFC
368
3339 duration; for example
369
<quote><literal>P1Y2M3DT4H5M6S</literal></quote> meaning
370
one year, two months, three days, four hours, five
371
minutes, and six seconds. Some values can be omitted, see
372
RFC 3339 Appendix A for details.
378
<term><option>enabled<literal> = </literal>{ <literal
379
>1</literal> | <literal>yes</literal> | <literal>true</literal
380
> | <literal >on</literal> | <literal>0</literal> | <literal
381
>no</literal> | <literal>false</literal> | <literal
382
>off</literal> }</option></term>
385
Whether this client should be enabled by default. The
386
default is <quote>true</quote>.
364
433
<quote><literal>approval_duration</literal></quote>,
365
434
<quote><literal>created</literal></quote>,
366
435
<quote><literal>enabled</literal></quote>,
436
<quote><literal>expires</literal></quote>,
437
<quote><literal>key_id</literal></quote>,
367
438
<quote><literal>fingerprint</literal></quote>,
368
439
<quote><literal>host</literal></quote>,
369
440
<quote><literal>interval</literal></quote>,
459
533
<refsect1 id="see_also">
460
534
<title>SEE ALSO</title>
536
<citerefentry><refentrytitle>intro</refentrytitle>
537
<manvolnum>8mandos</manvolnum></citerefentry>,
462
538
<citerefentry><refentrytitle>mandos-keygen</refentrytitle>
463
539
<manvolnum>8</manvolnum></citerefentry>,
464
540
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
465
541
<manvolnum>5</manvolnum></citerefentry>,
466
542
<citerefentry><refentrytitle>mandos</refentrytitle>
543
<manvolnum>8</manvolnum></citerefentry>,
544
<citerefentry><refentrytitle>fping</refentrytitle>
467
545
<manvolnum>8</manvolnum></citerefentry>
550
RFC 3339: <citetitle>Date and Time on the Internet:
551
Timestamps</citetitle>
555
The time intervals are in the "duration" format, as
556
specified in ABNF in Appendix A of RFC 3339.
471
563
<!-- Local Variables: -->
added
removed
mandos-clients.conf.xml
