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
<!ENTITY VERSION "1.0">
4
5
<!ENTITY CONFNAME "mandos-clients.conf">
5
6
<!ENTITY CONFPATH "<filename>/etc/mandos/clients.conf</filename>">
6
<!ENTITY TIMESTAMP "2009-02-15">
7
<!ENTITY % common SYSTEM "common.ent">
7
<!ENTITY TIMESTAMP "2008-08-30">
11
<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>
37
35
<holder>Teddy Hogeborn</holder>
38
36
<holder>Björn Påhlsson</holder>
40
<xi:include href="legalnotice.xml"/>
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/"/>.
44
64
<refentrytitle>&CONFNAME;</refentrytitle>
45
65
<manvolnum>5</manvolnum>
95
115
start time expansion, see <xref linkend="expansion"/>.
98
Unknown options are ignored. The used options are as follows:
118
Uknown options are ignored. The used options are as follows:
104
124
<term><option>timeout<literal> = </literal><replaceable
105
125
>TIME</replaceable></option></term>
108
This option is <emphasis>optional</emphasis>.
111
128
The timeout is how long the server will wait for a
112
129
successful checker run until a client is considered
113
130
invalid - that is, ineligible to get the data this server
133
150
<term><option>interval<literal> = </literal><replaceable
134
151
>TIME</replaceable></option></term>
137
This option is <emphasis>optional</emphasis>.
140
154
How often to run the checker to confirm that a client is
141
155
still up. <emphasis>Note:</emphasis> a new checker will
142
156
not be started if an old one is still running. The server
156
170
<term><option>checker<literal> = </literal><replaceable
157
171
>COMMAND</replaceable></option></term>
160
This option is <emphasis>optional</emphasis>.
163
174
This option allows you to override the default shell
164
175
command that the server will use to check if the client is
165
176
still up. Any output of the command will be ignored, only
170
181
<varname>PATH</varname> will be searched. The default
171
182
value for the checker command is <quote><literal
172
183
><command>fping</command> <option>-q</option> <option
173
>--</option> %%(host)s</literal></quote>.
184
>--</option> %(host)s</literal></quote>.
176
187
In addition to normal start time expansion, this option
185
196
><replaceable>HEXSTRING</replaceable></option></term>
188
This option is <emphasis>required</emphasis>.
191
199
This option sets the OpenPGP fingerprint that identifies
192
200
the public key that clients authenticate themselves with
193
201
through TLS. The string needs to be in hexidecimal form,
201
209
>BASE64_ENCODED_DATA</replaceable></option></term>
204
If this option is not specified, the <option
205
>secfile</option> option is <emphasis>required</emphasis>
209
212
If present, this option must be set to a string of
210
213
base64-encoded binary data. It will be decoded and sent
211
214
to the client matching the above
223
226
lines is that a line beginning with white space adds to
224
227
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.
230
238
<term><option>secfile<literal> = </literal><replaceable
231
239
>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>.
239
242
Similar to the <option>secret</option>, except the secret
240
243
data is in an external file. The contents of the file
241
244
should <emphasis>not</emphasis> be base64-encoded, but
242
245
will be sent to clients verbatim.
245
File names of the form <filename>~user/foo/bar</filename>
246
and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
248
This option is only used, and <emphasis>must</emphasis> be
249
present, if <option>secret</option> is not specified.
253
255
<term><option><literal>host = </literal><replaceable
254
256
>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.
263
259
Host name for this client. This is not used by the server
264
260
directly, but can be, and is by default, used by the
265
261
checker. See the <option>checker</option> option.
added
removed
mandos-clients.conf.xml
