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 180
- compare with another revision
- download diff
- download tarball
- view history from revision 180
- Committer: Teddy Hogeborn
- Date: 2008-09-08 18:18:49 UTC
- Revision ID: teddy@fukt.bsnet.se-20080908181849-ogydhr0m4axi3dnu
* INSTALL: More text. Better text.
- 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 "2018-02-08">
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
<year>2018</year>
46
35
<holder>Teddy Hogeborn</holder>
47
36
<holder>Björn Påhlsson</holder>
48
37
</copyright>
49
38
<xi:include href="legalnotice.xml"/>
50
39
</refentryinfo>
51
40
52
41
<refmeta>
53
42
<refentrytitle>&CONFNAME;</refentrytitle>
54
43
<manvolnum>5</manvolnum>
60
49
Configuration file for the Mandos server
61
50
</refpurpose>
62
51
</refnamediv>
63
52
64
53
<refsynopsisdiv>
65
54
<synopsis>&CONFPATH;</synopsis>
66
55
</refsynopsisdiv>
67
56
68
57
<refsect1 id="description">
69
58
<title>DESCRIPTION</title>
70
59
<para>
72
61
><refentrytitle>mandos</refentrytitle>
73
62
<manvolnum>8</manvolnum></citerefentry>, read by it at startup.
74
63
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.
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.
82
67
</para>
83
68
<para>
84
69
The format starts with a <literal>[<replaceable>section
110
95
<para>
111
96
Unknown options are ignored. The used options are as follows:
112
97
</para>
113
98
114
99
<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
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
168
153
<varlistentry>
169
154
<term><option>checker<literal> = </literal><replaceable
170
155
>COMMAND</replaceable></option></term>
173
158
This option is <emphasis>optional</emphasis>.
174
159
</para>
175
160
<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>
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>
182
167
<option>-c</option></command></quote>, so
183
168
<varname>PATH</varname> will be searched. The default
184
169
value for the checker command is <quote><literal
185
170
><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.
171
>--</option> %(host)s</literal></quote>.
193
172
</para>
194
173
<para>
195
174
In addition to normal start time expansion, this option
200
179
</varlistentry>
201
180
202
181
<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
182
<term><option>fingerprint<literal> = </literal
227
183
><replaceable>HEXSTRING</replaceable></option></term>
228
184
<listitem>
232
188
<para>
233
189
This option sets the OpenPGP fingerprint that identifies
234
190
the public key that clients authenticate themselves with
235
through TLS. The string needs to be in hexadecimal form,
191
through TLS. The string needs to be in hexidecimal form,
236
192
but spaces or upper/lower case are not significant.
237
193
</para>
238
194
</listitem>
239
195
</varlistentry>
240
196
241
197
<varlistentry>
242
<term><option><literal>host = </literal><replaceable
243
>STRING</replaceable></option></term>
244
<listitem>
245
<para>
246
This option is <emphasis>optional</emphasis>, but highly
247
<emphasis>recommended</emphasis> unless the
248
<option>checker</option> option is modified to a
249
non-standard value without <quote>%%(host)s</quote> in it.
250
</para>
251
<para>
252
Host name for this client. This is not used by the server
253
directly, but can be, and is by default, used by the
254
checker. See the <option>checker</option> option.
255
</para>
256
</listitem>
257
</varlistentry>
258
259
<varlistentry>
260
<term><option>interval<literal> = </literal><replaceable
261
>TIME</replaceable></option></term>
262
<listitem>
263
<para>
264
This option is <emphasis>optional</emphasis>.
265
</para>
266
<para>
267
How often to run the checker to confirm that a client is
268
still up. <emphasis>Note:</emphasis> a new checker will
269
not be started if an old one is still running. The server
270
will wait for a checker to complete until the below
271
<quote><varname>timeout</varname></quote> occurs, at which
272
time the client will be disabled, and any running checker
273
killed. The default interval is 2 minutes.
274
</para>
275
<para>
276
The format of <replaceable>TIME</replaceable> is the same
277
as for <varname>timeout</varname> below.
278
</para>
279
</listitem>
280
</varlistentry>
281
282
<varlistentry>
283
<term><option>secfile<literal> = </literal><replaceable
284
>FILENAME</replaceable></option></term>
285
<listitem>
286
<para>
287
This option is only used if <option>secret</option> is not
288
specified, in which case this option is
289
<emphasis>required</emphasis>.
290
</para>
291
<para>
292
Similar to the <option>secret</option>, except the secret
293
data is in an external file. The contents of the file
294
should <emphasis>not</emphasis> be base64-encoded, but
295
will be sent to clients verbatim.
296
</para>
297
<para>
298
File names of the form <filename>~user/foo/bar</filename>
299
and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
300
are supported.
301
</para>
302
</listitem>
303
</varlistentry>
304
305
<varlistentry>
306
198
<term><option>secret<literal> = </literal><replaceable
307
199
>BASE64_ENCODED_DATA</replaceable></option></term>
308
200
<listitem>
331
223
</para>
332
224
</listitem>
333
225
</varlistentry>
334
226
335
227
<varlistentry>
336
<term><option>timeout<literal> = </literal><replaceable
337
>TIME</replaceable></option></term>
228
<term><option>secfile<literal> = </literal><replaceable
229
>FILENAME</replaceable></option></term>
338
230
<listitem>
339
231
<para>
340
This option is <emphasis>optional</emphasis>.
341
</para>
342
<para>
343
The timeout is how long the server will wait, after a
344
successful checker run, until a client is disabled and not
345
allowed to get the data this server holds. By default
346
Mandos will use 5 minutes. See also the
347
<option>extended_timeout</option> option.
348
</para>
349
<para>
350
The <replaceable>TIME</replaceable> is specified as an RFC
351
3339 duration; for example
352
<quote><literal>P1Y2M3DT4H5M6S</literal></quote> meaning
353
one year, two months, three days, four hours, five
354
minutes, and six seconds. Some values can be omitted, see
355
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.
356
241
</para>
357
242
</listitem>
358
243
</varlistentry>
359
244
360
245
<varlistentry>
361
<term><option>enabled<literal> = </literal>{ <literal
362
>1</literal> | <literal>yes</literal> | <literal>true</literal
363
> | <literal >on</literal> | <literal>0</literal> | <literal
364
>no</literal> | <literal>false</literal> | <literal
365
>off</literal> }</option></term>
246
<term><option><literal>host = </literal><replaceable
247
>STRING</replaceable></option></term>
366
248
<listitem>
367
249
<para>
368
Whether this client should be enabled by default. The
369
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.
370
259
</para>
371
260
</listitem>
372
261
</varlistentry>
409
298
<quote><literal>%%(<replaceable>foo</replaceable>)s</literal
410
299
></quote> will be replaced by the value of the attribute
411
300
<varname>foo</varname> of the internal
412
<quote><classname>Client</classname></quote> object in the
413
Mandos server. The currently allowed values for
414
<replaceable>foo</replaceable> are:
415
<quote><literal>approval_delay</literal></quote>,
416
<quote><literal>approval_duration</literal></quote>,
417
<quote><literal>created</literal></quote>,
418
<quote><literal>enabled</literal></quote>,
419
<quote><literal>expires</literal></quote>,
420
<quote><literal>fingerprint</literal></quote>,
421
<quote><literal>host</literal></quote>,
422
<quote><literal>interval</literal></quote>,
423
<quote><literal>last_approval_request</literal></quote>,
424
<quote><literal>last_checked_ok</literal></quote>,
425
<quote><literal>last_enabled</literal></quote>,
426
<quote><literal>name</literal></quote>,
427
<quote><literal>timeout</literal></quote>, and, if using
428
D-Bus, <quote><literal>dbus_object_path</literal></quote>.
429
See the source code for details. <emphasis role="strong"
430
>Currently, <emphasis>none</emphasis> of these attributes
431
except <quote><literal>host</literal></quote> are guaranteed
432
to be valid in future versions.</emphasis> Therefore, please
433
let the authors know of any attributes that are useful so they
434
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.
435
305
</para>
436
306
<para>
437
307
Note that this means that, in order to include an actual
443
313
mode is needed to expose an error of this kind.
444
314
</para>
445
315
</refsect2>
446
316
447
317
</refsect1>
448
318
449
319
<refsect1 id="files">
465
335
<literal>%(<replaceable>foo</replaceable>)s</literal> is
466
336
obscure.
467
337
</para>
468
<xi:include href="bugs.xml"/>
469
338
</refsect1>
470
339
471
340
<refsect1 id="example">
473
342
<informalexample>
474
343
<programlisting>
475
344
[DEFAULT]
476
timeout = PT5M
477
interval = PT2M
478
checker = fping -q -- %%(host)s
345
timeout = 1h
346
interval = 5m
347
checker = fping -q -- %(host)s
479
348
480
349
# Client "foo"
481
350
[foo]
497
366
4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
498
367
QlnHIvPzEArRQLo=
499
368
host = foo.example.org
500
interval = PT1M
369
interval = 1m
501
370
502
371
# Client "bar"
503
372
[bar]
504
373
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
505
374
secfile = /etc/mandos/bar-secret
506
timeout = PT15M
507
approved_by_default = False
508
approval_delay = PT30S
375
timeout = 15m
376
509
377
</programlisting>
510
378
</informalexample>
511
379
</refsect1>
513
381
<refsect1 id="see_also">
514
382
<title>SEE ALSO</title>
515
383
<para>
516
<citerefentry><refentrytitle>intro</refentrytitle>
517
<manvolnum>8mandos</manvolnum></citerefentry>,
518
384
<citerefentry><refentrytitle>mandos-keygen</refentrytitle>
519
385
<manvolnum>8</manvolnum></citerefentry>,
520
386
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
521
387
<manvolnum>5</manvolnum></citerefentry>,
522
388
<citerefentry><refentrytitle>mandos</refentrytitle>
523
<manvolnum>8</manvolnum></citerefentry>,
524
<citerefentry><refentrytitle>fping</refentrytitle>
525
389
<manvolnum>8</manvolnum></citerefentry>
526
390
</para>
527
<variablelist>
528
<varlistentry>
529
<term>
530
RFC 3339: <citetitle>Date and Time on the Internet:
531
Timestamps</citetitle>
532
</term>
533
<listitem>
534
<para>
535
The time intervals are in the "duration" format, as
536
specified in ABNF in Appendix A of RFC 3339.
537
</para>
538
</listitem>
539
</varlistentry>
540
</variablelist>
541
391
</refsect1>
542
392
</refentry>
543
393
<!-- Local Variables: -->
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0