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 612
- compare with another revision
- download diff
- download tarball
- view history from revision 612
- Committer: Björn Påhlsson
- Date: 2012-07-03 20:55:09 UTC
- Revision ID: belorn@recompile.se-20120703205509-fkeb6uqy4i6gt4b6
added note messages when mandos-monitor starts without running server,
or a server with no clients.
or a server with no clients.
- files added:
- .bzr-builddeb
- debian
- debian/po
- debian/source
- network-hooks.d
- files removed:
- plugins.d/usplash
- files renamed:
- plugins.d/password-request.c => plugins.d/mandos-client.c
- plugins.d/password-request.xml => plugins.d/mandos-client.xml
- files modified:
- .bzrignore
added
removed
mandos-clients.conf.xml
1
<?xml version='1.0' encoding='UTF-8'?>
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">
5
4
<!ENTITY CONFNAME "mandos-clients.conf">
6
5
<!ENTITY CONFPATH "<filename>/etc/mandos/clients.conf</filename>">
7
<!ENTITY TIMESTAMP "2008-08-30">
6
<!ENTITY TIMESTAMP "2012-06-23">
7
<!ENTITY % common SYSTEM "common.ent">
8
%common;
8
9
]>
9
10
10
<refentry>
11
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
11
12
<refentryinfo>
12
13
<title>Mandos Manual</title>
13
14
<!-- NWalsh’s docbook scripts use this to generate the footer: -->
14
15
<productname>Mandos</productname>
15
<productnumber>&VERSION;</productnumber>
16
<productnumber>&version;</productnumber>
16
17
<date>&TIMESTAMP;</date>
17
18
<authorgroup>
18
19
<author>
19
20
<firstname>Björn</firstname>
20
21
<surname>Påhlsson</surname>
21
22
<address>
22
<email>belorn@fukt.bsnet.se</email>
23
<email>belorn@recompile.se</email>
23
24
</address>
24
25
</author>
25
26
<author>
26
27
<firstname>Teddy</firstname>
27
28
<surname>Hogeborn</surname>
28
29
<address>
29
<email>teddy@fukt.bsnet.se</email>
30
<email>teddy@recompile.se</email>
30
31
</address>
31
32
</author>
32
33
</authorgroup>
33
34
<copyright>
34
35
<year>2008</year>
36
<year>2009</year>
37
<year>2010</year>
38
<year>2011</year>
39
<year>2012</year>
35
40
<holder>Teddy Hogeborn</holder>
36
41
<holder>Björn Påhlsson</holder>
37
42
</copyright>
38
<legalnotice>
39
<para>
40
This manual page is free software: you can redistribute it
41
and/or modify it under the terms of the GNU General Public
42
License as published by the Free Software Foundation,
43
either version 3 of the License, or (at your option) any
44
later version.
45
</para>
46
47
<para>
48
This manual page is distributed in the hope that it will
49
be useful, but WITHOUT ANY WARRANTY; without even the
50
implied warranty of MERCHANTABILITY or FITNESS FOR A
51
PARTICULAR PURPOSE. See the GNU General Public License
52
for more details.
53
</para>
54
55
<para>
56
You should have received a copy of the GNU General Public
57
License along with this program; If not, see
58
<ulink url="http://www.gnu.org/licenses/"/>.
59
</para>
60
</legalnotice>
43
<xi:include href="legalnotice.xml"/>
61
44
</refentryinfo>
62
45
63
46
<refmeta>
64
47
<refentrytitle>&CONFNAME;</refentrytitle>
65
48
<manvolnum>5</manvolnum>
71
54
Configuration file for the Mandos server
72
55
</refpurpose>
73
56
</refnamediv>
74
57
75
58
<refsynopsisdiv>
76
59
<synopsis>&CONFPATH;</synopsis>
77
60
</refsynopsisdiv>
78
61
79
62
<refsect1 id="description">
80
63
<title>DESCRIPTION</title>
81
64
<para>
83
66
><refentrytitle>mandos</refentrytitle>
84
67
<manvolnum>8</manvolnum></citerefentry>, read by it at startup.
85
68
The file needs to list all clients that should be able to use
86
the service. All clients listed will be regarded as valid, even
87
if a client was declared invalid in a previous run of the
88
server.
69
the service. The settings in this file can be overridden by
70
runtime changes to the server, which it saves across restarts.
71
(See the section called <quote>PERSISTENT STATE</quote> in
72
<citerefentry><refentrytitle>mandos</refentrytitle><manvolnum
73
>8</manvolnum></citerefentry>.) However, any <emphasis
74
>changes</emphasis> to this file (including adding and removing
75
clients) will, at startup, override changes done during runtime.
89
76
</para>
90
77
<para>
91
78
The format starts with a <literal>[<replaceable>section
115
102
start time expansion, see <xref linkend="expansion"/>.
116
103
</para>
117
104
<para>
118
Uknown options are ignored. The used options are as follows:
105
Unknown options are ignored. The used options are as follows:
119
106
</para>
120
107
121
108
<variablelist>
122
123
<varlistentry>
124
<term><option>timeout<literal> = </literal><replaceable
125
>TIME</replaceable></option></term>
126
<listitem>
127
<para>
128
The timeout is how long the server will wait for a
129
successful checker run until a client is considered
130
invalid - that is, ineligible to get the data this server
131
holds. By default Mandos will use 1 hour.
132
</para>
133
<para>
134
The <replaceable>TIME</replaceable> is specified as a
135
space-separated number of values, each of which is a
136
number and a one-character suffix. The suffix must be one
137
of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
138
<quote>h</quote>, and <quote>w</quote> for days, seconds,
139
minutes, hours, and weeks, respectively. The values are
140
added together to give the total time value, so all of
141
<quote><literal>330s</literal></quote>,
142
<quote><literal>110s 110s 110s</literal></quote>, and
143
<quote><literal>5m 30s</literal></quote> will give a value
144
of five minutes and thirty seconds.
145
</para>
146
</listitem>
147
</varlistentry>
148
149
<varlistentry>
150
<term><option>interval<literal> = </literal><replaceable
151
>TIME</replaceable></option></term>
152
<listitem>
153
<para>
154
How often to run the checker to confirm that a client is
155
still up. <emphasis>Note:</emphasis> a new checker will
156
not be started if an old one is still running. The server
157
will wait for a checker to complete until the above
158
<quote><varname>timeout</varname></quote> occurs, at which
159
time the client will be marked invalid, and any running
160
checker killed. The default interval is 5 minutes.
161
</para>
162
<para>
163
The format of <replaceable>TIME</replaceable> is the same
164
as for <varname>timeout</varname> above.
165
</para>
166
</listitem>
167
</varlistentry>
168
109
110
<varlistentry>
111
<term><option>approval_delay<literal> = </literal><replaceable
112
>TIME</replaceable></option></term>
113
<listitem>
114
<para>
115
This option is <emphasis>optional</emphasis>.
116
</para>
117
<para>
118
How long to wait for external approval before resorting to
119
use the <option>approved_by_default</option> value. The
120
default is <quote>0s</quote>, i.e. not to wait.
121
</para>
122
<para>
123
The format of <replaceable>TIME</replaceable> is the same
124
as for <varname>timeout</varname> below.
125
</para>
126
</listitem>
127
</varlistentry>
128
129
<varlistentry>
130
<term><option>approval_duration<literal> = </literal
131
><replaceable>TIME</replaceable></option></term>
132
<listitem>
133
<para>
134
This option is <emphasis>optional</emphasis>.
135
</para>
136
<para>
137
How long an external approval lasts. The default is 1
138
second.
139
</para>
140
<para>
141
The format of <replaceable>TIME</replaceable> is the same
142
as for <varname>timeout</varname> below.
143
</para>
144
</listitem>
145
</varlistentry>
146
147
<varlistentry>
148
<term><option>approved_by_default<literal> = </literal
149
>{ <literal >1</literal> | <literal>yes</literal> | <literal
150
>true</literal> | <literal>on</literal> | <literal
151
>0</literal> | <literal>no</literal> | <literal
152
>false</literal> | <literal>off</literal> }</option></term>
153
<listitem>
154
<para>
155
Whether to approve a client by default after
156
the <option>approval_delay</option>. The default
157
is <quote>True</quote>.
158
</para>
159
</listitem>
160
</varlistentry>
161
169
162
<varlistentry>
170
163
<term><option>checker<literal> = </literal><replaceable
171
164
>COMMAND</replaceable></option></term>
172
165
<listitem>
173
166
<para>
174
This option allows you to override the default shell
175
command that the server will use to check if the client is
176
still up. Any output of the command will be ignored, only
177
the exit code is checked: If the exit code of the command
178
is zero, the client is considered up. The command will be
179
run using <quote><command><filename>/bin/sh</filename>
167
This option is <emphasis>optional</emphasis>.
168
</para>
169
<para>
170
This option overrides the default shell command that the
171
server will use to check if the client is still up. Any
172
output of the command will be ignored, only the exit code
173
is checked: If the exit code of the command is zero, the
174
client is considered up. The command will be run using
175
<quote><command><filename>/bin/sh</filename>
180
176
<option>-c</option></command></quote>, so
181
177
<varname>PATH</varname> will be searched. The default
182
178
value for the checker command is <quote><literal
183
179
><command>fping</command> <option>-q</option> <option
184
>--</option> %(host)s</literal></quote>.
180
>--</option> %%(host)s</literal></quote>.
185
181
</para>
186
182
<para>
187
183
In addition to normal start time expansion, this option
192
188
</varlistentry>
193
189
194
190
<varlistentry>
191
<term><option>extended_timeout<literal> = </literal><replaceable
192
>TIME</replaceable></option></term>
193
<listitem>
194
<para>
195
This option is <emphasis>optional</emphasis>.
196
</para>
197
<para>
198
Extended timeout is an added timeout that is given once
199
after a password has been sent successfully to a client.
200
The timeout is by default longer than the normal timeout,
201
and is used for handling the extra long downtime while a
202
machine is booting up. Time to take into consideration
203
when changing this value is file system checks and quota
204
checks. The default value is 15 minutes.
205
</para>
206
<para>
207
The format of <replaceable>TIME</replaceable> is the same
208
as for <varname>timeout</varname> below.
209
</para>
210
</listitem>
211
</varlistentry>
212
213
<varlistentry>
195
214
<term><option>fingerprint<literal> = </literal
196
215
><replaceable>HEXSTRING</replaceable></option></term>
197
216
<listitem>
198
217
<para>
218
This option is <emphasis>required</emphasis>.
219
</para>
220
<para>
199
221
This option sets the OpenPGP fingerprint that identifies
200
222
the public key that clients authenticate themselves with
201
223
through TLS. The string needs to be in hexidecimal form,
205
227
</varlistentry>
206
228
207
229
<varlistentry>
230
<term><option><literal>host = </literal><replaceable
231
>STRING</replaceable></option></term>
232
<listitem>
233
<para>
234
This option is <emphasis>optional</emphasis>, but highly
235
<emphasis>recommended</emphasis> unless the
236
<option>checker</option> option is modified to a
237
non-standard value without <quote>%%(host)s</quote> in it.
238
</para>
239
<para>
240
Host name for this client. This is not used by the server
241
directly, but can be, and is by default, used by the
242
checker. See the <option>checker</option> option.
243
</para>
244
</listitem>
245
</varlistentry>
246
247
<varlistentry>
248
<term><option>interval<literal> = </literal><replaceable
249
>TIME</replaceable></option></term>
250
<listitem>
251
<para>
252
This option is <emphasis>optional</emphasis>.
253
</para>
254
<para>
255
How often to run the checker to confirm that a client is
256
still up. <emphasis>Note:</emphasis> a new checker will
257
not be started if an old one is still running. The server
258
will wait for a checker to complete until the below
259
<quote><varname>timeout</varname></quote> occurs, at which
260
time the client will be disabled, and any running checker
261
killed. The default interval is 2 minutes.
262
</para>
263
<para>
264
The format of <replaceable>TIME</replaceable> is the same
265
as for <varname>timeout</varname> below.
266
</para>
267
</listitem>
268
</varlistentry>
269
270
<varlistentry>
271
<term><option>secfile<literal> = </literal><replaceable
272
>FILENAME</replaceable></option></term>
273
<listitem>
274
<para>
275
This option is only used if <option>secret</option> is not
276
specified, in which case this option is
277
<emphasis>required</emphasis>.
278
</para>
279
<para>
280
Similar to the <option>secret</option>, except the secret
281
data is in an external file. The contents of the file
282
should <emphasis>not</emphasis> be base64-encoded, but
283
will be sent to clients verbatim.
284
</para>
285
<para>
286
File names of the form <filename>~user/foo/bar</filename>
287
and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
288
are supported.
289
</para>
290
</listitem>
291
</varlistentry>
292
293
<varlistentry>
208
294
<term><option>secret<literal> = </literal><replaceable
209
295
>BASE64_ENCODED_DATA</replaceable></option></term>
210
296
<listitem>
211
297
<para>
298
If this option is not specified, the <option
299
>secfile</option> option is <emphasis>required</emphasis>
300
to be present.
301
</para>
302
<para>
212
303
If present, this option must be set to a string of
213
304
base64-encoded binary data. It will be decoded and sent
214
305
to the client matching the above
226
317
lines is that a line beginning with white space adds to
227
318
the value of the previous line, RFC 822-style.
228
319
</para>
229
<para>
230
If this option is not specified, the <option
231
>secfile</option> option is used instead, but one of them
232
<emphasis>must</emphasis> be present.
233
</para>
234
</listitem>
235
</varlistentry>
236
237
<varlistentry>
238
<term><option>secfile<literal> = </literal><replaceable
239
>FILENAME</replaceable></option></term>
240
<listitem>
241
<para>
242
Similar to the <option>secret</option>, except the secret
243
data is in an external file. The contents of the file
244
should <emphasis>not</emphasis> be base64-encoded, but
245
will be sent to clients verbatim.
246
</para>
247
<para>
248
This option is only used, and <emphasis>must</emphasis> be
249
present, if <option>secret</option> is not specified.
250
</para>
251
</listitem>
252
</varlistentry>
253
254
<varlistentry>
255
<term><option><literal>host = </literal><replaceable
256
>STRING</replaceable></option></term>
257
<listitem>
258
<para>
259
Host name for this client. This is not used by the server
260
directly, but can be, and is by default, used by the
261
checker. See the <option>checker</option> option.
320
</listitem>
321
</varlistentry>
322
323
<varlistentry>
324
<term><option>timeout<literal> = </literal><replaceable
325
>TIME</replaceable></option></term>
326
<listitem>
327
<para>
328
This option is <emphasis>optional</emphasis>.
329
</para>
330
<para>
331
The timeout is how long the server will wait, after a
332
successful checker run, until a client is disabled and not
333
allowed to get the data this server holds. By default
334
Mandos will use 5 minutes. See also the
335
<option>extended_timeout</option> option.
336
</para>
337
<para>
338
The <replaceable>TIME</replaceable> is specified as an RFC
339
3339 duration; for example
340
<quote><literal>P1Y2M3DT4H5M6S</literal></quote> meaning
341
one year, two months, three days, four hours, five
342
minutes, and six seconds. Some values can be omitted, see
343
RFC 3339 Appendix A for details.
344
</para>
345
</listitem>
346
</varlistentry>
347
348
<varlistentry>
349
<term><option>enabled<literal> = </literal>{ <literal
350
>1</literal> | <literal>yes</literal> | <literal>true</literal
351
> | <literal >on</literal> | <literal>0</literal> | <literal
352
>no</literal> | <literal>false</literal> | <literal
353
>off</literal> }</option></term>
354
<listitem>
355
<para>
356
Whether this client should be enabled by default. The
357
default is <quote>true</quote>.
262
358
</para>
263
359
</listitem>
264
360
</varlistentry>
301
397
<quote><literal>%%(<replaceable>foo</replaceable>)s</literal
302
398
></quote> will be replaced by the value of the attribute
303
399
<varname>foo</varname> of the internal
304
<quote><classname>Client</classname></quote> object. See the
305
source code for details, and let the authors know of any
306
attributes that are useful so they may be preserved to any new
307
versions of this software.
400
<quote><classname>Client</classname></quote> object in the
401
Mandos server. The currently allowed values for
402
<replaceable>foo</replaceable> are:
403
<quote><literal>approval_delay</literal></quote>,
404
<quote><literal>approval_duration</literal></quote>,
405
<quote><literal>created</literal></quote>,
406
<quote><literal>enabled</literal></quote>,
407
<quote><literal>expires</literal></quote>,
408
<quote><literal>fingerprint</literal></quote>,
409
<quote><literal>host</literal></quote>,
410
<quote><literal>interval</literal></quote>,
411
<quote><literal>last_approval_request</literal></quote>,
412
<quote><literal>last_checked_ok</literal></quote>,
413
<quote><literal>last_enabled</literal></quote>,
414
<quote><literal>name</literal></quote>,
415
<quote><literal>timeout</literal></quote>, and, if using
416
D-Bus, <quote><literal>dbus_object_path</literal></quote>.
417
See the source code for details. <emphasis role="strong"
418
>Currently, <emphasis>none</emphasis> of these attributes
419
except <quote><literal>host</literal></quote> are guaranteed
420
to be valid in future versions.</emphasis> Therefore, please
421
let the authors know of any attributes that are useful so they
422
may be preserved to any new versions of this software.
308
423
</para>
309
424
<para>
310
425
Note that this means that, in order to include an actual
316
431
mode is needed to expose an error of this kind.
317
432
</para>
318
433
</refsect2>
319
434
320
435
</refsect1>
321
436
322
437
<refsect1 id="files">
345
460
<informalexample>
346
461
<programlisting>
347
462
[DEFAULT]
348
timeout = 1h
349
interval = 5m
350
checker = fping -q -- %(host)s
463
timeout = PT5M
464
interval = PT2M
465
checker = fping -q -- %%(host)s
351
466
352
467
# Client "foo"
353
468
[foo]
369
484
4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
370
485
QlnHIvPzEArRQLo=
371
486
host = foo.example.org
372
interval = 1m
487
interval = PT1M
373
488
374
489
# Client "bar"
375
490
[bar]
376
491
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
377
492
secfile = /etc/mandos/bar-secret
378
timeout = 15m
379
493
timeout = PT15M
494
approved_by_default = False
495
approval_delay = PT30S
380
496
</programlisting>
381
497
</informalexample>
382
498
</refsect1>
384
500
<refsect1 id="see_also">
385
501
<title>SEE ALSO</title>
386
502
<para>
503
<citerefentry><refentrytitle>intro</refentrytitle>
504
<manvolnum>8mandos</manvolnum></citerefentry>,
387
505
<citerefentry><refentrytitle>mandos-keygen</refentrytitle>
388
506
<manvolnum>8</manvolnum></citerefentry>,
389
507
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
390
508
<manvolnum>5</manvolnum></citerefentry>,
391
509
<citerefentry><refentrytitle>mandos</refentrytitle>
510
<manvolnum>8</manvolnum></citerefentry>,
511
<citerefentry><refentrytitle>fping</refentrytitle>
392
512
<manvolnum>8</manvolnum></citerefentry>
393
513
</para>
514
<variablelist>
515
<varlistentry>
516
<term>
517
RFC 3339: <citetitle>Date and Time on the Internet:
518
Timestamps</citetitle>
519
</term>
520
<listitem>
521
<para>
522
The time intervals are in the "duration" format, as
523
specified in ABNF in Appendix A of RFC 3339.
524
</para>
525
</listitem>
526
</varlistentry>
527
</variablelist>
394
528
</refsect1>
395
529
</refentry>
396
530
<!-- Local Variables: -->
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0