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 425
- compare with another revision
- download diff
- download tarball
- view history from revision 425
- Committer: Teddy Hogeborn
- Date: 2010-09-12 03:15:54 UTC
- Revision ID: teddy@fukt.bsnet.se-20100912031554-le622fn5c0hy61ys
* Makefile: Compile and install new "plymouth" plugin.
- files removed:
- debian/mandos-client.examples
- debian/source
- network-hooks.d
- 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 "2013-10-15">
6
<!ENTITY TIMESTAMP "2010-09-12">
7
7
<!ENTITY % common SYSTEM "common.ent">
8
8
%common;
9
9
]>
20
20
<firstname>Björn</firstname>
21
21
<surname>Påhlsson</surname>
22
22
<address>
23
<email>belorn@recompile.se</email>
23
<email>belorn@fukt.bsnet.se</email>
24
24
</address>
25
25
</author>
26
26
<author>
27
27
<firstname>Teddy</firstname>
28
28
<surname>Hogeborn</surname>
29
29
<address>
30
<email>teddy@recompile.se</email>
30
<email>teddy@fukt.bsnet.se</email>
31
31
</address>
32
32
</author>
33
33
</authorgroup>
34
34
<copyright>
35
35
<year>2008</year>
36
36
<year>2009</year>
37
<year>2010</year>
38
<year>2011</year>
39
<year>2012</year>
40
37
<holder>Teddy Hogeborn</holder>
41
38
<holder>Björn Påhlsson</holder>
42
39
</copyright>
66
63
><refentrytitle>mandos</refentrytitle>
67
64
<manvolnum>8</manvolnum></citerefentry>, read by it at startup.
68
65
The file needs to list all clients that should be able to use
69
the service. The settings in this file can be overridden by
70
runtime changes to the server, which it saves across restarts.
71
(See the section called <quote>PERSISTENT STATE</quote> in
72
<citerefentry><refentrytitle>mandos</refentrytitle><manvolnum
73
>8</manvolnum></citerefentry>.) However, any <emphasis
74
>changes</emphasis> to this file (including adding and removing
75
clients) will, at startup, override changes done during runtime.
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.
76
68
</para>
77
69
<para>
78
70
The format starts with a <literal>[<replaceable>section
108
100
<variablelist>
109
101
110
102
<varlistentry>
111
<term><option>approval_delay<literal> = </literal><replaceable
112
>TIME</replaceable></option></term>
113
<listitem>
114
<para>
115
This option is <emphasis>optional</emphasis>.
116
</para>
117
<para>
118
How long to wait for external approval before resorting to
119
use the <option>approved_by_default</option> value. The
120
default is <quote>PT0S</quote>, i.e. not to wait.
121
</para>
122
<para>
123
The format of <replaceable>TIME</replaceable> is the same
124
as for <varname>timeout</varname> below.
125
</para>
126
</listitem>
127
</varlistentry>
128
129
<varlistentry>
130
<term><option>approval_duration<literal> = </literal
131
><replaceable>TIME</replaceable></option></term>
132
<listitem>
133
<para>
134
This option is <emphasis>optional</emphasis>.
135
</para>
136
<para>
137
How long an external approval lasts. The default is 1
138
second.
139
</para>
140
<para>
141
The format of <replaceable>TIME</replaceable> is the same
142
as for <varname>timeout</varname> below.
143
</para>
144
</listitem>
145
</varlistentry>
146
147
<varlistentry>
148
<term><option>approved_by_default<literal> = </literal
149
>{ <literal >1</literal> | <literal>yes</literal> | <literal
150
>true</literal> | <literal>on</literal> | <literal
151
>0</literal> | <literal>no</literal> | <literal
152
>false</literal> | <literal>off</literal> }</option></term>
153
<listitem>
154
<para>
155
Whether to approve a client by default after
156
the <option>approval_delay</option>. The default
157
is <quote>True</quote>.
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 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.
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 disabled, and any running checker
145
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.
158
150
</para>
159
151
</listitem>
160
152
</varlistentry>
167
159
This option is <emphasis>optional</emphasis>.
168
160
</para>
169
161
<para>
170
This option overrides the default shell command that the
171
server will use to check if the client is still up. Any
172
output of the command will be ignored, only the exit code
173
is checked: If the exit code of the command is zero, the
174
client is considered up. The command will be run using
175
<quote><command><filename>/bin/sh</filename>
162
This option allows you to override the default shell
163
command that the server will use to check if the client is
164
still up. Any output of the command will be ignored, only
165
the exit code is checked: If the exit code of the command
166
is zero, the client is considered up. The command will be
167
run using <quote><command><filename>/bin/sh</filename>
176
168
<option>-c</option></command></quote>, so
177
169
<varname>PATH</varname> will be searched. The default
178
170
value for the checker command is <quote><literal
188
180
</varlistentry>
189
181
190
182
<varlistentry>
191
<term><option>extended_timeout<literal> = </literal><replaceable
192
>TIME</replaceable></option></term>
193
<listitem>
194
<para>
195
This option is <emphasis>optional</emphasis>.
196
</para>
197
<para>
198
Extended timeout is an added timeout that is given once
199
after a password has been sent successfully to a client.
200
The timeout is by default longer than the normal timeout,
201
and is used for handling the extra long downtime while a
202
machine is booting up. Time to take into consideration
203
when changing this value is file system checks and quota
204
checks. The default value is 15 minutes.
205
</para>
206
<para>
207
The format of <replaceable>TIME</replaceable> is the same
208
as for <varname>timeout</varname> below.
209
</para>
210
</listitem>
211
</varlistentry>
212
213
<varlistentry>
214
183
<term><option>fingerprint<literal> = </literal
215
184
><replaceable>HEXSTRING</replaceable></option></term>
216
185
<listitem>
227
196
</varlistentry>
228
197
229
198
<varlistentry>
230
<term><option><literal>host = </literal><replaceable
231
>STRING</replaceable></option></term>
232
<listitem>
233
<para>
234
This option is <emphasis>optional</emphasis>, but highly
235
<emphasis>recommended</emphasis> unless the
236
<option>checker</option> option is modified to a
237
non-standard value without <quote>%%(host)s</quote> in it.
238
</para>
239
<para>
240
Host name for this client. This is not used by the server
241
directly, but can be, and is by default, used by the
242
checker. See the <option>checker</option> option.
243
</para>
244
</listitem>
245
</varlistentry>
246
247
<varlistentry>
248
<term><option>interval<literal> = </literal><replaceable
249
>TIME</replaceable></option></term>
250
<listitem>
251
<para>
252
This option is <emphasis>optional</emphasis>.
253
</para>
254
<para>
255
How often to run the checker to confirm that a client is
256
still up. <emphasis>Note:</emphasis> a new checker will
257
not be started if an old one is still running. The server
258
will wait for a checker to complete until the below
259
<quote><varname>timeout</varname></quote> occurs, at which
260
time the client will be disabled, and any running checker
261
killed. The default interval is 2 minutes.
262
</para>
263
<para>
264
The format of <replaceable>TIME</replaceable> is the same
265
as for <varname>timeout</varname> below.
266
</para>
267
</listitem>
268
</varlistentry>
269
270
<varlistentry>
271
<term><option>secfile<literal> = </literal><replaceable
272
>FILENAME</replaceable></option></term>
273
<listitem>
274
<para>
275
This option is only used if <option>secret</option> is not
276
specified, in which case this option is
277
<emphasis>required</emphasis>.
278
</para>
279
<para>
280
Similar to the <option>secret</option>, except the secret
281
data is in an external file. The contents of the file
282
should <emphasis>not</emphasis> be base64-encoded, but
283
will be sent to clients verbatim.
284
</para>
285
<para>
286
File names of the form <filename>~user/foo/bar</filename>
287
and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
288
are supported.
289
</para>
290
</listitem>
291
</varlistentry>
292
293
<varlistentry>
294
199
<term><option>secret<literal> = </literal><replaceable
295
200
>BASE64_ENCODED_DATA</replaceable></option></term>
296
201
<listitem>
321
226
</varlistentry>
322
227
323
228
<varlistentry>
324
<term><option>timeout<literal> = </literal><replaceable
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
<para>
244
File names of the form <filename>~user/foo/bar</filename>
245
and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
246
are supported.
247
</para>
248
</listitem>
249
</varlistentry>
250
251
<varlistentry>
252
<term><option><literal>host = </literal><replaceable
253
>STRING</replaceable></option></term>
254
<listitem>
255
<para>
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.
260
</para>
261
<para>
262
Host name for this client. This is not used by the server
263
directly, but can be, and is by default, used by the
264
checker. See the <option>checker</option> option.
265
</para>
266
</listitem>
267
</varlistentry>
268
269
<varlistentry>
270
<term><option>approved_by_default<literal> = </literal
271
>{ <literal >1</literal> | <literal>yes</literal> | <literal
272
>true</literal> | <literal>on</literal> | <literal
273
>0</literal> | <literal>no</literal> | <literal
274
>false</literal> | <literal>off</literal> }</option></term>
275
<listitem>
276
<para>
277
Whether to approve a client by default after
278
the <option>approval_delay</option>. The default
279
is <quote>True</quote>.
280
</para>
281
</listitem>
282
</varlistentry>
283
284
<varlistentry>
285
<term><option>approval_delay<literal> = </literal><replaceable
325
286
>TIME</replaceable></option></term>
326
287
<listitem>
327
288
<para>
328
289
This option is <emphasis>optional</emphasis>.
329
290
</para>
330
291
<para>
331
The timeout is how long the server will wait, after a
332
successful checker run, until a client is disabled and not
333
allowed to get the data this server holds. By default
334
Mandos will use 5 minutes. See also the
335
<option>extended_timeout</option> option.
292
How long to wait for external approval before resorting to
293
use the <option>approved_by_default</option> value. The
294
default is <quote>0s</quote>, i.e. not to wait.
336
295
</para>
337
296
<para>
338
The <replaceable>TIME</replaceable> is specified as an RFC
339
3339 duration; for example
340
<quote><literal>P1Y2M3DT4H5M6S</literal></quote> meaning
341
one year, two months, three days, four hours, five
342
minutes, and six seconds. Some values can be omitted, see
343
RFC 3339 Appendix A for details.
297
The format of <replaceable>TIME</replaceable> is the same
298
as for <varname>timeout</varname> above.
344
299
</para>
345
300
</listitem>
346
301
</varlistentry>
347
302
348
303
<varlistentry>
349
<term><option>enabled<literal> = </literal>{ <literal
350
>1</literal> | <literal>yes</literal> | <literal>true</literal
351
> | <literal >on</literal> | <literal>0</literal> | <literal
352
>no</literal> | <literal>false</literal> | <literal
353
>off</literal> }</option></term>
304
<term><option>approval_duration<literal> = </literal
305
><replaceable>TIME</replaceable></option></term>
354
306
<listitem>
355
307
<para>
356
Whether this client should be enabled by default. The
357
default is <quote>true</quote>.
308
This option is <emphasis>optional</emphasis>.
309
</para>
310
<para>
311
How long an external approval lasts. The default is 1
312
second.
313
</para>
314
<para>
315
The format of <replaceable>TIME</replaceable> is the same
316
as for <varname>timeout</varname> above.
358
317
</para>
359
318
</listitem>
360
319
</varlistentry>
397
356
<quote><literal>%%(<replaceable>foo</replaceable>)s</literal
398
357
></quote> will be replaced by the value of the attribute
399
358
<varname>foo</varname> of the internal
400
<quote><classname>Client</classname></quote> object in the
401
Mandos server. The currently allowed values for
402
<replaceable>foo</replaceable> are:
403
<quote><literal>approval_delay</literal></quote>,
404
<quote><literal>approval_duration</literal></quote>,
405
<quote><literal>created</literal></quote>,
406
<quote><literal>enabled</literal></quote>,
407
<quote><literal>expires</literal></quote>,
408
<quote><literal>fingerprint</literal></quote>,
409
<quote><literal>host</literal></quote>,
410
<quote><literal>interval</literal></quote>,
411
<quote><literal>last_approval_request</literal></quote>,
412
<quote><literal>last_checked_ok</literal></quote>,
413
<quote><literal>last_enabled</literal></quote>,
414
<quote><literal>name</literal></quote>,
415
<quote><literal>timeout</literal></quote>, and, if using
416
D-Bus, <quote><literal>dbus_object_path</literal></quote>.
417
See the source code for details. <emphasis role="strong"
418
>Currently, <emphasis>none</emphasis> of these attributes
419
except <quote><literal>host</literal></quote> are guaranteed
420
to be valid in future versions.</emphasis> Therefore, please
421
let the authors know of any attributes that are useful so they
422
may be preserved to any new versions of this software.
359
<quote><classname>Client</classname></quote> object. See the
360
source code for details, and let the authors know of any
361
attributes that are useful so they may be preserved to any new
362
versions of this software.
423
363
</para>
424
364
<para>
425
365
Note that this means that, in order to include an actual
460
400
<informalexample>
461
401
<programlisting>
462
402
[DEFAULT]
463
timeout = PT5M
464
interval = PT2M
403
timeout = 1h
404
interval = 5m
465
405
checker = fping -q -- %%(host)s
466
406
467
407
# Client "foo"
484
424
4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
485
425
QlnHIvPzEArRQLo=
486
426
host = foo.example.org
487
interval = PT1M
427
interval = 1m
488
428
489
429
# Client "bar"
490
430
[bar]
491
431
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
492
432
secfile = /etc/mandos/bar-secret
493
timeout = PT15M
433
timeout = 15m
494
434
approved_by_default = False
495
approval_delay = PT30S
435
approval_delay = 30s
496
436
</programlisting>
497
437
</informalexample>
498
438
</refsect1>
500
440
<refsect1 id="see_also">
501
441
<title>SEE ALSO</title>
502
442
<para>
503
<citerefentry><refentrytitle>intro</refentrytitle>
504
<manvolnum>8mandos</manvolnum></citerefentry>,
505
443
<citerefentry><refentrytitle>mandos-keygen</refentrytitle>
506
444
<manvolnum>8</manvolnum></citerefentry>,
507
445
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
508
446
<manvolnum>5</manvolnum></citerefentry>,
509
447
<citerefentry><refentrytitle>mandos</refentrytitle>
510
<manvolnum>8</manvolnum></citerefentry>,
511
<citerefentry><refentrytitle>fping</refentrytitle>
512
448
<manvolnum>8</manvolnum></citerefentry>
513
449
</para>
514
<variablelist>
515
<varlistentry>
516
<term>
517
RFC 3339: <citetitle>Date and Time on the Internet:
518
Timestamps</citetitle>
519
</term>
520
<listitem>
521
<para>
522
The time intervals are in the "duration" format, as
523
specified in ABNF in Appendix A of RFC 3339.
524
</para>
525
</listitem>
526
</varlistentry>
527
</variablelist>
528
450
</refsect1>
529
451
</refentry>
530
452
<!-- Local Variables: -->
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0