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-12-09">
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>
63
85
><refentrytitle>mandos</refentrytitle>
64
86
<manvolnum>8</manvolnum></citerefentry>, read by it at startup.
65
87
The file needs to list all clients that should be able to use
66
the service. All clients listed will be regarded as enabled,
67
even if a client was disabled in a previous run of the server.
88
the service. All clients listed will be regarded as valid, even
89
if a client was declared invalid in a previous run of the
70
93
The format starts with a <literal>[<replaceable>section
94
117
start time expansion, see <xref linkend="expansion"/>.
97
Unknown options are ignored. The used options are as follows:
120
Uknown options are ignored. The used options are as follows:
103
<term><option>timeout<literal> = </literal><replaceable
104
>TIME</replaceable></option></term>
126
<term><literal><varname>timeout</varname></literal></term>
107
This option is <emphasis>optional</emphasis>.
110
The timeout is how long the server will wait (for either a
111
successful checker run or a client receiving its secret)
112
until a client is disabled and not allowed to get the data
113
this server holds. By default Mandos will use 1 hour.
128
<synopsis><literal>timeout = </literal><replaceable
132
The timeout is how long the server will wait for a
133
successful checker run until a client is considered
134
invalid - that is, ineligible to get the data this server
135
holds. By default Mandos will use 1 hour.
116
138
The <replaceable>TIME</replaceable> is specified as a
132
<term><option>interval<literal> = </literal><replaceable
133
>TIME</replaceable></option></term>
154
<term><literal><varname>interval</varname></literal></term>
136
This option is <emphasis>optional</emphasis>.
156
<synopsis><literal>interval = </literal><replaceable
139
160
How often to run the checker to confirm that a client is
140
161
still up. <emphasis>Note:</emphasis> a new checker will
141
162
not be started if an old one is still running. The server
142
163
will wait for a checker to complete until the above
143
164
<quote><varname>timeout</varname></quote> occurs, at which
144
time the client will be disabled, and any running checker
145
killed. The default interval is 5 minutes.
165
time the client will be marked invalid, and any running
166
checker killed. The default interval is 5 minutes.
148
169
The format of <replaceable>TIME</replaceable> is the same
155
<term><option>checker<literal> = </literal><replaceable
156
>COMMAND</replaceable></option></term>
176
<term><literal>checker</literal></term>
159
This option is <emphasis>optional</emphasis>.
178
<synopsis><literal>checker = </literal><replaceable
179
>COMMAND</replaceable>
162
182
This option allows you to override the default shell
163
183
command that the server will use to check if the client is
169
189
<varname>PATH</varname> will be searched. The default
170
190
value for the checker command is <quote><literal
171
191
><command>fping</command> <option>-q</option> <option
172
>--</option> %%(host)s</literal></quote>.
192
>--</option> %(host)s</literal></quote>.
175
195
In addition to normal start time expansion, this option
183
<term><option>fingerprint<literal> = </literal
184
><replaceable>HEXSTRING</replaceable></option></term>
203
<term><literal>fingerprint</literal></term>
187
This option is <emphasis>required</emphasis>.
205
<synopsis><literal>fingerprint = </literal><replaceable
206
>HEXSTRING</replaceable>
190
209
This option sets the OpenPGP fingerprint that identifies
191
210
the public key that clients authenticate themselves with
199
<term><option>secret<literal> = </literal><replaceable
200
>BASE64_ENCODED_DATA</replaceable></option></term>
218
<term><literal>secret</literal></term>
203
If this option is not specified, the <option
204
>secfile</option> option is <emphasis>required</emphasis>
220
<synopsis><literal>secret = </literal><replaceable
221
>BASE64_ENCODED_DATA</replaceable>
208
224
If present, this option must be set to a string of
209
225
base64-encoded binary data. It will be decoded and sent
222
238
lines is that a line beginning with white space adds to
223
239
the value of the previous line, RFC 822-style.
229
<term><option>secfile<literal> = </literal><replaceable
230
>FILENAME</replaceable></option></term>
233
This option is only used if <option>secret</option> is not
234
specified, in which case this option is
235
<emphasis>required</emphasis>.
238
Similar to the <option>secret</option>, except the secret
239
data is in an external file. The contents of the file
240
should <emphasis>not</emphasis> be base64-encoded, but
241
will be sent to clients verbatim.
244
File names of the form <filename>~user/foo/bar</filename>
245
and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
252
<term><option><literal>host = </literal><replaceable
253
>STRING</replaceable></option></term>
256
This option is <emphasis>optional</emphasis>, but highly
257
<emphasis>recommended</emphasis> unless the
258
<option>checker</option> option is modified to a
259
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>
262
275
Host name for this client. This is not used by the server
263
276
directly, but can be, and is by default, used by the
316
329
percent characters in a row (<quote>%%%%</quote>) must be
317
330
entered. Also, a bad format here will lead to an immediate
318
331
but <emphasis>silent</emphasis> run-time fatal exit; debug
319
mode is needed to expose an error of this kind.
332
mode is needed to track down an error of this kind.
325
338
<refsect1 id="files">
added
removed
mandos-clients.conf.xml
