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