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">
5
4
<!ENTITY CONFNAME "mandos-clients.conf">
6
5
<!ENTITY CONFPATH "<filename>/etc/mandos/clients.conf</filename>">
7
<!ENTITY TIMESTAMP "2008-08-31">
6
<!ENTITY TIMESTAMP "2009-12-09">
7
<!ENTITY % common SYSTEM "common.ent">
10
11
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
12
13
<title>Mandos Manual</title>
13
14
<!-- NWalsh’s docbook scripts use this to generate the footer: -->
14
15
<productname>Mandos</productname>
15
<productnumber>&VERSION;</productnumber>
16
<productnumber>&version;</productnumber>
16
17
<date>&TIMESTAMP;</date>
61
63
><refentrytitle>mandos</refentrytitle>
62
64
<manvolnum>8</manvolnum></citerefentry>, read by it at startup.
63
65
The file needs to list all clients that should be able to use
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
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.
69
70
The format starts with a <literal>[<replaceable>section
93
94
start time expansion, see <xref linkend="expansion"/>.
96
Uknown options are ignored. The used options are as follows:
97
Unknown options are ignored. The used options are as follows:
102
103
<term><option>timeout<literal> = </literal><replaceable
103
104
>TIME</replaceable></option></term>
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.
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.
112
116
The <replaceable>TIME</replaceable> is specified as a
128
132
<term><option>interval<literal> = </literal><replaceable
129
133
>TIME</replaceable></option></term>
136
This option is <emphasis>optional</emphasis>.
132
139
How often to run the checker to confirm that a client is
133
140
still up. <emphasis>Note:</emphasis> a new checker will
134
141
not be started if an old one is still running. The server
135
142
will wait for a checker to complete until the above
136
143
<quote><varname>timeout</varname></quote> occurs, at which
137
time the client will be marked invalid, and any running
138
checker killed. The default interval is 5 minutes.
144
time the client will be disabled, and any running checker
145
killed. The default interval is 5 minutes.
141
148
The format of <replaceable>TIME</replaceable> is the same
148
155
<term><option>checker<literal> = </literal><replaceable
149
156
>COMMAND</replaceable></option></term>
159
This option is <emphasis>optional</emphasis>.
152
162
This option allows you to override the default shell
153
163
command that the server will use to check if the client is
154
164
still up. Any output of the command will be ignored, only
159
169
<varname>PATH</varname> will be searched. The default
160
170
value for the checker command is <quote><literal
161
171
><command>fping</command> <option>-q</option> <option
162
>--</option> %(host)s</literal></quote>.
172
>--</option> %%(host)s</literal></quote>.
165
175
In addition to normal start time expansion, this option
174
184
><replaceable>HEXSTRING</replaceable></option></term>
187
This option is <emphasis>required</emphasis>.
177
190
This option sets the OpenPGP fingerprint that identifies
178
191
the public key that clients authenticate themselves with
179
192
through TLS. The string needs to be in hexidecimal form,
187
200
>BASE64_ENCODED_DATA</replaceable></option></term>
203
If this option is not specified, the <option
204
>secfile</option> option is <emphasis>required</emphasis>
190
208
If present, this option must be set to a string of
191
209
base64-encoded binary data. It will be decoded and sent
192
210
to the client matching the above
204
222
lines is that a line beginning with white space adds to
205
223
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.
216
229
<term><option>secfile<literal> = </literal><replaceable
217
230
>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>.
220
238
Similar to the <option>secret</option>, except the secret
221
239
data is in an external file. The contents of the file
222
240
should <emphasis>not</emphasis> be base64-encoded, but
223
241
will be sent to clients verbatim.
226
This option is only used, and <emphasis>must</emphasis> be
227
present, if <option>secret</option> is not specified.
244
File names of the form <filename>~user/foo/bar</filename>
245
and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
233
252
<term><option><literal>host = </literal><replaceable
234
253
>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.
237
262
Host name for this client. This is not used by the server
238
263
directly, but can be, and is by default, used by the
239
264
checker. See the <option>checker</option> option.
added
removed
mandos-clients.conf.xml
