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 "2012-01-01">
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>
40
33
<holder>Teddy Hogeborn</holder>
41
34
<holder>Björn Påhlsson</holder>
43
<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/"/>.
47
62
<refentrytitle>&CONFNAME;</refentrytitle>
48
63
<manvolnum>5</manvolnum>
54
69
Configuration file for the Mandos server
59
<synopsis>&CONFPATH;</synopsis>
62
79
<refsect1 id="description">
63
80
<title>DESCRIPTION</title>
65
The file &CONFPATH; is a configuration file for <citerefentry
82
The file &CONFPATH; is the configuration file for <citerefentry
66
83
><refentrytitle>mandos</refentrytitle>
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.
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
78
91
The format starts with a <literal>[<replaceable>section
98
111
<refsect1 id="options">
99
112
<title>OPTIONS</title>
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:
114
The possible options are:
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>.
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>
170
176
This option allows you to override the default shell
171
177
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>.
178
still up. The output of the command will be ignored, only
179
the exit code is checked. The command will be run using
180
<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>.
183
187
In addition to normal start time expansion, this option
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>.
195
<term><literal>fingerprint</literal></term>
197
<synopsis><literal>fingerprint = </literal><replaceable
198
>HEXSTRING</replaceable>
221
201
This option sets the OpenPGP fingerprint that identifies
222
202
the public key that clients authenticate themselves with
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>
210
<term><literal>secret</literal></term>
212
<synopsis><literal>secret = </literal><replaceable
213
>BASE64_ENCODED_DATA</replaceable>
303
216
If present, this option must be set to a string of
304
217
base64-encoded binary data. It will be decoded and sent
305
218
to the client matching the above
306
219
<option>fingerprint</option>. This should, of course, be
307
220
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.
338
The <replaceable>TIME</replaceable> is specified as a
339
space-separated number of values, each of which is a
340
number and a one-character suffix. The suffix must be one
341
of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
342
<quote>h</quote>, and <quote>w</quote> for days, seconds,
343
minutes, hours, and weeks, respectively. The values are
344
added together to give the total time value, so all of
345
<quote><literal>330s</literal></quote>,
346
<quote><literal>110s 110s 110s</literal></quote>, and
347
<quote><literal>5m 30s</literal></quote> will give a value
348
of five minutes and thirty seconds.
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>.
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
370
277
<refsect1 id="expansion">
371
278
<title>EXPANSION</title>
402
309
<quote><literal>%%(<replaceable>foo</replaceable>)s</literal
403
310
></quote> will be replaced by the value of the attribute
404
311
<varname>foo</varname> of the internal
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.
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.
429
318
Note that this means that, in order to include an actual
430
319
percent character (<quote>%</quote>) in a
431
<varname>checker</varname> option, <emphasis>four</emphasis>
320
<varname>checker</varname> options, <emphasis>four</emphasis>
432
321
percent characters in a row (<quote>%%%%</quote>) must be
433
322
entered. Also, a bad format here will lead to an immediate
434
323
but <emphasis>silent</emphasis> run-time fatal exit; debug
435
mode is needed to expose an error of this kind.
324
mode is needed to track down an error of this kind.
441
330
<refsect1 id="files">
442
331
<title>FILES</title>
487
376
5MHdW9AYsNJZAQSOpirE4Xi31CSlWAi9KV+cUCmWF5zOFy1x23P6PjdaRm
488
377
4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
490
380
host = foo.example.org
495
385
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
496
secfile = /etc/mandos/bar-secret
498
approved_by_default = False
386
secfile = /etc/mandos/bar-secret.txt.asc
500
388
</programlisting>
501
389
</informalexample>
504
<refsect1 id="see_also">
505
<title>SEE ALSO</title>
507
<citerefentry><refentrytitle>intro</refentrytitle>
508
<manvolnum>8mandos</manvolnum></citerefentry>,
509
<citerefentry><refentrytitle>mandos-keygen</refentrytitle>
510
<manvolnum>8</manvolnum></citerefentry>,
511
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
512
<manvolnum>5</manvolnum></citerefentry>,
513
<citerefentry><refentrytitle>mandos</refentrytitle>
514
<manvolnum>8</manvolnum></citerefentry>
518
<!-- Local Variables: -->
519
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
520
<!-- time-stamp-end: "[\"']>" -->
521
<!-- time-stamp-format: "%:y-%02m-%02d" -->