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 24.1.151
- compare with another revision
- download diff
- download tarball
- view history from revision 24.1.151
- Committer: Björn Påhlsson
- Date: 2010-09-01 13:04:23 UTC
- mto: (237.4.3 mandos-release)
- mto: This revision was merged to the branch mainline in revision 421.
- Revision ID: belorn@fukt.bsnet.se-20100901130423-bkn4j4vukasa1d27
New graphical boot supported: Plymouth
- files added:
- plugins.d/plymouth
- 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 "2014-06-22">
6
<!ENTITY TIMESTAMP "2009-12-09">
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
179
171
><command>fping</command> <option>-q</option> <option
180
>--</option> %%(host)s</literal></quote>. Note that
181
<command>mandos-keygen</command>, when generating output
182
to be inserted into this file, normally looks for an SSH
183
server on the Mandos client, and, if it find one, outputs
184
a <option>checker</option> option to check for the
185
client’s key fingerprint – this is more secure against
186
spoofing.
172
>--</option> %%(host)s</literal></quote>.
187
173
</para>
188
174
<para>
189
175
In addition to normal start time expansion, this option
194
180
</varlistentry>
195
181
196
182
<varlistentry>
197
<term><option>extended_timeout<literal> = </literal><replaceable
198
>TIME</replaceable></option></term>
199
<listitem>
200
<para>
201
This option is <emphasis>optional</emphasis>.
202
</para>
203
<para>
204
Extended timeout is an added timeout that is given once
205
after a password has been sent successfully to a client.
206
The timeout is by default longer than the normal timeout,
207
and is used for handling the extra long downtime while a
208
machine is booting up. Time to take into consideration
209
when changing this value is file system checks and quota
210
checks. The default value is 15 minutes.
211
</para>
212
<para>
213
The format of <replaceable>TIME</replaceable> is the same
214
as for <varname>timeout</varname> below.
215
</para>
216
</listitem>
217
</varlistentry>
218
219
<varlistentry>
220
183
<term><option>fingerprint<literal> = </literal
221
184
><replaceable>HEXSTRING</replaceable></option></term>
222
185
<listitem>
233
196
</varlistentry>
234
197
235
198
<varlistentry>
236
<term><option><literal>host = </literal><replaceable
237
>STRING</replaceable></option></term>
238
<listitem>
239
<para>
240
This option is <emphasis>optional</emphasis>, but highly
241
<emphasis>recommended</emphasis> unless the
242
<option>checker</option> option is modified to a
243
non-standard value without <quote>%%(host)s</quote> in it.
244
</para>
245
<para>
246
Host name for this client. This is not used by the server
247
directly, but can be, and is by default, used by the
248
checker. See the <option>checker</option> option.
249
</para>
250
</listitem>
251
</varlistentry>
252
253
<varlistentry>
254
<term><option>interval<literal> = </literal><replaceable
255
>TIME</replaceable></option></term>
256
<listitem>
257
<para>
258
This option is <emphasis>optional</emphasis>.
259
</para>
260
<para>
261
How often to run the checker to confirm that a client is
262
still up. <emphasis>Note:</emphasis> a new checker will
263
not be started if an old one is still running. The server
264
will wait for a checker to complete until the below
265
<quote><varname>timeout</varname></quote> occurs, at which
266
time the client will be disabled, and any running checker
267
killed. The default interval is 2 minutes.
268
</para>
269
<para>
270
The format of <replaceable>TIME</replaceable> is the same
271
as for <varname>timeout</varname> below.
272
</para>
273
</listitem>
274
</varlistentry>
275
276
<varlistentry>
277
<term><option>secfile<literal> = </literal><replaceable
278
>FILENAME</replaceable></option></term>
279
<listitem>
280
<para>
281
This option is only used if <option>secret</option> is not
282
specified, in which case this option is
283
<emphasis>required</emphasis>.
284
</para>
285
<para>
286
Similar to the <option>secret</option>, except the secret
287
data is in an external file. The contents of the file
288
should <emphasis>not</emphasis> be base64-encoded, but
289
will be sent to clients verbatim.
290
</para>
291
<para>
292
File names of the form <filename>~user/foo/bar</filename>
293
and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
294
are supported.
295
</para>
296
</listitem>
297
</varlistentry>
298
299
<varlistentry>
300
199
<term><option>secret<literal> = </literal><replaceable
301
200
>BASE64_ENCODED_DATA</replaceable></option></term>
302
201
<listitem>
327
226
</varlistentry>
328
227
329
228
<varlistentry>
330
<term><option>timeout<literal> = </literal><replaceable
331
>TIME</replaceable></option></term>
229
<term><option>secfile<literal> = </literal><replaceable
230
>FILENAME</replaceable></option></term>
332
231
<listitem>
333
232
<para>
334
This option is <emphasis>optional</emphasis>.
335
</para>
336
<para>
337
The timeout is how long the server will wait, after a
338
successful checker run, until a client is disabled and not
339
allowed to get the data this server holds. By default
340
Mandos will use 5 minutes. See also the
341
<option>extended_timeout</option> option.
342
</para>
343
<para>
344
The <replaceable>TIME</replaceable> is specified as an RFC
345
3339 duration; for example
346
<quote><literal>P1Y2M3DT4H5M6S</literal></quote> meaning
347
one year, two months, three days, four hours, five
348
minutes, and six seconds. Some values can be omitted, see
349
RFC 3339 Appendix A for details.
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.
350
247
</para>
351
248
</listitem>
352
249
</varlistentry>
353
250
354
251
<varlistentry>
355
<term><option>enabled<literal> = </literal>{ <literal
356
>1</literal> | <literal>yes</literal> | <literal>true</literal
357
> | <literal >on</literal> | <literal>0</literal> | <literal
358
>no</literal> | <literal>false</literal> | <literal
359
>off</literal> }</option></term>
252
<term><option><literal>host = </literal><replaceable
253
>STRING</replaceable></option></term>
360
254
<listitem>
361
255
<para>
362
Whether this client should be enabled by default. The
363
default is <quote>true</quote>.
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.
364
265
</para>
365
266
</listitem>
366
267
</varlistentry>
403
304
<quote><literal>%%(<replaceable>foo</replaceable>)s</literal
404
305
></quote> will be replaced by the value of the attribute
405
306
<varname>foo</varname> of the internal
406
<quote><classname>Client</classname></quote> object in the
407
Mandos server. The currently allowed values for
408
<replaceable>foo</replaceable> are:
409
<quote><literal>approval_delay</literal></quote>,
410
<quote><literal>approval_duration</literal></quote>,
411
<quote><literal>created</literal></quote>,
412
<quote><literal>enabled</literal></quote>,
413
<quote><literal>expires</literal></quote>,
414
<quote><literal>fingerprint</literal></quote>,
415
<quote><literal>host</literal></quote>,
416
<quote><literal>interval</literal></quote>,
417
<quote><literal>last_approval_request</literal></quote>,
418
<quote><literal>last_checked_ok</literal></quote>,
419
<quote><literal>last_enabled</literal></quote>,
420
<quote><literal>name</literal></quote>,
421
<quote><literal>timeout</literal></quote>, and, if using
422
D-Bus, <quote><literal>dbus_object_path</literal></quote>.
423
See the source code for details. <emphasis role="strong"
424
>Currently, <emphasis>none</emphasis> of these attributes
425
except <quote><literal>host</literal></quote> are guaranteed
426
to be valid in future versions.</emphasis> Therefore, please
427
let the authors know of any attributes that are useful so they
428
may be preserved to any new versions of this software.
307
<quote><classname>Client</classname></quote> object. See the
308
source code for details, and let the authors know of any
309
attributes that are useful so they may be preserved to any new
310
versions of this software.
429
311
</para>
430
312
<para>
431
313
Note that this means that, in order to include an actual
466
348
<informalexample>
467
349
<programlisting>
468
350
[DEFAULT]
469
timeout = PT5M
470
interval = PT2M
351
timeout = 1h
352
interval = 5m
471
353
checker = fping -q -- %%(host)s
472
354
473
355
# Client "foo"
490
372
4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
491
373
QlnHIvPzEArRQLo=
492
374
host = foo.example.org
493
interval = PT1M
375
interval = 1m
494
376
495
377
# Client "bar"
496
378
[bar]
497
379
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
498
380
secfile = /etc/mandos/bar-secret
499
timeout = PT15M
500
approved_by_default = False
501
approval_delay = PT30S
381
timeout = 15m
502
382
</programlisting>
503
383
</informalexample>
504
384
</refsect1>
506
386
<refsect1 id="see_also">
507
387
<title>SEE ALSO</title>
508
388
<para>
509
<citerefentry><refentrytitle>intro</refentrytitle>
510
<manvolnum>8mandos</manvolnum></citerefentry>,
511
389
<citerefentry><refentrytitle>mandos-keygen</refentrytitle>
512
390
<manvolnum>8</manvolnum></citerefentry>,
513
391
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
514
392
<manvolnum>5</manvolnum></citerefentry>,
515
393
<citerefentry><refentrytitle>mandos</refentrytitle>
516
<manvolnum>8</manvolnum></citerefentry>,
517
<citerefentry><refentrytitle>fping</refentrytitle>
518
394
<manvolnum>8</manvolnum></citerefentry>
519
395
</para>
520
<variablelist>
521
<varlistentry>
522
<term>
523
RFC 3339: <citetitle>Date and Time on the Internet:
524
Timestamps</citetitle>
525
</term>
526
<listitem>
527
<para>
528
The time intervals are in the "duration" format, as
529
specified in ABNF in Appendix A of RFC 3339.
530
</para>
531
</listitem>
532
</varlistentry>
533
</variablelist>
534
396
</refsect1>
535
397
</refentry>
536
398
<!-- Local Variables: -->
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0