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">
4
5
<!ENTITY CONFNAME "mandos-clients.conf">
5
6
<!ENTITY CONFPATH "<filename>/etc/mandos/clients.conf</filename>">
6
<!ENTITY TIMESTAMP "2011-10-10">
7
<!ENTITY % common SYSTEM "common.ent">
11
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
13
<title>Mandos Manual</title>
11
<title>&CONFNAME;</title>
14
12
<!-- NWalsh’s docbook scripts use this to generate the footer: -->
15
<productname>Mandos</productname>
16
<productnumber>&version;</productnumber>
17
<date>&TIMESTAMP;</date>
13
<productname>&CONFNAME;</productname>
14
<productnumber>&VERSION;</productnumber>
20
17
<firstname>Björn</firstname>
21
18
<surname>Påhlsson</surname>
23
<email>belorn@recompile.se</email>
20
<email>belorn@fukt.bsnet.se</email>
27
24
<firstname>Teddy</firstname>
28
25
<surname>Hogeborn</surname>
30
<email>teddy@recompile.se</email>
27
<email>teddy@fukt.bsnet.se</email>
39
33
<holder>Teddy Hogeborn</holder>
40
34
<holder>Björn Påhlsson</holder>
42
<xi:include href="legalnotice.xml"/>
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
62
<refentrytitle>&CONFNAME;</refentrytitle>
47
63
<manvolnum>5</manvolnum>
53
69
Configuration file for the Mandos server
58
<synopsis>&CONFPATH;</synopsis>
61
79
<refsect1 id="description">
62
80
<title>DESCRIPTION</title>
64
The file &CONFPATH; is a configuration file for <citerefentry
82
The file &CONFPATH; is the configuration file for <citerefentry
65
83
><refentrytitle>mandos</refentrytitle>
66
<manvolnum>8</manvolnum></citerefentry>, read by it at startup.
67
The file needs to list all clients that should be able to use
68
the service. All clients listed will be regarded as enabled,
69
even if a client was disabled in a previous run of the server.
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
72
The format starts with a <literal>[<replaceable>section
73
header</replaceable>]</literal> which is either
91
The format starts with a section under [] which is either
74
92
<literal>[DEFAULT]</literal> or <literal>[<replaceable>client
75
name</replaceable>]</literal>. The <replaceable>client
76
name</replaceable> can be anything, and is not tied to a host
77
name. Following the section header is any number of
78
<quote><varname><replaceable>option</replaceable
93
name</replaceable>]</literal>. Following the section is any
94
number of <quote><varname><replaceable>option</replaceable
79
95
></varname>=<replaceable>value</replaceable></quote> entries,
80
96
with continuations in the style of RFC 822. <quote><varname
81
97
><replaceable>option</replaceable></varname>: <replaceable
82
98
>value</replaceable></quote> is also accepted. Note that
83
99
leading whitespace is removed from values. Values can contain
84
100
format strings which refer to other values in the same section,
85
or values in the <quote>DEFAULT</quote> section (see <xref
86
linkend="expansion"/>). Lines beginning with <quote>#</quote>
87
or <quote>;</quote> are ignored and may be used to provide
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.
92
107
<refsect1 id="options">
93
108
<title>OPTIONS</title>
95
<emphasis>Note:</emphasis> all option values are subject to
96
start time expansion, see <xref linkend="expansion"/>.
99
Unknown options are ignored. The used options are as follows:
110
The possible options are:
105
<term><option>approval_delay<literal> = </literal><replaceable
106
>TIME</replaceable></option></term>
109
This option is <emphasis>optional</emphasis>.
112
How long to wait for external approval before resorting to
113
use the <option>approved_by_default</option> value. The
114
default is <quote>0s</quote>, i.e. not to wait.
117
The format of <replaceable>TIME</replaceable> is the same
118
as for <varname>timeout</varname> below.
124
<term><option>approval_duration<literal> = </literal
125
><replaceable>TIME</replaceable></option></term>
128
This option is <emphasis>optional</emphasis>.
131
How long an external approval lasts. The default is 1
135
The format of <replaceable>TIME</replaceable> is the same
136
as for <varname>timeout</varname> below.
142
<term><option>approved_by_default<literal> = </literal
143
>{ <literal >1</literal> | <literal>yes</literal> | <literal
144
>true</literal> | <literal>on</literal> | <literal
145
>0</literal> | <literal>no</literal> | <literal
146
>false</literal> | <literal>off</literal> }</option></term>
149
Whether to approve a client by default after
150
the <option>approval_delay</option>. The default
151
is <quote>True</quote>.
157
<term><option>checker<literal> = </literal><replaceable
158
>COMMAND</replaceable></option></term>
161
This option is <emphasis>optional</emphasis>.
164
This option allows you to override the default shell
165
command that the server will use to check if the client is
166
still up. Any output of the command will be ignored, only
167
the exit code is checked: If the exit code of the command
168
is zero, the client is considered up. The command will be
169
run using <quote><command><filename>/bin/sh</filename>
170
<option>-c</option></command></quote>, so
171
<varname>PATH</varname> will be searched. The default
172
value for the checker command is <quote><literal
173
><command>fping</command> <option>-q</option> <option
174
>--</option> %%(host)s</literal></quote>.
177
In addition to normal start time expansion, this option
178
will also be subject to runtime expansion; see <xref
179
linkend="expansion"/>.
185
<term><option>extended_timeout<literal> = </literal><replaceable
186
>TIME</replaceable></option></term>
189
This option is <emphasis>optional</emphasis>.
192
Extended timeout is an added timeout that is given once
193
after a password has been sent successfully to a client.
194
The timeout is by default longer than the normal timeout,
195
and is used for handling the extra long downtime while a
196
machine is booting up. Time to take into consideration
197
when changing this value is file system checks and quota
198
checks. The default value is 15 minutes.
201
The format of <replaceable>TIME</replaceable> is the same
202
as for <varname>timeout</varname> below.
208
<term><option>fingerprint<literal> = </literal
209
><replaceable>HEXSTRING</replaceable></option></term>
212
This option is <emphasis>required</emphasis>.
215
This option sets the OpenPGP fingerprint that identifies
216
the public key that clients authenticate themselves with
217
through TLS. The string needs to be in hexidecimal form,
218
but spaces or upper/lower case are not significant.
224
<term><option><literal>host = </literal><replaceable
225
>STRING</replaceable></option></term>
228
This option is <emphasis>optional</emphasis>, but highly
229
<emphasis>recommended</emphasis> unless the
230
<option>checker</option> option is modified to a
231
non-standard value without <quote>%%(host)s</quote> in it.
234
Host name for this client. This is not used by the server
235
directly, but can be, and is by default, used by the
236
checker. See the <option>checker</option> option.
242
<term><option>interval<literal> = </literal><replaceable
243
>TIME</replaceable></option></term>
246
This option is <emphasis>optional</emphasis>.
249
How often to run the checker to confirm that a client is
250
still up. <emphasis>Note:</emphasis> a new checker will
251
not be started if an old one is still running. The server
252
will wait for a checker to complete until the below
253
<quote><varname>timeout</varname></quote> occurs, at which
254
time the client will be disabled, and any running checker
255
killed. The default interval is 2 minutes.
258
The format of <replaceable>TIME</replaceable> is the same
259
as for <varname>timeout</varname> below.
265
<term><option>secfile<literal> = </literal><replaceable
266
>FILENAME</replaceable></option></term>
269
This option is only used if <option>secret</option> is not
270
specified, in which case this option is
271
<emphasis>required</emphasis>.
274
Similar to the <option>secret</option>, except the secret
275
data is in an external file. The contents of the file
276
should <emphasis>not</emphasis> be base64-encoded, but
277
will be sent to clients verbatim.
280
File names of the form <filename>~user/foo/bar</filename>
281
and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
288
<term><option>secret<literal> = </literal><replaceable
289
>BASE64_ENCODED_DATA</replaceable></option></term>
292
If this option is not specified, the <option
293
>secfile</option> option is <emphasis>required</emphasis>
297
If present, this option must be set to a string of
298
base64-encoded binary data. It will be decoded and sent
299
to the client matching the above
300
<option>fingerprint</option>. This should, of course, be
301
OpenPGP encrypted data, decryptable only by the client.
302
The program <citerefentry><refentrytitle><command
303
>mandos-keygen</command></refentrytitle><manvolnum
304
>8</manvolnum></citerefentry> can, using its
305
<option>--password</option> option, be used to generate
309
Note: this value of this option will probably be very
310
long. A useful feature to avoid having unreadably-long
311
lines is that a line beginning with white space adds to
312
the value of the previous line, RFC 822-style.
318
<term><option>timeout<literal> = </literal><replaceable
319
>TIME</replaceable></option></term>
322
This option is <emphasis>optional</emphasis>.
325
The timeout is how long the server will wait, after a
326
successful checker run, until a client is disabled and not
327
allowed to get the data this server holds. By default
328
Mandos will use 5 minutes. See also the
329
<option>extended_timeout</option> option.
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.
332
128
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
350
239
<refsect1 id="expansion">
351
240
<title>EXPANSION</title>
382
271
<quote><literal>%%(<replaceable>foo</replaceable>)s</literal
383
272
></quote> will be replaced by the value of the attribute
384
273
<varname>foo</varname> of the internal
385
<quote><classname>Client</classname></quote> object in the
386
Mandos server. The currently allowed values for
387
<replaceable>foo</replaceable> are:
388
<quote><literal>approval_delay</literal></quote>,
389
<quote><literal>approval_duration</literal></quote>,
390
<quote><literal>created</literal></quote>,
391
<quote><literal>enabled</literal></quote>,
392
<quote><literal>fingerprint</literal></quote>,
393
<quote><literal>host</literal></quote>,
394
<quote><literal>interval</literal></quote>,
395
<quote><literal>last_approval_request</literal></quote>,
396
<quote><literal>last_checked_ok</literal></quote>,
397
<quote><literal>last_enabled</literal></quote>,
398
<quote><literal>name</literal></quote>,
399
<quote><literal>timeout</literal></quote>, and, if using
400
D-Bus, <quote><literal>dbus_object_path</literal></quote>.
401
See the source code for details. <emphasis role="strong"
402
>Currently, <emphasis>none</emphasis> of these attributes
403
except <quote><literal>host</literal></quote> are guaranteed
404
to be valid in future versions.</emphasis> Therefore, please
405
let the authors know of any attributes that are useful so they
406
may be preserved to any new versions of this software.
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.
409
280
Note that this means that, in order to include an actual
410
281
percent character (<quote>%</quote>) in a
411
<varname>checker</varname> option, <emphasis>four</emphasis>
282
<varname>checker</varname> options, <emphasis>four</emphasis>
412
283
percent characters in a row (<quote>%%%%</quote>) must be
413
284
entered. Also, a bad format here will lead to an immediate
414
285
but <emphasis>silent</emphasis> run-time fatal exit; debug
415
mode is needed to expose an error of this kind.
286
mode is needed to track down an error of this kind.
421
292
<refsect1 id="files">
422
293
<title>FILES</title>