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 427
- compare with another revision
- download diff
- download tarball
- view history from revision 427
- Committer: Teddy Hogeborn
- Date: 2010-09-13 05:56:48 UTC
- mfrom: (420.1.1 mandos-local)
- Revision ID: teddy@fukt.bsnet.se-20100913055648-v92t4egg6xubyqqo
Merge Makefile change.
- files removed:
- debian/mandos-client.examples
- debian/source
- debian/upstream
- network-hooks.d
- plugin-helpers
- 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 "2016-02-28">
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
<year>2013</year>
41
<year>2014</year>
42
<year>2015</year>
43
<year>2016</year>
44
37
<holder>Teddy Hogeborn</holder>
45
38
<holder>Björn Påhlsson</holder>
46
39
</copyright>
70
63
><refentrytitle>mandos</refentrytitle>
71
64
<manvolnum>8</manvolnum></citerefentry>, read by it at startup.
72
65
The file needs to list all clients that should be able to use
73
the service. The settings in this file can be overridden by
74
runtime changes to the server, which it saves across restarts.
75
(See the section called <quote>PERSISTENT STATE</quote> in
76
<citerefentry><refentrytitle>mandos</refentrytitle><manvolnum
77
>8</manvolnum></citerefentry>.) However, any <emphasis
78
>changes</emphasis> to this file (including adding and removing
79
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.
80
68
</para>
81
69
<para>
82
70
The format starts with a <literal>[<replaceable>section
112
100
<variablelist>
113
101
114
102
<varlistentry>
115
<term><option>approval_delay<literal> = </literal><replaceable
116
>TIME</replaceable></option></term>
117
<listitem>
118
<para>
119
This option is <emphasis>optional</emphasis>.
120
</para>
121
<para>
122
How long to wait for external approval before resorting to
123
use the <option>approved_by_default</option> value. The
124
default is <quote>PT0S</quote>, i.e. not to wait.
125
</para>
126
<para>
127
The format of <replaceable>TIME</replaceable> is the same
128
as for <varname>timeout</varname> below.
129
</para>
130
</listitem>
131
</varlistentry>
132
133
<varlistentry>
134
<term><option>approval_duration<literal> = </literal
135
><replaceable>TIME</replaceable></option></term>
136
<listitem>
137
<para>
138
This option is <emphasis>optional</emphasis>.
139
</para>
140
<para>
141
How long an external approval lasts. The default is 1
142
second.
143
</para>
144
<para>
145
The format of <replaceable>TIME</replaceable> is the same
146
as for <varname>timeout</varname> below.
147
</para>
148
</listitem>
149
</varlistentry>
150
151
<varlistentry>
152
<term><option>approved_by_default<literal> = </literal
153
>{ <literal >1</literal> | <literal>yes</literal> | <literal
154
>true</literal> | <literal>on</literal> | <literal
155
>0</literal> | <literal>no</literal> | <literal
156
>false</literal> | <literal>off</literal> }</option></term>
157
<listitem>
158
<para>
159
Whether to approve a client by default after
160
the <option>approval_delay</option>. The default
161
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.
162
150
</para>
163
151
</listitem>
164
152
</varlistentry>
171
159
This option is <emphasis>optional</emphasis>.
172
160
</para>
173
161
<para>
174
This option overrides the default shell command that the
175
server will use to check if the client is still up. Any
176
output of the command will be ignored, only the exit code
177
is checked: If the exit code of the command is zero, the
178
client is considered up. The command will be run using
179
<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>
180
168
<option>-c</option></command></quote>, so
181
169
<varname>PATH</varname> will be searched. The default
182
170
value for the checker command is <quote><literal
183
171
><command>fping</command> <option>-q</option> <option
184
>--</option> %%(host)s</literal></quote>. Note that
185
<command>mandos-keygen</command>, when generating output
186
to be inserted into this file, normally looks for an SSH
187
server on the Mandos client, and, if it find one, outputs
188
a <option>checker</option> option to check for the
189
client’s key fingerprint – this is more secure against
190
spoofing.
172
>--</option> %%(host)s</literal></quote>.
191
173
</para>
192
174
<para>
193
175
In addition to normal start time expansion, this option
198
180
</varlistentry>
199
181
200
182
<varlistentry>
201
<term><option>extended_timeout<literal> = </literal><replaceable
202
>TIME</replaceable></option></term>
203
<listitem>
204
<para>
205
This option is <emphasis>optional</emphasis>.
206
</para>
207
<para>
208
Extended timeout is an added timeout that is given once
209
after a password has been sent successfully to a client.
210
The timeout is by default longer than the normal timeout,
211
and is used for handling the extra long downtime while a
212
machine is booting up. Time to take into consideration
213
when changing this value is file system checks and quota
214
checks. The default value is 15 minutes.
215
</para>
216
<para>
217
The format of <replaceable>TIME</replaceable> is the same
218
as for <varname>timeout</varname> below.
219
</para>
220
</listitem>
221
</varlistentry>
222
223
<varlistentry>
224
183
<term><option>fingerprint<literal> = </literal
225
184
><replaceable>HEXSTRING</replaceable></option></term>
226
185
<listitem>
237
196
</varlistentry>
238
197
239
198
<varlistentry>
240
<term><option><literal>host = </literal><replaceable
241
>STRING</replaceable></option></term>
242
<listitem>
243
<para>
244
This option is <emphasis>optional</emphasis>, but highly
245
<emphasis>recommended</emphasis> unless the
246
<option>checker</option> option is modified to a
247
non-standard value without <quote>%%(host)s</quote> in it.
248
</para>
249
<para>
250
Host name for this client. This is not used by the server
251
directly, but can be, and is by default, used by the
252
checker. See the <option>checker</option> option.
253
</para>
254
</listitem>
255
</varlistentry>
256
257
<varlistentry>
258
<term><option>interval<literal> = </literal><replaceable
259
>TIME</replaceable></option></term>
260
<listitem>
261
<para>
262
This option is <emphasis>optional</emphasis>.
263
</para>
264
<para>
265
How often to run the checker to confirm that a client is
266
still up. <emphasis>Note:</emphasis> a new checker will
267
not be started if an old one is still running. The server
268
will wait for a checker to complete until the below
269
<quote><varname>timeout</varname></quote> occurs, at which
270
time the client will be disabled, and any running checker
271
killed. The default interval is 2 minutes.
272
</para>
273
<para>
274
The format of <replaceable>TIME</replaceable> is the same
275
as for <varname>timeout</varname> below.
276
</para>
277
</listitem>
278
</varlistentry>
279
280
<varlistentry>
281
<term><option>secfile<literal> = </literal><replaceable
282
>FILENAME</replaceable></option></term>
283
<listitem>
284
<para>
285
This option is only used if <option>secret</option> is not
286
specified, in which case this option is
287
<emphasis>required</emphasis>.
288
</para>
289
<para>
290
Similar to the <option>secret</option>, except the secret
291
data is in an external file. The contents of the file
292
should <emphasis>not</emphasis> be base64-encoded, but
293
will be sent to clients verbatim.
294
</para>
295
<para>
296
File names of the form <filename>~user/foo/bar</filename>
297
and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
298
are supported.
299
</para>
300
</listitem>
301
</varlistentry>
302
303
<varlistentry>
304
199
<term><option>secret<literal> = </literal><replaceable
305
200
>BASE64_ENCODED_DATA</replaceable></option></term>
306
201
<listitem>
331
226
</varlistentry>
332
227
333
228
<varlistentry>
334
<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
335
286
>TIME</replaceable></option></term>
336
287
<listitem>
337
288
<para>
338
289
This option is <emphasis>optional</emphasis>.
339
290
</para>
340
291
<para>
341
The timeout is how long the server will wait, after a
342
successful checker run, until a client is disabled and not
343
allowed to get the data this server holds. By default
344
Mandos will use 5 minutes. See also the
345
<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.
346
295
</para>
347
296
<para>
348
The <replaceable>TIME</replaceable> is specified as an RFC
349
3339 duration; for example
350
<quote><literal>P1Y2M3DT4H5M6S</literal></quote> meaning
351
one year, two months, three days, four hours, five
352
minutes, and six seconds. Some values can be omitted, see
353
RFC 3339 Appendix A for details.
297
The format of <replaceable>TIME</replaceable> is the same
298
as for <varname>timeout</varname> above.
354
299
</para>
355
300
</listitem>
356
301
</varlistentry>
357
302
358
303
<varlistentry>
359
<term><option>enabled<literal> = </literal>{ <literal
360
>1</literal> | <literal>yes</literal> | <literal>true</literal
361
> | <literal >on</literal> | <literal>0</literal> | <literal
362
>no</literal> | <literal>false</literal> | <literal
363
>off</literal> }</option></term>
304
<term><option>approval_duration<literal> = </literal
305
><replaceable>TIME</replaceable></option></term>
364
306
<listitem>
365
307
<para>
366
Whether this client should be enabled by default. The
367
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.
368
317
</para>
369
318
</listitem>
370
319
</varlistentry>
407
356
<quote><literal>%%(<replaceable>foo</replaceable>)s</literal
408
357
></quote> will be replaced by the value of the attribute
409
358
<varname>foo</varname> of the internal
410
<quote><classname>Client</classname></quote> object in the
411
Mandos server. The currently allowed values for
412
<replaceable>foo</replaceable> are:
413
<quote><literal>approval_delay</literal></quote>,
414
<quote><literal>approval_duration</literal></quote>,
415
<quote><literal>created</literal></quote>,
416
<quote><literal>enabled</literal></quote>,
417
<quote><literal>expires</literal></quote>,
418
<quote><literal>fingerprint</literal></quote>,
419
<quote><literal>host</literal></quote>,
420
<quote><literal>interval</literal></quote>,
421
<quote><literal>last_approval_request</literal></quote>,
422
<quote><literal>last_checked_ok</literal></quote>,
423
<quote><literal>last_enabled</literal></quote>,
424
<quote><literal>name</literal></quote>,
425
<quote><literal>timeout</literal></quote>, and, if using
426
D-Bus, <quote><literal>dbus_object_path</literal></quote>.
427
See the source code for details. <emphasis role="strong"
428
>Currently, <emphasis>none</emphasis> of these attributes
429
except <quote><literal>host</literal></quote> are guaranteed
430
to be valid in future versions.</emphasis> Therefore, please
431
let the authors know of any attributes that are useful so they
432
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.
433
363
</para>
434
364
<para>
435
365
Note that this means that, in order to include an actual
470
400
<informalexample>
471
401
<programlisting>
472
402
[DEFAULT]
473
timeout = PT5M
474
interval = PT2M
403
timeout = 1h
404
interval = 5m
475
405
checker = fping -q -- %%(host)s
476
406
477
407
# Client "foo"
494
424
4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
495
425
QlnHIvPzEArRQLo=
496
426
host = foo.example.org
497
interval = PT1M
427
interval = 1m
498
428
499
429
# Client "bar"
500
430
[bar]
501
431
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
502
432
secfile = /etc/mandos/bar-secret
503
timeout = PT15M
433
timeout = 15m
504
434
approved_by_default = False
505
approval_delay = PT30S
435
approval_delay = 30s
506
436
</programlisting>
507
437
</informalexample>
508
438
</refsect1>
510
440
<refsect1 id="see_also">
511
441
<title>SEE ALSO</title>
512
442
<para>
513
<citerefentry><refentrytitle>intro</refentrytitle>
514
<manvolnum>8mandos</manvolnum></citerefentry>,
515
443
<citerefentry><refentrytitle>mandos-keygen</refentrytitle>
516
444
<manvolnum>8</manvolnum></citerefentry>,
517
445
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
518
446
<manvolnum>5</manvolnum></citerefentry>,
519
447
<citerefentry><refentrytitle>mandos</refentrytitle>
520
<manvolnum>8</manvolnum></citerefentry>,
521
<citerefentry><refentrytitle>fping</refentrytitle>
522
448
<manvolnum>8</manvolnum></citerefentry>
523
449
</para>
524
<variablelist>
525
<varlistentry>
526
<term>
527
RFC 3339: <citetitle>Date and Time on the Internet:
528
Timestamps</citetitle>
529
</term>
530
<listitem>
531
<para>
532
The time intervals are in the "duration" format, as
533
specified in ABNF in Appendix A of RFC 3339.
534
</para>
535
</listitem>
536
</varlistentry>
537
</variablelist>
538
450
</refsect1>
539
451
</refentry>
540
452
<!-- Local Variables: -->
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0