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 795
- compare with another revision
- download diff
- download tarball
- view history from revision 795
- Committer: Teddy Hogeborn
- Date: 2015-12-06 04:09:43 UTC
- Revision ID: teddy@recompile.se-20151206040943-n08v1uym0d3h23u9
* mandos.xml (FILES): Removed duplicate entry for “/dev/log”.
- files added:
- 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 "2010-09-25">
6
<!ENTITY TIMESTAMP "2015-07-20">
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@fukt.bsnet.se</email>
23
<email>belorn@recompile.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@fukt.bsnet.se</email>
30
<email>teddy@recompile.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>
37
43
<holder>Teddy Hogeborn</holder>
38
44
<holder>Björn Påhlsson</holder>
39
45
</copyright>
63
69
><refentrytitle>mandos</refentrytitle>
64
70
<manvolnum>8</manvolnum></citerefentry>, read by it at startup.
65
71
The file needs to list all clients that should be able to use
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.
72
the service. The settings in this file can be overridden by
73
runtime changes to the server, which it saves across restarts.
74
(See the section called <quote>PERSISTENT STATE</quote> in
75
<citerefentry><refentrytitle>mandos</refentrytitle><manvolnum
76
>8</manvolnum></citerefentry>.) However, any <emphasis
77
>changes</emphasis> to this file (including adding and removing
78
clients) will, at startup, override changes done during runtime.
68
79
</para>
69
80
<para>
70
81
The format starts with a <literal>[<replaceable>section
109
120
<para>
110
121
How long to wait for external approval before resorting to
111
122
use the <option>approved_by_default</option> value. The
112
default is <quote>0s</quote>, i.e. not to wait.
123
default is <quote>PT0S</quote>, i.e. not to wait.
113
124
</para>
114
125
<para>
115
126
The format of <replaceable>TIME</replaceable> is the same
159
170
This option is <emphasis>optional</emphasis>.
160
171
</para>
161
172
<para>
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>
173
This option overrides the default shell command that the
174
server will use to check if the client is still up. Any
175
output of the command will be ignored, only the exit code
176
is checked: If the exit code of the command is zero, the
177
client is considered up. The command will be run using
178
<quote><command><filename>/bin/sh</filename>
168
179
<option>-c</option></command></quote>, so
169
180
<varname>PATH</varname> will be searched. The default
170
181
value for the checker command is <quote><literal
171
182
><command>fping</command> <option>-q</option> <option
172
>--</option> %%(host)s</literal></quote>.
183
>--</option> %%(host)s</literal></quote>. Note that
184
<command>mandos-keygen</command>, when generating output
185
to be inserted into this file, normally looks for an SSH
186
server on the Mandos client, and, if it find one, outputs
187
a <option>checker</option> option to check for the
188
client’s key fingerprint – this is more secure against
189
spoofing.
173
190
</para>
174
191
<para>
175
192
In addition to normal start time expansion, this option
180
197
</varlistentry>
181
198
182
199
<varlistentry>
200
<term><option>extended_timeout<literal> = </literal><replaceable
201
>TIME</replaceable></option></term>
202
<listitem>
203
<para>
204
This option is <emphasis>optional</emphasis>.
205
</para>
206
<para>
207
Extended timeout is an added timeout that is given once
208
after a password has been sent successfully to a client.
209
The timeout is by default longer than the normal timeout,
210
and is used for handling the extra long downtime while a
211
machine is booting up. Time to take into consideration
212
when changing this value is file system checks and quota
213
checks. The default value is 15 minutes.
214
</para>
215
<para>
216
The format of <replaceable>TIME</replaceable> is the same
217
as for <varname>timeout</varname> below.
218
</para>
219
</listitem>
220
</varlistentry>
221
222
<varlistentry>
183
223
<term><option>fingerprint<literal> = </literal
184
224
><replaceable>HEXSTRING</replaceable></option></term>
185
225
<listitem>
227
267
will wait for a checker to complete until the below
228
268
<quote><varname>timeout</varname></quote> occurs, at which
229
269
time the client will be disabled, and any running checker
230
killed. The default interval is 5 minutes.
270
killed. The default interval is 2 minutes.
231
271
</para>
232
272
<para>
233
273
The format of <replaceable>TIME</replaceable> is the same
297
337
This option is <emphasis>optional</emphasis>.
298
338
</para>
299
339
<para>
300
The timeout is how long the server will wait (for either a
301
successful checker run or a client receiving its secret)
302
until a client is disabled and not allowed to get the data
303
this server holds. By default Mandos will use 1 hour.
304
</para>
305
<para>
306
The <replaceable>TIME</replaceable> is specified as a
307
space-separated number of values, each of which is a
308
number and a one-character suffix. The suffix must be one
309
of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
310
<quote>h</quote>, and <quote>w</quote> for days, seconds,
311
minutes, hours, and weeks, respectively. The values are
312
added together to give the total time value, so all of
313
<quote><literal>330s</literal></quote>,
314
<quote><literal>110s 110s 110s</literal></quote>, and
315
<quote><literal>5m 30s</literal></quote> will give a value
316
of five minutes and thirty seconds.
340
The timeout is how long the server will wait, after a
341
successful checker run, until a client is disabled and not
342
allowed to get the data this server holds. By default
343
Mandos will use 5 minutes. See also the
344
<option>extended_timeout</option> option.
345
</para>
346
<para>
347
The <replaceable>TIME</replaceable> is specified as an RFC
348
3339 duration; for example
349
<quote><literal>P1Y2M3DT4H5M6S</literal></quote> meaning
350
one year, two months, three days, four hours, five
351
minutes, and six seconds. Some values can be omitted, see
352
RFC 3339 Appendix A for details.
353
</para>
354
</listitem>
355
</varlistentry>
356
357
<varlistentry>
358
<term><option>enabled<literal> = </literal>{ <literal
359
>1</literal> | <literal>yes</literal> | <literal>true</literal
360
> | <literal >on</literal> | <literal>0</literal> | <literal
361
>no</literal> | <literal>false</literal> | <literal
362
>off</literal> }</option></term>
363
<listitem>
364
<para>
365
Whether this client should be enabled by default. The
366
default is <quote>true</quote>.
317
367
</para>
318
368
</listitem>
319
369
</varlistentry>
356
406
<quote><literal>%%(<replaceable>foo</replaceable>)s</literal
357
407
></quote> will be replaced by the value of the attribute
358
408
<varname>foo</varname> of the internal
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.
409
<quote><classname>Client</classname></quote> object in the
410
Mandos server. The currently allowed values for
411
<replaceable>foo</replaceable> are:
412
<quote><literal>approval_delay</literal></quote>,
413
<quote><literal>approval_duration</literal></quote>,
414
<quote><literal>created</literal></quote>,
415
<quote><literal>enabled</literal></quote>,
416
<quote><literal>expires</literal></quote>,
417
<quote><literal>fingerprint</literal></quote>,
418
<quote><literal>host</literal></quote>,
419
<quote><literal>interval</literal></quote>,
420
<quote><literal>last_approval_request</literal></quote>,
421
<quote><literal>last_checked_ok</literal></quote>,
422
<quote><literal>last_enabled</literal></quote>,
423
<quote><literal>name</literal></quote>,
424
<quote><literal>timeout</literal></quote>, and, if using
425
D-Bus, <quote><literal>dbus_object_path</literal></quote>.
426
See the source code for details. <emphasis role="strong"
427
>Currently, <emphasis>none</emphasis> of these attributes
428
except <quote><literal>host</literal></quote> are guaranteed
429
to be valid in future versions.</emphasis> Therefore, please
430
let the authors know of any attributes that are useful so they
431
may be preserved to any new versions of this software.
363
432
</para>
364
433
<para>
365
434
Note that this means that, in order to include an actual
400
469
<informalexample>
401
470
<programlisting>
402
471
[DEFAULT]
403
timeout = 1h
404
interval = 5m
472
timeout = PT5M
473
interval = PT2M
405
474
checker = fping -q -- %%(host)s
406
475
407
476
# Client "foo"
424
493
4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
425
494
QlnHIvPzEArRQLo=
426
495
host = foo.example.org
427
interval = 1m
496
interval = PT1M
428
497
429
498
# Client "bar"
430
499
[bar]
431
500
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
432
501
secfile = /etc/mandos/bar-secret
433
timeout = 15m
502
timeout = PT15M
434
503
approved_by_default = False
435
approval_delay = 30s
504
approval_delay = PT30S
436
505
</programlisting>
437
506
</informalexample>
438
507
</refsect1>
440
509
<refsect1 id="see_also">
441
510
<title>SEE ALSO</title>
442
511
<para>
512
<citerefentry><refentrytitle>intro</refentrytitle>
513
<manvolnum>8mandos</manvolnum></citerefentry>,
443
514
<citerefentry><refentrytitle>mandos-keygen</refentrytitle>
444
515
<manvolnum>8</manvolnum></citerefentry>,
445
516
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
446
517
<manvolnum>5</manvolnum></citerefentry>,
447
518
<citerefentry><refentrytitle>mandos</refentrytitle>
519
<manvolnum>8</manvolnum></citerefentry>,
520
<citerefentry><refentrytitle>fping</refentrytitle>
448
521
<manvolnum>8</manvolnum></citerefentry>
449
522
</para>
523
<variablelist>
524
<varlistentry>
525
<term>
526
RFC 3339: <citetitle>Date and Time on the Internet:
527
Timestamps</citetitle>
528
</term>
529
<listitem>
530
<para>
531
The time intervals are in the "duration" format, as
532
specified in ABNF in Appendix A of RFC 3339.
533
</para>
534
</listitem>
535
</varlistentry>
536
</variablelist>
450
537
</refsect1>
451
538
</refentry>
452
539
<!-- Local Variables: -->
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0