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
4
<!ENTITY VERSION "1.0">
5
5
<!ENTITY CONFNAME "mandos-clients.conf">
6
6
<!ENTITY CONFPATH "<filename>/etc/mandos/clients.conf</filename>">
7
<!ENTITY TIMESTAMP "2008-08-30">
7
<!ENTITY TIMESTAMP "2008-09-12">
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
12
12
<title>Mandos Manual</title>
13
13
<!-- NWalsh’s docbook scripts use this to generate the footer: -->
35
35
<holder>Teddy Hogeborn</holder>
36
36
<holder>Björn Påhlsson</holder>
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/"/>.
38
<xi:include href="legalnotice.xml"/>
64
42
<refentrytitle>&CONFNAME;</refentrytitle>
65
43
<manvolnum>5</manvolnum>
115
93
start time expansion, see <xref linkend="expansion"/>.
118
Uknown options are ignored. The used options are as follows:
96
Unknown options are ignored. The used options are as follows:
124
102
<term><option>timeout<literal> = </literal><replaceable
125
103
>TIME</replaceable></option></term>
106
This option is <emphasis>optional</emphasis>.
128
109
The timeout is how long the server will wait for a
129
110
successful checker run until a client is considered
130
111
invalid - that is, ineligible to get the data this server
150
131
<term><option>interval<literal> = </literal><replaceable
151
132
>TIME</replaceable></option></term>
135
This option is <emphasis>optional</emphasis>.
154
138
How often to run the checker to confirm that a client is
155
139
still up. <emphasis>Note:</emphasis> a new checker will
156
140
not be started if an old one is still running. The server
170
154
<term><option>checker<literal> = </literal><replaceable
171
155
>COMMAND</replaceable></option></term>
158
This option is <emphasis>optional</emphasis>.
174
161
This option allows you to override the default shell
175
162
command that the server will use to check if the client is
176
163
still up. Any output of the command will be ignored, only
196
183
><replaceable>HEXSTRING</replaceable></option></term>
186
This option is <emphasis>required</emphasis>.
199
189
This option sets the OpenPGP fingerprint that identifies
200
190
the public key that clients authenticate themselves with
201
191
through TLS. The string needs to be in hexidecimal form,
209
199
>BASE64_ENCODED_DATA</replaceable></option></term>
202
If this option is not specified, the <option
203
>secfile</option> option is <emphasis>required</emphasis>
212
207
If present, this option must be set to a string of
213
208
base64-encoded binary data. It will be decoded and sent
214
209
to the client matching the above
226
221
lines is that a line beginning with white space adds to
227
222
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.
238
228
<term><option>secfile<literal> = </literal><replaceable
239
229
>FILENAME</replaceable></option></term>
232
This option is only used if <option>secret</option> is not
233
specified, in which case this option is
234
<emphasis>required</emphasis>.
242
237
Similar to the <option>secret</option>, except the secret
243
238
data is in an external file. The contents of the file
244
239
should <emphasis>not</emphasis> be base64-encoded, but
245
240
will be sent to clients verbatim.
248
This option is only used, and <emphasis>must</emphasis> be
249
present, if <option>secret</option> is not specified.
255
246
<term><option><literal>host = </literal><replaceable
256
247
>STRING</replaceable></option></term>
250
This option is <emphasis>optional</emphasis>, but highly
251
<emphasis>recommended</emphasis> unless the
252
<option>checker</option> option is modified to a
253
non-standard value without <quote>%(host)s</quote> in it.
259
256
Host name for this client. This is not used by the server
260
257
directly, but can be, and is by default, used by the
261
258
checker. See the <option>checker</option> option.
added
removed
mandos-clients.conf.xml
