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 176
- compare with another revision
- download diff
- download tarball
- view history from revision 176
- Committer: Teddy Hogeborn
- Date: 2008-09-07 01:44:44 UTC
- mfrom: (24.1.93 mandos)
- Revision ID: teddy@fukt.bsnet.se-20080907014444-cf4ilzndc0tbn8va
Merge & resolve.
- files added:
- etc-plugins.d-README
- files removed:
- .bzr-builddeb
- debian
- debian/po
- debian/source
- debian/upstream
- network-hooks.d
- plugin-helpers
- files modified:
- .bzrignore
added
removed
mandos-clients.conf.xml
1
1
<?xml version="1.0" encoding="UTF-8"?>
2
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
3
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
<!ENTITY VERSION "1.0">
4
5
<!ENTITY CONFNAME "mandos-clients.conf">
5
6
<!ENTITY CONFPATH "<filename>/etc/mandos/clients.conf</filename>">
6
<!ENTITY TIMESTAMP "2017-02-23">
7
<!ENTITY % common SYSTEM "common.ent">
8
%common;
7
<!ENTITY TIMESTAMP "2008-09-04">
9
8
]>
10
9
11
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
13
12
<title>Mandos Manual</title>
14
13
<!-- NWalsh’s docbook scripts use this to generate the footer: -->
15
14
<productname>Mandos</productname>
16
<productnumber>&version;</productnumber>
15
<productnumber>&VERSION;</productnumber>
17
16
<date>&TIMESTAMP;</date>
18
17
<authorgroup>
19
18
<author>
20
19
<firstname>Björn</firstname>
21
20
<surname>Påhlsson</surname>
22
21
<address>
23
<email>belorn@recompile.se</email>
22
<email>belorn@fukt.bsnet.se</email>
24
23
</address>
25
24
</author>
26
25
<author>
27
26
<firstname>Teddy</firstname>
28
27
<surname>Hogeborn</surname>
29
28
<address>
30
<email>teddy@recompile.se</email>
29
<email>teddy@fukt.bsnet.se</email>
31
30
</address>
32
31
</author>
33
32
</authorgroup>
34
33
<copyright>
35
34
<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
35
<holder>Teddy Hogeborn</holder>
46
36
<holder>Björn Påhlsson</holder>
47
37
</copyright>
48
38
<xi:include href="legalnotice.xml"/>
49
39
</refentryinfo>
50
40
51
41
<refmeta>
52
42
<refentrytitle>&CONFNAME;</refentrytitle>
53
43
<manvolnum>5</manvolnum>
59
49
Configuration file for the Mandos server
60
50
</refpurpose>
61
51
</refnamediv>
62
52
63
53
<refsynopsisdiv>
64
54
<synopsis>&CONFPATH;</synopsis>
65
55
</refsynopsisdiv>
66
56
67
57
<refsect1 id="description">
68
58
<title>DESCRIPTION</title>
69
59
<para>
71
61
><refentrytitle>mandos</refentrytitle>
72
62
<manvolnum>8</manvolnum></citerefentry>, read by it at startup.
73
63
The file needs to list all clients that should be able to use
74
the service. The settings in this file can be overridden by
75
runtime changes to the server, which it saves across restarts.
76
(See the section called <quote>PERSISTENT STATE</quote> in
77
<citerefentry><refentrytitle>mandos</refentrytitle><manvolnum
78
>8</manvolnum></citerefentry>.) However, any <emphasis
79
>changes</emphasis> to this file (including adding and removing
80
clients) will, at startup, override changes done during runtime.
64
the service. All clients listed will be regarded as valid, even
65
if a client was declared invalid in a previous run of the
66
server.
81
67
</para>
82
68
<para>
83
69
The format starts with a <literal>[<replaceable>section
109
95
<para>
110
96
Unknown options are ignored. The used options are as follows:
111
97
</para>
112
98
113
99
<variablelist>
114
115
<varlistentry>
116
<term><option>approval_delay<literal> = </literal><replaceable
117
>TIME</replaceable></option></term>
118
<listitem>
119
<para>
120
This option is <emphasis>optional</emphasis>.
121
</para>
122
<para>
123
How long to wait for external approval before resorting to
124
use the <option>approved_by_default</option> value. The
125
default is <quote>PT0S</quote>, i.e. not to wait.
126
</para>
127
<para>
128
The format of <replaceable>TIME</replaceable> is the same
129
as for <varname>timeout</varname> below.
130
</para>
131
</listitem>
132
</varlistentry>
133
134
<varlistentry>
135
<term><option>approval_duration<literal> = </literal
136
><replaceable>TIME</replaceable></option></term>
137
<listitem>
138
<para>
139
This option is <emphasis>optional</emphasis>.
140
</para>
141
<para>
142
How long an external approval lasts. The default is 1
143
second.
144
</para>
145
<para>
146
The format of <replaceable>TIME</replaceable> is the same
147
as for <varname>timeout</varname> below.
148
</para>
149
</listitem>
150
</varlistentry>
151
152
<varlistentry>
153
<term><option>approved_by_default<literal> = </literal
154
>{ <literal >1</literal> | <literal>yes</literal> | <literal
155
>true</literal> | <literal>on</literal> | <literal
156
>0</literal> | <literal>no</literal> | <literal
157
>false</literal> | <literal>off</literal> }</option></term>
158
<listitem>
159
<para>
160
Whether to approve a client by default after
161
the <option>approval_delay</option>. The default
162
is <quote>True</quote>.
163
</para>
164
</listitem>
165
</varlistentry>
166
100
101
<varlistentry>
102
<term><option>timeout<literal> = </literal><replaceable
103
>TIME</replaceable></option></term>
104
<listitem>
105
<para>
106
This option is <emphasis>optional</emphasis>.
107
</para>
108
<para>
109
The timeout is how long the server will wait for a
110
successful checker run until a client is considered
111
invalid - that is, ineligible to get the data this server
112
holds. By default Mandos will use 1 hour.
113
</para>
114
<para>
115
The <replaceable>TIME</replaceable> is specified as a
116
space-separated number of values, each of which is a
117
number and a one-character suffix. The suffix must be one
118
of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
119
<quote>h</quote>, and <quote>w</quote> for days, seconds,
120
minutes, hours, and weeks, respectively. The values are
121
added together to give the total time value, so all of
122
<quote><literal>330s</literal></quote>,
123
<quote><literal>110s 110s 110s</literal></quote>, and
124
<quote><literal>5m 30s</literal></quote> will give a value
125
of five minutes and thirty seconds.
126
</para>
127
</listitem>
128
</varlistentry>
129
130
<varlistentry>
131
<term><option>interval<literal> = </literal><replaceable
132
>TIME</replaceable></option></term>
133
<listitem>
134
<para>
135
This option is <emphasis>optional</emphasis>.
136
</para>
137
<para>
138
How often to run the checker to confirm that a client is
139
still up. <emphasis>Note:</emphasis> a new checker will
140
not be started if an old one is still running. The server
141
will wait for a checker to complete until the above
142
<quote><varname>timeout</varname></quote> occurs, at which
143
time the client will be marked invalid, and any running
144
checker killed. The default interval is 5 minutes.
145
</para>
146
<para>
147
The format of <replaceable>TIME</replaceable> is the same
148
as for <varname>timeout</varname> above.
149
</para>
150
</listitem>
151
</varlistentry>
152
167
153
<varlistentry>
168
154
<term><option>checker<literal> = </literal><replaceable
169
155
>COMMAND</replaceable></option></term>
172
158
This option is <emphasis>optional</emphasis>.
173
159
</para>
174
160
<para>
175
This option overrides the default shell command that the
176
server will use to check if the client is still up. Any
177
output of the command will be ignored, only the exit code
178
is checked: If the exit code of the command is zero, the
179
client is considered up. The command will be run using
180
<quote><command><filename>/bin/sh</filename>
161
This option allows you to override the default shell
162
command that the server will use to check if the client is
163
still up. Any output of the command will be ignored, only
164
the exit code is checked: If the exit code of the command
165
is zero, the client is considered up. The command will be
166
run using <quote><command><filename>/bin/sh</filename>
181
167
<option>-c</option></command></quote>, so
182
168
<varname>PATH</varname> will be searched. The default
183
169
value for the checker command is <quote><literal
184
170
><command>fping</command> <option>-q</option> <option
185
>--</option> %%(host)s</literal></quote>. Note that
186
<command>mandos-keygen</command>, when generating output
187
to be inserted into this file, normally looks for an SSH
188
server on the Mandos client, and, if it find one, outputs
189
a <option>checker</option> option to check for the
190
client’s key fingerprint – this is more secure against
191
spoofing.
171
>--</option> %(host)s</literal></quote>.
192
172
</para>
193
173
<para>
194
174
In addition to normal start time expansion, this option
199
179
</varlistentry>
200
180
201
181
<varlistentry>
202
<term><option>extended_timeout<literal> = </literal><replaceable
203
>TIME</replaceable></option></term>
204
<listitem>
205
<para>
206
This option is <emphasis>optional</emphasis>.
207
</para>
208
<para>
209
Extended timeout is an added timeout that is given once
210
after a password has been sent successfully to a client.
211
The timeout is by default longer than the normal timeout,
212
and is used for handling the extra long downtime while a
213
machine is booting up. Time to take into consideration
214
when changing this value is file system checks and quota
215
checks. The default value is 15 minutes.
216
</para>
217
<para>
218
The format of <replaceable>TIME</replaceable> is the same
219
as for <varname>timeout</varname> below.
220
</para>
221
</listitem>
222
</varlistentry>
223
224
<varlistentry>
225
182
<term><option>fingerprint<literal> = </literal
226
183
><replaceable>HEXSTRING</replaceable></option></term>
227
184
<listitem>
231
188
<para>
232
189
This option sets the OpenPGP fingerprint that identifies
233
190
the public key that clients authenticate themselves with
234
through TLS. The string needs to be in hexadecimal form,
191
through TLS. The string needs to be in hexidecimal form,
235
192
but spaces or upper/lower case are not significant.
236
193
</para>
237
194
</listitem>
238
195
</varlistentry>
239
196
240
197
<varlistentry>
241
<term><option><literal>host = </literal><replaceable
242
>STRING</replaceable></option></term>
243
<listitem>
244
<para>
245
This option is <emphasis>optional</emphasis>, but highly
246
<emphasis>recommended</emphasis> unless the
247
<option>checker</option> option is modified to a
248
non-standard value without <quote>%%(host)s</quote> in it.
249
</para>
250
<para>
251
Host name for this client. This is not used by the server
252
directly, but can be, and is by default, used by the
253
checker. See the <option>checker</option> option.
254
</para>
255
</listitem>
256
</varlistentry>
257
258
<varlistentry>
259
<term><option>interval<literal> = </literal><replaceable
260
>TIME</replaceable></option></term>
261
<listitem>
262
<para>
263
This option is <emphasis>optional</emphasis>.
264
</para>
265
<para>
266
How often to run the checker to confirm that a client is
267
still up. <emphasis>Note:</emphasis> a new checker will
268
not be started if an old one is still running. The server
269
will wait for a checker to complete until the below
270
<quote><varname>timeout</varname></quote> occurs, at which
271
time the client will be disabled, and any running checker
272
killed. The default interval is 2 minutes.
273
</para>
274
<para>
275
The format of <replaceable>TIME</replaceable> is the same
276
as for <varname>timeout</varname> below.
277
</para>
278
</listitem>
279
</varlistentry>
280
281
<varlistentry>
282
<term><option>secfile<literal> = </literal><replaceable
283
>FILENAME</replaceable></option></term>
284
<listitem>
285
<para>
286
This option is only used if <option>secret</option> is not
287
specified, in which case this option is
288
<emphasis>required</emphasis>.
289
</para>
290
<para>
291
Similar to the <option>secret</option>, except the secret
292
data is in an external file. The contents of the file
293
should <emphasis>not</emphasis> be base64-encoded, but
294
will be sent to clients verbatim.
295
</para>
296
<para>
297
File names of the form <filename>~user/foo/bar</filename>
298
and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
299
are supported.
300
</para>
301
</listitem>
302
</varlistentry>
303
304
<varlistentry>
305
198
<term><option>secret<literal> = </literal><replaceable
306
199
>BASE64_ENCODED_DATA</replaceable></option></term>
307
200
<listitem>
330
223
</para>
331
224
</listitem>
332
225
</varlistentry>
333
226
334
227
<varlistentry>
335
<term><option>timeout<literal> = </literal><replaceable
336
>TIME</replaceable></option></term>
228
<term><option>secfile<literal> = </literal><replaceable
229
>FILENAME</replaceable></option></term>
337
230
<listitem>
338
231
<para>
339
This option is <emphasis>optional</emphasis>.
340
</para>
341
<para>
342
The timeout is how long the server will wait, after a
343
successful checker run, until a client is disabled and not
344
allowed to get the data this server holds. By default
345
Mandos will use 5 minutes. See also the
346
<option>extended_timeout</option> option.
347
</para>
348
<para>
349
The <replaceable>TIME</replaceable> is specified as an RFC
350
3339 duration; for example
351
<quote><literal>P1Y2M3DT4H5M6S</literal></quote> meaning
352
one year, two months, three days, four hours, five
353
minutes, and six seconds. Some values can be omitted, see
354
RFC 3339 Appendix A for details.
232
This option is only used if <option>secret</option> is not
233
specified, in which case this option is
234
<emphasis>required</emphasis>.
235
</para>
236
<para>
237
Similar to the <option>secret</option>, except the secret
238
data is in an external file. The contents of the file
239
should <emphasis>not</emphasis> be base64-encoded, but
240
will be sent to clients verbatim.
355
241
</para>
356
242
</listitem>
357
243
</varlistentry>
358
244
359
245
<varlistentry>
360
<term><option>enabled<literal> = </literal>{ <literal
361
>1</literal> | <literal>yes</literal> | <literal>true</literal
362
> | <literal >on</literal> | <literal>0</literal> | <literal
363
>no</literal> | <literal>false</literal> | <literal
364
>off</literal> }</option></term>
246
<term><option><literal>host = </literal><replaceable
247
>STRING</replaceable></option></term>
365
248
<listitem>
366
249
<para>
367
Whether this client should be enabled by default. The
368
default is <quote>true</quote>.
250
This option is <emphasis>optional</emphasis>, but highly
251
<emphasis>recommended</emphasis> unless the
252
<option>checker</option> option is modified to a
253
non-standard value without <quote>%(host)s</quote> in it.
254
</para>
255
<para>
256
Host name for this client. This is not used by the server
257
directly, but can be, and is by default, used by the
258
checker. See the <option>checker</option> option.
369
259
</para>
370
260
</listitem>
371
261
</varlistentry>
408
298
<quote><literal>%%(<replaceable>foo</replaceable>)s</literal
409
299
></quote> will be replaced by the value of the attribute
410
300
<varname>foo</varname> of the internal
411
<quote><classname>Client</classname></quote> object in the
412
Mandos server. The currently allowed values for
413
<replaceable>foo</replaceable> are:
414
<quote><literal>approval_delay</literal></quote>,
415
<quote><literal>approval_duration</literal></quote>,
416
<quote><literal>created</literal></quote>,
417
<quote><literal>enabled</literal></quote>,
418
<quote><literal>expires</literal></quote>,
419
<quote><literal>fingerprint</literal></quote>,
420
<quote><literal>host</literal></quote>,
421
<quote><literal>interval</literal></quote>,
422
<quote><literal>last_approval_request</literal></quote>,
423
<quote><literal>last_checked_ok</literal></quote>,
424
<quote><literal>last_enabled</literal></quote>,
425
<quote><literal>name</literal></quote>,
426
<quote><literal>timeout</literal></quote>, and, if using
427
D-Bus, <quote><literal>dbus_object_path</literal></quote>.
428
See the source code for details. <emphasis role="strong"
429
>Currently, <emphasis>none</emphasis> of these attributes
430
except <quote><literal>host</literal></quote> are guaranteed
431
to be valid in future versions.</emphasis> Therefore, please
432
let the authors know of any attributes that are useful so they
433
may be preserved to any new versions of this software.
301
<quote><classname>Client</classname></quote> object. See the
302
source code for details, and let the authors know of any
303
attributes that are useful so they may be preserved to any new
304
versions of this software.
434
305
</para>
435
306
<para>
436
307
Note that this means that, in order to include an actual
442
313
mode is needed to expose an error of this kind.
443
314
</para>
444
315
</refsect2>
445
316
446
317
</refsect1>
447
318
448
319
<refsect1 id="files">
464
335
<literal>%(<replaceable>foo</replaceable>)s</literal> is
465
336
obscure.
466
337
</para>
467
<xi:include href="bugs.xml"/>
468
338
</refsect1>
469
339
470
340
<refsect1 id="example">
472
342
<informalexample>
473
343
<programlisting>
474
344
[DEFAULT]
475
timeout = PT5M
476
interval = PT2M
477
checker = fping -q -- %%(host)s
345
timeout = 1h
346
interval = 5m
347
checker = fping -q -- %(host)s
478
348
479
349
# Client "foo"
480
350
[foo]
496
366
4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
497
367
QlnHIvPzEArRQLo=
498
368
host = foo.example.org
499
interval = PT1M
369
interval = 1m
500
370
501
371
# Client "bar"
502
372
[bar]
503
373
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
504
374
secfile = /etc/mandos/bar-secret
505
timeout = PT15M
506
approved_by_default = False
507
approval_delay = PT30S
375
timeout = 15m
376
508
377
</programlisting>
509
378
</informalexample>
510
379
</refsect1>
512
381
<refsect1 id="see_also">
513
382
<title>SEE ALSO</title>
514
383
<para>
515
<citerefentry><refentrytitle>intro</refentrytitle>
516
<manvolnum>8mandos</manvolnum></citerefentry>,
517
384
<citerefentry><refentrytitle>mandos-keygen</refentrytitle>
518
385
<manvolnum>8</manvolnum></citerefentry>,
519
386
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
520
387
<manvolnum>5</manvolnum></citerefentry>,
521
388
<citerefentry><refentrytitle>mandos</refentrytitle>
522
<manvolnum>8</manvolnum></citerefentry>,
523
<citerefentry><refentrytitle>fping</refentrytitle>
524
389
<manvolnum>8</manvolnum></citerefentry>
525
390
</para>
526
<variablelist>
527
<varlistentry>
528
<term>
529
RFC 3339: <citetitle>Date and Time on the Internet:
530
Timestamps</citetitle>
531
</term>
532
<listitem>
533
<para>
534
The time intervals are in the "duration" format, as
535
specified in ABNF in Appendix A of RFC 3339.
536
</para>
537
</listitem>
538
</varlistentry>
539
</variablelist>
540
391
</refsect1>
541
392
</refentry>
542
393
<!-- Local Variables: -->
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0