To get this branch, use:
bzr branch
http://bzr.recompile.se/loggerhead/mandos/release
« back to all changes in this revision
Viewing changes to mandos-clients.conf.xml
- browse files at revision 237.8.5
- compare with another revision
- download diff
- download tarball
- view history from revision 237.8.5
- Committer: teddy at bsnet
- Date: 2011-02-13 10:17:16 UTC
- mto: (237.7.13 mandos)
- mto: This revision was merged to the branch mainline in revision 282.
- Revision ID: teddy@fukt.bsnet.se-20110213101716-987z5189e9x1jtad
* mandos: Use unicode string literals.
- files added:
- DBUS-API
- debian/source
- files removed:
- debian/mandos-client.config
- files modified:
- .bzrignore
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 "2008-09-30">
6
<!ENTITY TIMESTAMP "2010-09-26">
7
7
<!ENTITY % common SYSTEM "common.ent">
8
8
%common;
9
9
]>
33
33
</authorgroup>
34
34
<copyright>
35
35
<year>2008</year>
36
<year>2009</year>
37
<year>2010</year>
36
38
<holder>Teddy Hogeborn</holder>
37
39
<holder>Björn Påhlsson</holder>
38
40
</copyright>
62
64
><refentrytitle>mandos</refentrytitle>
63
65
<manvolnum>8</manvolnum></citerefentry>, read by it at startup.
64
66
The file needs to list all clients that should be able to use
65
the service. All clients listed will be regarded as valid, even
66
if a client was declared invalid in a previous run of the
67
server.
67
the service. All clients listed will be regarded as enabled,
68
even if a client was disabled in a previous run of the 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>timeout<literal> = </literal><replaceable
104
>TIME</replaceable></option></term>
105
<listitem>
106
<para>
107
This option is <emphasis>optional</emphasis>.
108
</para>
109
<para>
110
The timeout is how long the server will wait for a
111
successful checker run until a client is considered
112
invalid - that is, ineligible to get the data this server
113
holds. By default Mandos will use 1 hour.
114
</para>
115
<para>
116
The <replaceable>TIME</replaceable> is specified as a
117
space-separated number of values, each of which is a
118
number and a one-character suffix. The suffix must be one
119
of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
120
<quote>h</quote>, and <quote>w</quote> for days, seconds,
121
minutes, hours, and weeks, respectively. The values are
122
added together to give the total time value, so all of
123
<quote><literal>330s</literal></quote>,
124
<quote><literal>110s 110s 110s</literal></quote>, and
125
<quote><literal>5m 30s</literal></quote> will give a value
126
of five minutes and thirty seconds.
127
</para>
128
</listitem>
129
</varlistentry>
130
131
<varlistentry>
132
<term><option>interval<literal> = </literal><replaceable
133
>TIME</replaceable></option></term>
134
<listitem>
135
<para>
136
This option is <emphasis>optional</emphasis>.
137
</para>
138
<para>
139
How often to run the checker to confirm that a client is
140
still up. <emphasis>Note:</emphasis> a new checker will
141
not be started if an old one is still running. The server
142
will wait for a checker to complete until the above
143
<quote><varname>timeout</varname></quote> occurs, at which
144
time the client will be marked invalid, and any running
145
checker killed. The default interval is 5 minutes.
146
</para>
147
<para>
148
The format of <replaceable>TIME</replaceable> is the same
149
as for <varname>timeout</varname> above.
104
<term><option>approval_delay<literal> = </literal><replaceable
105
>TIME</replaceable></option></term>
106
<listitem>
107
<para>
108
This option is <emphasis>optional</emphasis>.
109
</para>
110
<para>
111
How long to wait for external approval before resorting to
112
use the <option>approved_by_default</option> value. The
113
default is <quote>0s</quote>, i.e. not to wait.
114
</para>
115
<para>
116
The format of <replaceable>TIME</replaceable> is the same
117
as for <varname>timeout</varname> below.
118
</para>
119
</listitem>
120
</varlistentry>
121
122
<varlistentry>
123
<term><option>approval_duration<literal> = </literal
124
><replaceable>TIME</replaceable></option></term>
125
<listitem>
126
<para>
127
This option is <emphasis>optional</emphasis>.
128
</para>
129
<para>
130
How long an external approval lasts. The default is 1
131
second.
132
</para>
133
<para>
134
The format of <replaceable>TIME</replaceable> is the same
135
as for <varname>timeout</varname> below.
136
</para>
137
</listitem>
138
</varlistentry>
139
140
<varlistentry>
141
<term><option>approved_by_default<literal> = </literal
142
>{ <literal >1</literal> | <literal>yes</literal> | <literal
143
>true</literal> | <literal>on</literal> | <literal
144
>0</literal> | <literal>no</literal> | <literal
145
>false</literal> | <literal>off</literal> }</option></term>
146
<listitem>
147
<para>
148
Whether to approve a client by default after
149
the <option>approval_delay</option>. The default
150
is <quote>True</quote>.
150
151
</para>
151
152
</listitem>
152
153
</varlistentry>
169
170
<varname>PATH</varname> will be searched. The default
170
171
value for the checker command is <quote><literal
171
172
><command>fping</command> <option>-q</option> <option
172
>--</option> %(host)s</literal></quote>.
173
>--</option> %%(host)s</literal></quote>.
173
174
</para>
174
175
<para>
175
176
In addition to normal start time expansion, this option
196
197
</varlistentry>
197
198
198
199
<varlistentry>
200
<term><option><literal>host = </literal><replaceable
201
>STRING</replaceable></option></term>
202
<listitem>
203
<para>
204
This option is <emphasis>optional</emphasis>, but highly
205
<emphasis>recommended</emphasis> unless the
206
<option>checker</option> option is modified to a
207
non-standard value without <quote>%%(host)s</quote> in it.
208
</para>
209
<para>
210
Host name for this client. This is not used by the server
211
directly, but can be, and is by default, used by the
212
checker. See the <option>checker</option> option.
213
</para>
214
</listitem>
215
</varlistentry>
216
217
<varlistentry>
218
<term><option>interval<literal> = </literal><replaceable
219
>TIME</replaceable></option></term>
220
<listitem>
221
<para>
222
This option is <emphasis>optional</emphasis>.
223
</para>
224
<para>
225
How often to run the checker to confirm that a client is
226
still up. <emphasis>Note:</emphasis> a new checker will
227
not be started if an old one is still running. The server
228
will wait for a checker to complete until the below
229
<quote><varname>timeout</varname></quote> occurs, at which
230
time the client will be disabled, and any running checker
231
killed. The default interval is 5 minutes.
232
</para>
233
<para>
234
The format of <replaceable>TIME</replaceable> is the same
235
as for <varname>timeout</varname> below.
236
</para>
237
</listitem>
238
</varlistentry>
239
240
<varlistentry>
241
<term><option>secfile<literal> = </literal><replaceable
242
>FILENAME</replaceable></option></term>
243
<listitem>
244
<para>
245
This option is only used if <option>secret</option> is not
246
specified, in which case this option is
247
<emphasis>required</emphasis>.
248
</para>
249
<para>
250
Similar to the <option>secret</option>, except the secret
251
data is in an external file. The contents of the file
252
should <emphasis>not</emphasis> be base64-encoded, but
253
will be sent to clients verbatim.
254
</para>
255
<para>
256
File names of the form <filename>~user/foo/bar</filename>
257
and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
258
are supported.
259
</para>
260
</listitem>
261
</varlistentry>
262
263
<varlistentry>
199
264
<term><option>secret<literal> = </literal><replaceable
200
265
>BASE64_ENCODED_DATA</replaceable></option></term>
201
266
<listitem>
226
291
</varlistentry>
227
292
228
293
<varlistentry>
229
<term><option>secfile<literal> = </literal><replaceable
230
>FILENAME</replaceable></option></term>
231
<listitem>
232
<para>
233
This option is only used if <option>secret</option> is not
234
specified, in which case this option is
235
<emphasis>required</emphasis>.
236
</para>
237
<para>
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.
242
</para>
243
</listitem>
244
</varlistentry>
245
246
<varlistentry>
247
<term><option><literal>host = </literal><replaceable
248
>STRING</replaceable></option></term>
249
<listitem>
250
<para>
251
This option is <emphasis>optional</emphasis>, but highly
252
<emphasis>recommended</emphasis> unless the
253
<option>checker</option> option is modified to a
254
non-standard value without <quote>%(host)s</quote> in it.
255
</para>
256
<para>
257
Host name for this client. This is not used by the server
258
directly, but can be, and is by default, used by the
259
checker. See the <option>checker</option> option.
294
<term><option>timeout<literal> = </literal><replaceable
295
>TIME</replaceable></option></term>
296
<listitem>
297
<para>
298
This option is <emphasis>optional</emphasis>.
299
</para>
300
<para>
301
The timeout is how long the server will wait (for either a
302
successful checker run or a client receiving its secret)
303
until a client is disabled and not allowed to get the data
304
this server holds. By default Mandos will use 1 hour.
305
</para>
306
<para>
307
The <replaceable>TIME</replaceable> is specified as a
308
space-separated number of values, each of which is a
309
number and a one-character suffix. The suffix must be one
310
of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
311
<quote>h</quote>, and <quote>w</quote> for days, seconds,
312
minutes, hours, and weeks, respectively. The values are
313
added together to give the total time value, so all of
314
<quote><literal>330s</literal></quote>,
315
<quote><literal>110s 110s 110s</literal></quote>, and
316
<quote><literal>5m 30s</literal></quote> will give a value
317
of five minutes and thirty seconds.
260
318
</para>
261
319
</listitem>
262
320
</varlistentry>
299
357
<quote><literal>%%(<replaceable>foo</replaceable>)s</literal
300
358
></quote> will be replaced by the value of the attribute
301
359
<varname>foo</varname> of the internal
302
<quote><classname>Client</classname></quote> object. See the
303
source code for details, and let the authors know of any
304
attributes that are useful so they may be preserved to any new
305
versions of this software.
360
<quote><classname>Client</classname></quote> object in the
361
Mandos server. The currently allowed values for
362
<replaceable>foo</replaceable> are:
363
<quote><literal>approval_delay</literal></quote>,
364
<quote><literal>approval_duration</literal></quote>,
365
<quote><literal>created</literal></quote>,
366
<quote><literal>enabled</literal></quote>,
367
<quote><literal>fingerprint</literal></quote>,
368
<quote><literal>host</literal></quote>,
369
<quote><literal>interval</literal></quote>,
370
<quote><literal>last_approval_request</literal></quote>,
371
<quote><literal>last_checked_ok</literal></quote>,
372
<quote><literal>last_enabled</literal></quote>,
373
<quote><literal>name</literal></quote>,
374
<quote><literal>timeout</literal></quote>, and, if using
375
D-Bus, <quote><literal>dbus_object_path</literal></quote>.
376
See the source code for details. <emphasis role="strong"
377
>Currently, <emphasis>none</emphasis> of these attributes
378
except <quote><literal>host</literal></quote> are guaranteed
379
to be valid in future versions.</emphasis> Therefore, please
380
let the authors know of any attributes that are useful so they
381
may be preserved to any new versions of this software.
306
382
</para>
307
383
<para>
308
384
Note that this means that, in order to include an actual
345
421
[DEFAULT]
346
422
timeout = 1h
347
423
interval = 5m
348
checker = fping -q -- %(host)s
424
checker = fping -q -- %%(host)s
349
425
350
426
# Client "foo"
351
427
[foo]
374
450
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
375
451
secfile = /etc/mandos/bar-secret
376
452
timeout = 15m
453
approved_by_default = False
454
approval_delay = 30s
377
455
</programlisting>
378
456
</informalexample>
379
457
</refsect1>
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0