To get this branch, use:
bzr branch
http://bzr.recompile.se/loggerhead/mandos/release
« back to all changes in this revision
Viewing changes to mandos-clients.conf.xml
- browse files at revision 359
- compare with another revision
- download diff
- download tarball
- view history from revision 359
- Committer: Teddy Hogeborn
- Date: 2017-02-23 20:35:20 UTC
- Revision ID: teddy@recompile.se-20170223203520-7ti8vo1m86ib192m
Tags: version-1.7.15-1
* Makefile (version): Change to 1.7.15.
* NEWS (Version 1.7.15): Add new entry.
* debian/changelog (1.7.15-1): - '' -
* NEWS (Version 1.7.15): Add new entry.
* debian/changelog (1.7.15-1): - '' -
- files added:
- DBUS-API
- debian/source
- debian/upstream
- network-hooks.d
- plugin-helpers
- files removed:
- debian/mandos-client.config
- files renamed:
- mandos-list => mandos-ctl
- 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 "2008-10-07">
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>
34
34
<copyright>
35
35
<year>2008</year>
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
<year>2017</year>
36
45
<holder>Teddy Hogeborn</holder>
37
46
<holder>Björn Påhlsson</holder>
38
47
</copyright>
62
71
><refentrytitle>mandos</refentrytitle>
63
72
<manvolnum>8</manvolnum></citerefentry>, read by it at startup.
64
73
The file needs to list all clients that should be able to use
65
the service. All clients listed will be regarded as valid, even
66
if a client was declared invalid in a previous run of the
67
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.
68
81
</para>
69
82
<para>
70
83
The format starts with a <literal>[<replaceable>section
100
113
<variablelist>
101
114
102
115
<varlistentry>
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 a
111
successful checker run until a client is considered
112
invalid - that is, ineligible to get the data this server
113
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 marked invalid, and any running
145
checker 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.
116
<term><option>approval_delay<literal> = </literal><replaceable
117
>TIME</replaceable></option></term>
118
<listitem>
119
<para>
120
This option is <emphasis>optional</emphasis>.
121
</para>
122
<para>
123
How long to wait for external approval before resorting to
124
use the <option>approved_by_default</option> value. The
125
default is <quote>PT0S</quote>, i.e. not to wait.
126
</para>
127
<para>
128
The format of <replaceable>TIME</replaceable> is the same
129
as for <varname>timeout</varname> below.
130
</para>
131
</listitem>
132
</varlistentry>
133
134
<varlistentry>
135
<term><option>approval_duration<literal> = </literal
136
><replaceable>TIME</replaceable></option></term>
137
<listitem>
138
<para>
139
This option is <emphasis>optional</emphasis>.
140
</para>
141
<para>
142
How long an external approval lasts. The default is 1
143
second.
144
</para>
145
<para>
146
The format of <replaceable>TIME</replaceable> is the same
147
as for <varname>timeout</varname> below.
148
</para>
149
</listitem>
150
</varlistentry>
151
152
<varlistentry>
153
<term><option>approved_by_default<literal> = </literal
154
>{ <literal >1</literal> | <literal>yes</literal> | <literal
155
>true</literal> | <literal>on</literal> | <literal
156
>0</literal> | <literal>no</literal> | <literal
157
>false</literal> | <literal>off</literal> }</option></term>
158
<listitem>
159
<para>
160
Whether to approve a client by default after
161
the <option>approval_delay</option>. The default
162
is <quote>True</quote>.
150
163
</para>
151
164
</listitem>
152
165
</varlistentry>
159
172
This option is <emphasis>optional</emphasis>.
160
173
</para>
161
174
<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>
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>
168
181
<option>-c</option></command></quote>, so
169
182
<varname>PATH</varname> will be searched. The default
170
183
value for the checker command is <quote><literal
171
184
><command>fping</command> <option>-q</option> <option
172
>--</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.
173
192
</para>
174
193
<para>
175
194
In addition to normal start time expansion, this option
180
199
</varlistentry>
181
200
182
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>
183
225
<term><option>fingerprint<literal> = </literal
184
226
><replaceable>HEXSTRING</replaceable></option></term>
185
227
<listitem>
189
231
<para>
190
232
This option sets the OpenPGP fingerprint that identifies
191
233
the public key that clients authenticate themselves with
192
through TLS. The string needs to be in hexidecimal form,
234
through TLS. The string needs to be in hexadecimal form,
193
235
but spaces or upper/lower case are not significant.
194
236
</para>
195
237
</listitem>
196
238
</varlistentry>
197
239
198
240
<varlistentry>
241
<term><option><literal>host = </literal><replaceable
242
>STRING</replaceable></option></term>
243
<listitem>
244
<para>
245
This option is <emphasis>optional</emphasis>, but highly
246
<emphasis>recommended</emphasis> unless the
247
<option>checker</option> option is modified to a
248
non-standard value without <quote>%%(host)s</quote> in it.
249
</para>
250
<para>
251
Host name for this client. This is not used by the server
252
directly, but can be, and is by default, used by the
253
checker. See the <option>checker</option> option.
254
</para>
255
</listitem>
256
</varlistentry>
257
258
<varlistentry>
259
<term><option>interval<literal> = </literal><replaceable
260
>TIME</replaceable></option></term>
261
<listitem>
262
<para>
263
This option is <emphasis>optional</emphasis>.
264
</para>
265
<para>
266
How often to run the checker to confirm that a client is
267
still up. <emphasis>Note:</emphasis> a new checker will
268
not be started if an old one is still running. The server
269
will wait for a checker to complete until the below
270
<quote><varname>timeout</varname></quote> occurs, at which
271
time the client will be disabled, and any running checker
272
killed. The default interval is 2 minutes.
273
</para>
274
<para>
275
The format of <replaceable>TIME</replaceable> is the same
276
as for <varname>timeout</varname> below.
277
</para>
278
</listitem>
279
</varlistentry>
280
281
<varlistentry>
282
<term><option>secfile<literal> = </literal><replaceable
283
>FILENAME</replaceable></option></term>
284
<listitem>
285
<para>
286
This option is only used if <option>secret</option> is not
287
specified, in which case this option is
288
<emphasis>required</emphasis>.
289
</para>
290
<para>
291
Similar to the <option>secret</option>, except the secret
292
data is in an external file. The contents of the file
293
should <emphasis>not</emphasis> be base64-encoded, but
294
will be sent to clients verbatim.
295
</para>
296
<para>
297
File names of the form <filename>~user/foo/bar</filename>
298
and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
299
are supported.
300
</para>
301
</listitem>
302
</varlistentry>
303
304
<varlistentry>
199
305
<term><option>secret<literal> = </literal><replaceable
200
306
>BASE64_ENCODED_DATA</replaceable></option></term>
201
307
<listitem>
226
332
</varlistentry>
227
333
228
334
<varlistentry>
229
<term><option>secfile<literal> = </literal><replaceable
230
>FILENAME</replaceable></option></term>
335
<term><option>timeout<literal> = </literal><replaceable
336
>TIME</replaceable></option></term>
231
337
<listitem>
232
338
<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.
339
This option is <emphasis>optional</emphasis>.
340
</para>
341
<para>
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.
247
355
</para>
248
356
</listitem>
249
357
</varlistentry>
250
358
251
359
<varlistentry>
252
<term><option><literal>host = </literal><replaceable
253
>STRING</replaceable></option></term>
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>
254
365
<listitem>
255
366
<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.
367
Whether this client should be enabled by default. The
368
default is <quote>true</quote>.
265
369
</para>
266
370
</listitem>
267
371
</varlistentry>
304
408
<quote><literal>%%(<replaceable>foo</replaceable>)s</literal
305
409
></quote> will be replaced by the value of the attribute
306
410
<varname>foo</varname> of the internal
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.
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.
311
434
</para>
312
435
<para>
313
436
Note that this means that, in order to include an actual
341
464
<literal>%(<replaceable>foo</replaceable>)s</literal> is
342
465
obscure.
343
466
</para>
467
<xi:include href="bugs.xml"/>
344
468
</refsect1>
345
469
346
470
<refsect1 id="example">
348
472
<informalexample>
349
473
<programlisting>
350
474
[DEFAULT]
351
timeout = 1h
352
interval = 5m
353
checker = fping -q -- %(host)s
475
timeout = PT5M
476
interval = PT2M
477
checker = fping -q -- %%(host)s
354
478
355
479
# Client "foo"
356
480
[foo]
372
496
4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
373
497
QlnHIvPzEArRQLo=
374
498
host = foo.example.org
375
interval = 1m
499
interval = PT1M
376
500
377
501
# Client "bar"
378
502
[bar]
379
503
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
380
504
secfile = /etc/mandos/bar-secret
381
timeout = 15m
505
timeout = PT15M
506
approved_by_default = False
507
approval_delay = PT30S
382
508
</programlisting>
383
509
</informalexample>
384
510
</refsect1>
386
512
<refsect1 id="see_also">
387
513
<title>SEE ALSO</title>
388
514
<para>
515
<citerefentry><refentrytitle>intro</refentrytitle>
516
<manvolnum>8mandos</manvolnum></citerefentry>,
389
517
<citerefentry><refentrytitle>mandos-keygen</refentrytitle>
390
518
<manvolnum>8</manvolnum></citerefentry>,
391
519
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
392
520
<manvolnum>5</manvolnum></citerefentry>,
393
521
<citerefentry><refentrytitle>mandos</refentrytitle>
522
<manvolnum>8</manvolnum></citerefentry>,
523
<citerefentry><refentrytitle>fping</refentrytitle>
394
524
<manvolnum>8</manvolnum></citerefentry>
395
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>
396
540
</refsect1>
397
541
</refentry>
398
542
<!-- Local Variables: -->
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0