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 376
- compare with another revision
- download diff
- download tarball
- view history from revision 376
- Committer: Teddy Hogeborn
- Date: 2009-09-17 14:21:18 UTC
- Revision ID: teddy@fukt.bsnet.se-20090917142118-6wto8m380jhiot68
Merge from release branch.
- files removed:
- DBUS-API
- 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-03-05">
6
<!ENTITY TIMESTAMP "2009-09-17">
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 valid, even
67
if a client was declared invalid in a previous run of the
68
server.
80
69
</para>
81
70
<para>
82
71
The format starts with a <literal>[<replaceable>section
112
101
<variablelist>
113
102
114
103
<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>.
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 either a
112
successful checker run or a client receiving its secret)
113
until a client is considered invalid - that is, ineligible
114
to get the data this server holds. By default Mandos will
115
use 1 hour.
116
</para>
117
<para>
118
The <replaceable>TIME</replaceable> is specified as a
119
space-separated number of values, each of which is a
120
number and a one-character suffix. The suffix must be one
121
of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
122
<quote>h</quote>, and <quote>w</quote> for days, seconds,
123
minutes, hours, and weeks, respectively. The values are
124
added together to give the total time value, so all of
125
<quote><literal>330s</literal></quote>,
126
<quote><literal>110s 110s 110s</literal></quote>, and
127
<quote><literal>5m 30s</literal></quote> will give a value
128
of five minutes and thirty seconds.
129
</para>
130
</listitem>
131
</varlistentry>
132
133
<varlistentry>
134
<term><option>interval<literal> = </literal><replaceable
135
>TIME</replaceable></option></term>
136
<listitem>
137
<para>
138
This option is <emphasis>optional</emphasis>.
139
</para>
140
<para>
141
How often to run the checker to confirm that a client is
142
still up. <emphasis>Note:</emphasis> a new checker will
143
not be started if an old one is still running. The server
144
will wait for a checker to complete until the above
145
<quote><varname>timeout</varname></quote> occurs, at which
146
time the client will be marked invalid, and any running
147
checker killed. The default interval is 5 minutes.
148
</para>
149
<para>
150
The format of <replaceable>TIME</replaceable> is the same
151
as for <varname>timeout</varname> above.
162
152
</para>
163
153
</listitem>
164
154
</varlistentry>
171
161
This option is <emphasis>optional</emphasis>.
172
162
</para>
173
163
<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>
164
This option allows you to override the default shell
165
command that the server will use to check if the client is
166
still up. Any output of the command will be ignored, only
167
the exit code is checked: If the exit code of the command
168
is zero, the client is considered up. The command will be
169
run using <quote><command><filename>/bin/sh</filename>
180
170
<option>-c</option></command></quote>, so
181
171
<varname>PATH</varname> will be searched. The default
182
172
value for the checker command is <quote><literal
183
173
><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.
174
>--</option> %%(host)s</literal></quote>.
191
175
</para>
192
176
<para>
193
177
In addition to normal start time expansion, this option
198
182
</varlistentry>
199
183
200
184
<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
185
<term><option>fingerprint<literal> = </literal
225
186
><replaceable>HEXSTRING</replaceable></option></term>
226
187
<listitem>
237
198
</varlistentry>
238
199
239
200
<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
201
<term><option>secret<literal> = </literal><replaceable
305
202
>BASE64_ENCODED_DATA</replaceable></option></term>
306
203
<listitem>
331
228
</varlistentry>
332
229
333
230
<varlistentry>
334
<term><option>timeout<literal> = </literal><replaceable
335
>TIME</replaceable></option></term>
231
<term><option>secfile<literal> = </literal><replaceable
232
>FILENAME</replaceable></option></term>
336
233
<listitem>
337
234
<para>
338
This option is <emphasis>optional</emphasis>.
339
</para>
340
<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.
346
</para>
347
<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.
235
This option is only used if <option>secret</option> is not
236
specified, in which case this option is
237
<emphasis>required</emphasis>.
238
</para>
239
<para>
240
Similar to the <option>secret</option>, except the secret
241
data is in an external file. The contents of the file
242
should <emphasis>not</emphasis> be base64-encoded, but
243
will be sent to clients verbatim.
244
</para>
245
<para>
246
File names of the form <filename>~user/foo/bar</filename>
247
and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
248
are supported.
354
249
</para>
355
250
</listitem>
356
251
</varlistentry>
357
252
358
253
<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>
254
<term><option><literal>host = </literal><replaceable
255
>STRING</replaceable></option></term>
364
256
<listitem>
365
257
<para>
366
Whether this client should be enabled by default. The
367
default is <quote>true</quote>.
258
This option is <emphasis>optional</emphasis>, but highly
259
<emphasis>recommended</emphasis> unless the
260
<option>checker</option> option is modified to a
261
non-standard value without <quote>%%(host)s</quote> in it.
262
</para>
263
<para>
264
Host name for this client. This is not used by the server
265
directly, but can be, and is by default, used by the
266
checker. See the <option>checker</option> option.
368
267
</para>
369
268
</listitem>
370
269
</varlistentry>
407
306
<quote><literal>%%(<replaceable>foo</replaceable>)s</literal
408
307
></quote> will be replaced by the value of the attribute
409
308
<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.
309
<quote><classname>Client</classname></quote> object. See the
310
source code for details, and let the authors know of any
311
attributes that are useful so they may be preserved to any new
312
versions of this software.
433
313
</para>
434
314
<para>
435
315
Note that this means that, in order to include an actual
463
343
<literal>%(<replaceable>foo</replaceable>)s</literal> is
464
344
obscure.
465
345
</para>
466
<xi:include href="bugs.xml"/>
467
346
</refsect1>
468
347
469
348
<refsect1 id="example">
471
350
<informalexample>
472
351
<programlisting>
473
352
[DEFAULT]
474
timeout = PT5M
475
interval = PT2M
353
timeout = 1h
354
interval = 5m
476
355
checker = fping -q -- %%(host)s
477
356
478
357
# Client "foo"
495
374
4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
496
375
QlnHIvPzEArRQLo=
497
376
host = foo.example.org
498
interval = PT1M
377
interval = 1m
499
378
500
379
# Client "bar"
501
380
[bar]
502
381
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
503
382
secfile = /etc/mandos/bar-secret
504
timeout = PT15M
505
approved_by_default = False
506
approval_delay = PT30S
383
timeout = 15m
507
384
</programlisting>
508
385
</informalexample>
509
386
</refsect1>
511
388
<refsect1 id="see_also">
512
389
<title>SEE ALSO</title>
513
390
<para>
514
<citerefentry><refentrytitle>intro</refentrytitle>
515
<manvolnum>8mandos</manvolnum></citerefentry>,
516
391
<citerefentry><refentrytitle>mandos-keygen</refentrytitle>
517
392
<manvolnum>8</manvolnum></citerefentry>,
518
393
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
519
394
<manvolnum>5</manvolnum></citerefentry>,
520
395
<citerefentry><refentrytitle>mandos</refentrytitle>
521
<manvolnum>8</manvolnum></citerefentry>,
522
<citerefentry><refentrytitle>fping</refentrytitle>
523
396
<manvolnum>8</manvolnum></citerefentry>
524
397
</para>
525
<variablelist>
526
<varlistentry>
527
<term>
528
RFC 3339: <citetitle>Date and Time on the Internet:
529
Timestamps</citetitle>
530
</term>
531
<listitem>
532
<para>
533
The time intervals are in the "duration" format, as
534
specified in ABNF in Appendix A of RFC 3339.
535
</para>
536
</listitem>
537
</varlistentry>
538
</variablelist>
539
398
</refsect1>
540
399
</refentry>
541
400
<!-- Local Variables: -->
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0