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-01-04">
7
<!ENTITY % common SYSTEM "common.ent">
7
<!ENTITY TIMESTAMP "2008-08-29">
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
117
start time expansion, see <xref linkend="expansion"/>.
98
Unknown options are ignored. The used options are as follows:
120
Uknown options are ignored. The used options are as follows:
104
<term><option>timeout<literal> = </literal><replaceable
105
>TIME</replaceable></option></term>
126
<term><literal><varname>timeout</varname></literal></term>
108
This option is <emphasis>optional</emphasis>.
128
<synopsis><literal>timeout = </literal><replaceable
111
132
The timeout is how long the server will wait for a
112
133
successful checker run until a client is considered
133
<term><option>interval<literal> = </literal><replaceable
134
>TIME</replaceable></option></term>
154
<term><literal><varname>interval</varname></literal></term>
137
This option is <emphasis>optional</emphasis>.
156
<synopsis><literal>interval = </literal><replaceable
140
160
How often to run the checker to confirm that a client is
141
161
still up. <emphasis>Note:</emphasis> a new checker will
150
170
as for <varname>timeout</varname> above.
156
<term><option>checker<literal> = </literal><replaceable
157
>COMMAND</replaceable></option></term>
176
<term><literal>checker</literal></term>
160
This option is <emphasis>optional</emphasis>.
178
<synopsis><literal>checker = </literal><replaceable
179
>COMMAND</replaceable>
163
182
This option allows you to override the default shell
164
183
command that the server will use to check if the client is
184
<term><option>fingerprint<literal> = </literal
185
><replaceable>HEXSTRING</replaceable></option></term>
203
<term><literal>fingerprint</literal></term>
188
This option is <emphasis>required</emphasis>.
205
<synopsis><literal>fingerprint = </literal><replaceable
206
>HEXSTRING</replaceable>
191
209
This option sets the OpenPGP fingerprint that identifies
192
210
the public key that clients authenticate themselves with
200
<term><option>secret<literal> = </literal><replaceable
201
>BASE64_ENCODED_DATA</replaceable></option></term>
218
<term><literal>secret</literal></term>
204
If this option is not specified, the <option
205
>secfile</option> option is <emphasis>required</emphasis>
220
<synopsis><literal>secret = </literal><replaceable
221
>BASE64_ENCODED_DATA</replaceable>
209
224
If present, this option must be set to a string of
210
225
base64-encoded binary data. It will be decoded and sent
223
238
lines is that a line beginning with white space adds to
224
239
the value of the previous line, RFC 822-style.
230
<term><option>secfile<literal> = </literal><replaceable
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>.
239
Similar to the <option>secret</option>, except the secret
240
data is in an external file. The contents of the file
241
should <emphasis>not</emphasis> be base64-encoded, but
242
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>
253
<term><option><literal>host = </literal><replaceable
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.
242
If this option is not specified, the <option
243
>secfile</option> option is used instead, but one of them
244
<emphasis>must</emphasis> be present.
250
<term><literal>secfile</literal></term>
252
<synopsis><literal>secfile = </literal><replaceable
253
>FILENAME</replaceable>
256
The same as <option>secret</option>, but the secret data
257
is in an external file. The contents of the file should
258
<emphasis>not</emphasis> be base64-encoded, but will be
259
sent to clients verbatim.
262
This option is only used, and <emphasis>must</emphasis> be
263
present, if <option>secret</option> is not specified.
269
<term><literal>host</literal></term>
271
<synopsis><literal>host = </literal><replaceable
272
>STRING</replaceable>
263
275
Host name for this client. This is not used by the server
264
276
directly, but can be, and is by default, used by the
317
329
percent characters in a row (<quote>%%%%</quote>) must be
318
330
entered. Also, a bad format here will lead to an immediate
319
331
but <emphasis>silent</emphasis> run-time fatal exit; debug
320
mode is needed to expose an error of this kind.
332
mode is needed to track down an error of this kind.
326
338
<refsect1 id="files">
327
339
<title>FILES</title>
added
removed
mandos-clients.conf.xml
