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 "2011-10-03">
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
39
<holder>Teddy Hogeborn</holder>
34
40
<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/"/>.
42
<xi:include href="legalnotice.xml"/>
62
46
<refentrytitle>&CONFNAME;</refentrytitle>
63
47
<manvolnum>5</manvolnum>
69
53
Configuration file for the Mandos server
58
<synopsis>&CONFPATH;</synopsis>
79
61
<refsect1 id="description">
80
62
<title>DESCRIPTION</title>
82
The file &CONFPATH; is the configuration file for <citerefentry
64
The file &CONFPATH; is a configuration file for <citerefentry
83
65
><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
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.
91
72
The format starts with a <literal>[<replaceable>section
111
92
<refsect1 id="options">
112
93
<title>OPTIONS</title>
114
The possible options are:
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:
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>
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>.
176
164
This option allows you to override the default shell
177
165
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
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>.
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>.
187
177
In addition to normal start time expansion, this option
195
<term><literal>fingerprint</literal></term>
197
<synopsis><literal>fingerprint = </literal><replaceable
198
>HEXSTRING</replaceable>
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 sucessfully 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>.
201
215
This option sets the OpenPGP fingerprint that identifies
202
216
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>
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>
216
297
If present, this option must be set to a string of
217
298
base64-encoded binary data. It will be decoded and sent
218
299
to the client matching the above
219
300
<option>fingerprint</option>. This should, of course, be
220
301
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
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.
332
The <replaceable>TIME</replaceable> is specified as a
333
space-separated number of values, each of which is a
334
number and a one-character suffix. The suffix must be one
335
of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
336
<quote>h</quote>, and <quote>w</quote> for days, seconds,
337
minutes, hours, and weeks, respectively. The values are
338
added together to give the total time value, so all of
339
<quote><literal>330s</literal></quote>,
340
<quote><literal>110s 110s 110s</literal></quote>, and
341
<quote><literal>5m 30s</literal></quote> will give a value
342
of five minutes and thirty seconds.
277
350
<refsect1 id="expansion">
278
351
<title>EXPANSION</title>
309
382
<quote><literal>%%(<replaceable>foo</replaceable>)s</literal
310
383
></quote> will be replaced by the value of the attribute
311
384
<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.
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.
318
409
Note that this means that, in order to include an actual
319
410
percent character (<quote>%</quote>) in a
320
<varname>checker</varname> options, <emphasis>four</emphasis>
411
<varname>checker</varname> option, <emphasis>four</emphasis>
321
412
percent characters in a row (<quote>%%%%</quote>) must be
322
413
entered. Also, a bad format here will lead to an immediate
323
414
but <emphasis>silent</emphasis> run-time fatal exit; debug
324
mode is needed to track down an error of this kind.
415
mode is needed to expose an error of this kind.
330
421
<refsect1 id="files">
331
422
<title>FILES</title>
376
467
5MHdW9AYsNJZAQSOpirE4Xi31CSlWAi9KV+cUCmWF5zOFy1x23P6PjdaRm
377
468
4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
380
470
host = foo.example.org
385
475
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
386
secfile = /etc/mandos/bar-secret.txt.asc
476
secfile = /etc/mandos/bar-secret
478
approved_by_default = False
388
480
</programlisting>
389
481
</informalexample>
484
<refsect1 id="see_also">
485
<title>SEE ALSO</title>
487
<citerefentry><refentrytitle>intro</refentrytitle>
488
<manvolnum>8mandos</manvolnum></citerefentry>,
489
<citerefentry><refentrytitle>mandos-keygen</refentrytitle>
490
<manvolnum>8</manvolnum></citerefentry>,
491
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
492
<manvolnum>5</manvolnum></citerefentry>,
493
<citerefentry><refentrytitle>mandos</refentrytitle>
494
<manvolnum>8</manvolnum></citerefentry>
498
<!-- Local Variables: -->
499
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
500
<!-- time-stamp-end: "[\"']>" -->
501
<!-- time-stamp-format: "%:y-%02m-%02d" -->