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