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-10">
6
<!ENTITY TIMESTAMP "2011-09-19">
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>
73
65
><refentrytitle>mandos</refentrytitle>
74
66
<manvolnum>8</manvolnum></citerefentry>, read by it at startup.
75
67
The file needs to list all clients that should be able to use
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.
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.
85
72
The format starts with a <literal>[<replaceable>section
125
112
How long to wait for external approval before resorting to
126
113
use the <option>approved_by_default</option> value. The
127
default is <quote>PT0S</quote>, i.e. not to wait.
114
default is <quote>0s</quote>, i.e. not to wait.
130
117
The format of <replaceable>TIME</replaceable> is the same
174
161
This option is <emphasis>optional</emphasis>.
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>
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>
183
170
<option>-c</option></command></quote>, so
184
171
<varname>PATH</varname> will be searched. The default
185
172
value for the checker command is <quote><literal
186
173
><command>fping</command> <option>-q</option> <option
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
174
>--</option> %%(host)s</literal></quote>.
196
177
In addition to normal start time expansion, this option
211
192
Extended timeout is an added timeout that is given once
212
after a password has been sent successfully to a client.
193
after a password has been sent sucessfully to a client.
213
194
The timeout is by default longer than the normal timeout,
214
195
and is used for handling the extra long downtime while a
215
196
machine is booting up. Time to take into consideration
234
215
This option sets the OpenPGP fingerprint that identifies
235
216
the public key that clients authenticate themselves with
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,
217
through TLS. The string needs to be in hexidecimal form,
253
218
but spaces or upper/lower case are not significant.
332
297
If present, this option must be set to a string of
333
298
base64-encoded binary data. It will be decoded and sent
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.
299
to the client matching the above
300
<option>fingerprint</option>. This should, of course, be
301
OpenPGP encrypted data, decryptable only by the client.
337
302
The program <citerefentry><refentrytitle><command
338
303
>mandos-keygen</command></refentrytitle><manvolnum
339
304
>8</manvolnum></citerefentry> can, using its
357
322
This option is <emphasis>optional</emphasis>.
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>.
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.
433
388
<quote><literal>approval_duration</literal></quote>,
434
389
<quote><literal>created</literal></quote>,
435
390
<quote><literal>enabled</literal></quote>,
436
<quote><literal>expires</literal></quote>,
437
<quote><literal>key_id</literal></quote>,
438
391
<quote><literal>fingerprint</literal></quote>,
439
392
<quote><literal>host</literal></quote>,
440
393
<quote><literal>interval</literal></quote>,
540
490
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
541
491
<manvolnum>5</manvolnum></citerefentry>,
542
492
<citerefentry><refentrytitle>mandos</refentrytitle>
543
<manvolnum>8</manvolnum></citerefentry>,
544
<citerefentry><refentrytitle>fping</refentrytitle>
545
493
<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.
563
497
<!-- Local Variables: -->
added
removed
mandos-clients.conf.xml
