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 904
- compare with another revision
- download diff
- download tarball
- view history from revision 904
- Committer: Teddy Hogeborn
- Date: 2017-08-20 14:08:59 UTC
- Revision ID: teddy@recompile.se-20170820140859-6niaa0ebf6bdovfn
Use || instead of -o in shell scripts.
* mandos-keygen: Use || instead of -o.
* network-hooks.d/bridge: - '' -
* mandos-keygen: Use || instead of -o.
* network-hooks.d/bridge: - '' -
- files added:
- .bzr-builddeb
- debian
- debian/po
- debian/source
- debian/upstream
- network-hooks.d
- plugin-helpers
- 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
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-31">
6
<!ENTITY TIMESTAMP "2017-02-23">
7
<!ENTITY % common SYSTEM "common.ent">
8
%common;
8
9
]>
9
10
10
11
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
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>
40
<year>2013</year>
41
<year>2014</year>
42
<year>2015</year>
43
<year>2016</year>
44
<year>2017</year>
35
45
<holder>Teddy Hogeborn</holder>
36
46
<holder>Björn Påhlsson</holder>
37
47
</copyright>
38
48
<xi:include href="legalnotice.xml"/>
39
49
</refentryinfo>
40
50
41
51
<refmeta>
42
52
<refentrytitle>&CONFNAME;</refentrytitle>
43
53
<manvolnum>5</manvolnum>
49
59
Configuration file for the Mandos server
50
60
</refpurpose>
51
61
</refnamediv>
52
62
53
63
<refsynopsisdiv>
54
64
<synopsis>&CONFPATH;</synopsis>
55
65
</refsynopsisdiv>
56
66
57
67
<refsect1 id="description">
58
68
<title>DESCRIPTION</title>
59
69
<para>
61
71
><refentrytitle>mandos</refentrytitle>
62
72
<manvolnum>8</manvolnum></citerefentry>, read by it at startup.
63
73
The file needs to list all clients that should be able to use
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.
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.
67
81
</para>
68
82
<para>
69
83
The format starts with a <literal>[<replaceable>section
93
107
start time expansion, see <xref linkend="expansion"/>.
94
108
</para>
95
109
<para>
96
Uknown options are ignored. The used options are as follows:
110
Unknown options are ignored. The used options are as follows:
97
111
</para>
98
112
99
113
<variablelist>
100
101
<varlistentry>
102
<term><option>timeout<literal> = </literal><replaceable
103
>TIME</replaceable></option></term>
104
<listitem>
105
<para>
106
The timeout is how long the server will wait for a
107
successful checker run until a client is considered
108
invalid - that is, ineligible to get the data this server
109
holds. By default Mandos will use 1 hour.
110
</para>
111
<para>
112
The <replaceable>TIME</replaceable> is specified as a
113
space-separated number of values, each of which is a
114
number and a one-character suffix. The suffix must be one
115
of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
116
<quote>h</quote>, and <quote>w</quote> for days, seconds,
117
minutes, hours, and weeks, respectively. The values are
118
added together to give the total time value, so all of
119
<quote><literal>330s</literal></quote>,
120
<quote><literal>110s 110s 110s</literal></quote>, and
121
<quote><literal>5m 30s</literal></quote> will give a value
122
of five minutes and thirty seconds.
123
</para>
124
</listitem>
125
</varlistentry>
126
127
<varlistentry>
128
<term><option>interval<literal> = </literal><replaceable
129
>TIME</replaceable></option></term>
130
<listitem>
131
<para>
132
How often to run the checker to confirm that a client is
133
still up. <emphasis>Note:</emphasis> a new checker will
134
not be started if an old one is still running. The server
135
will wait for a checker to complete until the above
136
<quote><varname>timeout</varname></quote> occurs, at which
137
time the client will be marked invalid, and any running
138
checker killed. The default interval is 5 minutes.
139
</para>
140
<para>
141
The format of <replaceable>TIME</replaceable> is the same
142
as for <varname>timeout</varname> above.
143
</para>
144
</listitem>
145
</varlistentry>
146
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
147
167
<varlistentry>
148
168
<term><option>checker<literal> = </literal><replaceable
149
169
>COMMAND</replaceable></option></term>
150
170
<listitem>
151
171
<para>
152
This option allows you to override the default shell
153
command that the server will use to check if the client is
154
still up. Any output of the command will be ignored, only
155
the exit code is checked: If the exit code of the command
156
is zero, the client is considered up. The command will be
157
run using <quote><command><filename>/bin/sh</filename>
172
This option is <emphasis>optional</emphasis>.
173
</para>
174
<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>
158
181
<option>-c</option></command></quote>, so
159
182
<varname>PATH</varname> will be searched. The default
160
183
value for the checker command is <quote><literal
161
184
><command>fping</command> <option>-q</option> <option
162
>--</option> %(host)s</literal></quote>.
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.
163
192
</para>
164
193
<para>
165
194
In addition to normal start time expansion, this option
170
199
</varlistentry>
171
200
172
201
<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>
173
225
<term><option>fingerprint<literal> = </literal
174
226
><replaceable>HEXSTRING</replaceable></option></term>
175
227
<listitem>
176
228
<para>
229
This option is <emphasis>required</emphasis>.
230
</para>
231
<para>
177
232
This option sets the OpenPGP fingerprint that identifies
178
233
the public key that clients authenticate themselves with
179
through TLS. The string needs to be in hexidecimal form,
234
through TLS. The string needs to be in hexadecimal form,
180
235
but spaces or upper/lower case are not significant.
181
236
</para>
182
237
</listitem>
183
238
</varlistentry>
184
239
185
240
<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>
186
305
<term><option>secret<literal> = </literal><replaceable
187
306
>BASE64_ENCODED_DATA</replaceable></option></term>
188
307
<listitem>
189
308
<para>
309
If this option is not specified, the <option
310
>secfile</option> option is <emphasis>required</emphasis>
311
to be present.
312
</para>
313
<para>
190
314
If present, this option must be set to a string of
191
315
base64-encoded binary data. It will be decoded and sent
192
316
to the client matching the above
204
328
lines is that a line beginning with white space adds to
205
329
the value of the previous line, RFC 822-style.
206
330
</para>
207
<para>
208
If this option is not specified, the <option
209
>secfile</option> option is used instead, but one of them
210
<emphasis>must</emphasis> be present.
211
</para>
212
</listitem>
213
</varlistentry>
214
215
<varlistentry>
216
<term><option>secfile<literal> = </literal><replaceable
217
>FILENAME</replaceable></option></term>
218
<listitem>
219
<para>
220
Similar to the <option>secret</option>, except the secret
221
data is in an external file. The contents of the file
222
should <emphasis>not</emphasis> be base64-encoded, but
223
will be sent to clients verbatim.
224
</para>
225
<para>
226
This option is only used, and <emphasis>must</emphasis> be
227
present, if <option>secret</option> is not specified.
228
</para>
229
</listitem>
230
</varlistentry>
231
232
<varlistentry>
233
<term><option><literal>host = </literal><replaceable
234
>STRING</replaceable></option></term>
235
<listitem>
236
<para>
237
Host name for this client. This is not used by the server
238
directly, but can be, and is by default, used by the
239
checker. See the <option>checker</option> option.
331
</listitem>
332
</varlistentry>
333
334
<varlistentry>
335
<term><option>timeout<literal> = </literal><replaceable
336
>TIME</replaceable></option></term>
337
<listitem>
338
<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.
355
</para>
356
</listitem>
357
</varlistentry>
358
359
<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>
365
<listitem>
366
<para>
367
Whether this client should be enabled by default. The
368
default is <quote>true</quote>.
240
369
</para>
241
370
</listitem>
242
371
</varlistentry>
279
408
<quote><literal>%%(<replaceable>foo</replaceable>)s</literal
280
409
></quote> will be replaced by the value of the attribute
281
410
<varname>foo</varname> of the internal
282
<quote><classname>Client</classname></quote> object. See the
283
source code for details, and let the authors know of any
284
attributes that are useful so they may be preserved to any new
285
versions of this software.
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.
286
434
</para>
287
435
<para>
288
436
Note that this means that, in order to include an actual
294
442
mode is needed to expose an error of this kind.
295
443
</para>
296
444
</refsect2>
297
445
298
446
</refsect1>
299
447
300
448
<refsect1 id="files">
316
464
<literal>%(<replaceable>foo</replaceable>)s</literal> is
317
465
obscure.
318
466
</para>
467
<xi:include href="bugs.xml"/>
319
468
</refsect1>
320
469
321
470
<refsect1 id="example">
323
472
<informalexample>
324
473
<programlisting>
325
474
[DEFAULT]
326
timeout = 1h
327
interval = 5m
328
checker = fping -q -- %(host)s
475
timeout = PT5M
476
interval = PT2M
477
checker = fping -q -- %%(host)s
329
478
330
479
# Client "foo"
331
480
[foo]
347
496
4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
348
497
QlnHIvPzEArRQLo=
349
498
host = foo.example.org
350
interval = 1m
499
interval = PT1M
351
500
352
501
# Client "bar"
353
502
[bar]
354
503
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
355
504
secfile = /etc/mandos/bar-secret
356
timeout = 15m
357
505
timeout = PT15M
506
approved_by_default = False
507
approval_delay = PT30S
358
508
</programlisting>
359
509
</informalexample>
360
510
</refsect1>
362
512
<refsect1 id="see_also">
363
513
<title>SEE ALSO</title>
364
514
<para>
515
<citerefentry><refentrytitle>intro</refentrytitle>
516
<manvolnum>8mandos</manvolnum></citerefentry>,
365
517
<citerefentry><refentrytitle>mandos-keygen</refentrytitle>
366
518
<manvolnum>8</manvolnum></citerefentry>,
367
519
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
368
520
<manvolnum>5</manvolnum></citerefentry>,
369
521
<citerefentry><refentrytitle>mandos</refentrytitle>
522
<manvolnum>8</manvolnum></citerefentry>,
523
<citerefentry><refentrytitle>fping</refentrytitle>
370
524
<manvolnum>8</manvolnum></citerefentry>
371
525
</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>
372
540
</refsect1>
373
541
</refentry>
374
542
<!-- Local Variables: -->
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0