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 "2012-01-01">
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
The format starts with a section under [] which is either
78
The format starts with a <literal>[<replaceable>section
79
header</replaceable>]</literal> which is either
92
80
<literal>[DEFAULT]</literal> or <literal>[<replaceable>client
93
name</replaceable>]</literal>. Following the section is any
94
number of <quote><varname><replaceable>option</replaceable
81
name</replaceable>]</literal>. The <replaceable>client
82
name</replaceable> can be anything, and is not tied to a host
83
name. Following the section header is any number of
84
<quote><varname><replaceable>option</replaceable
95
85
></varname>=<replaceable>value</replaceable></quote> entries,
96
86
with continuations in the style of RFC 822. <quote><varname
97
87
><replaceable>option</replaceable></varname>: <replaceable
98
88
>value</replaceable></quote> is also accepted. Note that
99
89
leading whitespace is removed from values. Values can contain
100
90
format strings which refer to other values in the same section,
101
or values in the <quote>DEFAULT</quote> section. Lines
102
beginning with <quote>#</quote> or <quote>;</quote> are ignored
103
and may be used to provide comments.
91
or values in the <quote>DEFAULT</quote> section (see <xref
92
linkend="expansion"/>). Lines beginning with <quote>#</quote>
93
or <quote>;</quote> are ignored and may be used to provide
107
98
<refsect1 id="options">
108
99
<title>OPTIONS</title>
110
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:
116
<term><literal><varname>timeout</varname></literal></term>
118
<synopsis><literal>timeout = </literal><replaceable
122
The timeout is how long the server will wait for a
123
successful checker run until a client is considered
124
invalid - that is, ineligible to get the data this server
125
holds. By default Mandos will use 1 hour.
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>0s</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 allows you to override the default shell
171
command that the server will use to check if the client is
172
still up. Any output of the command will be ignored, only
173
the exit code is checked: If the exit code of the command
174
is zero, the client is considered up. The command will be
175
run using <quote><command><filename>/bin/sh</filename>
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>.
183
In addition to normal start time expansion, this option
184
will also be subject to runtime expansion; see <xref
185
linkend="expansion"/>.
191
<term><option>extended_timeout<literal> = </literal><replaceable
192
>TIME</replaceable></option></term>
195
This option is <emphasis>optional</emphasis>.
198
Extended timeout is an added timeout that is given once
199
after a password has been sent successfully to a client.
200
The timeout is by default longer than the normal timeout,
201
and is used for handling the extra long downtime while a
202
machine is booting up. Time to take into consideration
203
when changing this value is file system checks and quota
204
checks. The default value is 15 minutes.
207
The format of <replaceable>TIME</replaceable> is the same
208
as for <varname>timeout</varname> below.
214
<term><option>fingerprint<literal> = </literal
215
><replaceable>HEXSTRING</replaceable></option></term>
218
This option is <emphasis>required</emphasis>.
221
This option sets the OpenPGP fingerprint that identifies
222
the public key that clients authenticate themselves with
223
through TLS. The string needs to be in hexidecimal form,
224
but spaces or upper/lower case are not significant.
230
<term><option><literal>host = </literal><replaceable
231
>STRING</replaceable></option></term>
234
This option is <emphasis>optional</emphasis>, but highly
235
<emphasis>recommended</emphasis> unless the
236
<option>checker</option> option is modified to a
237
non-standard value without <quote>%%(host)s</quote> in it.
240
Host name for this client. This is not used by the server
241
directly, but can be, and is by default, used by the
242
checker. See the <option>checker</option> option.
248
<term><option>interval<literal> = </literal><replaceable
249
>TIME</replaceable></option></term>
252
This option is <emphasis>optional</emphasis>.
255
How often to run the checker to confirm that a client is
256
still up. <emphasis>Note:</emphasis> a new checker will
257
not be started if an old one is still running. The server
258
will wait for a checker to complete until the below
259
<quote><varname>timeout</varname></quote> occurs, at which
260
time the client will be disabled, and any running checker
261
killed. The default interval is 2 minutes.
264
The format of <replaceable>TIME</replaceable> is the same
265
as for <varname>timeout</varname> below.
271
<term><option>secfile<literal> = </literal><replaceable
272
>FILENAME</replaceable></option></term>
275
This option is only used if <option>secret</option> is not
276
specified, in which case this option is
277
<emphasis>required</emphasis>.
280
Similar to the <option>secret</option>, except the secret
281
data is in an external file. The contents of the file
282
should <emphasis>not</emphasis> be base64-encoded, but
283
will be sent to clients verbatim.
286
File names of the form <filename>~user/foo/bar</filename>
287
and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
294
<term><option>secret<literal> = </literal><replaceable
295
>BASE64_ENCODED_DATA</replaceable></option></term>
298
If this option is not specified, the <option
299
>secfile</option> option is <emphasis>required</emphasis>
303
If present, this option must be set to a string of
304
base64-encoded binary data. It will be decoded and sent
305
to the client matching the above
306
<option>fingerprint</option>. This should, of course, be
307
OpenPGP encrypted data, decryptable only by the client.
308
The program <citerefentry><refentrytitle><command
309
>mandos-keygen</command></refentrytitle><manvolnum
310
>8</manvolnum></citerefentry> can, using its
311
<option>--password</option> option, be used to generate
315
Note: this value of this option will probably be very
316
long. A useful feature to avoid having unreadably-long
317
lines is that a line beginning with white space adds to
318
the value of the previous line, RFC 822-style.
324
<term><option>timeout<literal> = </literal><replaceable
325
>TIME</replaceable></option></term>
328
This option is <emphasis>optional</emphasis>.
331
The timeout is how long the server will wait, after a
332
successful checker run, until a client is disabled and not
333
allowed to get the data this server holds. By default
334
Mandos will use 5 minutes. See also the
335
<option>extended_timeout</option> option.
128
338
The <replaceable>TIME</replaceable> is specified as a
144
<term><literal><varname>interval</varname></literal></term>
146
<synopsis><literal>interval = </literal><replaceable
150
How often to run the checker to confirm that a client is
151
still up. <emphasis>Note:</emphasis> a new checker will
152
not be started if an old one is still running. The server
153
will wait for a checker to complete until the above
154
<quote><varname>timeout</varname></quote> occurs, at which
155
time the client will be marked invalid, and any running
156
checker killed. The default interval is 5 minutes.
159
The format of <replaceable>TIME</replaceable> is the same
160
as for <varname>timeout</varname> above.
166
<term><literal>checker</literal></term>
169
This option allows you to override the default shell
170
command that the server will use to check up if the client
171
is still up. By default mandos will "fping -q -- %%(host)s"
177
<term><literal>fingerprint</literal></term>
180
This option sets the openpgp fingerprint that identifies
181
the public certificate that clients authenticates themself
182
through gnutls. The string need to be in hex-decimal form.
188
<term><literal>secret</literal></term>
191
Base 64 encoded OpenPGP encrypted password encrypted by
192
the clients openpgp certificate.
198
<term><literal>secfile</literal></term>
201
Base 64 encoded OpenPGP encrypted password encrypted by
202
the clients openpgp certificate as a binary file.
208
<term><literal>host</literal></term>
211
Host name that can be used in for checking that the client is up.
217
<term><literal>checker</literal></term>
220
Shell command that the server will use to check up if a
227
<term><literal>timeout</literal></term>
230
Duration that a client can be down whitout be removed from
354
<term><option>enabled<literal> = </literal>{ <literal
355
>1</literal> | <literal>yes</literal> | <literal>true</literal
356
> | <literal >on</literal> | <literal>0</literal> | <literal
357
>no</literal> | <literal>false</literal> | <literal
358
>off</literal> }</option></term>
361
Whether this client should be enabled by default. The
362
default is <quote>true</quote>.
239
370
<refsect1 id="expansion">
240
371
<title>EXPANSION</title>
271
402
<quote><literal>%%(<replaceable>foo</replaceable>)s</literal
272
403
></quote> will be replaced by the value of the attribute
273
404
<varname>foo</varname> of the internal
274
<quote><classname>Client</classname></quote> object. See the
275
source code for details, and let the authors know of any
276
attributes that are useful so they may be preserved to any new
277
versions of this software.
405
<quote><classname>Client</classname></quote> object in the
406
Mandos server. The currently allowed values for
407
<replaceable>foo</replaceable> are:
408
<quote><literal>approval_delay</literal></quote>,
409
<quote><literal>approval_duration</literal></quote>,
410
<quote><literal>created</literal></quote>,
411
<quote><literal>enabled</literal></quote>,
412
<quote><literal>fingerprint</literal></quote>,
413
<quote><literal>host</literal></quote>,
414
<quote><literal>interval</literal></quote>,
415
<quote><literal>last_approval_request</literal></quote>,
416
<quote><literal>last_checked_ok</literal></quote>,
417
<quote><literal>last_enabled</literal></quote>,
418
<quote><literal>name</literal></quote>,
419
<quote><literal>timeout</literal></quote>, and, if using
420
D-Bus, <quote><literal>dbus_object_path</literal></quote>.
421
See the source code for details. <emphasis role="strong"
422
>Currently, <emphasis>none</emphasis> of these attributes
423
except <quote><literal>host</literal></quote> are guaranteed
424
to be valid in future versions.</emphasis> Therefore, please
425
let the authors know of any attributes that are useful so they
426
may be preserved to any new versions of this software.
280
429
Note that this means that, in order to include an actual
281
430
percent character (<quote>%</quote>) in a
282
<varname>checker</varname> options, <emphasis>four</emphasis>
431
<varname>checker</varname> option, <emphasis>four</emphasis>
283
432
percent characters in a row (<quote>%%%%</quote>) must be
284
433
entered. Also, a bad format here will lead to an immediate
285
434
but <emphasis>silent</emphasis> run-time fatal exit; debug
286
mode is needed to track down an error of this kind.
435
mode is needed to expose an error of this kind.
292
441
<refsect1 id="files">
293
442
<title>FILES</title>