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 237.7.177
- compare with another revision
- download diff
- download tarball
- view history from revision 237.7.177
- Committer: Teddy Hogeborn
- Date: 2013-10-20 22:20:11 UTC
- mto: (237.7.272 trunk)
- mto: This revision was merged to the branch mainline in revision 305.
- Revision ID: teddy@recompile.se-20131020222011-g2fvjicx5lrv4h4e
* mandos-change-keytype: Bug fix: call mandos-keygen from $PATH, not
current directory.
current directory.
- files added:
- .bzr-builddeb
- debian
- debian/po
- debian/source
- network-hooks.d
- files removed:
- etc-plugins.d-README
- files modified:
- .bzrignore
added
removed
mandos-clients.conf.xml
1
1
<?xml version="1.0" encoding="UTF-8"?>
2
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
3
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
<!ENTITY VERSION "1.0">
5
4
<!ENTITY CONFNAME "mandos-clients.conf">
6
5
<!ENTITY CONFPATH "<filename>/etc/mandos/clients.conf</filename>">
7
<!ENTITY TIMESTAMP "2008-09-04">
6
<!ENTITY TIMESTAMP "2013-10-15">
7
<!ENTITY % common SYSTEM "common.ent">
8
%common;
8
9
]>
9
10
10
11
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
12
13
<title>Mandos Manual</title>
13
14
<!-- NWalsh’s docbook scripts use this to generate the footer: -->
14
15
<productname>Mandos</productname>
15
<productnumber>&VERSION;</productnumber>
16
<productnumber>&version;</productnumber>
16
17
<date>&TIMESTAMP;</date>
17
18
<authorgroup>
18
19
<author>
19
20
<firstname>Björn</firstname>
20
21
<surname>Påhlsson</surname>
21
22
<address>
22
<email>belorn@fukt.bsnet.se</email>
23
<email>belorn@recompile.se</email>
23
24
</address>
24
25
</author>
25
26
<author>
26
27
<firstname>Teddy</firstname>
27
28
<surname>Hogeborn</surname>
28
29
<address>
29
<email>teddy@fukt.bsnet.se</email>
30
<email>teddy@recompile.se</email>
30
31
</address>
31
32
</author>
32
33
</authorgroup>
33
34
<copyright>
34
35
<year>2008</year>
36
<year>2009</year>
37
<year>2010</year>
38
<year>2011</year>
39
<year>2012</year>
35
40
<holder>Teddy Hogeborn</holder>
36
41
<holder>Björn Påhlsson</holder>
37
42
</copyright>
38
43
<xi:include href="legalnotice.xml"/>
39
44
</refentryinfo>
40
45
41
46
<refmeta>
42
47
<refentrytitle>&CONFNAME;</refentrytitle>
43
48
<manvolnum>5</manvolnum>
49
54
Configuration file for the Mandos server
50
55
</refpurpose>
51
56
</refnamediv>
52
57
53
58
<refsynopsisdiv>
54
59
<synopsis>&CONFPATH;</synopsis>
55
60
</refsynopsisdiv>
56
61
57
62
<refsect1 id="description">
58
63
<title>DESCRIPTION</title>
59
64
<para>
61
66
><refentrytitle>mandos</refentrytitle>
62
67
<manvolnum>8</manvolnum></citerefentry>, read by it at startup.
63
68
The file needs to list all clients that should be able to use
64
the service. All clients listed will be regarded as valid, even
65
if a client was declared invalid in a previous run of the
66
server.
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.
67
76
</para>
68
77
<para>
69
78
The format starts with a <literal>[<replaceable>section
95
104
<para>
96
105
Unknown options are ignored. The used options are as follows:
97
106
</para>
98
107
99
108
<variablelist>
100
101
<varlistentry>
102
<term><option>timeout<literal> = </literal><replaceable
103
>TIME</replaceable></option></term>
104
<listitem>
105
<para>
106
This option is <emphasis>optional</emphasis>.
107
</para>
108
<para>
109
The timeout is how long the server will wait for a
110
successful checker run until a client is considered
111
invalid - that is, ineligible to get the data this server
112
holds. By default Mandos will use 1 hour.
113
</para>
114
<para>
115
The <replaceable>TIME</replaceable> is specified as a
116
space-separated number of values, each of which is a
117
number and a one-character suffix. The suffix must be one
118
of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
119
<quote>h</quote>, and <quote>w</quote> for days, seconds,
120
minutes, hours, and weeks, respectively. The values are
121
added together to give the total time value, so all of
122
<quote><literal>330s</literal></quote>,
123
<quote><literal>110s 110s 110s</literal></quote>, and
124
<quote><literal>5m 30s</literal></quote> will give a value
125
of five minutes and thirty seconds.
126
</para>
127
</listitem>
128
</varlistentry>
129
130
<varlistentry>
131
<term><option>interval<literal> = </literal><replaceable
132
>TIME</replaceable></option></term>
133
<listitem>
134
<para>
135
This option is <emphasis>optional</emphasis>.
136
</para>
137
<para>
138
How often to run the checker to confirm that a client is
139
still up. <emphasis>Note:</emphasis> a new checker will
140
not be started if an old one is still running. The server
141
will wait for a checker to complete until the above
142
<quote><varname>timeout</varname></quote> occurs, at which
143
time the client will be marked invalid, and any running
144
checker killed. The default interval is 5 minutes.
145
</para>
146
<para>
147
The format of <replaceable>TIME</replaceable> is the same
148
as for <varname>timeout</varname> above.
149
</para>
150
</listitem>
151
</varlistentry>
152
109
110
<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>.
158
</para>
159
</listitem>
160
</varlistentry>
161
153
162
<varlistentry>
154
163
<term><option>checker<literal> = </literal><replaceable
155
164
>COMMAND</replaceable></option></term>
158
167
This option is <emphasis>optional</emphasis>.
159
168
</para>
160
169
<para>
161
This option allows you to override the default shell
162
command that the server will use to check if the client is
163
still up. Any output of the command will be ignored, only
164
the exit code is checked: If the exit code of the command
165
is zero, the client is considered up. The command will be
166
run using <quote><command><filename>/bin/sh</filename>
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>
167
176
<option>-c</option></command></quote>, so
168
177
<varname>PATH</varname> will be searched. The default
169
178
value for the checker command is <quote><literal
170
179
><command>fping</command> <option>-q</option> <option
171
>--</option> %(host)s</literal></quote>.
180
>--</option> %%(host)s</literal></quote>.
172
181
</para>
173
182
<para>
174
183
In addition to normal start time expansion, this option
179
188
</varlistentry>
180
189
181
190
<varlistentry>
191
<term><option>extended_timeout<literal> = </literal><replaceable
192
>TIME</replaceable></option></term>
193
<listitem>
194
<para>
195
This option is <emphasis>optional</emphasis>.
196
</para>
197
<para>
198
Extended timeout is an added timeout that is given once
199
after a password has been sent successfully to a client.
200
The timeout is by default longer than the normal timeout,
201
and is used for handling the extra long downtime while a
202
machine is booting up. Time to take into consideration
203
when changing this value is file system checks and quota
204
checks. The default value is 15 minutes.
205
</para>
206
<para>
207
The format of <replaceable>TIME</replaceable> is the same
208
as for <varname>timeout</varname> below.
209
</para>
210
</listitem>
211
</varlistentry>
212
213
<varlistentry>
182
214
<term><option>fingerprint<literal> = </literal
183
215
><replaceable>HEXSTRING</replaceable></option></term>
184
216
<listitem>
195
227
</varlistentry>
196
228
197
229
<varlistentry>
230
<term><option><literal>host = </literal><replaceable
231
>STRING</replaceable></option></term>
232
<listitem>
233
<para>
234
This option is <emphasis>optional</emphasis>, but highly
235
<emphasis>recommended</emphasis> unless the
236
<option>checker</option> option is modified to a
237
non-standard value without <quote>%%(host)s</quote> in it.
238
</para>
239
<para>
240
Host name for this client. This is not used by the server
241
directly, but can be, and is by default, used by the
242
checker. See the <option>checker</option> option.
243
</para>
244
</listitem>
245
</varlistentry>
246
247
<varlistentry>
248
<term><option>interval<literal> = </literal><replaceable
249
>TIME</replaceable></option></term>
250
<listitem>
251
<para>
252
This option is <emphasis>optional</emphasis>.
253
</para>
254
<para>
255
How often to run the checker to confirm that a client is
256
still up. <emphasis>Note:</emphasis> a new checker will
257
not be started if an old one is still running. The server
258
will wait for a checker to complete until the below
259
<quote><varname>timeout</varname></quote> occurs, at which
260
time the client will be disabled, and any running checker
261
killed. The default interval is 2 minutes.
262
</para>
263
<para>
264
The format of <replaceable>TIME</replaceable> is the same
265
as for <varname>timeout</varname> below.
266
</para>
267
</listitem>
268
</varlistentry>
269
270
<varlistentry>
271
<term><option>secfile<literal> = </literal><replaceable
272
>FILENAME</replaceable></option></term>
273
<listitem>
274
<para>
275
This option is only used if <option>secret</option> is not
276
specified, in which case this option is
277
<emphasis>required</emphasis>.
278
</para>
279
<para>
280
Similar to the <option>secret</option>, except the secret
281
data is in an external file. The contents of the file
282
should <emphasis>not</emphasis> be base64-encoded, but
283
will be sent to clients verbatim.
284
</para>
285
<para>
286
File names of the form <filename>~user/foo/bar</filename>
287
and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
288
are supported.
289
</para>
290
</listitem>
291
</varlistentry>
292
293
<varlistentry>
198
294
<term><option>secret<literal> = </literal><replaceable
199
295
>BASE64_ENCODED_DATA</replaceable></option></term>
200
296
<listitem>
223
319
</para>
224
320
</listitem>
225
321
</varlistentry>
226
322
227
323
<varlistentry>
228
<term><option>secfile<literal> = </literal><replaceable
229
>FILENAME</replaceable></option></term>
324
<term><option>timeout<literal> = </literal><replaceable
325
>TIME</replaceable></option></term>
230
326
<listitem>
231
327
<para>
232
This option is only used if <option>secret</option> is not
233
specified, in which case this option is
234
<emphasis>required</emphasis>.
235
</para>
236
<para>
237
Similar to the <option>secret</option>, except the secret
238
data is in an external file. The contents of the file
239
should <emphasis>not</emphasis> be base64-encoded, but
240
will be sent to clients verbatim.
328
This option is <emphasis>optional</emphasis>.
329
</para>
330
<para>
331
The timeout is how long the server will wait, after a
332
successful checker run, until a client is disabled and not
333
allowed to get the data this server holds. By default
334
Mandos will use 5 minutes. See also the
335
<option>extended_timeout</option> option.
336
</para>
337
<para>
338
The <replaceable>TIME</replaceable> is specified as an RFC
339
3339 duration; for example
340
<quote><literal>P1Y2M3DT4H5M6S</literal></quote> meaning
341
one year, two months, three days, four hours, five
342
minutes, and six seconds. Some values can be omitted, see
343
RFC 3339 Appendix A for details.
241
344
</para>
242
345
</listitem>
243
346
</varlistentry>
244
347
245
348
<varlistentry>
246
<term><option><literal>host = </literal><replaceable
247
>STRING</replaceable></option></term>
349
<term><option>enabled<literal> = </literal>{ <literal
350
>1</literal> | <literal>yes</literal> | <literal>true</literal
351
> | <literal >on</literal> | <literal>0</literal> | <literal
352
>no</literal> | <literal>false</literal> | <literal
353
>off</literal> }</option></term>
248
354
<listitem>
249
355
<para>
250
This option is <emphasis>optional</emphasis>, but highly
251
<emphasis>recommended</emphasis> unless the
252
<option>checker</option> option is modified to a
253
non-standard value without <quote>%(host)s</quote> in it.
254
</para>
255
<para>
256
Host name for this client. This is not used by the server
257
directly, but can be, and is by default, used by the
258
checker. See the <option>checker</option> option.
356
Whether this client should be enabled by default. The
357
default is <quote>true</quote>.
259
358
</para>
260
359
</listitem>
261
360
</varlistentry>
298
397
<quote><literal>%%(<replaceable>foo</replaceable>)s</literal
299
398
></quote> will be replaced by the value of the attribute
300
399
<varname>foo</varname> of the internal
301
<quote><classname>Client</classname></quote> object. See the
302
source code for details, and let the authors know of any
303
attributes that are useful so they may be preserved to any new
304
versions of this software.
400
<quote><classname>Client</classname></quote> object in the
401
Mandos server. The currently allowed values for
402
<replaceable>foo</replaceable> are:
403
<quote><literal>approval_delay</literal></quote>,
404
<quote><literal>approval_duration</literal></quote>,
405
<quote><literal>created</literal></quote>,
406
<quote><literal>enabled</literal></quote>,
407
<quote><literal>expires</literal></quote>,
408
<quote><literal>fingerprint</literal></quote>,
409
<quote><literal>host</literal></quote>,
410
<quote><literal>interval</literal></quote>,
411
<quote><literal>last_approval_request</literal></quote>,
412
<quote><literal>last_checked_ok</literal></quote>,
413
<quote><literal>last_enabled</literal></quote>,
414
<quote><literal>name</literal></quote>,
415
<quote><literal>timeout</literal></quote>, and, if using
416
D-Bus, <quote><literal>dbus_object_path</literal></quote>.
417
See the source code for details. <emphasis role="strong"
418
>Currently, <emphasis>none</emphasis> of these attributes
419
except <quote><literal>host</literal></quote> are guaranteed
420
to be valid in future versions.</emphasis> Therefore, please
421
let the authors know of any attributes that are useful so they
422
may be preserved to any new versions of this software.
305
423
</para>
306
424
<para>
307
425
Note that this means that, in order to include an actual
313
431
mode is needed to expose an error of this kind.
314
432
</para>
315
433
</refsect2>
316
434
317
435
</refsect1>
318
436
319
437
<refsect1 id="files">
342
460
<informalexample>
343
461
<programlisting>
344
462
[DEFAULT]
345
timeout = 1h
346
interval = 5m
347
checker = fping -q -- %(host)s
463
timeout = PT5M
464
interval = PT2M
465
checker = fping -q -- %%(host)s
348
466
349
467
# Client "foo"
350
468
[foo]
366
484
4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
367
485
QlnHIvPzEArRQLo=
368
486
host = foo.example.org
369
interval = 1m
487
interval = PT1M
370
488
371
489
# Client "bar"
372
490
[bar]
373
491
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
374
492
secfile = /etc/mandos/bar-secret
375
timeout = 15m
376
493
timeout = PT15M
494
approved_by_default = False
495
approval_delay = PT30S
377
496
</programlisting>
378
497
</informalexample>
379
498
</refsect1>
381
500
<refsect1 id="see_also">
382
501
<title>SEE ALSO</title>
383
502
<para>
503
<citerefentry><refentrytitle>intro</refentrytitle>
504
<manvolnum>8mandos</manvolnum></citerefentry>,
384
505
<citerefentry><refentrytitle>mandos-keygen</refentrytitle>
385
506
<manvolnum>8</manvolnum></citerefentry>,
386
507
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
387
508
<manvolnum>5</manvolnum></citerefentry>,
388
509
<citerefentry><refentrytitle>mandos</refentrytitle>
510
<manvolnum>8</manvolnum></citerefentry>,
511
<citerefentry><refentrytitle>fping</refentrytitle>
389
512
<manvolnum>8</manvolnum></citerefentry>
390
513
</para>
514
<variablelist>
515
<varlistentry>
516
<term>
517
RFC 3339: <citetitle>Date and Time on the Internet:
518
Timestamps</citetitle>
519
</term>
520
<listitem>
521
<para>
522
The time intervals are in the "duration" format, as
523
specified in ABNF in Appendix A of RFC 3339.
524
</para>
525
</listitem>
526
</varlistentry>
527
</variablelist>
391
528
</refsect1>
392
529
</refentry>
393
530
<!-- Local Variables: -->
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0