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 406
- compare with another revision
- download diff
- download tarball
- view history from revision 406
- Committer: Teddy Hogeborn
- Date: 2009-11-09 07:35:16 UTC
- Revision ID: teddy@fukt.bsnet.se-20091109073516-v1vem352uz0vuwrd
* dbus-mandos.conf: New; to be copied to
"/etc/dbus-1/system.d/mandos.conf".
"/etc/dbus-1/system.d/mandos.conf".
- files added:
- initramfs-tools-hook-conf
- 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 "2019-02-09">
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 finds one, outputs
190
a <option>checker</option> option to check for the
191
client’s SSH 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,
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.
194
through TLS. The string needs to be in hexidecimal form,
195
but spaces or upper/lower case are not significant.
317
196
</para>
318
197
</listitem>
319
198
</varlistentry>
330
209
<para>
331
210
If present, this option must be set to a string of
332
211
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.
212
to the client matching the above
213
<option>fingerprint</option>. This should, of course, be
214
OpenPGP encrypted data, decryptable only by the client.
336
215
The program <citerefentry><refentrytitle><command
337
216
>mandos-keygen</command></refentrytitle><manvolnum
338
217
>8</manvolnum></citerefentry> can, using its
349
228
</varlistentry>
350
229
351
230
<varlistentry>
352
<term><option>timeout<literal> = </literal><replaceable
353
>TIME</replaceable></option></term>
231
<term><option>secfile<literal> = </literal><replaceable
232
>FILENAME</replaceable></option></term>
354
233
<listitem>
355
234
<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.
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.
372
249
</para>
373
250
</listitem>
374
251
</varlistentry>
375
252
376
253
<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>
254
<term><option><literal>host = </literal><replaceable
255
>STRING</replaceable></option></term>
382
256
<listitem>
383
257
<para>
384
Whether this client should be enabled by default. The
385
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.
386
267
</para>
387
268
</listitem>
388
269
</varlistentry>
425
306
<quote><literal>%%(<replaceable>foo</replaceable>)s</literal
426
307
></quote> will be replaced by the value of the attribute
427
308
<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.
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.
452
313
</para>
453
314
<para>
454
315
Note that this means that, in order to include an actual
482
343
<literal>%(<replaceable>foo</replaceable>)s</literal> is
483
344
obscure.
484
345
</para>
485
<xi:include href="bugs.xml"/>
486
346
</refsect1>
487
347
488
348
<refsect1 id="example">
490
350
<informalexample>
491
351
<programlisting>
492
352
[DEFAULT]
493
timeout = PT5M
494
interval = PT2M
353
timeout = 1h
354
interval = 5m
495
355
checker = fping -q -- %%(host)s
496
356
497
357
# Client "foo"
498
358
[foo]
499
key_id = 788cd77115cd0bb7b2d5e0ae8496f6b48149d5e712c652076b1fd2d957ef7c1f
500
359
fingerprint = 7788 2722 5BA7 DE53 9C5A 7CFA 59CF F7CD BD9A 5920
501
360
secret =
502
361
hQIOA6QdEjBs2L/HEAf/TCyrDe5Xnm9esa+Pb/vWF9CUqfn4srzVgSu234
515
374
4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
516
375
QlnHIvPzEArRQLo=
517
376
host = foo.example.org
518
interval = PT1M
377
interval = 1m
519
378
520
379
# Client "bar"
521
380
[bar]
522
key_id = F90C7A81D72D1EA69A51031A91FF8885F36C8B46D155C8C58709A4C99AE9E361
523
381
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
524
382
secfile = /etc/mandos/bar-secret
525
timeout = PT15M
526
approved_by_default = False
527
approval_delay = PT30S
383
timeout = 15m
528
384
</programlisting>
529
385
</informalexample>
530
386
</refsect1>
532
388
<refsect1 id="see_also">
533
389
<title>SEE ALSO</title>
534
390
<para>
535
<citerefentry><refentrytitle>intro</refentrytitle>
536
<manvolnum>8mandos</manvolnum></citerefentry>,
537
391
<citerefentry><refentrytitle>mandos-keygen</refentrytitle>
538
392
<manvolnum>8</manvolnum></citerefentry>,
539
393
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
540
394
<manvolnum>5</manvolnum></citerefentry>,
541
395
<citerefentry><refentrytitle>mandos</refentrytitle>
542
<manvolnum>8</manvolnum></citerefentry>,
543
<citerefentry><refentrytitle>fping</refentrytitle>
544
396
<manvolnum>8</manvolnum></citerefentry>
545
397
</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
398
</refsect1>
561
399
</refentry>
562
400
<!-- Local Variables: -->
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0