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 "2015-07-20">
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
43
<holder>Teddy Hogeborn</holder>
34
44
<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/"/>.
46
<xi:include href="legalnotice.xml"/>
62
50
<refentrytitle>&CONFNAME;</refentrytitle>
63
51
<manvolnum>5</manvolnum>
83
69
><refentrytitle>mandos</refentrytitle>
84
70
<manvolnum>8</manvolnum></citerefentry>, read by it at startup.
85
71
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
72
the service. The settings in this file can be overridden by
73
runtime changes to the server, which it saves across restarts.
74
(See the section called <quote>PERSISTENT STATE</quote> in
75
<citerefentry><refentrytitle>mandos</refentrytitle><manvolnum
76
>8</manvolnum></citerefentry>.) However, any <emphasis
77
>changes</emphasis> to this file (including adding and removing
78
clients) will, at startup, override changes done during runtime.
91
81
The format starts with a <literal>[<replaceable>section
115
105
start time expansion, see <xref linkend="expansion"/>.
118
Uknown options are ignored. The used options are as follows:
108
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>
114
<term><option>approval_delay<literal> = </literal><replaceable
115
>TIME</replaceable></option></term>
118
This option is <emphasis>optional</emphasis>.
121
How long to wait for external approval before resorting to
122
use the <option>approved_by_default</option> value. The
123
default is <quote>PT0S</quote>, i.e. not to wait.
126
The format of <replaceable>TIME</replaceable> is the same
127
as for <varname>timeout</varname> below.
133
<term><option>approval_duration<literal> = </literal
134
><replaceable>TIME</replaceable></option></term>
137
This option is <emphasis>optional</emphasis>.
140
How long an external approval lasts. The default is 1
144
The format of <replaceable>TIME</replaceable> is the same
145
as for <varname>timeout</varname> below.
151
<term><option>approved_by_default<literal> = </literal
152
>{ <literal >1</literal> | <literal>yes</literal> | <literal
153
>true</literal> | <literal>on</literal> | <literal
154
>0</literal> | <literal>no</literal> | <literal
155
>false</literal> | <literal>off</literal> }</option></term>
158
Whether to approve a client by default after
159
the <option>approval_delay</option>. The default
160
is <quote>True</quote>.
166
<term><option>checker<literal> = </literal><replaceable
167
>COMMAND</replaceable></option></term>
170
This option is <emphasis>optional</emphasis>.
173
This option overrides the default shell command that the
174
server will use to check if the client is still up. Any
175
output of the command will be ignored, only the exit code
176
is checked: If the exit code of the command is zero, the
177
client is considered up. The command will be run using
178
<quote><command><filename>/bin/sh</filename>
186
179
<option>-c</option></command></quote>, so
187
180
<varname>PATH</varname> will be searched. The default
188
181
value for the checker command is <quote><literal
189
182
><command>fping</command> <option>-q</option> <option
190
>--</option> %(host)s</literal></quote>.
183
>--</option> %%(host)s</literal></quote>. Note that
184
<command>mandos-keygen</command>, when generating output
185
to be inserted into this file, normally looks for an SSH
186
server on the Mandos client, and, if it find one, outputs
187
a <option>checker</option> option to check for the
188
client’s key fingerprint – this is more secure against
193
192
In addition to normal start time expansion, this option
201
<term><literal>fingerprint</literal></term>
203
<synopsis><literal>fingerprint = </literal><replaceable
204
>HEXSTRING</replaceable>
200
<term><option>extended_timeout<literal> = </literal><replaceable
201
>TIME</replaceable></option></term>
204
This option is <emphasis>optional</emphasis>.
207
Extended timeout is an added timeout that is given once
208
after a password has been sent successfully to a client.
209
The timeout is by default longer than the normal timeout,
210
and is used for handling the extra long downtime while a
211
machine is booting up. Time to take into consideration
212
when changing this value is file system checks and quota
213
checks. The default value is 15 minutes.
216
The format of <replaceable>TIME</replaceable> is the same
217
as for <varname>timeout</varname> below.
223
<term><option>fingerprint<literal> = </literal
224
><replaceable>HEXSTRING</replaceable></option></term>
227
This option is <emphasis>required</emphasis>.
207
230
This option sets the OpenPGP fingerprint that identifies
208
231
the public key that clients authenticate themselves with
216
<term><literal>secret</literal></term>
218
<synopsis><literal>secret = </literal><replaceable
219
>BASE64_ENCODED_DATA</replaceable>
239
<term><option><literal>host = </literal><replaceable
240
>STRING</replaceable></option></term>
243
This option is <emphasis>optional</emphasis>, but highly
244
<emphasis>recommended</emphasis> unless the
245
<option>checker</option> option is modified to a
246
non-standard value without <quote>%%(host)s</quote> in it.
249
Host name for this client. This is not used by the server
250
directly, but can be, and is by default, used by the
251
checker. See the <option>checker</option> option.
257
<term><option>interval<literal> = </literal><replaceable
258
>TIME</replaceable></option></term>
261
This option is <emphasis>optional</emphasis>.
264
How often to run the checker to confirm that a client is
265
still up. <emphasis>Note:</emphasis> a new checker will
266
not be started if an old one is still running. The server
267
will wait for a checker to complete until the below
268
<quote><varname>timeout</varname></quote> occurs, at which
269
time the client will be disabled, and any running checker
270
killed. The default interval is 2 minutes.
273
The format of <replaceable>TIME</replaceable> is the same
274
as for <varname>timeout</varname> below.
280
<term><option>secfile<literal> = </literal><replaceable
281
>FILENAME</replaceable></option></term>
284
This option is only used if <option>secret</option> is not
285
specified, in which case this option is
286
<emphasis>required</emphasis>.
289
Similar to the <option>secret</option>, except the secret
290
data is in an external file. The contents of the file
291
should <emphasis>not</emphasis> be base64-encoded, but
292
will be sent to clients verbatim.
295
File names of the form <filename>~user/foo/bar</filename>
296
and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
303
<term><option>secret<literal> = </literal><replaceable
304
>BASE64_ENCODED_DATA</replaceable></option></term>
307
If this option is not specified, the <option
308
>secfile</option> option is <emphasis>required</emphasis>
222
312
If present, this option must be set to a string of
223
313
base64-encoded binary data. It will be decoded and sent
236
326
lines is that a line beginning with white space adds to
237
327
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.
333
<term><option>timeout<literal> = </literal><replaceable
334
>TIME</replaceable></option></term>
337
This option is <emphasis>optional</emphasis>.
340
The timeout is how long the server will wait, after a
341
successful checker run, until a client is disabled and not
342
allowed to get the data this server holds. By default
343
Mandos will use 5 minutes. See also the
344
<option>extended_timeout</option> option.
347
The <replaceable>TIME</replaceable> is specified as an RFC
348
3339 duration; for example
349
<quote><literal>P1Y2M3DT4H5M6S</literal></quote> meaning
350
one year, two months, three days, four hours, five
351
minutes, and six seconds. Some values can be omitted, see
352
RFC 3339 Appendix A for details.
358
<term><option>enabled<literal> = </literal>{ <literal
359
>1</literal> | <literal>yes</literal> | <literal>true</literal
360
> | <literal >on</literal> | <literal>0</literal> | <literal
361
>no</literal> | <literal>false</literal> | <literal
362
>off</literal> }</option></term>
365
Whether this client should be enabled by default. The
366
default is <quote>true</quote>.
283
374
<refsect1 id="expansion">
284
375
<title>EXPANSION</title>
315
406
<quote><literal>%%(<replaceable>foo</replaceable>)s</literal
316
407
></quote> will be replaced by the value of the attribute
317
408
<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.
409
<quote><classname>Client</classname></quote> object in the
410
Mandos server. The currently allowed values for
411
<replaceable>foo</replaceable> are:
412
<quote><literal>approval_delay</literal></quote>,
413
<quote><literal>approval_duration</literal></quote>,
414
<quote><literal>created</literal></quote>,
415
<quote><literal>enabled</literal></quote>,
416
<quote><literal>expires</literal></quote>,
417
<quote><literal>fingerprint</literal></quote>,
418
<quote><literal>host</literal></quote>,
419
<quote><literal>interval</literal></quote>,
420
<quote><literal>last_approval_request</literal></quote>,
421
<quote><literal>last_checked_ok</literal></quote>,
422
<quote><literal>last_enabled</literal></quote>,
423
<quote><literal>name</literal></quote>,
424
<quote><literal>timeout</literal></quote>, and, if using
425
D-Bus, <quote><literal>dbus_object_path</literal></quote>.
426
See the source code for details. <emphasis role="strong"
427
>Currently, <emphasis>none</emphasis> of these attributes
428
except <quote><literal>host</literal></quote> are guaranteed
429
to be valid in future versions.</emphasis> Therefore, please
430
let the authors know of any attributes that are useful so they
431
may be preserved to any new versions of this software.
324
434
Note that this means that, in order to include an actual
383
493
4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
385
495
host = foo.example.org
390
500
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
391
501
secfile = /etc/mandos/bar-secret
503
approved_by_default = False
504
approval_delay = PT30S
394
505
</programlisting>
395
506
</informalexample>
398
509
<refsect1 id="see_also">
399
510
<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>
512
<citerefentry><refentrytitle>intro</refentrytitle>
513
<manvolnum>8mandos</manvolnum></citerefentry>,
514
<citerefentry><refentrytitle>mandos-keygen</refentrytitle>
515
<manvolnum>8</manvolnum></citerefentry>,
516
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
517
<manvolnum>5</manvolnum></citerefentry>,
518
<citerefentry><refentrytitle>mandos</refentrytitle>
519
<manvolnum>8</manvolnum></citerefentry>,
520
<citerefentry><refentrytitle>fping</refentrytitle>
521
<manvolnum>8</manvolnum></citerefentry>
526
RFC 3339: <citetitle>Date and Time on the Internet:
527
Timestamps</citetitle>
531
The time intervals are in the "duration" format, as
532
specified in ABNF in Appendix A of RFC 3339.
539
<!-- Local Variables: -->
540
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
541
<!-- time-stamp-end: "[\"']>" -->
542
<!-- time-stamp-format: "%:y-%02m-%02d" -->