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 535
- compare with another revision
- download diff
- download tarball
- view history from revision 535
- Committer: teddy at bsnet
- Date: 2011-12-25 00:43:51 UTC
- Revision ID: teddy@fukt.bsnet.se-20111225004351-3hw3msbs8ooesltd
Removed implemented TODO entry
- files added:
- .bzr-builddeb
- debian
- debian/po
- debian/source
- network-hooks.d
- plugins.d
- files removed:
- ca.pem
- files renamed:
- mandos-clients.conf => clients.conf
- server.py => mandos
- files modified:
- Makefile
added
removed
mandos-clients.conf.xml
1
<?xml version="1.0" encoding="UTF-8"?>
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
<!ENTITY CONFNAME "mandos-clients.conf">
5
<!ENTITY CONFPATH "<filename>/etc/mandos/clients.conf</filename>">
6
<!ENTITY TIMESTAMP "2011-11-26">
7
<!ENTITY % common SYSTEM "common.ent">
8
%common;
9
]>
10
11
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
12
<refentryinfo>
13
<title>Mandos Manual</title>
14
<!-- NWalsh’s docbook scripts use this to generate the footer: -->
15
<productname>Mandos</productname>
16
<productnumber>&version;</productnumber>
17
<date>&TIMESTAMP;</date>
18
<authorgroup>
19
<author>
20
<firstname>Björn</firstname>
21
<surname>Påhlsson</surname>
22
<address>
23
<email>belorn@recompile.se</email>
24
</address>
25
</author>
26
<author>
27
<firstname>Teddy</firstname>
28
<surname>Hogeborn</surname>
29
<address>
30
<email>teddy@recompile.se</email>
31
</address>
32
</author>
33
</authorgroup>
34
<copyright>
35
<year>2008</year>
36
<year>2009</year>
37
<year>2010</year>
38
<year>2011</year>
39
<holder>Teddy Hogeborn</holder>
40
<holder>Björn Påhlsson</holder>
41
</copyright>
42
<xi:include href="legalnotice.xml"/>
43
</refentryinfo>
44
45
<refmeta>
46
<refentrytitle>&CONFNAME;</refentrytitle>
47
<manvolnum>5</manvolnum>
48
</refmeta>
49
50
<refnamediv>
51
<refname><filename>&CONFNAME;</filename></refname>
52
<refpurpose>
53
Configuration file for the Mandos server
54
</refpurpose>
55
</refnamediv>
56
57
<refsynopsisdiv>
58
<synopsis>&CONFPATH;</synopsis>
59
</refsynopsisdiv>
60
61
<refsect1 id="description">
62
<title>DESCRIPTION</title>
63
<para>
64
The file &CONFPATH; is a configuration file for <citerefentry
65
><refentrytitle>mandos</refentrytitle>
66
<manvolnum>8</manvolnum></citerefentry>, read by it at startup.
67
The file needs to list all clients that should be able to use
68
the service. All clients listed will be regarded as enabled,
69
even if a client was disabled in a previous run of the server.
70
</para>
71
<para>
72
The format starts with a <literal>[<replaceable>section
73
header</replaceable>]</literal> which is either
74
<literal>[DEFAULT]</literal> or <literal>[<replaceable>client
75
name</replaceable>]</literal>. The <replaceable>client
76
name</replaceable> can be anything, and is not tied to a host
77
name. Following the section header is any number of
78
<quote><varname><replaceable>option</replaceable
79
></varname>=<replaceable>value</replaceable></quote> entries,
80
with continuations in the style of RFC 822. <quote><varname
81
><replaceable>option</replaceable></varname>: <replaceable
82
>value</replaceable></quote> is also accepted. Note that
83
leading whitespace is removed from values. Values can contain
84
format strings which refer to other values in the same section,
85
or values in the <quote>DEFAULT</quote> section (see <xref
86
linkend="expansion"/>). Lines beginning with <quote>#</quote>
87
or <quote>;</quote> are ignored and may be used to provide
88
comments.
89
</para>
90
</refsect1>
91
92
<refsect1 id="options">
93
<title>OPTIONS</title>
94
<para>
95
<emphasis>Note:</emphasis> all option values are subject to
96
start time expansion, see <xref linkend="expansion"/>.
97
</para>
98
<para>
99
Unknown options are ignored. The used options are as follows:
100
</para>
101
102
<variablelist>
103
104
<varlistentry>
105
<term><option>approval_delay<literal> = </literal><replaceable
106
>TIME</replaceable></option></term>
107
<listitem>
108
<para>
109
This option is <emphasis>optional</emphasis>.
110
</para>
111
<para>
112
How long to wait for external approval before resorting to
113
use the <option>approved_by_default</option> value. The
114
default is <quote>0s</quote>, i.e. not to wait.
115
</para>
116
<para>
117
The format of <replaceable>TIME</replaceable> is the same
118
as for <varname>timeout</varname> below.
119
</para>
120
</listitem>
121
</varlistentry>
122
123
<varlistentry>
124
<term><option>approval_duration<literal> = </literal
125
><replaceable>TIME</replaceable></option></term>
126
<listitem>
127
<para>
128
This option is <emphasis>optional</emphasis>.
129
</para>
130
<para>
131
How long an external approval lasts. The default is 1
132
second.
133
</para>
134
<para>
135
The format of <replaceable>TIME</replaceable> is the same
136
as for <varname>timeout</varname> below.
137
</para>
138
</listitem>
139
</varlistentry>
140
141
<varlistentry>
142
<term><option>approved_by_default<literal> = </literal
143
>{ <literal >1</literal> | <literal>yes</literal> | <literal
144
>true</literal> | <literal>on</literal> | <literal
145
>0</literal> | <literal>no</literal> | <literal
146
>false</literal> | <literal>off</literal> }</option></term>
147
<listitem>
148
<para>
149
Whether to approve a client by default after
150
the <option>approval_delay</option>. The default
151
is <quote>True</quote>.
152
</para>
153
</listitem>
154
</varlistentry>
155
156
<varlistentry>
157
<term><option>checker<literal> = </literal><replaceable
158
>COMMAND</replaceable></option></term>
159
<listitem>
160
<para>
161
This option is <emphasis>optional</emphasis>.
162
</para>
163
<para>
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>
170
<option>-c</option></command></quote>, so
171
<varname>PATH</varname> will be searched. The default
172
value for the checker command is <quote><literal
173
><command>fping</command> <option>-q</option> <option
174
>--</option> %%(host)s</literal></quote>.
175
</para>
176
<para>
177
In addition to normal start time expansion, this option
178
will also be subject to runtime expansion; see <xref
179
linkend="expansion"/>.
180
</para>
181
</listitem>
182
</varlistentry>
183
184
<varlistentry>
185
<term><option>extended_timeout<literal> = </literal><replaceable
186
>TIME</replaceable></option></term>
187
<listitem>
188
<para>
189
This option is <emphasis>optional</emphasis>.
190
</para>
191
<para>
192
Extended timeout is an added timeout that is given once
193
after a password has been sent successfully to a client.
194
The timeout is by default longer than the normal timeout,
195
and is used for handling the extra long downtime while a
196
machine is booting up. Time to take into consideration
197
when changing this value is file system checks and quota
198
checks. The default value is 15 minutes.
199
</para>
200
<para>
201
The format of <replaceable>TIME</replaceable> is the same
202
as for <varname>timeout</varname> below.
203
</para>
204
</listitem>
205
</varlistentry>
206
207
<varlistentry>
208
<term><option>fingerprint<literal> = </literal
209
><replaceable>HEXSTRING</replaceable></option></term>
210
<listitem>
211
<para>
212
This option is <emphasis>required</emphasis>.
213
</para>
214
<para>
215
This option sets the OpenPGP fingerprint that identifies
216
the public key that clients authenticate themselves with
217
through TLS. The string needs to be in hexidecimal form,
218
but spaces or upper/lower case are not significant.
219
</para>
220
</listitem>
221
</varlistentry>
222
223
<varlistentry>
224
<term><option><literal>host = </literal><replaceable
225
>STRING</replaceable></option></term>
226
<listitem>
227
<para>
228
This option is <emphasis>optional</emphasis>, but highly
229
<emphasis>recommended</emphasis> unless the
230
<option>checker</option> option is modified to a
231
non-standard value without <quote>%%(host)s</quote> in it.
232
</para>
233
<para>
234
Host name for this client. This is not used by the server
235
directly, but can be, and is by default, used by the
236
checker. See the <option>checker</option> option.
237
</para>
238
</listitem>
239
</varlistentry>
240
241
<varlistentry>
242
<term><option>interval<literal> = </literal><replaceable
243
>TIME</replaceable></option></term>
244
<listitem>
245
<para>
246
This option is <emphasis>optional</emphasis>.
247
</para>
248
<para>
249
How often to run the checker to confirm that a client is
250
still up. <emphasis>Note:</emphasis> a new checker will
251
not be started if an old one is still running. The server
252
will wait for a checker to complete until the below
253
<quote><varname>timeout</varname></quote> occurs, at which
254
time the client will be disabled, and any running checker
255
killed. The default interval is 2 minutes.
256
</para>
257
<para>
258
The format of <replaceable>TIME</replaceable> is the same
259
as for <varname>timeout</varname> below.
260
</para>
261
</listitem>
262
</varlistentry>
263
264
<varlistentry>
265
<term><option>secfile<literal> = </literal><replaceable
266
>FILENAME</replaceable></option></term>
267
<listitem>
268
<para>
269
This option is only used if <option>secret</option> is not
270
specified, in which case this option is
271
<emphasis>required</emphasis>.
272
</para>
273
<para>
274
Similar to the <option>secret</option>, except the secret
275
data is in an external file. The contents of the file
276
should <emphasis>not</emphasis> be base64-encoded, but
277
will be sent to clients verbatim.
278
</para>
279
<para>
280
File names of the form <filename>~user/foo/bar</filename>
281
and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
282
are supported.
283
</para>
284
</listitem>
285
</varlistentry>
286
287
<varlistentry>
288
<term><option>secret<literal> = </literal><replaceable
289
>BASE64_ENCODED_DATA</replaceable></option></term>
290
<listitem>
291
<para>
292
If this option is not specified, the <option
293
>secfile</option> option is <emphasis>required</emphasis>
294
to be present.
295
</para>
296
<para>
297
If present, this option must be set to a string of
298
base64-encoded binary data. It will be decoded and sent
299
to the client matching the above
300
<option>fingerprint</option>. This should, of course, be
301
OpenPGP encrypted data, decryptable only by the client.
302
The program <citerefentry><refentrytitle><command
303
>mandos-keygen</command></refentrytitle><manvolnum
304
>8</manvolnum></citerefentry> can, using its
305
<option>--password</option> option, be used to generate
306
this, if desired.
307
</para>
308
<para>
309
Note: this value of this option will probably be very
310
long. A useful feature to avoid having unreadably-long
311
lines is that a line beginning with white space adds to
312
the value of the previous line, RFC 822-style.
313
</para>
314
</listitem>
315
</varlistentry>
316
317
<varlistentry>
318
<term><option>timeout<literal> = </literal><replaceable
319
>TIME</replaceable></option></term>
320
<listitem>
321
<para>
322
This option is <emphasis>optional</emphasis>.
323
</para>
324
<para>
325
The timeout is how long the server will wait, after a
326
successful checker run, until a client is disabled and not
327
allowed to get the data this server holds. By default
328
Mandos will use 5 minutes. See also the
329
<option>extended_timeout</option> option.
330
</para>
331
<para>
332
The <replaceable>TIME</replaceable> is specified as a
333
space-separated number of values, each of which is a
334
number and a one-character suffix. The suffix must be one
335
of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
336
<quote>h</quote>, and <quote>w</quote> for days, seconds,
337
minutes, hours, and weeks, respectively. The values are
338
added together to give the total time value, so all of
339
<quote><literal>330s</literal></quote>,
340
<quote><literal>110s 110s 110s</literal></quote>, and
341
<quote><literal>5m 30s</literal></quote> will give a value
342
of five minutes and thirty seconds.
343
</para>
344
</listitem>
345
</varlistentry>
346
347
<varlistentry>
348
<term><option>enabled<literal> = </literal>{ <literal
349
>1</literal> | <literal>yes</literal> | <literal>true</literal
350
> | <literal >on</literal> | <literal>0</literal> | <literal
351
>no</literal> | <literal>false</literal> | <literal
352
>off</literal> }</option></term>
353
<listitem>
354
<para>
355
Whether this client should be enabled by default. The
356
default is <quote>true</quote>.
357
</para>
358
</listitem>
359
</varlistentry>
360
361
</variablelist>
362
</refsect1>
363
364
<refsect1 id="expansion">
365
<title>EXPANSION</title>
366
<para>
367
There are two forms of expansion: Start time expansion and
368
runtime expansion.
369
</para>
370
<refsect2 id="start_time_expansion">
371
<title>START TIME EXPANSION</title>
372
<para>
373
Any string in an option value of the form
374
<quote><literal>%(<replaceable>foo</replaceable>)s</literal
375
></quote> will be replaced by the value of the option
376
<varname>foo</varname> either in the same section, or, if it
377
does not exist there, the <literal>[DEFAULT]</literal>
378
section. This is done at start time, when the configuration
379
file is read.
380
</para>
381
<para>
382
Note that this means that, in order to include an actual
383
percent character (<quote>%</quote>) in an option value, two
384
percent characters in a row (<quote>%%</quote>) must be
385
entered.
386
</para>
387
</refsect2>
388
<refsect2 id="runtime_expansion">
389
<title>RUNTIME EXPANSION</title>
390
<para>
391
This is currently only done for the <varname>checker</varname>
392
option.
393
</para>
394
<para>
395
Any string in an option value of the form
396
<quote><literal>%%(<replaceable>foo</replaceable>)s</literal
397
></quote> will be replaced by the value of the attribute
398
<varname>foo</varname> of the internal
399
<quote><classname>Client</classname></quote> object in the
400
Mandos server. The currently allowed values for
401
<replaceable>foo</replaceable> are:
402
<quote><literal>approval_delay</literal></quote>,
403
<quote><literal>approval_duration</literal></quote>,
404
<quote><literal>created</literal></quote>,
405
<quote><literal>enabled</literal></quote>,
406
<quote><literal>fingerprint</literal></quote>,
407
<quote><literal>host</literal></quote>,
408
<quote><literal>interval</literal></quote>,
409
<quote><literal>last_approval_request</literal></quote>,
410
<quote><literal>last_checked_ok</literal></quote>,
411
<quote><literal>last_enabled</literal></quote>,
412
<quote><literal>name</literal></quote>,
413
<quote><literal>timeout</literal></quote>, and, if using
414
D-Bus, <quote><literal>dbus_object_path</literal></quote>.
415
See the source code for details. <emphasis role="strong"
416
>Currently, <emphasis>none</emphasis> of these attributes
417
except <quote><literal>host</literal></quote> are guaranteed
418
to be valid in future versions.</emphasis> Therefore, please
419
let the authors know of any attributes that are useful so they
420
may be preserved to any new versions of this software.
421
</para>
422
<para>
423
Note that this means that, in order to include an actual
424
percent character (<quote>%</quote>) in a
425
<varname>checker</varname> option, <emphasis>four</emphasis>
426
percent characters in a row (<quote>%%%%</quote>) must be
427
entered. Also, a bad format here will lead to an immediate
428
but <emphasis>silent</emphasis> run-time fatal exit; debug
429
mode is needed to expose an error of this kind.
430
</para>
431
</refsect2>
432
433
</refsect1>
434
435
<refsect1 id="files">
436
<title>FILES</title>
437
<para>
438
The file described here is &CONFPATH;
439
</para>
440
</refsect1>
441
442
<refsect1 id="bugs">
443
<title>BUGS</title>
444
<para>
445
The format for specifying times for <varname>timeout</varname>
446
and <varname>interval</varname> is not very good.
447
</para>
448
<para>
449
The difference between
450
<literal>%%(<replaceable>foo</replaceable>)s</literal> and
451
<literal>%(<replaceable>foo</replaceable>)s</literal> is
452
obscure.
453
</para>
454
</refsect1>
455
456
<refsect1 id="example">
457
<title>EXAMPLE</title>
458
<informalexample>
459
<programlisting>
460
[DEFAULT]
461
timeout = 5m
462
interval = 2m
463
checker = fping -q -- %%(host)s
464
465
# Client "foo"
466
[foo]
467
fingerprint = 7788 2722 5BA7 DE53 9C5A 7CFA 59CF F7CD BD9A 5920
468
secret =
469
hQIOA6QdEjBs2L/HEAf/TCyrDe5Xnm9esa+Pb/vWF9CUqfn4srzVgSu234
470
REJMVv7lBSrPE2132Lmd2gqF1HeLKDJRSVxJpt6xoWOChGHg+TMyXDxK+N
471
Xl89vGvdU1XfhKkVm9MDLOgT5ECDPysDGHFPDhqHOSu3Kaw2DWMV/iH9vz
472
3Z20erVNbdcvyBnuojcoWO/6yfB5EQO0BXp7kcyy00USA3CjD5FGZdoQGI
473
Tb8A/ar0tVA5crSQmaSotm6KmNLhrFnZ5BxX+TiE+eTUTqSloWRY6VAvqW
474
QHC7OASxK5E6RXPBuFH5IohUA2Qbk5AHt99pYvsIPX88j2rWauOokoiKZo
475
t/9leJ8VxO5l3wf/U64IH8bkPIoWmWZfd/nqh4uwGNbCgKMyT+AnvH7kMJ
476
3i7DivfWl2mKLV0PyPHUNva0VQxX6yYjcOhj1R6fCr/at8/NSLe2OhLchz
477
dC+Ls9h+kvJXgF8Sisv+Wk/1RadPLFmraRlqvJwt6Ww21LpiXqXHV2mIgq
478
WnR98YgSvUi3TJHrUQiNc9YyBzuRo0AjgG2C9qiE3FM+Y28+iQ/sR3+bFs
479
zYuZKVTObqiIslwXu7imO0cvvFRgJF/6u3HNFQ4LUTGhiM3FQmC6NNlF3/
480
vJM2hwRDMcJqDd54Twx90Wh+tYz0z7QMsK4ANXWHHWHR0JchnLWmenzbtW
481
5MHdW9AYsNJZAQSOpirE4Xi31CSlWAi9KV+cUCmWF5zOFy1x23P6PjdaRm
482
4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
483
QlnHIvPzEArRQLo=
484
host = foo.example.org
485
interval = 1m
486
487
# Client "bar"
488
[bar]
489
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
490
secfile = /etc/mandos/bar-secret
491
timeout = 15m
492
approved_by_default = False
493
approval_delay = 30s
494
</programlisting>
495
</informalexample>
496
</refsect1>
497
498
<refsect1 id="see_also">
499
<title>SEE ALSO</title>
500
<para>
501
<citerefentry><refentrytitle>intro</refentrytitle>
502
<manvolnum>8mandos</manvolnum></citerefentry>,
503
<citerefentry><refentrytitle>mandos-keygen</refentrytitle>
504
<manvolnum>8</manvolnum></citerefentry>,
505
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
506
<manvolnum>5</manvolnum></citerefentry>,
507
<citerefentry><refentrytitle>mandos</refentrytitle>
508
<manvolnum>8</manvolnum></citerefentry>
509
</para>
510
</refsect1>
511
</refentry>
512
<!-- Local Variables: -->
513
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
514
<!-- time-stamp-end: "[\"']>" -->
515
<!-- time-stamp-format: "%:y-%02m-%02d" -->
516
<!-- End: -->
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0