To get this branch, use:
bzr branch
http://bzr.recompile.se/loggerhead/mandos/trunk
« back to all changes in this revision
Viewing changes to mandos-clients.conf.xml
- browse files at revision 287
- compare with another revision
- download diff
- download tarball
- view history from revision 287
- Committer: Teddy Hogeborn
- Date: 2009-01-27 00:07:26 UTC
- Revision ID: teddy@fukt.bsnet.se-20090127000726-4cafcfy35g8kh2b8
* INSTALL (Prerequisites/Mandos Server): Added "PyGObject".
added
removed
mandos-clients.conf.xml
3
3
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
4
<!ENTITY CONFNAME "mandos-clients.conf">
5
5
<!ENTITY CONFPATH "<filename>/etc/mandos/clients.conf</filename>">
6
<!ENTITY TIMESTAMP "2010-09-25">
6
<!ENTITY TIMESTAMP "2009-01-08">
7
7
<!ENTITY % common SYSTEM "common.ent">
8
8
%common;
9
9
]>
63
63
><refentrytitle>mandos</refentrytitle>
64
64
<manvolnum>8</manvolnum></citerefentry>, read by it at startup.
65
65
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.
66
the service. All clients listed will be regarded as valid, even
67
if a client was declared invalid in a previous run of the
68
server.
68
69
</para>
69
70
<para>
70
71
The format starts with a <literal>[<replaceable>section
100
101
<variablelist>
101
102
102
103
<varlistentry>
103
<term><option>approval_delay<literal> = </literal><replaceable
104
>TIME</replaceable></option></term>
105
<listitem>
106
<para>
107
This option is <emphasis>optional</emphasis>.
108
</para>
109
<para>
110
How long to wait for external approval before resorting to
111
use the <option>approved_by_default</option> value. The
112
default is <quote>0s</quote>, i.e. not to wait.
113
</para>
114
<para>
115
The format of <replaceable>TIME</replaceable> is the same
116
as for <varname>timeout</varname> below.
117
</para>
118
</listitem>
119
</varlistentry>
120
121
<varlistentry>
122
<term><option>approval_duration<literal> = </literal
123
><replaceable>TIME</replaceable></option></term>
124
<listitem>
125
<para>
126
This option is <emphasis>optional</emphasis>.
127
</para>
128
<para>
129
How long an external approval lasts. The default is 1
130
second.
131
</para>
132
<para>
133
The format of <replaceable>TIME</replaceable> is the same
134
as for <varname>timeout</varname> below.
135
</para>
136
</listitem>
137
</varlistentry>
138
139
<varlistentry>
140
<term><option>approved_by_default<literal> = </literal
141
>{ <literal >1</literal> | <literal>yes</literal> | <literal
142
>true</literal> | <literal>on</literal> | <literal
143
>0</literal> | <literal>no</literal> | <literal
144
>false</literal> | <literal>off</literal> }</option></term>
145
<listitem>
146
<para>
147
Whether to approve a client by default after
148
the <option>approval_delay</option>. The default
149
is <quote>True</quote>.
104
<term><option>timeout<literal> = </literal><replaceable
105
>TIME</replaceable></option></term>
106
<listitem>
107
<para>
108
This option is <emphasis>optional</emphasis>.
109
</para>
110
<para>
111
The timeout is how long the server will wait for a
112
successful checker run until a client is considered
113
invalid - that is, ineligible to get the data this server
114
holds. By default Mandos will use 1 hour.
115
</para>
116
<para>
117
The <replaceable>TIME</replaceable> is specified as a
118
space-separated number of values, each of which is a
119
number and a one-character suffix. The suffix must be one
120
of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
121
<quote>h</quote>, and <quote>w</quote> for days, seconds,
122
minutes, hours, and weeks, respectively. The values are
123
added together to give the total time value, so all of
124
<quote><literal>330s</literal></quote>,
125
<quote><literal>110s 110s 110s</literal></quote>, and
126
<quote><literal>5m 30s</literal></quote> will give a value
127
of five minutes and thirty seconds.
128
</para>
129
</listitem>
130
</varlistentry>
131
132
<varlistentry>
133
<term><option>interval<literal> = </literal><replaceable
134
>TIME</replaceable></option></term>
135
<listitem>
136
<para>
137
This option is <emphasis>optional</emphasis>.
138
</para>
139
<para>
140
How often to run the checker to confirm that a client is
141
still up. <emphasis>Note:</emphasis> a new checker will
142
not be started if an old one is still running. The server
143
will wait for a checker to complete until the above
144
<quote><varname>timeout</varname></quote> occurs, at which
145
time the client will be marked invalid, and any running
146
checker killed. The default interval is 5 minutes.
147
</para>
148
<para>
149
The format of <replaceable>TIME</replaceable> is the same
150
as for <varname>timeout</varname> above.
150
151
</para>
151
152
</listitem>
152
153
</varlistentry>
196
197
</varlistentry>
197
198
198
199
<varlistentry>
199
<term><option><literal>host = </literal><replaceable
200
>STRING</replaceable></option></term>
201
<listitem>
202
<para>
203
This option is <emphasis>optional</emphasis>, but highly
204
<emphasis>recommended</emphasis> unless the
205
<option>checker</option> option is modified to a
206
non-standard value without <quote>%%(host)s</quote> in it.
207
</para>
208
<para>
209
Host name for this client. This is not used by the server
210
directly, but can be, and is by default, used by the
211
checker. See the <option>checker</option> option.
212
</para>
213
</listitem>
214
</varlistentry>
215
216
<varlistentry>
217
<term><option>interval<literal> = </literal><replaceable
218
>TIME</replaceable></option></term>
219
<listitem>
220
<para>
221
This option is <emphasis>optional</emphasis>.
222
</para>
223
<para>
224
How often to run the checker to confirm that a client is
225
still up. <emphasis>Note:</emphasis> a new checker will
226
not be started if an old one is still running. The server
227
will wait for a checker to complete until the below
228
<quote><varname>timeout</varname></quote> occurs, at which
229
time the client will be disabled, and any running checker
230
killed. The default interval is 5 minutes.
231
</para>
232
<para>
233
The format of <replaceable>TIME</replaceable> is the same
234
as for <varname>timeout</varname> below.
235
</para>
236
</listitem>
237
</varlistentry>
238
239
<varlistentry>
240
<term><option>secfile<literal> = </literal><replaceable
241
>FILENAME</replaceable></option></term>
242
<listitem>
243
<para>
244
This option is only used if <option>secret</option> is not
245
specified, in which case this option is
246
<emphasis>required</emphasis>.
247
</para>
248
<para>
249
Similar to the <option>secret</option>, except the secret
250
data is in an external file. The contents of the file
251
should <emphasis>not</emphasis> be base64-encoded, but
252
will be sent to clients verbatim.
253
</para>
254
<para>
255
File names of the form <filename>~user/foo/bar</filename>
256
and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
257
are supported.
258
</para>
259
</listitem>
260
</varlistentry>
261
262
<varlistentry>
263
200
<term><option>secret<literal> = </literal><replaceable
264
201
>BASE64_ENCODED_DATA</replaceable></option></term>
265
202
<listitem>
290
227
</varlistentry>
291
228
292
229
<varlistentry>
293
<term><option>timeout<literal> = </literal><replaceable
294
>TIME</replaceable></option></term>
295
<listitem>
296
<para>
297
This option is <emphasis>optional</emphasis>.
298
</para>
299
<para>
300
The timeout is how long the server will wait (for either a
301
successful checker run or a client receiving its secret)
302
until a client is disabled and not allowed to get the data
303
this server holds. By default Mandos will use 1 hour.
304
</para>
305
<para>
306
The <replaceable>TIME</replaceable> is specified as a
307
space-separated number of values, each of which is a
308
number and a one-character suffix. The suffix must be one
309
of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
310
<quote>h</quote>, and <quote>w</quote> for days, seconds,
311
minutes, hours, and weeks, respectively. The values are
312
added together to give the total time value, so all of
313
<quote><literal>330s</literal></quote>,
314
<quote><literal>110s 110s 110s</literal></quote>, and
315
<quote><literal>5m 30s</literal></quote> will give a value
316
of five minutes and thirty seconds.
230
<term><option>secfile<literal> = </literal><replaceable
231
>FILENAME</replaceable></option></term>
232
<listitem>
233
<para>
234
This option is only used if <option>secret</option> is not
235
specified, in which case this option is
236
<emphasis>required</emphasis>.
237
</para>
238
<para>
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.
243
</para>
244
<para>
245
File names of the form <filename>~user/foo/bar</filename>
246
and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
247
are supported.
248
</para>
249
</listitem>
250
</varlistentry>
251
252
<varlistentry>
253
<term><option><literal>host = </literal><replaceable
254
>STRING</replaceable></option></term>
255
<listitem>
256
<para>
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.
261
</para>
262
<para>
263
Host name for this client. This is not used by the server
264
directly, but can be, and is by default, used by the
265
checker. See the <option>checker</option> option.
317
266
</para>
318
267
</listitem>
319
268
</varlistentry>
431
380
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
432
381
secfile = /etc/mandos/bar-secret
433
382
timeout = 15m
434
approved_by_default = False
435
approval_delay = 30s
436
383
</programlisting>
437
384
</informalexample>
438
385
</refsect1>
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0