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 "2010-09-12">
7
<!ENTITY % common SYSTEM "common.ent">
7
<!ENTITY TIMESTAMP "2008-08-30">
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>
37
35
<holder>Teddy Hogeborn</holder>
38
36
<holder>Björn Påhlsson</holder>
40
<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/"/>.
44
64
<refentrytitle>&CONFNAME;</refentrytitle>
45
65
<manvolnum>5</manvolnum>
63
83
><refentrytitle>mandos</refentrytitle>
64
84
<manvolnum>8</manvolnum></citerefentry>, read by it at startup.
65
85
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.
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
70
91
The format starts with a <literal>[<replaceable>section
94
115
start time expansion, see <xref linkend="expansion"/>.
97
Unknown options are ignored. The used options are as follows:
118
Uknown options are ignored. The used options are as follows:
103
124
<term><option>timeout<literal> = </literal><replaceable
104
125
>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.
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.
116
134
The <replaceable>TIME</replaceable> is specified as a
132
150
<term><option>interval<literal> = </literal><replaceable
133
151
>TIME</replaceable></option></term>
136
This option is <emphasis>optional</emphasis>.
139
154
How often to run the checker to confirm that a client is
140
155
still up. <emphasis>Note:</emphasis> a new checker will
141
156
not be started if an old one is still running. The server
142
157
will wait for a checker to complete until the above
143
158
<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.
159
time the client will be marked invalid, and any running
160
checker killed. The default interval is 5 minutes.
148
163
The format of <replaceable>TIME</replaceable> is the same
155
170
<term><option>checker<literal> = </literal><replaceable
156
171
>COMMAND</replaceable></option></term>
159
This option is <emphasis>optional</emphasis>.
162
174
This option allows you to override the default shell
163
175
command that the server will use to check if the client is
164
176
still up. Any output of the command will be ignored, only
169
181
<varname>PATH</varname> will be searched. The default
170
182
value for the checker command is <quote><literal
171
183
><command>fping</command> <option>-q</option> <option
172
>--</option> %%(host)s</literal></quote>.
184
>--</option> %(host)s</literal></quote>.
175
187
In addition to normal start time expansion, this option
184
196
><replaceable>HEXSTRING</replaceable></option></term>
187
This option is <emphasis>required</emphasis>.
190
199
This option sets the OpenPGP fingerprint that identifies
191
200
the public key that clients authenticate themselves with
192
201
through TLS. The string needs to be in hexidecimal form,
200
209
>BASE64_ENCODED_DATA</replaceable></option></term>
203
If this option is not specified, the <option
204
>secfile</option> option is <emphasis>required</emphasis>
208
212
If present, this option must be set to a string of
209
213
base64-encoded binary data. It will be decoded and sent
210
214
to the client matching the above
222
226
lines is that a line beginning with white space adds to
223
227
the value of the previous line, RFC 822-style.
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.
229
238
<term><option>secfile<literal> = </literal><replaceable
230
239
>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
242
Similar to the <option>secret</option>, except the secret
239
243
data is in an external file. The contents of the file
240
244
should <emphasis>not</emphasis> be base64-encoded, but
241
245
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>
248
This option is only used, and <emphasis>must</emphasis> be
249
present, if <option>secret</option> is not specified.
252
255
<term><option><literal>host = </literal><replaceable
253
256
>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
259
Host name for this client. This is not used by the server
263
260
directly, but can be, and is by default, used by the
264
261
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
