65
73
><refentrytitle>mandos</refentrytitle>
66
74
<manvolnum>8</manvolnum></citerefentry>, read by it at startup.
67
75
The file needs to list all clients that should be able to use
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.
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.
72
85
The format starts with a <literal>[<replaceable>section
161
174
This option is <emphasis>optional</emphasis>.
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>
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>
170
183
<option>-c</option></command></quote>, so
171
184
<varname>PATH</varname> will be searched. The default
172
185
value for the checker command is <quote><literal
173
186
><command>fping</command> <option>-q</option> <option
174
>--</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
177
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.
185
227
<term><option>fingerprint<literal> = </literal
186
228
><replaceable>HEXSTRING</replaceable></option></term>
192
234
This option sets the OpenPGP fingerprint that identifies
193
235
the public key that clients authenticate themselves with
194
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,
195
253
but spaces or upper/lower case are not significant.
274
332
If present, this option must be set to a string of
275
333
base64-encoded binary data. It will be decoded and sent
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.
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.
279
337
The program <citerefentry><refentrytitle><command
280
338
>mandos-keygen</command></refentrytitle><manvolnum
281
339
>8</manvolnum></citerefentry> can, using its
299
357
This option is <emphasis>optional</emphasis>.
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 5 minutes.
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.
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.
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.
324
<term><option>extended_timeout<literal> = </literal><replaceable
325
>TIME</replaceable></option></term>
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>
328
This option is <emphasis>optional</emphasis>.
331
Extended timeout is an added timeout that is given once
332
after a password has been sent sucessfully to a client.
333
The timeout is by default longer than the normal timeout,
334
and is used for handling the extra long downtime while a
335
matchine is booting up. Time to take into consideration
336
when changing this value is system file checks and quota
337
checks. The default value is 15 minutes.
340
The format of <replaceable>TIME</replaceable> is the same
341
as for <varname>timeout</varname> above.
385
Whether this client should be enabled by default. The
386
default is <quote>true</quote>.
388
433
<quote><literal>approval_duration</literal></quote>,
389
434
<quote><literal>created</literal></quote>,
390
435
<quote><literal>enabled</literal></quote>,
436
<quote><literal>expires</literal></quote>,
437
<quote><literal>key_id</literal></quote>,
391
438
<quote><literal>fingerprint</literal></quote>,
392
439
<quote><literal>host</literal></quote>,
393
440
<quote><literal>interval</literal></quote>,
490
540
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
491
541
<manvolnum>5</manvolnum></citerefentry>,
492
542
<citerefentry><refentrytitle>mandos</refentrytitle>
543
<manvolnum>8</manvolnum></citerefentry>,
544
<citerefentry><refentrytitle>fping</refentrytitle>
493
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.
497
563
<!-- Local Variables: -->
added
removed
mandos-clients.conf.xml
