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 "2008-09-30">
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
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>
107
This option is <emphasis>optional</emphasis>.
106
110
The timeout is how long the server will wait for a
107
111
successful checker run until a client is considered
108
112
invalid - that is, ineligible to get the data this server
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
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
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.
233
247
<term><option><literal>host = </literal><replaceable
234
248
>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.
237
257
Host name for this client. This is not used by the server
238
258
directly, but can be, and is by default, used by the
239
259
checker. See the <option>checker</option> option.
added
removed
mandos-clients.conf.xml
