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