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 "2010-09-12">
7
<!ENTITY % common SYSTEM "common.ent">
7
<!ENTITY TIMESTAMP "2008-08-31">
11
10
<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>
63
61
><refentrytitle>mandos</refentrytitle>
64
62
<manvolnum>8</manvolnum></citerefentry>, read by it at startup.
65
63
The file needs to list all clients that should be able to use
66
the service. All clients listed will be regarded as enabled,
67
even if a client was disabled in a previous run of the server.
64
the service. All clients listed will be regarded as valid, even
65
if a client was declared invalid in a previous run of the
70
69
The format starts with a <literal>[<replaceable>section
94
93
start time expansion, see <xref linkend="expansion"/>.
97
Unknown options are ignored. The used options are as follows:
96
Uknown options are ignored. The used options are as follows:
103
102
<term><option>timeout<literal> = </literal><replaceable
104
103
>TIME</replaceable></option></term>
107
This option is <emphasis>optional</emphasis>.
110
The timeout is how long the server will wait (for either a
111
successful checker run or a client receiving its secret)
112
until a client is disabled and not allowed to get the data
113
this server holds. By default Mandos will use 1 hour.
106
The timeout is how long the server will wait for a
107
successful checker run until a client is considered
108
invalid - that is, ineligible to get the data this server
109
holds. By default Mandos will use 1 hour.
116
112
The <replaceable>TIME</replaceable> is specified as a
132
128
<term><option>interval<literal> = </literal><replaceable
133
129
>TIME</replaceable></option></term>
136
This option is <emphasis>optional</emphasis>.
139
132
How often to run the checker to confirm that a client is
140
133
still up. <emphasis>Note:</emphasis> a new checker will
141
134
not be started if an old one is still running. The server
142
135
will wait for a checker to complete until the above
143
136
<quote><varname>timeout</varname></quote> occurs, at which
144
time the client will be disabled, and any running checker
145
killed. The default interval is 5 minutes.
137
time the client will be marked invalid, and any running
138
checker killed. The default interval is 5 minutes.
148
141
The format of <replaceable>TIME</replaceable> is the same
155
148
<term><option>checker<literal> = </literal><replaceable
156
149
>COMMAND</replaceable></option></term>
159
This option is <emphasis>optional</emphasis>.
162
152
This option allows you to override the default shell
163
153
command that the server will use to check if the client is
164
154
still up. Any output of the command will be ignored, only
169
159
<varname>PATH</varname> will be searched. The default
170
160
value for the checker command is <quote><literal
171
161
><command>fping</command> <option>-q</option> <option
172
>--</option> %%(host)s</literal></quote>.
162
>--</option> %(host)s</literal></quote>.
175
165
In addition to normal start time expansion, this option
184
174
><replaceable>HEXSTRING</replaceable></option></term>
187
This option is <emphasis>required</emphasis>.
190
177
This option sets the OpenPGP fingerprint that identifies
191
178
the public key that clients authenticate themselves with
192
179
through TLS. The string needs to be in hexidecimal form,
200
187
>BASE64_ENCODED_DATA</replaceable></option></term>
203
If this option is not specified, the <option
204
>secfile</option> option is <emphasis>required</emphasis>
208
190
If present, this option must be set to a string of
209
191
base64-encoded binary data. It will be decoded and sent
210
192
to the client matching the above
222
204
lines is that a line beginning with white space adds to
223
205
the value of the previous line, RFC 822-style.
208
If this option is not specified, the <option
209
>secfile</option> option is used instead, but one of them
210
<emphasis>must</emphasis> be present.
229
216
<term><option>secfile<literal> = </literal><replaceable
230
217
>FILENAME</replaceable></option></term>
233
This option is only used if <option>secret</option> is not
234
specified, in which case this option is
235
<emphasis>required</emphasis>.
238
220
Similar to the <option>secret</option>, except the secret
239
221
data is in an external file. The contents of the file
240
222
should <emphasis>not</emphasis> be base64-encoded, but
241
223
will be sent to clients verbatim.
244
File names of the form <filename>~user/foo/bar</filename>
245
and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
226
This option is only used, and <emphasis>must</emphasis> be
227
present, if <option>secret</option> is not specified.
252
233
<term><option><literal>host = </literal><replaceable
253
234
>STRING</replaceable></option></term>
256
This option is <emphasis>optional</emphasis>, but highly
257
<emphasis>recommended</emphasis> unless the
258
<option>checker</option> option is modified to a
259
non-standard value without <quote>%%(host)s</quote> in it.
262
237
Host name for this client. This is not used by the server
263
238
directly, but can be, and is by default, used by the
264
239
checker. See the <option>checker</option> option.
270
<term><option>approved_by_default<literal> = </literal
271
>{ <literal >1</literal> | <literal>yes</literal> | <literal
272
>true</literal> | <literal>on</literal> | <literal
273
>0</literal> | <literal>no</literal> | <literal
274
>false</literal> | <literal>off</literal> }</option></term>
277
Whether to approve a client by default after
278
the <option>approval_delay</option>. The default
279
is <quote>True</quote>.
285
<term><option>approval_delay<literal> = </literal><replaceable
286
>TIME</replaceable></option></term>
289
This option is <emphasis>optional</emphasis>.
292
How long to wait for external approval before resorting to
293
use the <option>approved_by_default</option> value. The
294
default is <quote>0s</quote>, i.e. not to wait.
297
The format of <replaceable>TIME</replaceable> is the same
298
as for <varname>timeout</varname> above.
304
<term><option>approval_duration<literal> = </literal
305
><replaceable>TIME</replaceable></option></term>
308
This option is <emphasis>optional</emphasis>.
311
How long an external approval lasts. The default is 1
315
The format of <replaceable>TIME</replaceable> is the same
316
as for <varname>timeout</varname> above.
added
removed
mandos-clients.conf.xml
