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 741
- compare with another revision
- download diff
- download tarball
- view history from revision 741
- Committer: Teddy Hogeborn
- Date: 2015-01-25 00:02:51 UTC
- Revision ID: teddy@recompile.se-20150125000251-j2bw50gfq9smqyxe
mandos.xml (SEE ALSO): Update links.
Update link to GnuPG home page, change reference from TLS 1.1 to TLS
1.2, and change to latest RFC for using OpenPGP keys with TLS (and use
its correct title).
Update link to GnuPG home page, change reference from TLS 1.1 to TLS
1.2, and change to latest RFC for using OpenPGP keys with TLS (and use
its correct title).
- files added:
- .bzr-builddeb
- debian
- debian/po
- debian/source
- debian/upstream
- network-hooks.d
- files removed:
- ca.pem
- files renamed:
- mandos-clients.conf => clients.conf
- server.py => mandos
- plugbasedclient.c => plugin-runner.c
- plugins.d/mandosclient.c => plugins.d/mandos-client.c
- plugins.d/passprompt.c => plugins.d/password-prompt.c
- 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 "2014-06-22">
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
<year>2012</year>
40
<holder>Teddy Hogeborn</holder>
41
<holder>Björn Påhlsson</holder>
42
</copyright>
43
<xi:include href="legalnotice.xml"/>
44
</refentryinfo>
45
46
<refmeta>
47
<refentrytitle>&CONFNAME;</refentrytitle>
48
<manvolnum>5</manvolnum>
49
</refmeta>
50
51
<refnamediv>
52
<refname><filename>&CONFNAME;</filename></refname>
53
<refpurpose>
54
Configuration file for the Mandos server
55
</refpurpose>
56
</refnamediv>
57
58
<refsynopsisdiv>
59
<synopsis>&CONFPATH;</synopsis>
60
</refsynopsisdiv>
61
62
<refsect1 id="description">
63
<title>DESCRIPTION</title>
64
<para>
65
The file &CONFPATH; is a configuration file for <citerefentry
66
><refentrytitle>mandos</refentrytitle>
67
<manvolnum>8</manvolnum></citerefentry>, read by it at startup.
68
The file needs to list all clients that should be able to use
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.
76
</para>
77
<para>
78
The format starts with a <literal>[<replaceable>section
79
header</replaceable>]</literal> which is either
80
<literal>[DEFAULT]</literal> or <literal>[<replaceable>client
81
name</replaceable>]</literal>. The <replaceable>client
82
name</replaceable> can be anything, and is not tied to a host
83
name. Following the section header is any number of
84
<quote><varname><replaceable>option</replaceable
85
></varname>=<replaceable>value</replaceable></quote> entries,
86
with continuations in the style of RFC 822. <quote><varname
87
><replaceable>option</replaceable></varname>: <replaceable
88
>value</replaceable></quote> is also accepted. Note that
89
leading whitespace is removed from values. Values can contain
90
format strings which refer to other values in the same section,
91
or values in the <quote>DEFAULT</quote> section (see <xref
92
linkend="expansion"/>). Lines beginning with <quote>#</quote>
93
or <quote>;</quote> are ignored and may be used to provide
94
comments.
95
</para>
96
</refsect1>
97
98
<refsect1 id="options">
99
<title>OPTIONS</title>
100
<para>
101
<emphasis>Note:</emphasis> all option values are subject to
102
start time expansion, see <xref linkend="expansion"/>.
103
</para>
104
<para>
105
Unknown options are ignored. The used options are as follows:
106
</para>
107
108
<variablelist>
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
162
<varlistentry>
163
<term><option>checker<literal> = </literal><replaceable
164
>COMMAND</replaceable></option></term>
165
<listitem>
166
<para>
167
This option is <emphasis>optional</emphasis>.
168
</para>
169
<para>
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>
176
<option>-c</option></command></quote>, so
177
<varname>PATH</varname> will be searched. The default
178
value for the checker command is <quote><literal
179
><command>fping</command> <option>-q</option> <option
180
>--</option> %%(host)s</literal></quote>. Note that
181
<command>mandos-keygen</command>, when generating output
182
to be inserted into this file, normally looks for an SSH
183
server on the Mandos client, and, if it find one, outputs
184
a <option>checker</option> option to check for the
185
client’s key fingerprint – this is more secure against
186
spoofing.
187
</para>
188
<para>
189
In addition to normal start time expansion, this option
190
will also be subject to runtime expansion; see <xref
191
linkend="expansion"/>.
192
</para>
193
</listitem>
194
</varlistentry>
195
196
<varlistentry>
197
<term><option>extended_timeout<literal> = </literal><replaceable
198
>TIME</replaceable></option></term>
199
<listitem>
200
<para>
201
This option is <emphasis>optional</emphasis>.
202
</para>
203
<para>
204
Extended timeout is an added timeout that is given once
205
after a password has been sent successfully to a client.
206
The timeout is by default longer than the normal timeout,
207
and is used for handling the extra long downtime while a
208
machine is booting up. Time to take into consideration
209
when changing this value is file system checks and quota
210
checks. The default value is 15 minutes.
211
</para>
212
<para>
213
The format of <replaceable>TIME</replaceable> is the same
214
as for <varname>timeout</varname> below.
215
</para>
216
</listitem>
217
</varlistentry>
218
219
<varlistentry>
220
<term><option>fingerprint<literal> = </literal
221
><replaceable>HEXSTRING</replaceable></option></term>
222
<listitem>
223
<para>
224
This option is <emphasis>required</emphasis>.
225
</para>
226
<para>
227
This option sets the OpenPGP fingerprint that identifies
228
the public key that clients authenticate themselves with
229
through TLS. The string needs to be in hexidecimal form,
230
but spaces or upper/lower case are not significant.
231
</para>
232
</listitem>
233
</varlistentry>
234
235
<varlistentry>
236
<term><option><literal>host = </literal><replaceable
237
>STRING</replaceable></option></term>
238
<listitem>
239
<para>
240
This option is <emphasis>optional</emphasis>, but highly
241
<emphasis>recommended</emphasis> unless the
242
<option>checker</option> option is modified to a
243
non-standard value without <quote>%%(host)s</quote> in it.
244
</para>
245
<para>
246
Host name for this client. This is not used by the server
247
directly, but can be, and is by default, used by the
248
checker. See the <option>checker</option> option.
249
</para>
250
</listitem>
251
</varlistentry>
252
253
<varlistentry>
254
<term><option>interval<literal> = </literal><replaceable
255
>TIME</replaceable></option></term>
256
<listitem>
257
<para>
258
This option is <emphasis>optional</emphasis>.
259
</para>
260
<para>
261
How often to run the checker to confirm that a client is
262
still up. <emphasis>Note:</emphasis> a new checker will
263
not be started if an old one is still running. The server
264
will wait for a checker to complete until the below
265
<quote><varname>timeout</varname></quote> occurs, at which
266
time the client will be disabled, and any running checker
267
killed. The default interval is 2 minutes.
268
</para>
269
<para>
270
The format of <replaceable>TIME</replaceable> is the same
271
as for <varname>timeout</varname> below.
272
</para>
273
</listitem>
274
</varlistentry>
275
276
<varlistentry>
277
<term><option>secfile<literal> = </literal><replaceable
278
>FILENAME</replaceable></option></term>
279
<listitem>
280
<para>
281
This option is only used if <option>secret</option> is not
282
specified, in which case this option is
283
<emphasis>required</emphasis>.
284
</para>
285
<para>
286
Similar to the <option>secret</option>, except the secret
287
data is in an external file. The contents of the file
288
should <emphasis>not</emphasis> be base64-encoded, but
289
will be sent to clients verbatim.
290
</para>
291
<para>
292
File names of the form <filename>~user/foo/bar</filename>
293
and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
294
are supported.
295
</para>
296
</listitem>
297
</varlistentry>
298
299
<varlistentry>
300
<term><option>secret<literal> = </literal><replaceable
301
>BASE64_ENCODED_DATA</replaceable></option></term>
302
<listitem>
303
<para>
304
If this option is not specified, the <option
305
>secfile</option> option is <emphasis>required</emphasis>
306
to be present.
307
</para>
308
<para>
309
If present, this option must be set to a string of
310
base64-encoded binary data. It will be decoded and sent
311
to the client matching the above
312
<option>fingerprint</option>. This should, of course, be
313
OpenPGP encrypted data, decryptable only by the client.
314
The program <citerefentry><refentrytitle><command
315
>mandos-keygen</command></refentrytitle><manvolnum
316
>8</manvolnum></citerefentry> can, using its
317
<option>--password</option> option, be used to generate
318
this, if desired.
319
</para>
320
<para>
321
Note: this value of this option will probably be very
322
long. A useful feature to avoid having unreadably-long
323
lines is that a line beginning with white space adds to
324
the value of the previous line, RFC 822-style.
325
</para>
326
</listitem>
327
</varlistentry>
328
329
<varlistentry>
330
<term><option>timeout<literal> = </literal><replaceable
331
>TIME</replaceable></option></term>
332
<listitem>
333
<para>
334
This option is <emphasis>optional</emphasis>.
335
</para>
336
<para>
337
The timeout is how long the server will wait, after a
338
successful checker run, until a client is disabled and not
339
allowed to get the data this server holds. By default
340
Mandos will use 5 minutes. See also the
341
<option>extended_timeout</option> option.
342
</para>
343
<para>
344
The <replaceable>TIME</replaceable> is specified as an RFC
345
3339 duration; for example
346
<quote><literal>P1Y2M3DT4H5M6S</literal></quote> meaning
347
one year, two months, three days, four hours, five
348
minutes, and six seconds. Some values can be omitted, see
349
RFC 3339 Appendix A for details.
350
</para>
351
</listitem>
352
</varlistentry>
353
354
<varlistentry>
355
<term><option>enabled<literal> = </literal>{ <literal
356
>1</literal> | <literal>yes</literal> | <literal>true</literal
357
> | <literal >on</literal> | <literal>0</literal> | <literal
358
>no</literal> | <literal>false</literal> | <literal
359
>off</literal> }</option></term>
360
<listitem>
361
<para>
362
Whether this client should be enabled by default. The
363
default is <quote>true</quote>.
364
</para>
365
</listitem>
366
</varlistentry>
367
368
</variablelist>
369
</refsect1>
370
371
<refsect1 id="expansion">
372
<title>EXPANSION</title>
373
<para>
374
There are two forms of expansion: Start time expansion and
375
runtime expansion.
376
</para>
377
<refsect2 id="start_time_expansion">
378
<title>START TIME EXPANSION</title>
379
<para>
380
Any string in an option value of the form
381
<quote><literal>%(<replaceable>foo</replaceable>)s</literal
382
></quote> will be replaced by the value of the option
383
<varname>foo</varname> either in the same section, or, if it
384
does not exist there, the <literal>[DEFAULT]</literal>
385
section. This is done at start time, when the configuration
386
file is read.
387
</para>
388
<para>
389
Note that this means that, in order to include an actual
390
percent character (<quote>%</quote>) in an option value, two
391
percent characters in a row (<quote>%%</quote>) must be
392
entered.
393
</para>
394
</refsect2>
395
<refsect2 id="runtime_expansion">
396
<title>RUNTIME EXPANSION</title>
397
<para>
398
This is currently only done for the <varname>checker</varname>
399
option.
400
</para>
401
<para>
402
Any string in an option value of the form
403
<quote><literal>%%(<replaceable>foo</replaceable>)s</literal
404
></quote> will be replaced by the value of the attribute
405
<varname>foo</varname> of the internal
406
<quote><classname>Client</classname></quote> object in the
407
Mandos server. The currently allowed values for
408
<replaceable>foo</replaceable> are:
409
<quote><literal>approval_delay</literal></quote>,
410
<quote><literal>approval_duration</literal></quote>,
411
<quote><literal>created</literal></quote>,
412
<quote><literal>enabled</literal></quote>,
413
<quote><literal>expires</literal></quote>,
414
<quote><literal>fingerprint</literal></quote>,
415
<quote><literal>host</literal></quote>,
416
<quote><literal>interval</literal></quote>,
417
<quote><literal>last_approval_request</literal></quote>,
418
<quote><literal>last_checked_ok</literal></quote>,
419
<quote><literal>last_enabled</literal></quote>,
420
<quote><literal>name</literal></quote>,
421
<quote><literal>timeout</literal></quote>, and, if using
422
D-Bus, <quote><literal>dbus_object_path</literal></quote>.
423
See the source code for details. <emphasis role="strong"
424
>Currently, <emphasis>none</emphasis> of these attributes
425
except <quote><literal>host</literal></quote> are guaranteed
426
to be valid in future versions.</emphasis> Therefore, please
427
let the authors know of any attributes that are useful so they
428
may be preserved to any new versions of this software.
429
</para>
430
<para>
431
Note that this means that, in order to include an actual
432
percent character (<quote>%</quote>) in a
433
<varname>checker</varname> option, <emphasis>four</emphasis>
434
percent characters in a row (<quote>%%%%</quote>) must be
435
entered. Also, a bad format here will lead to an immediate
436
but <emphasis>silent</emphasis> run-time fatal exit; debug
437
mode is needed to expose an error of this kind.
438
</para>
439
</refsect2>
440
441
</refsect1>
442
443
<refsect1 id="files">
444
<title>FILES</title>
445
<para>
446
The file described here is &CONFPATH;
447
</para>
448
</refsect1>
449
450
<refsect1 id="bugs">
451
<title>BUGS</title>
452
<para>
453
The format for specifying times for <varname>timeout</varname>
454
and <varname>interval</varname> is not very good.
455
</para>
456
<para>
457
The difference between
458
<literal>%%(<replaceable>foo</replaceable>)s</literal> and
459
<literal>%(<replaceable>foo</replaceable>)s</literal> is
460
obscure.
461
</para>
462
</refsect1>
463
464
<refsect1 id="example">
465
<title>EXAMPLE</title>
466
<informalexample>
467
<programlisting>
468
[DEFAULT]
469
timeout = PT5M
470
interval = PT2M
471
checker = fping -q -- %%(host)s
472
473
# Client "foo"
474
[foo]
475
fingerprint = 7788 2722 5BA7 DE53 9C5A 7CFA 59CF F7CD BD9A 5920
476
secret =
477
hQIOA6QdEjBs2L/HEAf/TCyrDe5Xnm9esa+Pb/vWF9CUqfn4srzVgSu234
478
REJMVv7lBSrPE2132Lmd2gqF1HeLKDJRSVxJpt6xoWOChGHg+TMyXDxK+N
479
Xl89vGvdU1XfhKkVm9MDLOgT5ECDPysDGHFPDhqHOSu3Kaw2DWMV/iH9vz
480
3Z20erVNbdcvyBnuojcoWO/6yfB5EQO0BXp7kcyy00USA3CjD5FGZdoQGI
481
Tb8A/ar0tVA5crSQmaSotm6KmNLhrFnZ5BxX+TiE+eTUTqSloWRY6VAvqW
482
QHC7OASxK5E6RXPBuFH5IohUA2Qbk5AHt99pYvsIPX88j2rWauOokoiKZo
483
t/9leJ8VxO5l3wf/U64IH8bkPIoWmWZfd/nqh4uwGNbCgKMyT+AnvH7kMJ
484
3i7DivfWl2mKLV0PyPHUNva0VQxX6yYjcOhj1R6fCr/at8/NSLe2OhLchz
485
dC+Ls9h+kvJXgF8Sisv+Wk/1RadPLFmraRlqvJwt6Ww21LpiXqXHV2mIgq
486
WnR98YgSvUi3TJHrUQiNc9YyBzuRo0AjgG2C9qiE3FM+Y28+iQ/sR3+bFs
487
zYuZKVTObqiIslwXu7imO0cvvFRgJF/6u3HNFQ4LUTGhiM3FQmC6NNlF3/
488
vJM2hwRDMcJqDd54Twx90Wh+tYz0z7QMsK4ANXWHHWHR0JchnLWmenzbtW
489
5MHdW9AYsNJZAQSOpirE4Xi31CSlWAi9KV+cUCmWF5zOFy1x23P6PjdaRm
490
4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
491
QlnHIvPzEArRQLo=
492
host = foo.example.org
493
interval = PT1M
494
495
# Client "bar"
496
[bar]
497
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
498
secfile = /etc/mandos/bar-secret
499
timeout = PT15M
500
approved_by_default = False
501
approval_delay = PT30S
502
</programlisting>
503
</informalexample>
504
</refsect1>
505
506
<refsect1 id="see_also">
507
<title>SEE ALSO</title>
508
<para>
509
<citerefentry><refentrytitle>intro</refentrytitle>
510
<manvolnum>8mandos</manvolnum></citerefentry>,
511
<citerefentry><refentrytitle>mandos-keygen</refentrytitle>
512
<manvolnum>8</manvolnum></citerefentry>,
513
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
514
<manvolnum>5</manvolnum></citerefentry>,
515
<citerefentry><refentrytitle>mandos</refentrytitle>
516
<manvolnum>8</manvolnum></citerefentry>,
517
<citerefentry><refentrytitle>fping</refentrytitle>
518
<manvolnum>8</manvolnum></citerefentry>
519
</para>
520
<variablelist>
521
<varlistentry>
522
<term>
523
RFC 3339: <citetitle>Date and Time on the Internet:
524
Timestamps</citetitle>
525
</term>
526
<listitem>
527
<para>
528
The time intervals are in the "duration" format, as
529
specified in ABNF in Appendix A of RFC 3339.
530
</para>
531
</listitem>
532
</varlistentry>
533
</variablelist>
534
</refsect1>
535
</refentry>
536
<!-- Local Variables: -->
537
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
538
<!-- time-stamp-end: "[\"']>" -->
539
<!-- time-stamp-format: "%:y-%02m-%02d" -->
540
<!-- End: -->
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0