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-01-08">
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>
93
95
start time expansion, see <xref linkend="expansion"/>.
96
Uknown options are ignored. The used options are as follows:
98
Unknown options are ignored. The used options are as follows:
102
104
<term><option>timeout<literal> = </literal><replaceable
103
105
>TIME</replaceable></option></term>
108
This option is <emphasis>optional</emphasis>.
106
111
The timeout is how long the server will wait for a
107
112
successful checker run until a client is considered
108
113
invalid - that is, ineligible to get the data this server
128
133
<term><option>interval<literal> = </literal><replaceable
129
134
>TIME</replaceable></option></term>
137
This option is <emphasis>optional</emphasis>.
132
140
How often to run the checker to confirm that a client is
133
141
still up. <emphasis>Note:</emphasis> a new checker will
134
142
not be started if an old one is still running. The server
148
156
<term><option>checker<literal> = </literal><replaceable
149
157
>COMMAND</replaceable></option></term>
160
This option is <emphasis>optional</emphasis>.
152
163
This option allows you to override the default shell
153
164
command that the server will use to check if the client is
154
165
still up. Any output of the command will be ignored, only
159
170
<varname>PATH</varname> will be searched. The default
160
171
value for the checker command is <quote><literal
161
172
><command>fping</command> <option>-q</option> <option
162
>--</option> %(host)s</literal></quote>.
173
>--</option> %%(host)s</literal></quote>.
165
176
In addition to normal start time expansion, this option
174
185
><replaceable>HEXSTRING</replaceable></option></term>
188
This option is <emphasis>required</emphasis>.
177
191
This option sets the OpenPGP fingerprint that identifies
178
192
the public key that clients authenticate themselves with
179
193
through TLS. The string needs to be in hexidecimal form,
187
201
>BASE64_ENCODED_DATA</replaceable></option></term>
204
If this option is not specified, the <option
205
>secfile</option> option is <emphasis>required</emphasis>
190
209
If present, this option must be set to a string of
191
210
base64-encoded binary data. It will be decoded and sent
192
211
to the client matching the above
204
223
lines is that a line beginning with white space adds to
205
224
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
230
<term><option>secfile<literal> = </literal><replaceable
217
231
>FILENAME</replaceable></option></term>
234
This option is only used if <option>secret</option> is not
235
specified, in which case this option is
236
<emphasis>required</emphasis>.
220
239
Similar to the <option>secret</option>, except the secret
221
240
data is in an external file. The contents of the file
222
241
should <emphasis>not</emphasis> be base64-encoded, but
223
242
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.
245
File names of the form <filename>~user/foo/bar</filename>
246
and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
233
253
<term><option><literal>host = </literal><replaceable
234
254
>STRING</replaceable></option></term>
257
This option is <emphasis>optional</emphasis>, but highly
258
<emphasis>recommended</emphasis> unless the
259
<option>checker</option> option is modified to a
260
non-standard value without <quote>%(host)s</quote> in it.
237
263
Host name for this client. This is not used by the server
238
264
directly, but can be, and is by default, used by the
239
265
checker. See the <option>checker</option> option.
added
removed
mandos-clients.conf.xml
