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 "2014-06-22">
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
40
<holder>Teddy Hogeborn</holder>
34
41
<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/"/>.
43
<xi:include href="legalnotice.xml"/>
62
47
<refentrytitle>&CONFNAME;</refentrytitle>
63
48
<manvolnum>5</manvolnum>
69
54
Configuration file for the Mandos server
59
<synopsis>&CONFPATH;</synopsis>
79
62
<refsect1 id="description">
80
63
<title>DESCRIPTION</title>
82
The file &CONFPATH; is the configuration file for <citerefentry
65
The file &CONFPATH; is a configuration file for <citerefentry
83
66
><refentrytitle>mandos</refentrytitle>
84
<manvolnum>8</manvolnum></citerefentry>, read by it at startup,
85
where each client that will be able to use the service needs to
86
be listed. All clients listed will be regarded as valid, even
87
if a client was declared invalid in a previous run of the
67
<manvolnum>8</manvolnum></citerefentry>, read by it at startup.
68
The file needs to list all clients that should be able to use
69
the service. The settings in this file can be overridden by
70
runtime changes to the server, which it saves across restarts.
71
(See the section called <quote>PERSISTENT STATE</quote> in
72
<citerefentry><refentrytitle>mandos</refentrytitle><manvolnum
73
>8</manvolnum></citerefentry>.) However, any <emphasis
74
>changes</emphasis> to this file (including adding and removing
75
clients) will, at startup, override changes done during runtime.
91
78
The format starts with a <literal>[<replaceable>section
111
98
<refsect1 id="options">
112
99
<title>OPTIONS</title>
114
The possible options are:
101
<emphasis>Note:</emphasis> all option values are subject to
102
start time expansion, see <xref linkend="expansion"/>.
105
Unknown options are ignored. The used options are as follows:
120
<term><literal><varname>timeout</varname></literal></term>
122
<synopsis><literal>timeout = </literal><replaceable
126
The timeout is how long the server will wait for a
127
successful checker run until a client is considered
128
invalid - that is, ineligible to get the data this server
129
holds. By default Mandos will use 1 hour.
132
The <replaceable>TIME</replaceable> is specified as a
133
space-separated number of values, each of which is a
134
number and a one-character suffix. The suffix must be one
135
of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
136
<quote>h</quote>, and <quote>w</quote> for days, seconds,
137
minutes, hours, and weeks, respectively. The values are
138
added together to give the total time value, so all of
139
<quote><literal>330s</literal></quote>,
140
<quote><literal>110s 110s 110s</literal></quote>, and
141
<quote><literal>5m 30s</literal></quote> will give a value
142
of five minutes and thirty seconds.
148
<term><literal><varname>interval</varname></literal></term>
150
<synopsis><literal>interval = </literal><replaceable
154
How often to run the checker to confirm that a client is
155
still up. <emphasis>Note:</emphasis> a new checker will
156
not be started if an old one is still running. The server
157
will wait for a checker to complete until the above
158
<quote><varname>timeout</varname></quote> occurs, at which
159
time the client will be marked invalid, and any running
160
checker killed. The default interval is 5 minutes.
163
The format of <replaceable>TIME</replaceable> is the same
164
as for <varname>timeout</varname> above.
170
<term><literal>checker</literal></term>
172
<synopsis><literal>checker = </literal><replaceable
173
>COMMAND</replaceable>
176
This option allows you to override the default shell
177
command that the server will use to check if the client is
178
still up. The output of the command will be ignored, only
179
the exit code is checked. The command will be run using
111
<term><option>approval_delay<literal> = </literal><replaceable
112
>TIME</replaceable></option></term>
115
This option is <emphasis>optional</emphasis>.
118
How long to wait for external approval before resorting to
119
use the <option>approved_by_default</option> value. The
120
default is <quote>PT0S</quote>, i.e. not to wait.
123
The format of <replaceable>TIME</replaceable> is the same
124
as for <varname>timeout</varname> below.
130
<term><option>approval_duration<literal> = </literal
131
><replaceable>TIME</replaceable></option></term>
134
This option is <emphasis>optional</emphasis>.
137
How long an external approval lasts. The default is 1
141
The format of <replaceable>TIME</replaceable> is the same
142
as for <varname>timeout</varname> below.
148
<term><option>approved_by_default<literal> = </literal
149
>{ <literal >1</literal> | <literal>yes</literal> | <literal
150
>true</literal> | <literal>on</literal> | <literal
151
>0</literal> | <literal>no</literal> | <literal
152
>false</literal> | <literal>off</literal> }</option></term>
155
Whether to approve a client by default after
156
the <option>approval_delay</option>. The default
157
is <quote>True</quote>.
163
<term><option>checker<literal> = </literal><replaceable
164
>COMMAND</replaceable></option></term>
167
This option is <emphasis>optional</emphasis>.
170
This option overrides the default shell command that the
171
server will use to check if the client is still up. Any
172
output of the command will be ignored, only the exit code
173
is checked: If the exit code of the command is zero, the
174
client is considered up. The command will be run using
180
175
<quote><command><filename>/bin/sh</filename>
181
<option>-c</option></command></quote>. The default
182
command is <quote><literal><command>fping</command>
183
<option>-q</option> <option>--</option>
184
%(host)s</literal></quote>.
176
<option>-c</option></command></quote>, so
177
<varname>PATH</varname> will be searched. The default
178
value for the checker command is <quote><literal
179
><command>fping</command> <option>-q</option> <option
180
>--</option> %%(host)s</literal></quote>. Note that
181
<command>mandos-keygen</command>, when generating output
182
to be inserted into this file, normally looks for an SSH
183
server on the Mandos client, and, if it find one, outputs
184
a <option>checker</option> option to check for the
185
client’s key fingerprint – this is more secure against
187
189
In addition to normal start time expansion, this option
195
<term><literal>fingerprint</literal></term>
197
<synopsis><literal>fingerprint = </literal><replaceable
198
>HEXSTRING</replaceable>
197
<term><option>extended_timeout<literal> = </literal><replaceable
198
>TIME</replaceable></option></term>
201
This option is <emphasis>optional</emphasis>.
204
Extended timeout is an added timeout that is given once
205
after a password has been sent successfully to a client.
206
The timeout is by default longer than the normal timeout,
207
and is used for handling the extra long downtime while a
208
machine is booting up. Time to take into consideration
209
when changing this value is file system checks and quota
210
checks. The default value is 15 minutes.
213
The format of <replaceable>TIME</replaceable> is the same
214
as for <varname>timeout</varname> below.
220
<term><option>fingerprint<literal> = </literal
221
><replaceable>HEXSTRING</replaceable></option></term>
224
This option is <emphasis>required</emphasis>.
201
227
This option sets the OpenPGP fingerprint that identifies
202
228
the public key that clients authenticate themselves with
210
<term><literal>secret</literal></term>
212
<synopsis><literal>secret = </literal><replaceable
213
>BASE64_ENCODED_DATA</replaceable>
236
<term><option><literal>host = </literal><replaceable
237
>STRING</replaceable></option></term>
240
This option is <emphasis>optional</emphasis>, but highly
241
<emphasis>recommended</emphasis> unless the
242
<option>checker</option> option is modified to a
243
non-standard value without <quote>%%(host)s</quote> in it.
246
Host name for this client. This is not used by the server
247
directly, but can be, and is by default, used by the
248
checker. See the <option>checker</option> option.
254
<term><option>interval<literal> = </literal><replaceable
255
>TIME</replaceable></option></term>
258
This option is <emphasis>optional</emphasis>.
261
How often to run the checker to confirm that a client is
262
still up. <emphasis>Note:</emphasis> a new checker will
263
not be started if an old one is still running. The server
264
will wait for a checker to complete until the below
265
<quote><varname>timeout</varname></quote> occurs, at which
266
time the client will be disabled, and any running checker
267
killed. The default interval is 2 minutes.
270
The format of <replaceable>TIME</replaceable> is the same
271
as for <varname>timeout</varname> below.
277
<term><option>secfile<literal> = </literal><replaceable
278
>FILENAME</replaceable></option></term>
281
This option is only used if <option>secret</option> is not
282
specified, in which case this option is
283
<emphasis>required</emphasis>.
286
Similar to the <option>secret</option>, except the secret
287
data is in an external file. The contents of the file
288
should <emphasis>not</emphasis> be base64-encoded, but
289
will be sent to clients verbatim.
292
File names of the form <filename>~user/foo/bar</filename>
293
and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
300
<term><option>secret<literal> = </literal><replaceable
301
>BASE64_ENCODED_DATA</replaceable></option></term>
304
If this option is not specified, the <option
305
>secfile</option> option is <emphasis>required</emphasis>
216
309
If present, this option must be set to a string of
217
310
base64-encoded binary data. It will be decoded and sent
218
311
to the client matching the above
219
312
<option>fingerprint</option>. This should, of course, be
220
313
OpenPGP encrypted data, decryptable only by the client.
221
<!-- The program <citerefentry><refentrytitle><command -->
222
<!-- >mandos-keygen</command></refentrytitle><manvolnum -->
223
<!-- >8</manvolnum></citerefentry> can be used to generate it, -->
227
Note: this value of this option will probably run over
228
many lines, and will then have to use the fact that a line
229
beginning with white space adds to the value of the
230
previous line, RFC 822-style.
236
<term><literal>secfile</literal></term>
239
Base 64 encoded OpenPGP encrypted password encrypted by
240
the clients openpgp certificate as a binary file.
246
<term><literal>host</literal></term>
249
Host name that can be used in for checking that the client is up.
255
<term><literal>checker</literal></term>
258
Shell command that the server will use to check up if a
265
<term><literal>timeout</literal></term>
268
Duration that a client can be down whitout be removed from
314
The program <citerefentry><refentrytitle><command
315
>mandos-keygen</command></refentrytitle><manvolnum
316
>8</manvolnum></citerefentry> can, using its
317
<option>--password</option> option, be used to generate
321
Note: this value of this option will probably be very
322
long. A useful feature to avoid having unreadably-long
323
lines is that a line beginning with white space adds to
324
the value of the previous line, RFC 822-style.
330
<term><option>timeout<literal> = </literal><replaceable
331
>TIME</replaceable></option></term>
334
This option is <emphasis>optional</emphasis>.
337
The timeout is how long the server will wait, after a
338
successful checker run, until a client is disabled and not
339
allowed to get the data this server holds. By default
340
Mandos will use 5 minutes. See also the
341
<option>extended_timeout</option> option.
344
The <replaceable>TIME</replaceable> is specified as an RFC
345
3339 duration; for example
346
<quote><literal>P1Y2M3DT4H5M6S</literal></quote> meaning
347
one year, two months, three days, four hours, five
348
minutes, and six seconds. Some values can be omitted, see
349
RFC 3339 Appendix A for details.
355
<term><option>enabled<literal> = </literal>{ <literal
356
>1</literal> | <literal>yes</literal> | <literal>true</literal
357
> | <literal >on</literal> | <literal>0</literal> | <literal
358
>no</literal> | <literal>false</literal> | <literal
359
>off</literal> }</option></term>
362
Whether this client should be enabled by default. The
363
default is <quote>true</quote>.
277
371
<refsect1 id="expansion">
278
372
<title>EXPANSION</title>
309
403
<quote><literal>%%(<replaceable>foo</replaceable>)s</literal
310
404
></quote> will be replaced by the value of the attribute
311
405
<varname>foo</varname> of the internal
312
<quote><classname>Client</classname></quote> object. See the
313
source code for details, and let the authors know of any
314
attributes that are useful so they may be preserved to any new
315
versions of this software.
406
<quote><classname>Client</classname></quote> object in the
407
Mandos server. The currently allowed values for
408
<replaceable>foo</replaceable> are:
409
<quote><literal>approval_delay</literal></quote>,
410
<quote><literal>approval_duration</literal></quote>,
411
<quote><literal>created</literal></quote>,
412
<quote><literal>enabled</literal></quote>,
413
<quote><literal>expires</literal></quote>,
414
<quote><literal>fingerprint</literal></quote>,
415
<quote><literal>host</literal></quote>,
416
<quote><literal>interval</literal></quote>,
417
<quote><literal>last_approval_request</literal></quote>,
418
<quote><literal>last_checked_ok</literal></quote>,
419
<quote><literal>last_enabled</literal></quote>,
420
<quote><literal>name</literal></quote>,
421
<quote><literal>timeout</literal></quote>, and, if using
422
D-Bus, <quote><literal>dbus_object_path</literal></quote>.
423
See the source code for details. <emphasis role="strong"
424
>Currently, <emphasis>none</emphasis> of these attributes
425
except <quote><literal>host</literal></quote> are guaranteed
426
to be valid in future versions.</emphasis> Therefore, please
427
let the authors know of any attributes that are useful so they
428
may be preserved to any new versions of this software.
318
431
Note that this means that, in order to include an actual
319
432
percent character (<quote>%</quote>) in a
320
<varname>checker</varname> options, <emphasis>four</emphasis>
433
<varname>checker</varname> option, <emphasis>four</emphasis>
321
434
percent characters in a row (<quote>%%%%</quote>) must be
322
435
entered. Also, a bad format here will lead to an immediate
323
436
but <emphasis>silent</emphasis> run-time fatal exit; debug
324
mode is needed to track down an error of this kind.
437
mode is needed to expose an error of this kind.
330
443
<refsect1 id="files">
331
444
<title>FILES</title>
376
489
5MHdW9AYsNJZAQSOpirE4Xi31CSlWAi9KV+cUCmWF5zOFy1x23P6PjdaRm
377
490
4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
380
492
host = foo.example.org
385
497
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
386
secfile = /etc/mandos/bar-secret.txt.asc
498
secfile = /etc/mandos/bar-secret
500
approved_by_default = False
501
approval_delay = PT30S
388
502
</programlisting>
389
503
</informalexample>
506
<refsect1 id="see_also">
507
<title>SEE ALSO</title>
509
<citerefentry><refentrytitle>intro</refentrytitle>
510
<manvolnum>8mandos</manvolnum></citerefentry>,
511
<citerefentry><refentrytitle>mandos-keygen</refentrytitle>
512
<manvolnum>8</manvolnum></citerefentry>,
513
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
514
<manvolnum>5</manvolnum></citerefentry>,
515
<citerefentry><refentrytitle>mandos</refentrytitle>
516
<manvolnum>8</manvolnum></citerefentry>,
517
<citerefentry><refentrytitle>fping</refentrytitle>
518
<manvolnum>8</manvolnum></citerefentry>
523
RFC 3339: <citetitle>Date and Time on the Internet:
524
Timestamps</citetitle>
528
The time intervals are in the "duration" format, as
529
specified in ABNF in Appendix A of RFC 3339.
536
<!-- Local Variables: -->
537
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
538
<!-- time-stamp-end: "[\"']>" -->
539
<!-- time-stamp-format: "%:y-%02m-%02d" -->