1
<?xml version='1.0' encoding='UTF-8'?>
1
<?xml version="1.0" encoding="UTF-8"?>
2
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
3
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
<!ENTITY VERSION "1.0">
5
4
<!ENTITY CONFNAME "mandos-clients.conf">
6
5
<!ENTITY CONFPATH "<filename>/etc/mandos/clients.conf</filename>">
6
<!ENTITY TIMESTAMP "2019-02-09">
7
<!ENTITY % common SYSTEM "common.ent">
11
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
11
<title>&CONFNAME;</title>
13
<title>Mandos Manual</title>
12
14
<!-- NWalsh’s docbook scripts use this to generate the footer: -->
13
<productname>&CONFNAME;</productname>
14
<productnumber>&VERSION;</productnumber>
15
<productname>Mandos</productname>
16
<productnumber>&version;</productnumber>
17
<date>&TIMESTAMP;</date>
17
20
<firstname>Björn</firstname>
18
21
<surname>Påhlsson</surname>
20
<email>belorn@fukt.bsnet.se</email>
23
<email>belorn@recompile.se</email>
24
27
<firstname>Teddy</firstname>
25
28
<surname>Hogeborn</surname>
27
<email>teddy@fukt.bsnet.se</email>
30
<email>teddy@recompile.se</email>
33
46
<holder>Teddy Hogeborn</holder>
34
47
<holder>Björn Påhlsson</holder>
38
This manual page is free software: you can redistribute it
39
and/or modify it under the terms of the GNU General Public
40
License as published by the Free Software Foundation,
41
either version 3 of the License, or (at your option) any
46
This manual page is distributed in the hope that it will
47
be useful, but WITHOUT ANY WARRANTY; without even the
48
implied warranty of MERCHANTABILITY or FITNESS FOR A
49
PARTICULAR PURPOSE. See the GNU General Public License
54
You should have received a copy of the GNU General Public
55
License along with this program; If not, see
56
<ulink url="http://www.gnu.org/licenses/"/>.
49
<xi:include href="legalnotice.xml"/>
62
53
<refentrytitle>&CONFNAME;</refentrytitle>
63
54
<manvolnum>5</manvolnum>
83
72
><refentrytitle>mandos</refentrytitle>
84
73
<manvolnum>8</manvolnum></citerefentry>, read by it at startup.
85
74
The file needs to list all clients that should be able to use
86
the service. All clients listed will be regarded as valid, even
87
if a client was declared invalid in a previous run of the
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.
91
84
The format starts with a <literal>[<replaceable>section
115
108
start time expansion, see <xref linkend="expansion"/>.
118
Uknown options are ignored. The used options are as follows:
111
Unknown options are ignored. The used options are as follows:
124
<term><literal><varname>timeout</varname></literal></term>
126
<synopsis><literal>timeout = </literal><replaceable
130
The timeout is how long the server will wait for a
131
successful checker run until a client is considered
132
invalid - that is, ineligible to get the data this server
133
holds. By default Mandos will use 1 hour.
136
The <replaceable>TIME</replaceable> is specified as a
137
space-separated number of values, each of which is a
138
number and a one-character suffix. The suffix must be one
139
of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
140
<quote>h</quote>, and <quote>w</quote> for days, seconds,
141
minutes, hours, and weeks, respectively. The values are
142
added together to give the total time value, so all of
143
<quote><literal>330s</literal></quote>,
144
<quote><literal>110s 110s 110s</literal></quote>, and
145
<quote><literal>5m 30s</literal></quote> will give a value
146
of five minutes and thirty seconds.
152
<term><literal><varname>interval</varname></literal></term>
154
<synopsis><literal>interval = </literal><replaceable
158
How often to run the checker to confirm that a client is
159
still up. <emphasis>Note:</emphasis> a new checker will
160
not be started if an old one is still running. The server
161
will wait for a checker to complete until the above
162
<quote><varname>timeout</varname></quote> occurs, at which
163
time the client will be marked invalid, and any running
164
checker killed. The default interval is 5 minutes.
167
The format of <replaceable>TIME</replaceable> is the same
168
as for <varname>timeout</varname> above.
174
<term><literal>checker</literal></term>
176
<synopsis><literal>checker = </literal><replaceable
177
>COMMAND</replaceable>
180
This option allows you to override the default shell
181
command that the server will use to check if the client is
182
still up. Any output of the command will be ignored, only
183
the exit code is checked: If the exit code of the command
184
is zero, the client is considered up. The command will be
185
run using <quote><command><filename>/bin/sh</filename>
117
<term><option>approval_delay<literal> = </literal><replaceable
118
>TIME</replaceable></option></term>
121
This option is <emphasis>optional</emphasis>.
124
How long to wait for external approval before resorting to
125
use the <option>approved_by_default</option> value. The
126
default is <quote>PT0S</quote>, i.e. not to wait.
129
The format of <replaceable>TIME</replaceable> is the same
130
as for <varname>timeout</varname> below.
136
<term><option>approval_duration<literal> = </literal
137
><replaceable>TIME</replaceable></option></term>
140
This option is <emphasis>optional</emphasis>.
143
How long an external approval lasts. The default is 1
147
The format of <replaceable>TIME</replaceable> is the same
148
as for <varname>timeout</varname> below.
154
<term><option>approved_by_default<literal> = </literal
155
>{ <literal >1</literal> | <literal>yes</literal> | <literal
156
>true</literal> | <literal>on</literal> | <literal
157
>0</literal> | <literal>no</literal> | <literal
158
>false</literal> | <literal>off</literal> }</option></term>
161
Whether to approve a client by default after
162
the <option>approval_delay</option>. The default
163
is <quote>True</quote>.
169
<term><option>checker<literal> = </literal><replaceable
170
>COMMAND</replaceable></option></term>
173
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>
186
182
<option>-c</option></command></quote>, so
187
183
<varname>PATH</varname> will be searched. The default
188
184
value for the checker command is <quote><literal
189
185
><command>fping</command> <option>-q</option> <option
190
>--</option> %(host)s</literal></quote>.
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 finds one, outputs
190
a <option>checker</option> option to check for the
191
client’s SSH key fingerprint – this is more secure against
193
195
In addition to normal start time expansion, this option
201
<term><literal>fingerprint</literal></term>
203
<synopsis><literal>fingerprint = </literal><replaceable
204
>HEXSTRING</replaceable>
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
<term><option>fingerprint<literal> = </literal
227
><replaceable>HEXSTRING</replaceable></option></term>
230
This option is <emphasis>required</emphasis>.
207
233
This option sets the OpenPGP fingerprint that identifies
208
234
the public key that clients authenticate themselves with
209
through TLS. The string needs to be in hexidecimal form,
210
but spaces or upper/lower case are not significant.
216
<term><literal>secret</literal></term>
218
<synopsis><literal>secret = </literal><replaceable
219
>BASE64_ENCODED_DATA</replaceable>
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,
252
but spaces or upper/lower case are not significant.
258
<term><option><literal>host = </literal><replaceable
259
>STRING</replaceable></option></term>
262
This option is <emphasis>optional</emphasis>, but highly
263
<emphasis>recommended</emphasis> unless the
264
<option>checker</option> option is modified to a
265
non-standard value without <quote>%%(host)s</quote> in it.
268
Host name for this client. This is not used by the server
269
directly, but can be, and is by default, used by the
270
checker. See the <option>checker</option> option.
276
<term><option>interval<literal> = </literal><replaceable
277
>TIME</replaceable></option></term>
280
This option is <emphasis>optional</emphasis>.
283
How often to run the checker to confirm that a client is
284
still up. <emphasis>Note:</emphasis> a new checker will
285
not be started if an old one is still running. The server
286
will wait for a checker to complete until the below
287
<quote><varname>timeout</varname></quote> occurs, at which
288
time the client will be disabled, and any running checker
289
killed. The default interval is 2 minutes.
292
The format of <replaceable>TIME</replaceable> is the same
293
as for <varname>timeout</varname> below.
299
<term><option>secfile<literal> = </literal><replaceable
300
>FILENAME</replaceable></option></term>
303
This option is only used if <option>secret</option> is not
304
specified, in which case this option is
305
<emphasis>required</emphasis>.
308
Similar to the <option>secret</option>, except the secret
309
data is in an external file. The contents of the file
310
should <emphasis>not</emphasis> be base64-encoded, but
311
will be sent to clients verbatim.
314
File names of the form <filename>~user/foo/bar</filename>
315
and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
322
<term><option>secret<literal> = </literal><replaceable
323
>BASE64_ENCODED_DATA</replaceable></option></term>
326
If this option is not specified, the <option
327
>secfile</option> option is <emphasis>required</emphasis>
222
331
If present, this option must be set to a string of
223
332
base64-encoded binary data. It will be decoded and sent
224
to the client matching the above
225
<option>fingerprint</option>. This should, of course, be
226
OpenPGP encrypted data, decryptable only by the client.
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.
227
336
The program <citerefentry><refentrytitle><command
228
337
>mandos-keygen</command></refentrytitle><manvolnum
229
338
>8</manvolnum></citerefentry> can, using its
236
345
lines is that a line beginning with white space adds to
237
346
the value of the previous line, RFC 822-style.
240
If this option is not specified, the <option
241
>secfile</option> option is used instead, but one of them
242
<emphasis>must</emphasis> be present.
248
<term><literal>secfile</literal></term>
250
<synopsis><literal>secfile = </literal><replaceable
251
>FILENAME</replaceable>
254
The same as <option>secret</option>, but the secret data
255
is in an external file. The contents of the file should
256
<emphasis>not</emphasis> be base64-encoded, but will be
257
sent to clients verbatim.
260
This option is only used, and <emphasis>must</emphasis> be
261
present, if <option>secret</option> is not specified.
267
<term><literal>host</literal></term>
269
<synopsis><literal>host = </literal><replaceable
270
>STRING</replaceable>
273
Host name for this client. This is not used by the server
274
directly, but can be, and is by default, used by the
275
checker. See the <option>checker</option> option.
352
<term><option>timeout<literal> = </literal><replaceable
353
>TIME</replaceable></option></term>
356
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>.
283
393
<refsect1 id="expansion">
284
394
<title>EXPANSION</title>
315
425
<quote><literal>%%(<replaceable>foo</replaceable>)s</literal
316
426
></quote> will be replaced by the value of the attribute
317
427
<varname>foo</varname> of the internal
318
<quote><classname>Client</classname></quote> object. See the
319
source code for details, and let the authors know of any
320
attributes that are useful so they may be preserved to any new
321
versions of this software.
428
<quote><classname>Client</classname></quote> object in the
429
Mandos server. The currently allowed values for
430
<replaceable>foo</replaceable> are:
431
<quote><literal>approval_delay</literal></quote>,
432
<quote><literal>approval_duration</literal></quote>,
433
<quote><literal>created</literal></quote>,
434
<quote><literal>enabled</literal></quote>,
435
<quote><literal>expires</literal></quote>,
436
<quote><literal>key_id</literal></quote>,
437
<quote><literal>fingerprint</literal></quote>,
438
<quote><literal>host</literal></quote>,
439
<quote><literal>interval</literal></quote>,
440
<quote><literal>last_approval_request</literal></quote>,
441
<quote><literal>last_checked_ok</literal></quote>,
442
<quote><literal>last_enabled</literal></quote>,
443
<quote><literal>name</literal></quote>,
444
<quote><literal>timeout</literal></quote>, and, if using
445
D-Bus, <quote><literal>dbus_object_path</literal></quote>.
446
See the source code for details. <emphasis role="strong"
447
>Currently, <emphasis>none</emphasis> of these attributes
448
except <quote><literal>host</literal></quote> are guaranteed
449
to be valid in future versions.</emphasis> Therefore, please
450
let the authors know of any attributes that are useful so they
451
may be preserved to any new versions of this software.
324
454
Note that this means that, in order to include an actual
383
515
4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
385
517
host = foo.example.org
522
key_id = F90C7A81D72D1EA69A51031A91FF8885F36C8B46D155C8C58709A4C99AE9E361
390
523
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
391
524
secfile = /etc/mandos/bar-secret
526
approved_by_default = False
527
approval_delay = PT30S
394
528
</programlisting>
395
529
</informalexample>
398
532
<refsect1 id="see_also">
399
533
<title>SEE ALSO</title>
402
<refentrytitle>mandos</refentrytitle>
403
<manvolnum>8</manvolnum></citerefentry>, <citerefentry>
404
<refentrytitle>mandos-keygen</refentrytitle>
405
<manvolnum>8</manvolnum></citerefentry>, <citerefentry>
406
<refentrytitle>mandos.conf</refentrytitle>
407
<manvolnum>5</manvolnum></citerefentry>
535
<citerefentry><refentrytitle>intro</refentrytitle>
536
<manvolnum>8mandos</manvolnum></citerefentry>,
537
<citerefentry><refentrytitle>mandos-keygen</refentrytitle>
538
<manvolnum>8</manvolnum></citerefentry>,
539
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
540
<manvolnum>5</manvolnum></citerefentry>,
541
<citerefentry><refentrytitle>mandos</refentrytitle>
542
<manvolnum>8</manvolnum></citerefentry>,
543
<citerefentry><refentrytitle>fping</refentrytitle>
544
<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
<!-- Local Variables: -->
563
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
564
<!-- time-stamp-end: "[\"']>" -->
565
<!-- time-stamp-format: "%:y-%02m-%02d" -->