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>">
7
<!ENTITY TIMESTAMP "2008-08-29">
6
<!ENTITY TIMESTAMP "2017-02-23">
7
<!ENTITY % common SYSTEM "common.ent">
11
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
12
13
<title>Mandos Manual</title>
13
14
<!-- NWalsh’s docbook scripts use this to generate the footer: -->
14
15
<productname>Mandos</productname>
15
<productnumber>&VERSION;</productnumber>
16
<productnumber>&version;</productnumber>
16
17
<date>&TIMESTAMP;</date>
19
20
<firstname>Björn</firstname>
20
21
<surname>Påhlsson</surname>
22
<email>belorn@fukt.bsnet.se</email>
23
<email>belorn@recompile.se</email>
26
27
<firstname>Teddy</firstname>
27
28
<surname>Hogeborn</surname>
29
<email>teddy@fukt.bsnet.se</email>
30
<email>teddy@recompile.se</email>
35
45
<holder>Teddy Hogeborn</holder>
36
46
<holder>Björn Påhlsson</holder>
40
This manual page is free software: you can redistribute it
41
and/or modify it under the terms of the GNU General Public
42
License as published by the Free Software Foundation,
43
either version 3 of the License, or (at your option) any
48
This manual page is distributed in the hope that it will
49
be useful, but WITHOUT ANY WARRANTY; without even the
50
implied warranty of MERCHANTABILITY or FITNESS FOR A
51
PARTICULAR PURPOSE. See the GNU General Public License
56
You should have received a copy of the GNU General Public
57
License along with this program; If not, see
58
<ulink url="http://www.gnu.org/licenses/"/>.
48
<xi:include href="legalnotice.xml"/>
64
52
<refentrytitle>&CONFNAME;</refentrytitle>
65
53
<manvolnum>5</manvolnum>
85
71
><refentrytitle>mandos</refentrytitle>
86
72
<manvolnum>8</manvolnum></citerefentry>, read by it at startup.
87
73
The file needs to list all clients that should be able to use
88
the service. All clients listed will be regarded as valid, even
89
if a client was declared invalid in a previous run of the
74
the service. The settings in this file can be overridden by
75
runtime changes to the server, which it saves across restarts.
76
(See the section called <quote>PERSISTENT STATE</quote> in
77
<citerefentry><refentrytitle>mandos</refentrytitle><manvolnum
78
>8</manvolnum></citerefentry>.) However, any <emphasis
79
>changes</emphasis> to this file (including adding and removing
80
clients) will, at startup, override changes done during runtime.
93
83
The format starts with a <literal>[<replaceable>section
117
107
start time expansion, see <xref linkend="expansion"/>.
120
Uknown options are ignored. The used options are as follows:
110
Unknown options are ignored. The used options are as follows:
126
<term><literal><varname>timeout</varname></literal></term>
128
<synopsis><literal>timeout = </literal><replaceable
132
The timeout is how long the server will wait for a
133
successful checker run until a client is considered
134
invalid - that is, ineligible to get the data this server
135
holds. By default Mandos will use 1 hour.
138
The <replaceable>TIME</replaceable> is specified as a
139
space-separated number of values, each of which is a
140
number and a one-character suffix. The suffix must be one
141
of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
142
<quote>h</quote>, and <quote>w</quote> for days, seconds,
143
minutes, hours, and weeks, respectively. The values are
144
added together to give the total time value, so all of
145
<quote><literal>330s</literal></quote>,
146
<quote><literal>110s 110s 110s</literal></quote>, and
147
<quote><literal>5m 30s</literal></quote> will give a value
148
of five minutes and thirty seconds.
154
<term><literal><varname>interval</varname></literal></term>
156
<synopsis><literal>interval = </literal><replaceable
160
How often to run the checker to confirm that a client is
161
still up. <emphasis>Note:</emphasis> a new checker will
162
not be started if an old one is still running. The server
163
will wait for a checker to complete until the above
164
<quote><varname>timeout</varname></quote> occurs, at which
165
time the client will be marked invalid, and any running
166
checker killed. The default interval is 5 minutes.
169
The format of <replaceable>TIME</replaceable> is the same
170
as for <varname>timeout</varname> above.
176
<term><literal>checker</literal></term>
178
<synopsis><literal>checker = </literal><replaceable
179
>COMMAND</replaceable>
182
This option allows you to override the default shell
183
command that the server will use to check if the client is
184
still up. Any output of the command will be ignored, only
185
the exit code is checked: If the exit code of the command
186
is zero, the client is considered up. The command will be
187
run using <quote><command><filename>/bin/sh</filename>
116
<term><option>approval_delay<literal> = </literal><replaceable
117
>TIME</replaceable></option></term>
120
This option is <emphasis>optional</emphasis>.
123
How long to wait for external approval before resorting to
124
use the <option>approved_by_default</option> value. The
125
default is <quote>PT0S</quote>, i.e. not to wait.
128
The format of <replaceable>TIME</replaceable> is the same
129
as for <varname>timeout</varname> below.
135
<term><option>approval_duration<literal> = </literal
136
><replaceable>TIME</replaceable></option></term>
139
This option is <emphasis>optional</emphasis>.
142
How long an external approval lasts. The default is 1
146
The format of <replaceable>TIME</replaceable> is the same
147
as for <varname>timeout</varname> below.
153
<term><option>approved_by_default<literal> = </literal
154
>{ <literal >1</literal> | <literal>yes</literal> | <literal
155
>true</literal> | <literal>on</literal> | <literal
156
>0</literal> | <literal>no</literal> | <literal
157
>false</literal> | <literal>off</literal> }</option></term>
160
Whether to approve a client by default after
161
the <option>approval_delay</option>. The default
162
is <quote>True</quote>.
168
<term><option>checker<literal> = </literal><replaceable
169
>COMMAND</replaceable></option></term>
172
This option is <emphasis>optional</emphasis>.
175
This option overrides the default shell command that the
176
server will use to check if the client is still up. Any
177
output of the command will be ignored, only the exit code
178
is checked: If the exit code of the command is zero, the
179
client is considered up. The command will be run using
180
<quote><command><filename>/bin/sh</filename>
188
181
<option>-c</option></command></quote>, so
189
182
<varname>PATH</varname> will be searched. The default
190
183
value for the checker command is <quote><literal
191
184
><command>fping</command> <option>-q</option> <option
192
>--</option> %(host)s</literal></quote>.
185
>--</option> %%(host)s</literal></quote>. Note that
186
<command>mandos-keygen</command>, when generating output
187
to be inserted into this file, normally looks for an SSH
188
server on the Mandos client, and, if it find one, outputs
189
a <option>checker</option> option to check for the
190
client’s key fingerprint – this is more secure against
195
194
In addition to normal start time expansion, this option
203
<term><literal>fingerprint</literal></term>
205
<synopsis><literal>fingerprint = </literal><replaceable
206
>HEXSTRING</replaceable>
202
<term><option>extended_timeout<literal> = </literal><replaceable
203
>TIME</replaceable></option></term>
206
This option is <emphasis>optional</emphasis>.
209
Extended timeout is an added timeout that is given once
210
after a password has been sent successfully to a client.
211
The timeout is by default longer than the normal timeout,
212
and is used for handling the extra long downtime while a
213
machine is booting up. Time to take into consideration
214
when changing this value is file system checks and quota
215
checks. The default value is 15 minutes.
218
The format of <replaceable>TIME</replaceable> is the same
219
as for <varname>timeout</varname> below.
225
<term><option>fingerprint<literal> = </literal
226
><replaceable>HEXSTRING</replaceable></option></term>
229
This option is <emphasis>required</emphasis>.
209
232
This option sets the OpenPGP fingerprint that identifies
210
233
the public key that clients authenticate themselves with
211
through TLS. The string needs to be in hexidecimal form,
234
through TLS. The string needs to be in hexadecimal form,
212
235
but spaces or upper/lower case are not significant.
218
<term><literal>secret</literal></term>
220
<synopsis><literal>secret = </literal><replaceable
221
>BASE64_ENCODED_DATA</replaceable>
241
<term><option><literal>host = </literal><replaceable
242
>STRING</replaceable></option></term>
245
This option is <emphasis>optional</emphasis>, but highly
246
<emphasis>recommended</emphasis> unless the
247
<option>checker</option> option is modified to a
248
non-standard value without <quote>%%(host)s</quote> in it.
251
Host name for this client. This is not used by the server
252
directly, but can be, and is by default, used by the
253
checker. See the <option>checker</option> option.
259
<term><option>interval<literal> = </literal><replaceable
260
>TIME</replaceable></option></term>
263
This option is <emphasis>optional</emphasis>.
266
How often to run the checker to confirm that a client is
267
still up. <emphasis>Note:</emphasis> a new checker will
268
not be started if an old one is still running. The server
269
will wait for a checker to complete until the below
270
<quote><varname>timeout</varname></quote> occurs, at which
271
time the client will be disabled, and any running checker
272
killed. The default interval is 2 minutes.
275
The format of <replaceable>TIME</replaceable> is the same
276
as for <varname>timeout</varname> below.
282
<term><option>secfile<literal> = </literal><replaceable
283
>FILENAME</replaceable></option></term>
286
This option is only used if <option>secret</option> is not
287
specified, in which case this option is
288
<emphasis>required</emphasis>.
291
Similar to the <option>secret</option>, except the secret
292
data is in an external file. The contents of the file
293
should <emphasis>not</emphasis> be base64-encoded, but
294
will be sent to clients verbatim.
297
File names of the form <filename>~user/foo/bar</filename>
298
and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
305
<term><option>secret<literal> = </literal><replaceable
306
>BASE64_ENCODED_DATA</replaceable></option></term>
309
If this option is not specified, the <option
310
>secfile</option> option is <emphasis>required</emphasis>
224
314
If present, this option must be set to a string of
225
315
base64-encoded binary data. It will be decoded and sent
238
328
lines is that a line beginning with white space adds to
239
329
the value of the previous line, RFC 822-style.
242
If this option is not specified, the <option
243
>secfile</option> option is used instead, but one of them
244
<emphasis>must</emphasis> be present.
250
<term><literal>secfile</literal></term>
252
<synopsis><literal>secfile = </literal><replaceable
253
>FILENAME</replaceable>
256
The same as <option>secret</option>, but the secret data
257
is in an external file. The contents of the file should
258
<emphasis>not</emphasis> be base64-encoded, but will be
259
sent to clients verbatim.
262
This option is only used, and <emphasis>must</emphasis> be
263
present, if <option>secret</option> is not specified.
269
<term><literal>host</literal></term>
271
<synopsis><literal>host = </literal><replaceable
272
>STRING</replaceable>
275
Host name for this client. This is not used by the server
276
directly, but can be, and is by default, used by the
277
checker. See the <option>checker</option> option.
335
<term><option>timeout<literal> = </literal><replaceable
336
>TIME</replaceable></option></term>
339
This option is <emphasis>optional</emphasis>.
342
The timeout is how long the server will wait, after a
343
successful checker run, until a client is disabled and not
344
allowed to get the data this server holds. By default
345
Mandos will use 5 minutes. See also the
346
<option>extended_timeout</option> option.
349
The <replaceable>TIME</replaceable> is specified as an RFC
350
3339 duration; for example
351
<quote><literal>P1Y2M3DT4H5M6S</literal></quote> meaning
352
one year, two months, three days, four hours, five
353
minutes, and six seconds. Some values can be omitted, see
354
RFC 3339 Appendix A for details.
360
<term><option>enabled<literal> = </literal>{ <literal
361
>1</literal> | <literal>yes</literal> | <literal>true</literal
362
> | <literal >on</literal> | <literal>0</literal> | <literal
363
>no</literal> | <literal>false</literal> | <literal
364
>off</literal> }</option></term>
367
Whether this client should be enabled by default. The
368
default is <quote>true</quote>.
285
376
<refsect1 id="expansion">
286
377
<title>EXPANSION</title>
317
408
<quote><literal>%%(<replaceable>foo</replaceable>)s</literal
318
409
></quote> will be replaced by the value of the attribute
319
410
<varname>foo</varname> of the internal
320
<quote><classname>Client</classname></quote> object. See the
321
source code for details, and let the authors know of any
322
attributes that are useful so they may be preserved to any new
323
versions of this software.
411
<quote><classname>Client</classname></quote> object in the
412
Mandos server. The currently allowed values for
413
<replaceable>foo</replaceable> are:
414
<quote><literal>approval_delay</literal></quote>,
415
<quote><literal>approval_duration</literal></quote>,
416
<quote><literal>created</literal></quote>,
417
<quote><literal>enabled</literal></quote>,
418
<quote><literal>expires</literal></quote>,
419
<quote><literal>fingerprint</literal></quote>,
420
<quote><literal>host</literal></quote>,
421
<quote><literal>interval</literal></quote>,
422
<quote><literal>last_approval_request</literal></quote>,
423
<quote><literal>last_checked_ok</literal></quote>,
424
<quote><literal>last_enabled</literal></quote>,
425
<quote><literal>name</literal></quote>,
426
<quote><literal>timeout</literal></quote>, and, if using
427
D-Bus, <quote><literal>dbus_object_path</literal></quote>.
428
See the source code for details. <emphasis role="strong"
429
>Currently, <emphasis>none</emphasis> of these attributes
430
except <quote><literal>host</literal></quote> are guaranteed
431
to be valid in future versions.</emphasis> Therefore, please
432
let the authors know of any attributes that are useful so they
433
may be preserved to any new versions of this software.
326
436
Note that this means that, in order to include an actual
385
496
4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
387
498
host = foo.example.org
392
503
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
393
504
secfile = /etc/mandos/bar-secret
506
approved_by_default = False
507
approval_delay = PT30S
396
508
</programlisting>
397
509
</informalexample>
400
512
<refsect1 id="see_also">
401
513
<title>SEE ALSO</title>
404
<refentrytitle>mandos</refentrytitle>
405
<manvolnum>8</manvolnum></citerefentry>, <citerefentry>
406
<refentrytitle>mandos-keygen</refentrytitle>
407
<manvolnum>8</manvolnum></citerefentry>, <citerefentry>
408
<refentrytitle>mandos.conf</refentrytitle>
409
<manvolnum>5</manvolnum></citerefentry>
515
<citerefentry><refentrytitle>intro</refentrytitle>
516
<manvolnum>8mandos</manvolnum></citerefentry>,
517
<citerefentry><refentrytitle>mandos-keygen</refentrytitle>
518
<manvolnum>8</manvolnum></citerefentry>,
519
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
520
<manvolnum>5</manvolnum></citerefentry>,
521
<citerefentry><refentrytitle>mandos</refentrytitle>
522
<manvolnum>8</manvolnum></citerefentry>,
523
<citerefentry><refentrytitle>fping</refentrytitle>
524
<manvolnum>8</manvolnum></citerefentry>
529
RFC 3339: <citetitle>Date and Time on the Internet:
530
Timestamps</citetitle>
534
The time intervals are in the "duration" format, as
535
specified in ABNF in Appendix A of RFC 3339.
413
542
<!-- Local Variables: -->