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">
4
5
<!ENTITY CONFNAME "mandos-clients.conf">
5
6
<!ENTITY CONFPATH "<filename>/etc/mandos/clients.conf</filename>">
6
<!ENTITY TIMESTAMP "2009-09-17">
7
<!ENTITY % common SYSTEM "common.ent">
7
<!ENTITY TIMESTAMP "2008-08-31">
11
10
<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>
95
93
start time expansion, see <xref linkend="expansion"/>.
98
Unknown options are ignored. The used options are as follows:
96
Uknown options are ignored. The used options are as follows:
104
102
<term><option>timeout<literal> = </literal><replaceable
105
103
>TIME</replaceable></option></term>
108
This option is <emphasis>optional</emphasis>.
111
The timeout is how long the server will wait (for either a
112
successful checker run or a client receiving its secret)
113
until a client is considered invalid - that is, ineligible
114
to get the data this server holds. By default Mandos will
106
The timeout is how long the server will wait for a
107
successful checker run until a client is considered
108
invalid - that is, ineligible to get the data this server
109
holds. By default Mandos will use 1 hour.
118
112
The <replaceable>TIME</replaceable> is specified as a
134
128
<term><option>interval<literal> = </literal><replaceable
135
129
>TIME</replaceable></option></term>
138
This option is <emphasis>optional</emphasis>.
141
132
How often to run the checker to confirm that a client is
142
133
still up. <emphasis>Note:</emphasis> a new checker will
143
134
not be started if an old one is still running. The server
157
148
<term><option>checker<literal> = </literal><replaceable
158
149
>COMMAND</replaceable></option></term>
161
This option is <emphasis>optional</emphasis>.
164
152
This option allows you to override the default shell
165
153
command that the server will use to check if the client is
166
154
still up. Any output of the command will be ignored, only
171
159
<varname>PATH</varname> will be searched. The default
172
160
value for the checker command is <quote><literal
173
161
><command>fping</command> <option>-q</option> <option
174
>--</option> %%(host)s</literal></quote>.
162
>--</option> %(host)s</literal></quote>.
177
165
In addition to normal start time expansion, this option
186
174
><replaceable>HEXSTRING</replaceable></option></term>
189
This option is <emphasis>required</emphasis>.
192
177
This option sets the OpenPGP fingerprint that identifies
193
178
the public key that clients authenticate themselves with
194
179
through TLS. The string needs to be in hexidecimal form,
202
187
>BASE64_ENCODED_DATA</replaceable></option></term>
205
If this option is not specified, the <option
206
>secfile</option> option is <emphasis>required</emphasis>
210
190
If present, this option must be set to a string of
211
191
base64-encoded binary data. It will be decoded and sent
212
192
to the client matching the above
224
204
lines is that a line beginning with white space adds to
225
205
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.
231
216
<term><option>secfile<literal> = </literal><replaceable
232
217
>FILENAME</replaceable></option></term>
235
This option is only used if <option>secret</option> is not
236
specified, in which case this option is
237
<emphasis>required</emphasis>.
240
220
Similar to the <option>secret</option>, except the secret
241
221
data is in an external file. The contents of the file
242
222
should <emphasis>not</emphasis> be base64-encoded, but
243
223
will be sent to clients verbatim.
246
File names of the form <filename>~user/foo/bar</filename>
247
and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
226
This option is only used, and <emphasis>must</emphasis> be
227
present, if <option>secret</option> is not specified.
254
233
<term><option><literal>host = </literal><replaceable
255
234
>STRING</replaceable></option></term>
258
This option is <emphasis>optional</emphasis>, but highly
259
<emphasis>recommended</emphasis> unless the
260
<option>checker</option> option is modified to a
261
non-standard value without <quote>%%(host)s</quote> in it.
264
237
Host name for this client. This is not used by the server
265
238
directly, but can be, and is by default, used by the
266
239
checker. See the <option>checker</option> option.
added
removed
mandos-clients.conf.xml
