1
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">
7
<!ENTITY TIMESTAMP "2008-08-31">
11
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
13
12
<title>Mandos Manual</title>
14
13
<!-- NWalsh’s docbook scripts use this to generate the footer: -->
15
14
<productname>Mandos</productname>
16
<productnumber>&version;</productnumber>
15
<productnumber>&VERSION;</productnumber>
17
16
<date>&TIMESTAMP;</date>
20
19
<firstname>Björn</firstname>
21
20
<surname>Påhlsson</surname>
23
<email>belorn@recompile.se</email>
22
<email>belorn@fukt.bsnet.se</email>
27
26
<firstname>Teddy</firstname>
28
27
<surname>Hogeborn</surname>
30
<email>teddy@recompile.se</email>
29
<email>teddy@fukt.bsnet.se</email>
40
35
<holder>Teddy Hogeborn</holder>
41
36
<holder>Björn Påhlsson</holder>
43
<xi:include href="legalnotice.xml"/>
40
This manual page is free software: you can redistribute it
41
and/or modify it under the terms of the GNU General Public
42
License as published by the Free Software Foundation,
43
either version 3 of the License, or (at your option) any
48
This manual page is distributed in the hope that it will
49
be useful, but WITHOUT ANY WARRANTY; without even the
50
implied warranty of MERCHANTABILITY or FITNESS FOR A
51
PARTICULAR PURPOSE. See the GNU General Public License
56
You should have received a copy of the GNU General Public
57
License along with this program; If not, see
58
<ulink url="http://www.gnu.org/licenses/"/>.
47
64
<refentrytitle>&CONFNAME;</refentrytitle>
48
65
<manvolnum>5</manvolnum>
66
83
><refentrytitle>mandos</refentrytitle>
67
84
<manvolnum>8</manvolnum></citerefentry>, read by it at startup.
68
85
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.
86
the service. 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
102
115
start time expansion, see <xref linkend="expansion"/>.
105
Unknown options are ignored. The used options are as follows:
118
Uknown options are ignored. The used options are as follows:
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>.
124
<term><option>timeout<literal> = </literal><replaceable
125
>TIME</replaceable></option></term>
128
The timeout is how long the server will wait for a
129
successful checker run until a client is considered
130
invalid - that is, ineligible to get the data this server
131
holds. By default Mandos will use 1 hour.
134
The <replaceable>TIME</replaceable> is specified as a
135
space-separated number of values, each of which is a
136
number and a one-character suffix. The suffix must be one
137
of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
138
<quote>h</quote>, and <quote>w</quote> for days, seconds,
139
minutes, hours, and weeks, respectively. The values are
140
added together to give the total time value, so all of
141
<quote><literal>330s</literal></quote>,
142
<quote><literal>110s 110s 110s</literal></quote>, and
143
<quote><literal>5m 30s</literal></quote> will give a value
144
of five minutes and thirty seconds.
150
<term><option>interval<literal> = </literal><replaceable
151
>TIME</replaceable></option></term>
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.
163
170
<term><option>checker<literal> = </literal><replaceable
164
171
>COMMAND</replaceable></option></term>
167
This option is <emphasis>optional</emphasis>.
170
174
This option allows you to override the default shell
171
175
command that the server will use to check if the client is
172
176
still up. Any output of the command will be ignored, only
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
195
<term><option>fingerprint<literal> = </literal
215
196
><replaceable>HEXSTRING</replaceable></option></term>
218
This option is <emphasis>required</emphasis>.
221
199
This option sets the OpenPGP fingerprint that identifies
222
200
the public key that clients authenticate themselves with
223
201
through TLS. The string needs to be in hexidecimal form,
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
208
<term><option>secret<literal> = </literal><replaceable
295
209
>BASE64_ENCODED_DATA</replaceable></option></term>
298
If this option is not specified, the <option
299
>secfile</option> option is <emphasis>required</emphasis>
303
212
If present, this option must be set to a string of
304
213
base64-encoded binary data. It will be decoded and sent
305
214
to the client matching the above
317
226
lines is that a line beginning with white space adds to
318
227
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>.
230
If this option is not specified, the <option
231
>secfile</option> option is used instead, but one of them
232
<emphasis>must</emphasis> be present.
238
<term><option>secfile<literal> = </literal><replaceable
239
>FILENAME</replaceable></option></term>
242
Similar to the <option>secret</option>, except the secret
243
data is in an external file. The contents of the file
244
should <emphasis>not</emphasis> be base64-encoded, but
245
will be sent to clients verbatim.
248
This option is only used, and <emphasis>must</emphasis> be
249
present, if <option>secret</option> is not specified.
255
<term><option><literal>host = </literal><replaceable
256
>STRING</replaceable></option></term>
259
Host name for this client. This is not used by the server
260
directly, but can be, and is by default, used by the
261
checker. See the <option>checker</option> option.
402
301
<quote><literal>%%(<replaceable>foo</replaceable>)s</literal
403
302
></quote> will be replaced by the value of the attribute
404
303
<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.
304
<quote><classname>Client</classname></quote> object. See the
305
source code for details, and let the authors know of any
306
attributes that are useful so they may be preserved to any new
307
versions of this software.
429
310
Note that this means that, in order to include an actual