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