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 723.1.1
- compare with another revision
- download diff
- download tarball
- view history from revision 723.1.1
- Committer: Teddy Hogeborn
- Date: 2014-07-25 22:44:20 UTC
- mto: This revision was merged to the branch mainline in revision 724.
- Revision ID: teddy@recompile.se-20140725224420-4a5ct2ptt0hsc92z
Require Python 2.7.
This is in preparation for the eventual move to Python 3, which will
happen as soon as all Python modules required by Mandos are available.
The mandos-ctl and mandos-monitor programs are already portable
between Python 2.6 and Python 3 without changes; this change will
bring the requirement up to Python 2.7.
* INSTALL (Prerequisites/Libraries/Mandos Server): Document
requirement of
Python 2.7; remove
Python-argparse
which is in the
Python 2.7 standard
library.
* debian/control (Source: mandos/Build-Depends-Indep): Depend on
exactly the
python2.7
package and all
the Python 2.7
versions of the
python modules.
(Package: mandos/Depends): - '' - but still depend on python (<=2.7)
and the generic versions of the Python
modules; this is for mandos-ctl and
mandos-monitor, both of which are
compatible with Python 3, and use
#!/usr/bin/python.
* mandos: Use #!/usr/bin/python2.7 instead of #!/usr/bin/python.
This is in preparation for the eventual move to Python 3, which will
happen as soon as all Python modules required by Mandos are available.
The mandos-ctl and mandos-monitor programs are already portable
between Python 2.6 and Python 3 without changes; this change will
bring the requirement up to Python 2.7.
* INSTALL (Prerequisites/Libraries/Mandos Server): Document
requirement of
Python 2.7; remove
Python-argparse
which is in the
Python 2.7 standard
library.
* debian/control (Source: mandos/Build-Depends-Indep): Depend on
exactly the
python2.7
package and all
the Python 2.7
versions of the
python modules.
(Package: mandos/Depends): - '' - but still depend on python (<=2.7)
and the generic versions of the Python
modules; this is for mandos-ctl and
mandos-monitor, both of which are
compatible with Python 3, and use
#!/usr/bin/python.
* mandos: Use #!/usr/bin/python2.7 instead of #!/usr/bin/python.
- files added:
- .bzr-builddeb
- debian
- debian/po
- debian/source
- debian/upstream
- 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>">
6
<!ENTITY TIMESTAMP "2014-06-22">
7
<!ENTITY % common SYSTEM "common.ent">
8
%common;
7
9
]>
8
10
9
<refentry>
11
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
10
12
<refentryinfo>
11
<title>&CONFNAME;</title>
13
<title>Mandos Manual</title>
12
14
<!-- NWalsh’s docbook scripts use this to generate the footer: -->
13
<productname>&CONFNAME;</productname>
14
<productnumber>&VERSION;</productnumber>
15
<productname>Mandos</productname>
16
<productnumber>&version;</productnumber>
17
<date>&TIMESTAMP;</date>
15
18
<authorgroup>
16
19
<author>
17
20
<firstname>Björn</firstname>
18
21
<surname>Påhlsson</surname>
19
22
<address>
20
<email>belorn@fukt.bsnet.se</email>
23
<email>belorn@recompile.se</email>
21
24
</address>
22
25
</author>
23
26
<author>
24
27
<firstname>Teddy</firstname>
25
28
<surname>Hogeborn</surname>
26
29
<address>
27
<email>teddy@fukt.bsnet.se</email>
30
<email>teddy@recompile.se</email>
28
31
</address>
29
32
</author>
30
33
</authorgroup>
31
34
<copyright>
32
35
<year>2008</year>
36
<year>2009</year>
37
<year>2010</year>
38
<year>2011</year>
39
<year>2012</year>
33
40
<holder>Teddy Hogeborn</holder>
34
41
<holder>Björn Påhlsson</holder>
35
42
</copyright>
36
<legalnotice>
37
<para>
38
This manual page is free software: you can redistribute it
39
and/or modify it under the terms of the GNU General Public
40
License as published by the Free Software Foundation,
41
either version 3 of the License, or (at your option) any
42
later version.
43
</para>
44
45
<para>
46
This manual page is distributed in the hope that it will
47
be useful, but WITHOUT ANY WARRANTY; without even the
48
implied warranty of MERCHANTABILITY or FITNESS FOR A
49
PARTICULAR PURPOSE. See the GNU General Public License
50
for more details.
51
</para>
52
53
<para>
54
You should have received a copy of the GNU General Public
55
License along with this program; If not, see
56
<ulink url="http://www.gnu.org/licenses/"/>.
57
</para>
58
</legalnotice>
43
<xi:include href="legalnotice.xml"/>
59
44
</refentryinfo>
60
45
61
46
<refmeta>
62
47
<refentrytitle>&CONFNAME;</refentrytitle>
63
48
<manvolnum>5</manvolnum>
69
54
Configuration file for the Mandos server
70
55
</refpurpose>
71
56
</refnamediv>
72
57
73
58
<refsynopsisdiv>
74
<synopsis>
75
&CONFPATH;
76
</synopsis>
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><literal><varname>timeout</varname></literal></term>
125
<listitem>
126
<synopsis><literal>timeout = </literal><replaceable
127
>TIME</replaceable>
128
</synopsis>
129
<para>
130
The timeout is how long the server will wait for a
131
successful checker run until a client is considered
132
invalid - that is, ineligible to get the data this server
133
holds. By default Mandos will use 1 hour.
134
</para>
135
<para>
136
The <replaceable>TIME</replaceable> is specified as a
137
space-separated number of values, each of which is a
138
number and a one-character suffix. The suffix must be one
139
of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
140
<quote>h</quote>, and <quote>w</quote> for days, seconds,
141
minutes, hours, and weeks, respectively. The values are
142
added together to give the total time value, so all of
143
<quote><literal>330s</literal></quote>,
144
<quote><literal>110s 110s 110s</literal></quote>, and
145
<quote><literal>5m 30s</literal></quote> will give a value
146
of five minutes and thirty seconds.
147
</para>
148
</listitem>
149
</varlistentry>
150
151
<varlistentry>
152
<term><literal><varname>interval</varname></literal></term>
153
<listitem>
154
<synopsis><literal>interval = </literal><replaceable
155
>TIME</replaceable>
156
</synopsis>
157
<para>
158
How often to run the checker to confirm that a client is
159
still up. <emphasis>Note:</emphasis> a new checker will
160
not be started if an old one is still running. The server
161
will wait for a checker to complete until the above
162
<quote><varname>timeout</varname></quote> occurs, at which
163
time the client will be marked invalid, and any running
164
checker killed. The default interval is 5 minutes.
165
</para>
166
<para>
167
The format of <replaceable>TIME</replaceable> is the same
168
as for <varname>timeout</varname> above.
169
</para>
170
</listitem>
171
</varlistentry>
172
173
<varlistentry>
174
<term><literal>checker</literal></term>
175
<listitem>
176
<synopsis><literal>checker = </literal><replaceable
177
>COMMAND</replaceable>
178
</synopsis>
179
<para>
180
This option allows you to override the default shell
181
command that the server will use to check if the client is
182
still up. Any output of the command will be ignored, only
183
the exit code is checked: If the exit code of the command
184
is zero, the client is considered up. The command will be
185
run using <quote><command><filename>/bin/sh</filename>
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>PT0S</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
162
<varlistentry>
163
<term><option>checker<literal> = </literal><replaceable
164
>COMMAND</replaceable></option></term>
165
<listitem>
166
<para>
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>
186
176
<option>-c</option></command></quote>, so
187
177
<varname>PATH</varname> will be searched. The default
188
178
value for the checker command is <quote><literal
189
179
><command>fping</command> <option>-q</option> <option
190
>--</option> %(host)s</literal></quote>.
180
>--</option> %%(host)s</literal></quote>. Note that
181
<command>mandos-keygen</command>, when generating output
182
to be inserted into this file, normally looks for an SSH
183
server on the Mandos client, and, if it find one, outputs
184
a <option>checker</option> option to check for the
185
client’s key fingerprint – this is more secure against
186
spoofing.
191
187
</para>
192
188
<para>
193
189
In addition to normal start time expansion, this option
198
194
</varlistentry>
199
195
200
196
<varlistentry>
201
<term><literal>fingerprint</literal></term>
202
<listitem>
203
<synopsis><literal>fingerprint = </literal><replaceable
204
>HEXSTRING</replaceable>
205
</synopsis>
197
<term><option>extended_timeout<literal> = </literal><replaceable
198
>TIME</replaceable></option></term>
199
<listitem>
200
<para>
201
This option is <emphasis>optional</emphasis>.
202
</para>
203
<para>
204
Extended timeout is an added timeout that is given once
205
after a password has been sent successfully to a client.
206
The timeout is by default longer than the normal timeout,
207
and is used for handling the extra long downtime while a
208
machine is booting up. Time to take into consideration
209
when changing this value is file system checks and quota
210
checks. The default value is 15 minutes.
211
</para>
212
<para>
213
The format of <replaceable>TIME</replaceable> is the same
214
as for <varname>timeout</varname> below.
215
</para>
216
</listitem>
217
</varlistentry>
218
219
<varlistentry>
220
<term><option>fingerprint<literal> = </literal
221
><replaceable>HEXSTRING</replaceable></option></term>
222
<listitem>
223
<para>
224
This option is <emphasis>required</emphasis>.
225
</para>
206
226
<para>
207
227
This option sets the OpenPGP fingerprint that identifies
208
228
the public key that clients authenticate themselves with
213
233
</varlistentry>
214
234
215
235
<varlistentry>
216
<term><literal>secret</literal></term>
217
<listitem>
218
<synopsis><literal>secret = </literal><replaceable
219
>BASE64_ENCODED_DATA</replaceable>
220
</synopsis>
236
<term><option><literal>host = </literal><replaceable
237
>STRING</replaceable></option></term>
238
<listitem>
239
<para>
240
This option is <emphasis>optional</emphasis>, but highly
241
<emphasis>recommended</emphasis> unless the
242
<option>checker</option> option is modified to a
243
non-standard value without <quote>%%(host)s</quote> in it.
244
</para>
245
<para>
246
Host name for this client. This is not used by the server
247
directly, but can be, and is by default, used by the
248
checker. See the <option>checker</option> option.
249
</para>
250
</listitem>
251
</varlistentry>
252
253
<varlistentry>
254
<term><option>interval<literal> = </literal><replaceable
255
>TIME</replaceable></option></term>
256
<listitem>
257
<para>
258
This option is <emphasis>optional</emphasis>.
259
</para>
260
<para>
261
How often to run the checker to confirm that a client is
262
still up. <emphasis>Note:</emphasis> a new checker will
263
not be started if an old one is still running. The server
264
will wait for a checker to complete until the below
265
<quote><varname>timeout</varname></quote> occurs, at which
266
time the client will be disabled, and any running checker
267
killed. The default interval is 2 minutes.
268
</para>
269
<para>
270
The format of <replaceable>TIME</replaceable> is the same
271
as for <varname>timeout</varname> below.
272
</para>
273
</listitem>
274
</varlistentry>
275
276
<varlistentry>
277
<term><option>secfile<literal> = </literal><replaceable
278
>FILENAME</replaceable></option></term>
279
<listitem>
280
<para>
281
This option is only used if <option>secret</option> is not
282
specified, in which case this option is
283
<emphasis>required</emphasis>.
284
</para>
285
<para>
286
Similar to the <option>secret</option>, except the secret
287
data is in an external file. The contents of the file
288
should <emphasis>not</emphasis> be base64-encoded, but
289
will be sent to clients verbatim.
290
</para>
291
<para>
292
File names of the form <filename>~user/foo/bar</filename>
293
and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
294
are supported.
295
</para>
296
</listitem>
297
</varlistentry>
298
299
<varlistentry>
300
<term><option>secret<literal> = </literal><replaceable
301
>BASE64_ENCODED_DATA</replaceable></option></term>
302
<listitem>
303
<para>
304
If this option is not specified, the <option
305
>secfile</option> option is <emphasis>required</emphasis>
306
to be present.
307
</para>
221
308
<para>
222
309
If present, this option must be set to a string of
223
310
base64-encoded binary data. It will be decoded and sent
236
323
lines is that a line beginning with white space adds to
237
324
the value of the previous line, RFC 822-style.
238
325
</para>
239
<para>
240
If this option is not specified, the <option
241
>secfile</option> option is used instead, but one of them
242
<emphasis>must</emphasis> be present.
243
</para>
244
</listitem>
245
</varlistentry>
246
247
<varlistentry>
248
<term><literal>secfile</literal></term>
249
<listitem>
250
<synopsis><literal>secfile = </literal><replaceable
251
>FILENAME</replaceable>
252
</synopsis>
253
<para>
254
The same as <option>secret</option>, but the secret data
255
is in an external file. The contents of the file should
256
<emphasis>not</emphasis> be base64-encoded, but will be
257
sent to clients verbatim.
258
</para>
259
<para>
260
This option is only used, and <emphasis>must</emphasis> be
261
present, if <option>secret</option> is not specified.
262
</para>
263
</listitem>
264
</varlistentry>
265
266
<varlistentry>
267
<term><literal>host</literal></term>
268
<listitem>
269
<synopsis><literal>host = </literal><replaceable
270
>STRING</replaceable>
271
</synopsis>
272
<para>
273
Host name for this client. This is not used by the server
274
directly, but can be, and is by default, used by the
275
checker. See the <option>checker</option> option.
326
</listitem>
327
</varlistentry>
328
329
<varlistentry>
330
<term><option>timeout<literal> = </literal><replaceable
331
>TIME</replaceable></option></term>
332
<listitem>
333
<para>
334
This option is <emphasis>optional</emphasis>.
335
</para>
336
<para>
337
The timeout is how long the server will wait, after a
338
successful checker run, until a client is disabled and not
339
allowed to get the data this server holds. By default
340
Mandos will use 5 minutes. See also the
341
<option>extended_timeout</option> option.
342
</para>
343
<para>
344
The <replaceable>TIME</replaceable> is specified as an RFC
345
3339 duration; for example
346
<quote><literal>P1Y2M3DT4H5M6S</literal></quote> meaning
347
one year, two months, three days, four hours, five
348
minutes, and six seconds. Some values can be omitted, see
349
RFC 3339 Appendix A for details.
350
</para>
351
</listitem>
352
</varlistentry>
353
354
<varlistentry>
355
<term><option>enabled<literal> = </literal>{ <literal
356
>1</literal> | <literal>yes</literal> | <literal>true</literal
357
> | <literal >on</literal> | <literal>0</literal> | <literal
358
>no</literal> | <literal>false</literal> | <literal
359
>off</literal> }</option></term>
360
<listitem>
361
<para>
362
Whether this client should be enabled by default. The
363
default is <quote>true</quote>.
276
364
</para>
277
365
</listitem>
278
366
</varlistentry>
279
367
280
368
</variablelist>
281
</refsect1>
369
</refsect1>
282
370
283
371
<refsect1 id="expansion">
284
372
<title>EXPANSION</title>
315
403
<quote><literal>%%(<replaceable>foo</replaceable>)s</literal
316
404
></quote> will be replaced by the value of the attribute
317
405
<varname>foo</varname> of the internal
318
<quote><classname>Client</classname></quote> object. See the
319
source code for details, and let the authors know of any
320
attributes that are useful so they may be preserved to any new
321
versions of this software.
406
<quote><classname>Client</classname></quote> object in the
407
Mandos server. The currently allowed values for
408
<replaceable>foo</replaceable> are:
409
<quote><literal>approval_delay</literal></quote>,
410
<quote><literal>approval_duration</literal></quote>,
411
<quote><literal>created</literal></quote>,
412
<quote><literal>enabled</literal></quote>,
413
<quote><literal>expires</literal></quote>,
414
<quote><literal>fingerprint</literal></quote>,
415
<quote><literal>host</literal></quote>,
416
<quote><literal>interval</literal></quote>,
417
<quote><literal>last_approval_request</literal></quote>,
418
<quote><literal>last_checked_ok</literal></quote>,
419
<quote><literal>last_enabled</literal></quote>,
420
<quote><literal>name</literal></quote>,
421
<quote><literal>timeout</literal></quote>, and, if using
422
D-Bus, <quote><literal>dbus_object_path</literal></quote>.
423
See the source code for details. <emphasis role="strong"
424
>Currently, <emphasis>none</emphasis> of these attributes
425
except <quote><literal>host</literal></quote> are guaranteed
426
to be valid in future versions.</emphasis> Therefore, please
427
let the authors know of any attributes that are useful so they
428
may be preserved to any new versions of this software.
322
429
</para>
323
430
<para>
324
431
Note that this means that, in order to include an actual
327
434
percent characters in a row (<quote>%%%%</quote>) must be
328
435
entered. Also, a bad format here will lead to an immediate
329
436
but <emphasis>silent</emphasis> run-time fatal exit; debug
330
mode is needed to track down an error of this kind.
437
mode is needed to expose an error of this kind.
331
438
</para>
332
439
</refsect2>
333
334
</refsect1>
440
441
</refsect1>
335
442
336
443
<refsect1 id="files">
337
444
<title>FILES</title>
359
466
<informalexample>
360
467
<programlisting>
361
468
[DEFAULT]
362
timeout = 1h
363
interval = 5m
364
checker = fping -q -- %(host)s
469
timeout = PT5M
470
interval = PT2M
471
checker = fping -q -- %%(host)s
365
472
366
473
# Client "foo"
367
474
[foo]
383
490
4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
384
491
QlnHIvPzEArRQLo=
385
492
host = foo.example.org
386
interval = 1m
493
interval = PT1M
387
494
388
495
# Client "bar"
389
496
[bar]
390
497
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
391
498
secfile = /etc/mandos/bar-secret
392
timeout = 15m
393
499
timeout = PT15M
500
approved_by_default = False
501
approval_delay = PT30S
394
502
</programlisting>
395
503
</informalexample>
396
</refsect1>
504
</refsect1>
397
505
398
506
<refsect1 id="see_also">
399
507
<title>SEE ALSO</title>
400
508
<para>
401
<citerefentry>
402
<refentrytitle>mandos</refentrytitle>
403
<manvolnum>8</manvolnum></citerefentry>, <citerefentry>
404
<refentrytitle>mandos-keygen</refentrytitle>
405
<manvolnum>8</manvolnum></citerefentry>, <citerefentry>
406
<refentrytitle>mandos.conf</refentrytitle>
407
<manvolnum>5</manvolnum></citerefentry>
509
<citerefentry><refentrytitle>intro</refentrytitle>
510
<manvolnum>8mandos</manvolnum></citerefentry>,
511
<citerefentry><refentrytitle>mandos-keygen</refentrytitle>
512
<manvolnum>8</manvolnum></citerefentry>,
513
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
514
<manvolnum>5</manvolnum></citerefentry>,
515
<citerefentry><refentrytitle>mandos</refentrytitle>
516
<manvolnum>8</manvolnum></citerefentry>,
517
<citerefentry><refentrytitle>fping</refentrytitle>
518
<manvolnum>8</manvolnum></citerefentry>
408
519
</para>
520
<variablelist>
521
<varlistentry>
522
<term>
523
RFC 3339: <citetitle>Date and Time on the Internet:
524
Timestamps</citetitle>
525
</term>
526
<listitem>
527
<para>
528
The time intervals are in the "duration" format, as
529
specified in ABNF in Appendix A of RFC 3339.
530
</para>
531
</listitem>
532
</varlistentry>
533
</variablelist>
409
534
</refsect1>
410
535
</refentry>
536
<!-- Local Variables: -->
537
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
538
<!-- time-stamp-end: "[\"']>" -->
539
<!-- time-stamp-format: "%:y-%02m-%02d" -->
540
<!-- End: -->
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0