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 "2008-09-30">
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>
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
106
The timeout is how long the server will wait for a
111
107
successful checker run until a client is considered
112
108
invalid - that is, ineligible to get the data this server
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
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
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.
226
This option is only used, and <emphasis>must</emphasis> be
227
present, if <option>secret</option> is not specified.
247
233
<term><option><literal>host = </literal><replaceable
248
234
>STRING</replaceable></option></term>
251
This option is <emphasis>optional</emphasis>, but highly
252
<emphasis>recommended</emphasis> unless the
253
<option>checker</option> option is modified to a
254
non-standard value without <quote>%(host)s</quote> in it.
257
237
Host name for this client. This is not used by the server
258
238
directly, but can be, and is by default, used by the
259
239
checker. See the <option>checker</option> option.
added
removed
mandos-clients.conf.xml
