To get this branch, use:
bzr branch
http://bzr.recompile.se/loggerhead/mandos/release
« back to all changes in this revision
Viewing changes to mandos-clients.conf.xml
- browse files at revision 206
- compare with another revision
- download diff
- download tarball
- view history from revision 206
- Committer: Teddy Hogeborn
- Date: 2008-09-23 18:52:33 UTC
- Revision ID: teddy@fukt.bsnet.se-20080923185233-a6zir2neltxk2qvd
* debian/mandos-client.lintian-overrides: Ignore setuid
"plugins.d/splashy".
"plugins.d/splashy".
- files added:
- debian/mandos-client.config
- files removed:
- DBUS-API
- debian/source
- debian/tests
- debian/upstream
- dracut-module
- 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 "2019-02-10">
7
<!ENTITY % common SYSTEM "common.ent">
8
%common;
7
<!ENTITY TIMESTAMP "2008-09-12">
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
<year>2019</year>
47
35
<holder>Teddy Hogeborn</holder>
48
36
<holder>Björn Påhlsson</holder>
49
37
</copyright>
73
61
><refentrytitle>mandos</refentrytitle>
74
62
<manvolnum>8</manvolnum></citerefentry>, read by it at startup.
75
63
The file needs to list all clients that should be able to use
76
the service. The settings in this file can be overridden by
77
runtime changes to the server, which it saves across restarts.
78
(See the section called <quote>PERSISTENT STATE</quote> in
79
<citerefentry><refentrytitle>mandos</refentrytitle><manvolnum
80
>8</manvolnum></citerefentry>.) However, any <emphasis
81
>changes</emphasis> to this file (including adding and removing
82
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.
83
67
</para>
84
68
<para>
85
69
The format starts with a <literal>[<replaceable>section
115
99
<variablelist>
116
100
117
101
<varlistentry>
118
<term><option>approval_delay<literal> = </literal><replaceable
119
>TIME</replaceable></option></term>
120
<listitem>
121
<para>
122
This option is <emphasis>optional</emphasis>.
123
</para>
124
<para>
125
How long to wait for external approval before resorting to
126
use the <option>approved_by_default</option> value. The
127
default is <quote>PT0S</quote>, i.e. not to wait.
128
</para>
129
<para>
130
The format of <replaceable>TIME</replaceable> is the same
131
as for <varname>timeout</varname> below.
132
</para>
133
</listitem>
134
</varlistentry>
135
136
<varlistentry>
137
<term><option>approval_duration<literal> = </literal
138
><replaceable>TIME</replaceable></option></term>
139
<listitem>
140
<para>
141
This option is <emphasis>optional</emphasis>.
142
</para>
143
<para>
144
How long an external approval lasts. The default is 1
145
second.
146
</para>
147
<para>
148
The format of <replaceable>TIME</replaceable> is the same
149
as for <varname>timeout</varname> below.
150
</para>
151
</listitem>
152
</varlistentry>
153
154
<varlistentry>
155
<term><option>approved_by_default<literal> = </literal
156
>{ <literal >1</literal> | <literal>yes</literal> | <literal
157
>true</literal> | <literal>on</literal> | <literal
158
>0</literal> | <literal>no</literal> | <literal
159
>false</literal> | <literal>off</literal> }</option></term>
160
<listitem>
161
<para>
162
Whether to approve a client by default after
163
the <option>approval_delay</option>. The default
164
is <quote>True</quote>.
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.
165
149
</para>
166
150
</listitem>
167
151
</varlistentry>
174
158
This option is <emphasis>optional</emphasis>.
175
159
</para>
176
160
<para>
177
This option overrides the default shell command that the
178
server will use to check if the client is still up. Any
179
output of the command will be ignored, only the exit code
180
is checked: If the exit code of the command is zero, the
181
client is considered up. The command will be run using
182
<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>
183
167
<option>-c</option></command></quote>, so
184
168
<varname>PATH</varname> will be searched. The default
185
169
value for the checker command is <quote><literal
186
170
><command>fping</command> <option>-q</option> <option
187
>--</option> %%(host)s</literal></quote>. Note that
188
<command>mandos-keygen</command>, when generating output
189
to be inserted into this file, normally looks for an SSH
190
server on the Mandos client, and, if it finds one, outputs
191
a <option>checker</option> option to check for the
192
client’s SSH key fingerprint – this is more secure against
193
spoofing.
171
>--</option> %(host)s</literal></quote>.
194
172
</para>
195
173
<para>
196
174
In addition to normal start time expansion, this option
201
179
</varlistentry>
202
180
203
181
<varlistentry>
204
<term><option>extended_timeout<literal> = </literal><replaceable
205
>TIME</replaceable></option></term>
206
<listitem>
207
<para>
208
This option is <emphasis>optional</emphasis>.
209
</para>
210
<para>
211
Extended timeout is an added timeout that is given once
212
after a password has been sent successfully to a client.
213
The timeout is by default longer than the normal timeout,
214
and is used for handling the extra long downtime while a
215
machine is booting up. Time to take into consideration
216
when changing this value is file system checks and quota
217
checks. The default value is 15 minutes.
218
</para>
219
<para>
220
The format of <replaceable>TIME</replaceable> is the same
221
as for <varname>timeout</varname> below.
222
</para>
223
</listitem>
224
</varlistentry>
225
226
<varlistentry>
227
182
<term><option>fingerprint<literal> = </literal
228
183
><replaceable>HEXSTRING</replaceable></option></term>
229
184
<listitem>
233
188
<para>
234
189
This option sets the OpenPGP fingerprint that identifies
235
190
the public key that clients authenticate themselves with
236
through TLS. The string needs to be in hexadecimal form,
237
but spaces or upper/lower case are not significant.
238
</para>
239
</listitem>
240
</varlistentry>
241
242
<varlistentry>
243
<term><option>key_id<literal> = </literal
244
><replaceable>HEXSTRING</replaceable></option></term>
245
<listitem>
246
<para>
247
This option is <emphasis>optional</emphasis>.
248
</para>
249
<para>
250
This option sets the certificate key ID that identifies
251
the public key that clients authenticate themselves with
252
through TLS. The string needs to be in hexadecimal form,
253
but spaces or upper/lower case are not significant.
254
</para>
255
</listitem>
256
</varlistentry>
257
258
<varlistentry>
259
<term><option><literal>host = </literal><replaceable
260
>STRING</replaceable></option></term>
261
<listitem>
262
<para>
263
This option is <emphasis>optional</emphasis>, but highly
264
<emphasis>recommended</emphasis> unless the
265
<option>checker</option> option is modified to a
266
non-standard value without <quote>%%(host)s</quote> in it.
267
</para>
268
<para>
269
Host name for this client. This is not used by the server
270
directly, but can be, and is by default, used by the
271
checker. See the <option>checker</option> option.
272
</para>
273
</listitem>
274
</varlistentry>
275
276
<varlistentry>
277
<term><option>interval<literal> = </literal><replaceable
278
>TIME</replaceable></option></term>
279
<listitem>
280
<para>
281
This option is <emphasis>optional</emphasis>.
282
</para>
283
<para>
284
How often to run the checker to confirm that a client is
285
still up. <emphasis>Note:</emphasis> a new checker will
286
not be started if an old one is still running. The server
287
will wait for a checker to complete until the below
288
<quote><varname>timeout</varname></quote> occurs, at which
289
time the client will be disabled, and any running checker
290
killed. The default interval is 2 minutes.
291
</para>
292
<para>
293
The format of <replaceable>TIME</replaceable> is the same
294
as for <varname>timeout</varname> below.
295
</para>
296
</listitem>
297
</varlistentry>
298
299
<varlistentry>
300
<term><option>secfile<literal> = </literal><replaceable
301
>FILENAME</replaceable></option></term>
302
<listitem>
303
<para>
304
This option is only used if <option>secret</option> is not
305
specified, in which case this option is
306
<emphasis>required</emphasis>.
307
</para>
308
<para>
309
Similar to the <option>secret</option>, except the secret
310
data is in an external file. The contents of the file
311
should <emphasis>not</emphasis> be base64-encoded, but
312
will be sent to clients verbatim.
313
</para>
314
<para>
315
File names of the form <filename>~user/foo/bar</filename>
316
and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
317
are supported.
191
through TLS. The string needs to be in hexidecimal form,
192
but spaces or upper/lower case are not significant.
318
193
</para>
319
194
</listitem>
320
195
</varlistentry>
331
206
<para>
332
207
If present, this option must be set to a string of
333
208
base64-encoded binary data. It will be decoded and sent
334
to the client matching the above <option>key_id</option>
335
or <option>fingerprint</option>. This should, of course,
336
be OpenPGP encrypted data, decryptable only by the client.
209
to the client matching the above
210
<option>fingerprint</option>. This should, of course, be
211
OpenPGP encrypted data, decryptable only by the client.
337
212
The program <citerefentry><refentrytitle><command
338
213
>mandos-keygen</command></refentrytitle><manvolnum
339
214
>8</manvolnum></citerefentry> can, using its
350
225
</varlistentry>
351
226
352
227
<varlistentry>
353
<term><option>timeout<literal> = </literal><replaceable
354
>TIME</replaceable></option></term>
228
<term><option>secfile<literal> = </literal><replaceable
229
>FILENAME</replaceable></option></term>
355
230
<listitem>
356
231
<para>
357
This option is <emphasis>optional</emphasis>.
358
</para>
359
<para>
360
The timeout is how long the server will wait, after a
361
successful checker run, until a client is disabled and not
362
allowed to get the data this server holds. By default
363
Mandos will use 5 minutes. See also the
364
<option>extended_timeout</option> option.
365
</para>
366
<para>
367
The <replaceable>TIME</replaceable> is specified as an RFC
368
3339 duration; for example
369
<quote><literal>P1Y2M3DT4H5M6S</literal></quote> meaning
370
one year, two months, three days, four hours, five
371
minutes, and six seconds. Some values can be omitted, see
372
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.
373
241
</para>
374
242
</listitem>
375
243
</varlistentry>
376
244
377
245
<varlistentry>
378
<term><option>enabled<literal> = </literal>{ <literal
379
>1</literal> | <literal>yes</literal> | <literal>true</literal
380
> | <literal >on</literal> | <literal>0</literal> | <literal
381
>no</literal> | <literal>false</literal> | <literal
382
>off</literal> }</option></term>
246
<term><option><literal>host = </literal><replaceable
247
>STRING</replaceable></option></term>
383
248
<listitem>
384
249
<para>
385
Whether this client should be enabled by default. The
386
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.
387
259
</para>
388
260
</listitem>
389
261
</varlistentry>
426
298
<quote><literal>%%(<replaceable>foo</replaceable>)s</literal
427
299
></quote> will be replaced by the value of the attribute
428
300
<varname>foo</varname> of the internal
429
<quote><classname>Client</classname></quote> object in the
430
Mandos server. The currently allowed values for
431
<replaceable>foo</replaceable> are:
432
<quote><literal>approval_delay</literal></quote>,
433
<quote><literal>approval_duration</literal></quote>,
434
<quote><literal>created</literal></quote>,
435
<quote><literal>enabled</literal></quote>,
436
<quote><literal>expires</literal></quote>,
437
<quote><literal>key_id</literal></quote>,
438
<quote><literal>fingerprint</literal></quote>,
439
<quote><literal>host</literal></quote>,
440
<quote><literal>interval</literal></quote>,
441
<quote><literal>last_approval_request</literal></quote>,
442
<quote><literal>last_checked_ok</literal></quote>,
443
<quote><literal>last_enabled</literal></quote>,
444
<quote><literal>name</literal></quote>,
445
<quote><literal>timeout</literal></quote>, and, if using
446
D-Bus, <quote><literal>dbus_object_path</literal></quote>.
447
See the source code for details. <emphasis role="strong"
448
>Currently, <emphasis>none</emphasis> of these attributes
449
except <quote><literal>host</literal></quote> are guaranteed
450
to be valid in future versions.</emphasis> Therefore, please
451
let the authors know of any attributes that are useful so they
452
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.
453
305
</para>
454
306
<para>
455
307
Note that this means that, in order to include an actual
483
335
<literal>%(<replaceable>foo</replaceable>)s</literal> is
484
336
obscure.
485
337
</para>
486
<xi:include href="bugs.xml"/>
487
338
</refsect1>
488
339
489
340
<refsect1 id="example">
491
342
<informalexample>
492
343
<programlisting>
493
344
[DEFAULT]
494
timeout = PT5M
495
interval = PT2M
496
checker = fping -q -- %%(host)s
345
timeout = 1h
346
interval = 5m
347
checker = fping -q -- %(host)s
497
348
498
349
# Client "foo"
499
350
[foo]
500
key_id = 788cd77115cd0bb7b2d5e0ae8496f6b48149d5e712c652076b1fd2d957ef7c1f
501
351
fingerprint = 7788 2722 5BA7 DE53 9C5A 7CFA 59CF F7CD BD9A 5920
502
352
secret =
503
353
hQIOA6QdEjBs2L/HEAf/TCyrDe5Xnm9esa+Pb/vWF9CUqfn4srzVgSu234
516
366
4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
517
367
QlnHIvPzEArRQLo=
518
368
host = foo.example.org
519
interval = PT1M
369
interval = 1m
520
370
521
371
# Client "bar"
522
372
[bar]
523
key_id = F90C7A81D72D1EA69A51031A91FF8885F36C8B46D155C8C58709A4C99AE9E361
524
373
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
525
374
secfile = /etc/mandos/bar-secret
526
timeout = PT15M
527
approved_by_default = False
528
approval_delay = PT30S
375
timeout = 15m
529
376
</programlisting>
530
377
</informalexample>
531
378
</refsect1>
533
380
<refsect1 id="see_also">
534
381
<title>SEE ALSO</title>
535
382
<para>
536
<citerefentry><refentrytitle>intro</refentrytitle>
537
<manvolnum>8mandos</manvolnum></citerefentry>,
538
383
<citerefentry><refentrytitle>mandos-keygen</refentrytitle>
539
384
<manvolnum>8</manvolnum></citerefentry>,
540
385
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
541
386
<manvolnum>5</manvolnum></citerefentry>,
542
387
<citerefentry><refentrytitle>mandos</refentrytitle>
543
<manvolnum>8</manvolnum></citerefentry>,
544
<citerefentry><refentrytitle>fping</refentrytitle>
545
388
<manvolnum>8</manvolnum></citerefentry>
546
389
</para>
547
<variablelist>
548
<varlistentry>
549
<term>
550
RFC 3339: <citetitle>Date and Time on the Internet:
551
Timestamps</citetitle>
552
</term>
553
<listitem>
554
<para>
555
The time intervals are in the "duration" format, as
556
specified in ABNF in Appendix A of RFC 3339.
557
</para>
558
</listitem>
559
</varlistentry>
560
</variablelist>
561
390
</refsect1>
562
391
</refentry>
563
392
<!-- Local Variables: -->
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0