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:
- 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 "2009-12-09">
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
100
111
<variablelist>
101
112
102
113
<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 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.
114
<term><option>approval_delay<literal> = </literal><replaceable
115
>TIME</replaceable></option></term>
116
<listitem>
117
<para>
118
This option is <emphasis>optional</emphasis>.
119
</para>
120
<para>
121
How long to wait for external approval before resorting to
122
use the <option>approved_by_default</option> value. The
123
default is <quote>PT0S</quote>, i.e. not to wait.
124
</para>
125
<para>
126
The format of <replaceable>TIME</replaceable> is the same
127
as for <varname>timeout</varname> below.
128
</para>
129
</listitem>
130
</varlistentry>
131
132
<varlistentry>
133
<term><option>approval_duration<literal> = </literal
134
><replaceable>TIME</replaceable></option></term>
135
<listitem>
136
<para>
137
This option is <emphasis>optional</emphasis>.
138
</para>
139
<para>
140
How long an external approval lasts. The default is 1
141
second.
142
</para>
143
<para>
144
The format of <replaceable>TIME</replaceable> is the same
145
as for <varname>timeout</varname> below.
146
</para>
147
</listitem>
148
</varlistentry>
149
150
<varlistentry>
151
<term><option>approved_by_default<literal> = </literal
152
>{ <literal >1</literal> | <literal>yes</literal> | <literal
153
>true</literal> | <literal>on</literal> | <literal
154
>0</literal> | <literal>no</literal> | <literal
155
>false</literal> | <literal>off</literal> }</option></term>
156
<listitem>
157
<para>
158
Whether to approve a client by default after
159
the <option>approval_delay</option>. The default
160
is <quote>True</quote>.
150
161
</para>
151
162
</listitem>
152
163
</varlistentry>
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>
196
236
</varlistentry>
197
237
198
238
<varlistentry>
239
<term><option><literal>host = </literal><replaceable
240
>STRING</replaceable></option></term>
241
<listitem>
242
<para>
243
This option is <emphasis>optional</emphasis>, but highly
244
<emphasis>recommended</emphasis> unless the
245
<option>checker</option> option is modified to a
246
non-standard value without <quote>%%(host)s</quote> in it.
247
</para>
248
<para>
249
Host name for this client. This is not used by the server
250
directly, but can be, and is by default, used by the
251
checker. See the <option>checker</option> option.
252
</para>
253
</listitem>
254
</varlistentry>
255
256
<varlistentry>
257
<term><option>interval<literal> = </literal><replaceable
258
>TIME</replaceable></option></term>
259
<listitem>
260
<para>
261
This option is <emphasis>optional</emphasis>.
262
</para>
263
<para>
264
How often to run the checker to confirm that a client is
265
still up. <emphasis>Note:</emphasis> a new checker will
266
not be started if an old one is still running. The server
267
will wait for a checker to complete until the below
268
<quote><varname>timeout</varname></quote> occurs, at which
269
time the client will be disabled, and any running checker
270
killed. The default interval is 2 minutes.
271
</para>
272
<para>
273
The format of <replaceable>TIME</replaceable> is the same
274
as for <varname>timeout</varname> below.
275
</para>
276
</listitem>
277
</varlistentry>
278
279
<varlistentry>
280
<term><option>secfile<literal> = </literal><replaceable
281
>FILENAME</replaceable></option></term>
282
<listitem>
283
<para>
284
This option is only used if <option>secret</option> is not
285
specified, in which case this option is
286
<emphasis>required</emphasis>.
287
</para>
288
<para>
289
Similar to the <option>secret</option>, except the secret
290
data is in an external file. The contents of the file
291
should <emphasis>not</emphasis> be base64-encoded, but
292
will be sent to clients verbatim.
293
</para>
294
<para>
295
File names of the form <filename>~user/foo/bar</filename>
296
and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
297
are supported.
298
</para>
299
</listitem>
300
</varlistentry>
301
302
<varlistentry>
199
303
<term><option>secret<literal> = </literal><replaceable
200
304
>BASE64_ENCODED_DATA</replaceable></option></term>
201
305
<listitem>
226
330
</varlistentry>
227
331
228
332
<varlistentry>
229
<term><option>secfile<literal> = </literal><replaceable
230
>FILENAME</replaceable></option></term>
333
<term><option>timeout<literal> = </literal><replaceable
334
>TIME</replaceable></option></term>
231
335
<listitem>
232
336
<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.
337
This option is <emphasis>optional</emphasis>.
338
</para>
339
<para>
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.
247
353
</para>
248
354
</listitem>
249
355
</varlistentry>
250
356
251
357
<varlistentry>
252
<term><option><literal>host = </literal><replaceable
253
>STRING</replaceable></option></term>
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>
254
363
<listitem>
255
364
<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.
365
Whether this client should be enabled by default. The
366
default is <quote>true</quote>.
265
367
</para>
266
368
</listitem>
267
369
</varlistentry>
304
406
<quote><literal>%%(<replaceable>foo</replaceable>)s</literal
305
407
></quote> will be replaced by the value of the attribute
306
408
<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.
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.
311
432
</para>
312
433
<para>
313
434
Note that this means that, in order to include an actual
348
469
<informalexample>
349
470
<programlisting>
350
471
[DEFAULT]
351
timeout = 1h
352
interval = 5m
472
timeout = PT5M
473
interval = PT2M
353
474
checker = fping -q -- %%(host)s
354
475
355
476
# Client "foo"
372
493
4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
373
494
QlnHIvPzEArRQLo=
374
495
host = foo.example.org
375
interval = 1m
496
interval = PT1M
376
497
377
498
# Client "bar"
378
499
[bar]
379
500
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
380
501
secfile = /etc/mandos/bar-secret
381
timeout = 15m
502
timeout = PT15M
503
approved_by_default = False
504
approval_delay = PT30S
382
505
</programlisting>
383
506
</informalexample>
384
507
</refsect1>
386
509
<refsect1 id="see_also">
387
510
<title>SEE ALSO</title>
388
511
<para>
512
<citerefentry><refentrytitle>intro</refentrytitle>
513
<manvolnum>8mandos</manvolnum></citerefentry>,
389
514
<citerefentry><refentrytitle>mandos-keygen</refentrytitle>
390
515
<manvolnum>8</manvolnum></citerefentry>,
391
516
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
392
517
<manvolnum>5</manvolnum></citerefentry>,
393
518
<citerefentry><refentrytitle>mandos</refentrytitle>
519
<manvolnum>8</manvolnum></citerefentry>,
520
<citerefentry><refentrytitle>fping</refentrytitle>
394
521
<manvolnum>8</manvolnum></citerefentry>
395
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>
396
537
</refsect1>
397
538
</refentry>
398
539
<!-- Local Variables: -->
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0