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 376
- compare with another revision
- download diff
- download tarball
- view history from revision 376
- Committer: Teddy Hogeborn
- Date: 2009-09-17 14:21:18 UTC
- Revision ID: teddy@fukt.bsnet.se-20090917142118-6wto8m380jhiot68
Merge from release branch.
- files removed:
- 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 "2018-02-08">
6
<!ENTITY TIMESTAMP "2009-09-17">
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@recompile.se</email>
23
<email>belorn@fukt.bsnet.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@recompile.se</email>
30
<email>teddy@fukt.bsnet.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>
43
<year>2016</year>
44
<year>2017</year>
45
<year>2018</year>
46
37
<holder>Teddy Hogeborn</holder>
47
38
<holder>Björn Påhlsson</holder>
48
39
</copyright>
72
63
><refentrytitle>mandos</refentrytitle>
73
64
<manvolnum>8</manvolnum></citerefentry>, read by it at startup.
74
65
The file needs to list all clients that should be able to use
75
the service. The settings in this file can be overridden by
76
runtime changes to the server, which it saves across restarts.
77
(See the section called <quote>PERSISTENT STATE</quote> in
78
<citerefentry><refentrytitle>mandos</refentrytitle><manvolnum
79
>8</manvolnum></citerefentry>.) However, any <emphasis
80
>changes</emphasis> to this file (including adding and removing
81
clients) will, at startup, override changes done during runtime.
66
the service. All clients listed will be regarded as valid, even
67
if a client was declared invalid in a previous run of the
68
server.
82
69
</para>
83
70
<para>
84
71
The format starts with a <literal>[<replaceable>section
114
101
<variablelist>
115
102
116
103
<varlistentry>
117
<term><option>approval_delay<literal> = </literal><replaceable
118
>TIME</replaceable></option></term>
119
<listitem>
120
<para>
121
This option is <emphasis>optional</emphasis>.
122
</para>
123
<para>
124
How long to wait for external approval before resorting to
125
use the <option>approved_by_default</option> value. The
126
default is <quote>PT0S</quote>, i.e. not to wait.
127
</para>
128
<para>
129
The format of <replaceable>TIME</replaceable> is the same
130
as for <varname>timeout</varname> below.
131
</para>
132
</listitem>
133
</varlistentry>
134
135
<varlistentry>
136
<term><option>approval_duration<literal> = </literal
137
><replaceable>TIME</replaceable></option></term>
138
<listitem>
139
<para>
140
This option is <emphasis>optional</emphasis>.
141
</para>
142
<para>
143
How long an external approval lasts. The default is 1
144
second.
145
</para>
146
<para>
147
The format of <replaceable>TIME</replaceable> is the same
148
as for <varname>timeout</varname> below.
149
</para>
150
</listitem>
151
</varlistentry>
152
153
<varlistentry>
154
<term><option>approved_by_default<literal> = </literal
155
>{ <literal >1</literal> | <literal>yes</literal> | <literal
156
>true</literal> | <literal>on</literal> | <literal
157
>0</literal> | <literal>no</literal> | <literal
158
>false</literal> | <literal>off</literal> }</option></term>
159
<listitem>
160
<para>
161
Whether to approve a client by default after
162
the <option>approval_delay</option>. The default
163
is <quote>True</quote>.
104
<term><option>timeout<literal> = </literal><replaceable
105
>TIME</replaceable></option></term>
106
<listitem>
107
<para>
108
This option is <emphasis>optional</emphasis>.
109
</para>
110
<para>
111
The timeout is how long the server will wait (for either a
112
successful checker run or a client receiving its secret)
113
until a client is considered invalid - that is, ineligible
114
to get the data this server holds. By default Mandos will
115
use 1 hour.
116
</para>
117
<para>
118
The <replaceable>TIME</replaceable> is specified as a
119
space-separated number of values, each of which is a
120
number and a one-character suffix. The suffix must be one
121
of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
122
<quote>h</quote>, and <quote>w</quote> for days, seconds,
123
minutes, hours, and weeks, respectively. The values are
124
added together to give the total time value, so all of
125
<quote><literal>330s</literal></quote>,
126
<quote><literal>110s 110s 110s</literal></quote>, and
127
<quote><literal>5m 30s</literal></quote> will give a value
128
of five minutes and thirty seconds.
129
</para>
130
</listitem>
131
</varlistentry>
132
133
<varlistentry>
134
<term><option>interval<literal> = </literal><replaceable
135
>TIME</replaceable></option></term>
136
<listitem>
137
<para>
138
This option is <emphasis>optional</emphasis>.
139
</para>
140
<para>
141
How often to run the checker to confirm that a client is
142
still up. <emphasis>Note:</emphasis> a new checker will
143
not be started if an old one is still running. The server
144
will wait for a checker to complete until the above
145
<quote><varname>timeout</varname></quote> occurs, at which
146
time the client will be marked invalid, and any running
147
checker killed. The default interval is 5 minutes.
148
</para>
149
<para>
150
The format of <replaceable>TIME</replaceable> is the same
151
as for <varname>timeout</varname> above.
164
152
</para>
165
153
</listitem>
166
154
</varlistentry>
173
161
This option is <emphasis>optional</emphasis>.
174
162
</para>
175
163
<para>
176
This option overrides the default shell command that the
177
server will use to check if the client is still up. Any
178
output of the command will be ignored, only the exit code
179
is checked: If the exit code of the command is zero, the
180
client is considered up. The command will be run using
181
<quote><command><filename>/bin/sh</filename>
164
This option allows you to override the default shell
165
command that the server will use to check if the client is
166
still up. Any output of the command will be ignored, only
167
the exit code is checked: If the exit code of the command
168
is zero, the client is considered up. The command will be
169
run using <quote><command><filename>/bin/sh</filename>
182
170
<option>-c</option></command></quote>, so
183
171
<varname>PATH</varname> will be searched. The default
184
172
value for the checker command is <quote><literal
185
173
><command>fping</command> <option>-q</option> <option
186
>--</option> %%(host)s</literal></quote>. Note that
187
<command>mandos-keygen</command>, when generating output
188
to be inserted into this file, normally looks for an SSH
189
server on the Mandos client, and, if it find one, outputs
190
a <option>checker</option> option to check for the
191
client’s key fingerprint – this is more secure against
192
spoofing.
174
>--</option> %%(host)s</literal></quote>.
193
175
</para>
194
176
<para>
195
177
In addition to normal start time expansion, this option
200
182
</varlistentry>
201
183
202
184
<varlistentry>
203
<term><option>extended_timeout<literal> = </literal><replaceable
204
>TIME</replaceable></option></term>
205
<listitem>
206
<para>
207
This option is <emphasis>optional</emphasis>.
208
</para>
209
<para>
210
Extended timeout is an added timeout that is given once
211
after a password has been sent successfully to a client.
212
The timeout is by default longer than the normal timeout,
213
and is used for handling the extra long downtime while a
214
machine is booting up. Time to take into consideration
215
when changing this value is file system checks and quota
216
checks. The default value is 15 minutes.
217
</para>
218
<para>
219
The format of <replaceable>TIME</replaceable> is the same
220
as for <varname>timeout</varname> below.
221
</para>
222
</listitem>
223
</varlistentry>
224
225
<varlistentry>
226
185
<term><option>fingerprint<literal> = </literal
227
186
><replaceable>HEXSTRING</replaceable></option></term>
228
187
<listitem>
232
191
<para>
233
192
This option sets the OpenPGP fingerprint that identifies
234
193
the public key that clients authenticate themselves with
235
through TLS. The string needs to be in hexadecimal form,
194
through TLS. The string needs to be in hexidecimal form,
236
195
but spaces or upper/lower case are not significant.
237
196
</para>
238
197
</listitem>
239
198
</varlistentry>
240
199
241
200
<varlistentry>
242
<term><option><literal>host = </literal><replaceable
243
>STRING</replaceable></option></term>
244
<listitem>
245
<para>
246
This option is <emphasis>optional</emphasis>, but highly
247
<emphasis>recommended</emphasis> unless the
248
<option>checker</option> option is modified to a
249
non-standard value without <quote>%%(host)s</quote> in it.
250
</para>
251
<para>
252
Host name for this client. This is not used by the server
253
directly, but can be, and is by default, used by the
254
checker. See the <option>checker</option> option.
255
</para>
256
</listitem>
257
</varlistentry>
258
259
<varlistentry>
260
<term><option>interval<literal> = </literal><replaceable
261
>TIME</replaceable></option></term>
262
<listitem>
263
<para>
264
This option is <emphasis>optional</emphasis>.
265
</para>
266
<para>
267
How often to run the checker to confirm that a client is
268
still up. <emphasis>Note:</emphasis> a new checker will
269
not be started if an old one is still running. The server
270
will wait for a checker to complete until the below
271
<quote><varname>timeout</varname></quote> occurs, at which
272
time the client will be disabled, and any running checker
273
killed. The default interval is 2 minutes.
274
</para>
275
<para>
276
The format of <replaceable>TIME</replaceable> is the same
277
as for <varname>timeout</varname> below.
278
</para>
279
</listitem>
280
</varlistentry>
281
282
<varlistentry>
283
<term><option>secfile<literal> = </literal><replaceable
284
>FILENAME</replaceable></option></term>
285
<listitem>
286
<para>
287
This option is only used if <option>secret</option> is not
288
specified, in which case this option is
289
<emphasis>required</emphasis>.
290
</para>
291
<para>
292
Similar to the <option>secret</option>, except the secret
293
data is in an external file. The contents of the file
294
should <emphasis>not</emphasis> be base64-encoded, but
295
will be sent to clients verbatim.
296
</para>
297
<para>
298
File names of the form <filename>~user/foo/bar</filename>
299
and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
300
are supported.
301
</para>
302
</listitem>
303
</varlistentry>
304
305
<varlistentry>
306
201
<term><option>secret<literal> = </literal><replaceable
307
202
>BASE64_ENCODED_DATA</replaceable></option></term>
308
203
<listitem>
333
228
</varlistentry>
334
229
335
230
<varlistentry>
336
<term><option>timeout<literal> = </literal><replaceable
337
>TIME</replaceable></option></term>
231
<term><option>secfile<literal> = </literal><replaceable
232
>FILENAME</replaceable></option></term>
338
233
<listitem>
339
234
<para>
340
This option is <emphasis>optional</emphasis>.
341
</para>
342
<para>
343
The timeout is how long the server will wait, after a
344
successful checker run, until a client is disabled and not
345
allowed to get the data this server holds. By default
346
Mandos will use 5 minutes. See also the
347
<option>extended_timeout</option> option.
348
</para>
349
<para>
350
The <replaceable>TIME</replaceable> is specified as an RFC
351
3339 duration; for example
352
<quote><literal>P1Y2M3DT4H5M6S</literal></quote> meaning
353
one year, two months, three days, four hours, five
354
minutes, and six seconds. Some values can be omitted, see
355
RFC 3339 Appendix A for details.
235
This option is only used if <option>secret</option> is not
236
specified, in which case this option is
237
<emphasis>required</emphasis>.
238
</para>
239
<para>
240
Similar to the <option>secret</option>, except the secret
241
data is in an external file. The contents of the file
242
should <emphasis>not</emphasis> be base64-encoded, but
243
will be sent to clients verbatim.
244
</para>
245
<para>
246
File names of the form <filename>~user/foo/bar</filename>
247
and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
248
are supported.
356
249
</para>
357
250
</listitem>
358
251
</varlistentry>
359
252
360
253
<varlistentry>
361
<term><option>enabled<literal> = </literal>{ <literal
362
>1</literal> | <literal>yes</literal> | <literal>true</literal
363
> | <literal >on</literal> | <literal>0</literal> | <literal
364
>no</literal> | <literal>false</literal> | <literal
365
>off</literal> }</option></term>
254
<term><option><literal>host = </literal><replaceable
255
>STRING</replaceable></option></term>
366
256
<listitem>
367
257
<para>
368
Whether this client should be enabled by default. The
369
default is <quote>true</quote>.
258
This option is <emphasis>optional</emphasis>, but highly
259
<emphasis>recommended</emphasis> unless the
260
<option>checker</option> option is modified to a
261
non-standard value without <quote>%%(host)s</quote> in it.
262
</para>
263
<para>
264
Host name for this client. This is not used by the server
265
directly, but can be, and is by default, used by the
266
checker. See the <option>checker</option> option.
370
267
</para>
371
268
</listitem>
372
269
</varlistentry>
409
306
<quote><literal>%%(<replaceable>foo</replaceable>)s</literal
410
307
></quote> will be replaced by the value of the attribute
411
308
<varname>foo</varname> of the internal
412
<quote><classname>Client</classname></quote> object in the
413
Mandos server. The currently allowed values for
414
<replaceable>foo</replaceable> are:
415
<quote><literal>approval_delay</literal></quote>,
416
<quote><literal>approval_duration</literal></quote>,
417
<quote><literal>created</literal></quote>,
418
<quote><literal>enabled</literal></quote>,
419
<quote><literal>expires</literal></quote>,
420
<quote><literal>fingerprint</literal></quote>,
421
<quote><literal>host</literal></quote>,
422
<quote><literal>interval</literal></quote>,
423
<quote><literal>last_approval_request</literal></quote>,
424
<quote><literal>last_checked_ok</literal></quote>,
425
<quote><literal>last_enabled</literal></quote>,
426
<quote><literal>name</literal></quote>,
427
<quote><literal>timeout</literal></quote>, and, if using
428
D-Bus, <quote><literal>dbus_object_path</literal></quote>.
429
See the source code for details. <emphasis role="strong"
430
>Currently, <emphasis>none</emphasis> of these attributes
431
except <quote><literal>host</literal></quote> are guaranteed
432
to be valid in future versions.</emphasis> Therefore, please
433
let the authors know of any attributes that are useful so they
434
may be preserved to any new versions of this software.
309
<quote><classname>Client</classname></quote> object. See the
310
source code for details, and let the authors know of any
311
attributes that are useful so they may be preserved to any new
312
versions of this software.
435
313
</para>
436
314
<para>
437
315
Note that this means that, in order to include an actual
465
343
<literal>%(<replaceable>foo</replaceable>)s</literal> is
466
344
obscure.
467
345
</para>
468
<xi:include href="bugs.xml"/>
469
346
</refsect1>
470
347
471
348
<refsect1 id="example">
473
350
<informalexample>
474
351
<programlisting>
475
352
[DEFAULT]
476
timeout = PT5M
477
interval = PT2M
353
timeout = 1h
354
interval = 5m
478
355
checker = fping -q -- %%(host)s
479
356
480
357
# Client "foo"
497
374
4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
498
375
QlnHIvPzEArRQLo=
499
376
host = foo.example.org
500
interval = PT1M
377
interval = 1m
501
378
502
379
# Client "bar"
503
380
[bar]
504
381
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
505
382
secfile = /etc/mandos/bar-secret
506
timeout = PT15M
507
approved_by_default = False
508
approval_delay = PT30S
383
timeout = 15m
509
384
</programlisting>
510
385
</informalexample>
511
386
</refsect1>
513
388
<refsect1 id="see_also">
514
389
<title>SEE ALSO</title>
515
390
<para>
516
<citerefentry><refentrytitle>intro</refentrytitle>
517
<manvolnum>8mandos</manvolnum></citerefentry>,
518
391
<citerefentry><refentrytitle>mandos-keygen</refentrytitle>
519
392
<manvolnum>8</manvolnum></citerefentry>,
520
393
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
521
394
<manvolnum>5</manvolnum></citerefentry>,
522
395
<citerefentry><refentrytitle>mandos</refentrytitle>
523
<manvolnum>8</manvolnum></citerefentry>,
524
<citerefentry><refentrytitle>fping</refentrytitle>
525
396
<manvolnum>8</manvolnum></citerefentry>
526
397
</para>
527
<variablelist>
528
<varlistentry>
529
<term>
530
RFC 3339: <citetitle>Date and Time on the Internet:
531
Timestamps</citetitle>
532
</term>
533
<listitem>
534
<para>
535
The time intervals are in the "duration" format, as
536
specified in ABNF in Appendix A of RFC 3339.
537
</para>
538
</listitem>
539
</varlistentry>
540
</variablelist>
541
398
</refsect1>
542
399
</refentry>
543
400
<!-- Local Variables: -->
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0