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 "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>
47
37
<holder>Teddy Hogeborn</holder>
48
38
<holder>Björn Påhlsson</holder>
73
63
><refentrytitle>mandos</refentrytitle>
74
64
<manvolnum>8</manvolnum></citerefentry>, read by it at startup.
75
65
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.
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.
85
70
The format starts with a <literal>[<replaceable>section
125
110
How long to wait for external approval before resorting to
126
111
use the <option>approved_by_default</option> value. The
127
default is <quote>PT0S</quote>, i.e. not to wait.
112
default is <quote>0s</quote>, i.e. not to wait.
130
115
The format of <replaceable>TIME</replaceable> is the same
174
159
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>
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>
183
168
<option>-c</option></command></quote>, so
184
169
<varname>PATH</varname> will be searched. The default
185
170
value for the checker command is <quote><literal
186
171
><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
172
>--</option> %%(host)s</literal></quote>.
196
175
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.
227
183
<term><option>fingerprint<literal> = </literal
228
184
><replaceable>HEXSTRING</replaceable></option></term>
231
This option is <emphasis>required</emphasis> if the
232
<option>key_id</option> is not set, and
233
<emphasis>optional</emphasis> otherwise.
236
This option sets the OpenPGP fingerprint that (before
237
GnuTLS 3.6.0) identified the public key that clients
238
authenticate themselves with through TLS. The string
239
needs to be in hexadecimal form, but spaces or upper/lower
240
case are not significant.
246
<term><option>key_id<literal> = </literal
247
><replaceable>HEXSTRING</replaceable></option></term>
250
This option is <emphasis>required</emphasis> if the
251
<option>fingerprint</option> is not set, and
252
<emphasis>optional</emphasis> otherwise.
255
This option sets the certificate key ID that (with GnuTLS
256
3.6.6 or later) identifies the public key that clients
257
authenticate themselves with through TLS. The string
258
needs to be in hexadecimal form, but spaces or upper/lower
259
case are not significant.
187
This option is <emphasis>required</emphasis>.
190
This option sets the OpenPGP fingerprint that identifies
191
the public key that clients authenticate themselves with
192
through TLS. The string needs to be in hexidecimal form,
193
but spaces or upper/lower case are not significant.
293
227
will wait for a checker to complete until the below
294
228
<quote><varname>timeout</varname></quote> occurs, at which
295
229
time the client will be disabled, and any running checker
296
killed. The default interval is 2 minutes.
230
killed. The default interval is 5 minutes.
299
233
The format of <replaceable>TIME</replaceable> is the same
338
272
If present, this option must be set to a string of
339
273
base64-encoded binary data. It will be decoded and sent
340
to the client matching the above <option>key_id</option>
341
or <option>fingerprint</option>. This should, of course,
342
be OpenPGP encrypted data, decryptable only by the client.
274
to the client matching the above
275
<option>fingerprint</option>. This should, of course, be
276
OpenPGP encrypted data, decryptable only by the client.
343
277
The program <citerefentry><refentrytitle><command
344
278
>mandos-keygen</command></refentrytitle><manvolnum
345
279
>8</manvolnum></citerefentry> can, using its
363
297
This option is <emphasis>optional</emphasis>.
366
The timeout is how long the server will wait, after a
367
successful checker run, until a client is disabled and not
368
allowed to get the data this server holds. By default
369
Mandos will use 5 minutes. See also the
370
<option>extended_timeout</option> option.
373
The <replaceable>TIME</replaceable> is specified as an RFC
374
3339 duration; for example
375
<quote><literal>P1Y2M3DT4H5M6S</literal></quote> meaning
376
one year, two months, three days, four hours, five
377
minutes, and six seconds. Some values can be omitted, see
378
RFC 3339 Appendix A for details.
384
<term><option>enabled<literal> = </literal>{ <literal
385
>1</literal> | <literal>yes</literal> | <literal>true</literal
386
> | <literal >on</literal> | <literal>0</literal> | <literal
387
>no</literal> | <literal>false</literal> | <literal
388
>off</literal> }</option></term>
391
Whether this client should be enabled by default. The
392
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.
432
356
<quote><literal>%%(<replaceable>foo</replaceable>)s</literal
433
357
></quote> will be replaced by the value of the attribute
434
358
<varname>foo</varname> of the internal
435
<quote><classname>Client</classname></quote> object in the
436
Mandos server. The currently allowed values for
437
<replaceable>foo</replaceable> are:
438
<quote><literal>approval_delay</literal></quote>,
439
<quote><literal>approval_duration</literal></quote>,
440
<quote><literal>created</literal></quote>,
441
<quote><literal>enabled</literal></quote>,
442
<quote><literal>expires</literal></quote>,
443
<quote><literal>key_id</literal></quote>,
444
<quote><literal>fingerprint</literal></quote>,
445
<quote><literal>host</literal></quote>,
446
<quote><literal>interval</literal></quote>,
447
<quote><literal>last_approval_request</literal></quote>,
448
<quote><literal>last_checked_ok</literal></quote>,
449
<quote><literal>last_enabled</literal></quote>,
450
<quote><literal>name</literal></quote>,
451
<quote><literal>timeout</literal></quote>, and, if using
452
D-Bus, <quote><literal>dbus_object_path</literal></quote>.
453
See the source code for details. <emphasis role="strong"
454
>Currently, <emphasis>none</emphasis> of these attributes
455
except <quote><literal>host</literal></quote> are guaranteed
456
to be valid in future versions.</emphasis> Therefore, please
457
let the authors know of any attributes that are useful so they
458
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.
461
365
Note that this means that, in order to include an actual
539
440
<refsect1 id="see_also">
540
441
<title>SEE ALSO</title>
542
<citerefentry><refentrytitle>intro</refentrytitle>
543
<manvolnum>8mandos</manvolnum></citerefentry>,
544
443
<citerefentry><refentrytitle>mandos-keygen</refentrytitle>
545
444
<manvolnum>8</manvolnum></citerefentry>,
546
445
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
547
446
<manvolnum>5</manvolnum></citerefentry>,
548
447
<citerefentry><refentrytitle>mandos</refentrytitle>
549
<manvolnum>8</manvolnum></citerefentry>,
550
<citerefentry><refentrytitle>fping</refentrytitle>
551
448
<manvolnum>8</manvolnum></citerefentry>
556
RFC 3339: <citetitle>Date and Time on the Internet:
557
Timestamps</citetitle>
561
The time intervals are in the "duration" format, as
562
specified in ABNF in Appendix A of RFC 3339.
569
452
<!-- Local Variables: -->
added
removed
mandos-clients.conf.xml
