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-09-17">
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
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
128
The timeout is how long the server will wait for a
129
successful checker run until a client is considered
130
invalid - that is, ineligible to get the data this server
131
holds. By default Mandos will use 1 hour.
118
134
The <replaceable>TIME</replaceable> is specified as a
134
150
<term><option>interval<literal> = </literal><replaceable
135
151
>TIME</replaceable></option></term>
138
This option is <emphasis>optional</emphasis>.
141
154
How often to run the checker to confirm that a client is
142
155
still up. <emphasis>Note:</emphasis> a new checker will
143
156
not be started if an old one is still running. The server
157
170
<term><option>checker<literal> = </literal><replaceable
158
171
>COMMAND</replaceable></option></term>
161
This option is <emphasis>optional</emphasis>.
164
174
This option allows you to override the default shell
165
175
command that the server will use to check if the client is
166
176
still up. Any output of the command will be ignored, only
171
181
<varname>PATH</varname> will be searched. The default
172
182
value for the checker command is <quote><literal
173
183
><command>fping</command> <option>-q</option> <option
174
>--</option> %%(host)s</literal></quote>.
184
>--</option> %(host)s</literal></quote>.
177
187
In addition to normal start time expansion, this option
186
196
><replaceable>HEXSTRING</replaceable></option></term>
189
This option is <emphasis>required</emphasis>.
192
199
This option sets the OpenPGP fingerprint that identifies
193
200
the public key that clients authenticate themselves with
194
201
through TLS. The string needs to be in hexidecimal form,
202
209
>BASE64_ENCODED_DATA</replaceable></option></term>
205
If this option is not specified, the <option
206
>secfile</option> option is <emphasis>required</emphasis>
210
212
If present, this option must be set to a string of
211
213
base64-encoded binary data. It will be decoded and sent
212
214
to the client matching the above
224
226
lines is that a line beginning with white space adds to
225
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.
231
238
<term><option>secfile<literal> = </literal><replaceable
232
239
>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
242
Similar to the <option>secret</option>, except the secret
241
243
data is in an external file. The contents of the file
242
244
should <emphasis>not</emphasis> be base64-encoded, but
243
245
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>
248
This option is only used, and <emphasis>must</emphasis> be
249
present, if <option>secret</option> is not specified.
254
255
<term><option><literal>host = </literal><replaceable
255
256
>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
259
Host name for this client. This is not used by the server
265
260
directly, but can be, and is by default, used by the
266
261
checker. See the <option>checker</option> option.
added
removed
mandos-clients.conf.xml
