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 "2019-02-09">
6
<!ENTITY TIMESTAMP "2011-02-27">
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
65
><refentrytitle>mandos</refentrytitle>
73
66
<manvolnum>8</manvolnum></citerefentry>, read by it at startup.
74
67
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.
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.
84
72
The format starts with a <literal>[<replaceable>section
124
112
How long to wait for external approval before resorting to
125
113
use the <option>approved_by_default</option> value. The
126
default is <quote>PT0S</quote>, i.e. not to wait.
114
default is <quote>0s</quote>, i.e. not to wait.
129
117
The format of <replaceable>TIME</replaceable> is the same
173
161
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>
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>
182
170
<option>-c</option></command></quote>, so
183
171
<varname>PATH</varname> will be searched. The default
184
172
value for the checker command is <quote><literal
185
173
><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
174
>--</option> %%(host)s</literal></quote>.
195
177
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
185
<term><option>fingerprint<literal> = </literal
227
186
><replaceable>HEXSTRING</replaceable></option></term>
233
192
This option sets the OpenPGP fingerprint that identifies
234
193
the public key that clients authenticate themselves with
235
through TLS. The string needs to be in hexadecimal form,
236
but spaces or upper/lower case are not significant.
242
<term><option>key_id<literal> = </literal
243
><replaceable>HEXSTRING</replaceable></option></term>
246
This option is <emphasis>optional</emphasis>.
249
This option sets the certificate key ID that identifies
250
the public key that clients authenticate themselves with
251
through TLS. The string needs to be in hexadecimal form,
194
through TLS. The string needs to be in hexidecimal form,
252
195
but spaces or upper/lower case are not significant.
286
229
will wait for a checker to complete until the below
287
230
<quote><varname>timeout</varname></quote> occurs, at which
288
231
time the client will be disabled, and any running checker
289
killed. The default interval is 2 minutes.
232
killed. The default interval is 5 minutes.
292
235
The format of <replaceable>TIME</replaceable> is the same
331
274
If present, this option must be set to a string of
332
275
base64-encoded binary data. It will be decoded and sent
333
to the client matching the above <option>key_id</option>
334
or <option>fingerprint</option>. This should, of course,
335
be OpenPGP encrypted data, decryptable only by the client.
276
to the client matching the above
277
<option>fingerprint</option>. This should, of course, be
278
OpenPGP encrypted data, decryptable only by the client.
336
279
The program <citerefentry><refentrytitle><command
337
280
>mandos-keygen</command></refentrytitle><manvolnum
338
281
>8</manvolnum></citerefentry> can, using its
356
299
This option is <emphasis>optional</emphasis>.
359
The timeout is how long the server will wait, after a
360
successful checker run, until a client is disabled and not
361
allowed to get the data this server holds. By default
362
Mandos will use 5 minutes. See also the
363
<option>extended_timeout</option> option.
366
The <replaceable>TIME</replaceable> is specified as an RFC
367
3339 duration; for example
368
<quote><literal>P1Y2M3DT4H5M6S</literal></quote> meaning
369
one year, two months, three days, four hours, five
370
minutes, and six seconds. Some values can be omitted, see
371
RFC 3339 Appendix A for details.
377
<term><option>enabled<literal> = </literal>{ <literal
378
>1</literal> | <literal>yes</literal> | <literal>true</literal
379
> | <literal >on</literal> | <literal>0</literal> | <literal
380
>no</literal> | <literal>false</literal> | <literal
381
>off</literal> }</option></term>
384
Whether this client should be enabled by default. The
385
default is <quote>true</quote>.
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.
432
365
<quote><literal>approval_duration</literal></quote>,
433
366
<quote><literal>created</literal></quote>,
434
367
<quote><literal>enabled</literal></quote>,
435
<quote><literal>expires</literal></quote>,
436
<quote><literal>key_id</literal></quote>,
437
368
<quote><literal>fingerprint</literal></quote>,
438
369
<quote><literal>host</literal></quote>,
439
370
<quote><literal>interval</literal></quote>,
532
460
<refsect1 id="see_also">
533
461
<title>SEE ALSO</title>
535
<citerefentry><refentrytitle>intro</refentrytitle>
536
<manvolnum>8mandos</manvolnum></citerefentry>,
537
463
<citerefentry><refentrytitle>mandos-keygen</refentrytitle>
538
464
<manvolnum>8</manvolnum></citerefentry>,
539
465
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
540
466
<manvolnum>5</manvolnum></citerefentry>,
541
467
<citerefentry><refentrytitle>mandos</refentrytitle>
542
<manvolnum>8</manvolnum></citerefentry>,
543
<citerefentry><refentrytitle>fping</refentrytitle>
544
468
<manvolnum>8</manvolnum></citerefentry>
549
RFC 3339: <citetitle>Date and Time on the Internet:
550
Timestamps</citetitle>
554
The time intervals are in the "duration" format, as
555
specified in ABNF in Appendix A of RFC 3339.
562
472
<!-- Local Variables: -->
added
removed
mandos-clients.conf.xml
