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 388
- compare with another revision
- download diff
- download tarball
- view history from revision 388
- Committer: Teddy Hogeborn
- Date: 2019-08-05 21:15:40 UTC
- mfrom: (237.7.700 trunk)
- Revision ID: teddy@recompile.se-20190805211540-fy4da3hn8wr52qna
Merge from trunk
- files added:
- DBUS-API
- debian/source
- debian/tests
- debian/upstream
- dracut-module
- network-hooks.d
- plugin-helpers
- files removed:
- initramfs-tools-hook-conf
- 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 "2009-02-15">
6
<!ENTITY TIMESTAMP "2019-02-10">
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@fukt.bsnet.se</email>
23
<email>belorn@recompile.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@fukt.bsnet.se</email>
30
<email>teddy@recompile.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
<year>2019</year>
37
47
<holder>Teddy Hogeborn</holder>
38
48
<holder>Björn Påhlsson</holder>
39
49
</copyright>
63
73
><refentrytitle>mandos</refentrytitle>
64
74
<manvolnum>8</manvolnum></citerefentry>, read by it at startup.
65
75
The file needs to list all clients that should be able to use
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.
76
the service. The settings in this file can be overridden by
77
runtime changes to the server, which it saves across restarts.
78
(See the section called <quote>PERSISTENT STATE</quote> in
79
<citerefentry><refentrytitle>mandos</refentrytitle><manvolnum
80
>8</manvolnum></citerefentry>.) However, any <emphasis
81
>changes</emphasis> to this file (including adding and removing
82
clients) will, at startup, override changes done during runtime.
69
83
</para>
70
84
<para>
71
85
The format starts with a <literal>[<replaceable>section
101
115
<variablelist>
102
116
103
117
<varlistentry>
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 a
112
successful checker run until a client is considered
113
invalid - that is, ineligible to get the data this server
114
holds. By default Mandos will use 1 hour.
115
</para>
116
<para>
117
The <replaceable>TIME</replaceable> is specified as a
118
space-separated number of values, each of which is a
119
number and a one-character suffix. The suffix must be one
120
of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
121
<quote>h</quote>, and <quote>w</quote> for days, seconds,
122
minutes, hours, and weeks, respectively. The values are
123
added together to give the total time value, so all of
124
<quote><literal>330s</literal></quote>,
125
<quote><literal>110s 110s 110s</literal></quote>, and
126
<quote><literal>5m 30s</literal></quote> will give a value
127
of five minutes and thirty seconds.
128
</para>
129
</listitem>
130
</varlistentry>
131
132
<varlistentry>
133
<term><option>interval<literal> = </literal><replaceable
134
>TIME</replaceable></option></term>
135
<listitem>
136
<para>
137
This option is <emphasis>optional</emphasis>.
138
</para>
139
<para>
140
How often to run the checker to confirm that a client is
141
still up. <emphasis>Note:</emphasis> a new checker will
142
not be started if an old one is still running. The server
143
will wait for a checker to complete until the above
144
<quote><varname>timeout</varname></quote> occurs, at which
145
time the client will be marked invalid, and any running
146
checker killed. The default interval is 5 minutes.
147
</para>
148
<para>
149
The format of <replaceable>TIME</replaceable> is the same
150
as for <varname>timeout</varname> above.
118
<term><option>approval_delay<literal> = </literal><replaceable
119
>TIME</replaceable></option></term>
120
<listitem>
121
<para>
122
This option is <emphasis>optional</emphasis>.
123
</para>
124
<para>
125
How long to wait for external approval before resorting to
126
use the <option>approved_by_default</option> value. The
127
default is <quote>PT0S</quote>, i.e. not to wait.
128
</para>
129
<para>
130
The format of <replaceable>TIME</replaceable> is the same
131
as for <varname>timeout</varname> below.
132
</para>
133
</listitem>
134
</varlistentry>
135
136
<varlistentry>
137
<term><option>approval_duration<literal> = </literal
138
><replaceable>TIME</replaceable></option></term>
139
<listitem>
140
<para>
141
This option is <emphasis>optional</emphasis>.
142
</para>
143
<para>
144
How long an external approval lasts. The default is 1
145
second.
146
</para>
147
<para>
148
The format of <replaceable>TIME</replaceable> is the same
149
as for <varname>timeout</varname> below.
150
</para>
151
</listitem>
152
</varlistentry>
153
154
<varlistentry>
155
<term><option>approved_by_default<literal> = </literal
156
>{ <literal >1</literal> | <literal>yes</literal> | <literal
157
>true</literal> | <literal>on</literal> | <literal
158
>0</literal> | <literal>no</literal> | <literal
159
>false</literal> | <literal>off</literal> }</option></term>
160
<listitem>
161
<para>
162
Whether to approve a client by default after
163
the <option>approval_delay</option>. The default
164
is <quote>True</quote>.
151
165
</para>
152
166
</listitem>
153
167
</varlistentry>
160
174
This option is <emphasis>optional</emphasis>.
161
175
</para>
162
176
<para>
163
This option allows you to override the default shell
164
command that the server will use to check if the client is
165
still up. Any output of the command will be ignored, only
166
the exit code is checked: If the exit code of the command
167
is zero, the client is considered up. The command will be
168
run using <quote><command><filename>/bin/sh</filename>
177
This option overrides the default shell command that the
178
server will use to check if the client is still up. Any
179
output of the command will be ignored, only the exit code
180
is checked: If the exit code of the command is zero, the
181
client is considered up. The command will be run using
182
<quote><command><filename>/bin/sh</filename>
169
183
<option>-c</option></command></quote>, so
170
184
<varname>PATH</varname> will be searched. The default
171
185
value for the checker command is <quote><literal
172
186
><command>fping</command> <option>-q</option> <option
173
>--</option> %%(host)s</literal></quote>.
187
>--</option> %%(host)s</literal></quote>. Note that
188
<command>mandos-keygen</command>, when generating output
189
to be inserted into this file, normally looks for an SSH
190
server on the Mandos client, and, if it finds one, outputs
191
a <option>checker</option> option to check for the
192
client’s SSH key fingerprint – this is more secure against
193
spoofing.
174
194
</para>
175
195
<para>
176
196
In addition to normal start time expansion, this option
181
201
</varlistentry>
182
202
183
203
<varlistentry>
204
<term><option>extended_timeout<literal> = </literal><replaceable
205
>TIME</replaceable></option></term>
206
<listitem>
207
<para>
208
This option is <emphasis>optional</emphasis>.
209
</para>
210
<para>
211
Extended timeout is an added timeout that is given once
212
after a password has been sent successfully to a client.
213
The timeout is by default longer than the normal timeout,
214
and is used for handling the extra long downtime while a
215
machine is booting up. Time to take into consideration
216
when changing this value is file system checks and quota
217
checks. The default value is 15 minutes.
218
</para>
219
<para>
220
The format of <replaceable>TIME</replaceable> is the same
221
as for <varname>timeout</varname> below.
222
</para>
223
</listitem>
224
</varlistentry>
225
226
<varlistentry>
184
227
<term><option>fingerprint<literal> = </literal
185
228
><replaceable>HEXSTRING</replaceable></option></term>
186
229
<listitem>
190
233
<para>
191
234
This option sets the OpenPGP fingerprint that identifies
192
235
the public key that clients authenticate themselves with
193
through TLS. The string needs to be in hexidecimal form,
194
but spaces or upper/lower case are not significant.
236
through TLS. The string needs to be in hexadecimal form,
237
but spaces or upper/lower case are not significant.
238
</para>
239
</listitem>
240
</varlistentry>
241
242
<varlistentry>
243
<term><option>key_id<literal> = </literal
244
><replaceable>HEXSTRING</replaceable></option></term>
245
<listitem>
246
<para>
247
This option is <emphasis>optional</emphasis>.
248
</para>
249
<para>
250
This option sets the certificate key ID that identifies
251
the public key that clients authenticate themselves with
252
through TLS. The string needs to be in hexadecimal form,
253
but spaces or upper/lower case are not significant.
254
</para>
255
</listitem>
256
</varlistentry>
257
258
<varlistentry>
259
<term><option><literal>host = </literal><replaceable
260
>STRING</replaceable></option></term>
261
<listitem>
262
<para>
263
This option is <emphasis>optional</emphasis>, but highly
264
<emphasis>recommended</emphasis> unless the
265
<option>checker</option> option is modified to a
266
non-standard value without <quote>%%(host)s</quote> in it.
267
</para>
268
<para>
269
Host name for this client. This is not used by the server
270
directly, but can be, and is by default, used by the
271
checker. See the <option>checker</option> option.
272
</para>
273
</listitem>
274
</varlistentry>
275
276
<varlistentry>
277
<term><option>interval<literal> = </literal><replaceable
278
>TIME</replaceable></option></term>
279
<listitem>
280
<para>
281
This option is <emphasis>optional</emphasis>.
282
</para>
283
<para>
284
How often to run the checker to confirm that a client is
285
still up. <emphasis>Note:</emphasis> a new checker will
286
not be started if an old one is still running. The server
287
will wait for a checker to complete until the below
288
<quote><varname>timeout</varname></quote> occurs, at which
289
time the client will be disabled, and any running checker
290
killed. The default interval is 2 minutes.
291
</para>
292
<para>
293
The format of <replaceable>TIME</replaceable> is the same
294
as for <varname>timeout</varname> below.
295
</para>
296
</listitem>
297
</varlistentry>
298
299
<varlistentry>
300
<term><option>secfile<literal> = </literal><replaceable
301
>FILENAME</replaceable></option></term>
302
<listitem>
303
<para>
304
This option is only used if <option>secret</option> is not
305
specified, in which case this option is
306
<emphasis>required</emphasis>.
307
</para>
308
<para>
309
Similar to the <option>secret</option>, except the secret
310
data is in an external file. The contents of the file
311
should <emphasis>not</emphasis> be base64-encoded, but
312
will be sent to clients verbatim.
313
</para>
314
<para>
315
File names of the form <filename>~user/foo/bar</filename>
316
and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
317
are supported.
195
318
</para>
196
319
</listitem>
197
320
</varlistentry>
208
331
<para>
209
332
If present, this option must be set to a string of
210
333
base64-encoded binary data. It will be decoded and sent
211
to the client matching the above
212
<option>fingerprint</option>. This should, of course, be
213
OpenPGP encrypted data, decryptable only by the client.
334
to the client matching the above <option>key_id</option>
335
or <option>fingerprint</option>. This should, of course,
336
be OpenPGP encrypted data, decryptable only by the client.
214
337
The program <citerefentry><refentrytitle><command
215
338
>mandos-keygen</command></refentrytitle><manvolnum
216
339
>8</manvolnum></citerefentry> can, using its
227
350
</varlistentry>
228
351
229
352
<varlistentry>
230
<term><option>secfile<literal> = </literal><replaceable
231
>FILENAME</replaceable></option></term>
353
<term><option>timeout<literal> = </literal><replaceable
354
>TIME</replaceable></option></term>
232
355
<listitem>
233
356
<para>
234
This option is only used if <option>secret</option> is not
235
specified, in which case this option is
236
<emphasis>required</emphasis>.
237
</para>
238
<para>
239
Similar to the <option>secret</option>, except the secret
240
data is in an external file. The contents of the file
241
should <emphasis>not</emphasis> be base64-encoded, but
242
will be sent to clients verbatim.
243
</para>
244
<para>
245
File names of the form <filename>~user/foo/bar</filename>
246
and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
247
are supported.
357
This option is <emphasis>optional</emphasis>.
358
</para>
359
<para>
360
The timeout is how long the server will wait, after a
361
successful checker run, until a client is disabled and not
362
allowed to get the data this server holds. By default
363
Mandos will use 5 minutes. See also the
364
<option>extended_timeout</option> option.
365
</para>
366
<para>
367
The <replaceable>TIME</replaceable> is specified as an RFC
368
3339 duration; for example
369
<quote><literal>P1Y2M3DT4H5M6S</literal></quote> meaning
370
one year, two months, three days, four hours, five
371
minutes, and six seconds. Some values can be omitted, see
372
RFC 3339 Appendix A for details.
248
373
</para>
249
374
</listitem>
250
375
</varlistentry>
251
376
252
377
<varlistentry>
253
<term><option><literal>host = </literal><replaceable
254
>STRING</replaceable></option></term>
378
<term><option>enabled<literal> = </literal>{ <literal
379
>1</literal> | <literal>yes</literal> | <literal>true</literal
380
> | <literal >on</literal> | <literal>0</literal> | <literal
381
>no</literal> | <literal>false</literal> | <literal
382
>off</literal> }</option></term>
255
383
<listitem>
256
384
<para>
257
This option is <emphasis>optional</emphasis>, but highly
258
<emphasis>recommended</emphasis> unless the
259
<option>checker</option> option is modified to a
260
non-standard value without <quote>%%(host)s</quote> in it.
261
</para>
262
<para>
263
Host name for this client. This is not used by the server
264
directly, but can be, and is by default, used by the
265
checker. See the <option>checker</option> option.
385
Whether this client should be enabled by default. The
386
default is <quote>true</quote>.
266
387
</para>
267
388
</listitem>
268
389
</varlistentry>
305
426
<quote><literal>%%(<replaceable>foo</replaceable>)s</literal
306
427
></quote> will be replaced by the value of the attribute
307
428
<varname>foo</varname> of the internal
308
<quote><classname>Client</classname></quote> object. See the
309
source code for details, and let the authors know of any
310
attributes that are useful so they may be preserved to any new
311
versions of this software.
429
<quote><classname>Client</classname></quote> object in the
430
Mandos server. The currently allowed values for
431
<replaceable>foo</replaceable> are:
432
<quote><literal>approval_delay</literal></quote>,
433
<quote><literal>approval_duration</literal></quote>,
434
<quote><literal>created</literal></quote>,
435
<quote><literal>enabled</literal></quote>,
436
<quote><literal>expires</literal></quote>,
437
<quote><literal>key_id</literal></quote>,
438
<quote><literal>fingerprint</literal></quote>,
439
<quote><literal>host</literal></quote>,
440
<quote><literal>interval</literal></quote>,
441
<quote><literal>last_approval_request</literal></quote>,
442
<quote><literal>last_checked_ok</literal></quote>,
443
<quote><literal>last_enabled</literal></quote>,
444
<quote><literal>name</literal></quote>,
445
<quote><literal>timeout</literal></quote>, and, if using
446
D-Bus, <quote><literal>dbus_object_path</literal></quote>.
447
See the source code for details. <emphasis role="strong"
448
>Currently, <emphasis>none</emphasis> of these attributes
449
except <quote><literal>host</literal></quote> are guaranteed
450
to be valid in future versions.</emphasis> Therefore, please
451
let the authors know of any attributes that are useful so they
452
may be preserved to any new versions of this software.
312
453
</para>
313
454
<para>
314
455
Note that this means that, in order to include an actual
342
483
<literal>%(<replaceable>foo</replaceable>)s</literal> is
343
484
obscure.
344
485
</para>
486
<xi:include href="bugs.xml"/>
345
487
</refsect1>
346
488
347
489
<refsect1 id="example">
349
491
<informalexample>
350
492
<programlisting>
351
493
[DEFAULT]
352
timeout = 1h
353
interval = 5m
494
timeout = PT5M
495
interval = PT2M
354
496
checker = fping -q -- %%(host)s
355
497
356
498
# Client "foo"
357
499
[foo]
500
key_id = 788cd77115cd0bb7b2d5e0ae8496f6b48149d5e712c652076b1fd2d957ef7c1f
358
501
fingerprint = 7788 2722 5BA7 DE53 9C5A 7CFA 59CF F7CD BD9A 5920
359
502
secret =
360
503
hQIOA6QdEjBs2L/HEAf/TCyrDe5Xnm9esa+Pb/vWF9CUqfn4srzVgSu234
373
516
4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
374
517
QlnHIvPzEArRQLo=
375
518
host = foo.example.org
376
interval = 1m
519
interval = PT1M
377
520
378
521
# Client "bar"
379
522
[bar]
523
key_id = F90C7A81D72D1EA69A51031A91FF8885F36C8B46D155C8C58709A4C99AE9E361
380
524
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
381
525
secfile = /etc/mandos/bar-secret
382
timeout = 15m
526
timeout = PT15M
527
approved_by_default = False
528
approval_delay = PT30S
383
529
</programlisting>
384
530
</informalexample>
385
531
</refsect1>
387
533
<refsect1 id="see_also">
388
534
<title>SEE ALSO</title>
389
535
<para>
536
<citerefentry><refentrytitle>intro</refentrytitle>
537
<manvolnum>8mandos</manvolnum></citerefentry>,
390
538
<citerefentry><refentrytitle>mandos-keygen</refentrytitle>
391
539
<manvolnum>8</manvolnum></citerefentry>,
392
540
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
393
541
<manvolnum>5</manvolnum></citerefentry>,
394
542
<citerefentry><refentrytitle>mandos</refentrytitle>
543
<manvolnum>8</manvolnum></citerefentry>,
544
<citerefentry><refentrytitle>fping</refentrytitle>
395
545
<manvolnum>8</manvolnum></citerefentry>
396
546
</para>
547
<variablelist>
548
<varlistentry>
549
<term>
550
RFC 3339: <citetitle>Date and Time on the Internet:
551
Timestamps</citetitle>
552
</term>
553
<listitem>
554
<para>
555
The time intervals are in the "duration" format, as
556
specified in ABNF in Appendix A of RFC 3339.
557
</para>
558
</listitem>
559
</varlistentry>
560
</variablelist>
397
561
</refsect1>
398
562
</refentry>
399
563
<!-- Local Variables: -->
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0