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-25">
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>
46
37
<holder>Teddy Hogeborn</holder>
47
38
<holder>Björn Påhlsson</holder>
72
63
><refentrytitle>mandos</refentrytitle>
73
64
<manvolnum>8</manvolnum></citerefentry>, read by it at startup.
74
65
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.
66
the service. All clients listed will be regarded as enabled,
67
even if a client was disabled in a previous run of the server.
84
70
The format starts with a <literal>[<replaceable>section
124
110
How long to wait for external approval before resorting to
125
111
use the <option>approved_by_default</option> value. The
126
default is <quote>PT0S</quote>, i.e. not to wait.
112
default is <quote>0s</quote>, i.e. not to wait.
129
115
The format of <replaceable>TIME</replaceable> is the same
173
159
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>
162
This option allows you to override the default shell
163
command that the server will use to check if the client is
164
still up. Any output of the command will be ignored, only
165
the exit code is checked: If the exit code of the command
166
is zero, the client is considered up. The command will be
167
run using <quote><command><filename>/bin/sh</filename>
182
168
<option>-c</option></command></quote>, so
183
169
<varname>PATH</varname> will be searched. The default
184
170
value for the checker command is <quote><literal
185
171
><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
172
>--</option> %%(host)s</literal></quote>.
195
175
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
183
<term><option>fingerprint<literal> = </literal
227
184
><replaceable>HEXSTRING</replaceable></option></term>
233
190
This option sets the OpenPGP fingerprint that identifies
234
191
the public key that clients authenticate themselves with
235
through TLS. The string needs to be in hexadecimal form,
192
through TLS. The string needs to be in hexidecimal form,
236
193
but spaces or upper/lower case are not significant.
270
227
will wait for a checker to complete until the below
271
228
<quote><varname>timeout</varname></quote> occurs, at which
272
229
time the client will be disabled, and any running checker
273
killed. The default interval is 2 minutes.
230
killed. The default interval is 5 minutes.
276
233
The format of <replaceable>TIME</replaceable> is the same
340
297
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>.
300
The timeout is how long the server will wait (for either a
301
successful checker run or a client receiving its secret)
302
until a client is disabled and not allowed to get the data
303
this server holds. By default Mandos will use 1 hour.
306
The <replaceable>TIME</replaceable> is specified as a
307
space-separated number of values, each of which is a
308
number and a one-character suffix. The suffix must be one
309
of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
310
<quote>h</quote>, and <quote>w</quote> for days, seconds,
311
minutes, hours, and weeks, respectively. The values are
312
added together to give the total time value, so all of
313
<quote><literal>330s</literal></quote>,
314
<quote><literal>110s 110s 110s</literal></quote>, and
315
<quote><literal>5m 30s</literal></quote> will give a value
316
of five minutes and thirty seconds.
409
356
<quote><literal>%%(<replaceable>foo</replaceable>)s</literal
410
357
></quote> will be replaced by the value of the attribute
411
358
<varname>foo</varname> of the internal
412
<quote><classname>Client</classname></quote> object in the
413
Mandos server. The currently allowed values for
414
<replaceable>foo</replaceable> are:
415
<quote><literal>approval_delay</literal></quote>,
416
<quote><literal>approval_duration</literal></quote>,
417
<quote><literal>created</literal></quote>,
418
<quote><literal>enabled</literal></quote>,
419
<quote><literal>expires</literal></quote>,
420
<quote><literal>fingerprint</literal></quote>,
421
<quote><literal>host</literal></quote>,
422
<quote><literal>interval</literal></quote>,
423
<quote><literal>last_approval_request</literal></quote>,
424
<quote><literal>last_checked_ok</literal></quote>,
425
<quote><literal>last_enabled</literal></quote>,
426
<quote><literal>name</literal></quote>,
427
<quote><literal>timeout</literal></quote>, and, if using
428
D-Bus, <quote><literal>dbus_object_path</literal></quote>.
429
See the source code for details. <emphasis role="strong"
430
>Currently, <emphasis>none</emphasis> of these attributes
431
except <quote><literal>host</literal></quote> are guaranteed
432
to be valid in future versions.</emphasis> Therefore, please
433
let the authors know of any attributes that are useful so they
434
may be preserved to any new versions of this software.
359
<quote><classname>Client</classname></quote> object. See the
360
source code for details, and let the authors know of any
361
attributes that are useful so they may be preserved to any new
362
versions of this software.
437
365
Note that this means that, in order to include an actual
513
440
<refsect1 id="see_also">
514
441
<title>SEE ALSO</title>
516
<citerefentry><refentrytitle>intro</refentrytitle>
517
<manvolnum>8mandos</manvolnum></citerefentry>,
518
443
<citerefentry><refentrytitle>mandos-keygen</refentrytitle>
519
444
<manvolnum>8</manvolnum></citerefentry>,
520
445
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
521
446
<manvolnum>5</manvolnum></citerefentry>,
522
447
<citerefentry><refentrytitle>mandos</refentrytitle>
523
<manvolnum>8</manvolnum></citerefentry>,
524
<citerefentry><refentrytitle>fping</refentrytitle>
525
448
<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
452
<!-- Local Variables: -->
added
removed
mandos-clients.conf.xml
