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 237.7.367
- compare with another revision
- download diff
- download tarball
- view history from revision 237.7.367
- Committer: Teddy Hogeborn
- Date: 2016-03-05 20:11:10 UTC
- mto: (237.7.594 trunk)
- mto: This revision was merged to the branch mainline in revision 335.
- Revision ID: teddy@recompile.se-20160305201110-6f7nws77k1h96e8k
errno is of type int, not error_t
* plugins.d/mandos-client.c (raise_privileges,
raise_privileges_permanently, lower_privileges,
lower_privileges_permanently, bring_up_interface,
take_down_interface, ): Change return type and all errno-containing
variables to type "int".
(get_flags): Change all errno-containing variables to type "int".
(main): Change all errno-containing variables to type "int", except
for values which are explicitly of type error_t.
* plugins.d/mandos-client.c (raise_privileges,
raise_privileges_permanently, lower_privileges,
lower_privileges_permanently, bring_up_interface,
take_down_interface, ): Change return type and all errno-containing
variables to type "int".
(get_flags): Change all errno-containing variables to type "int".
(main): Change all errno-containing variables to type "int", except
for values which are explicitly of type error_t.
- 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
<?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-29">
6
<!ENTITY TIMESTAMP "2016-02-28">
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>
40
<year>2013</year>
41
<year>2014</year>
42
<year>2015</year>
43
<year>2016</year>
35
44
<holder>Teddy Hogeborn</holder>
36
45
<holder>Björn Påhlsson</holder>
37
46
</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>
47
<xi:include href="legalnotice.xml"/>
61
48
</refentryinfo>
62
49
63
50
<refmeta>
64
51
<refentrytitle>&CONFNAME;</refentrytitle>
65
52
<manvolnum>5</manvolnum>
71
58
Configuration file for the Mandos server
72
59
</refpurpose>
73
60
</refnamediv>
74
61
75
62
<refsynopsisdiv>
76
<synopsis>
77
&CONFPATH;
78
</synopsis>
63
<synopsis>&CONFPATH;</synopsis>
79
64
</refsynopsisdiv>
80
65
81
66
<refsect1 id="description">
82
67
<title>DESCRIPTION</title>
83
68
<para>
85
70
><refentrytitle>mandos</refentrytitle>
86
71
<manvolnum>8</manvolnum></citerefentry>, read by it at startup.
87
72
The file needs to list all clients that should be able to use
88
the service. All clients listed will be regarded as valid, even
89
if a client was declared invalid in a previous run of the
90
server.
73
the service. The settings in this file can be overridden by
74
runtime changes to the server, which it saves across restarts.
75
(See the section called <quote>PERSISTENT STATE</quote> in
76
<citerefentry><refentrytitle>mandos</refentrytitle><manvolnum
77
>8</manvolnum></citerefentry>.) However, any <emphasis
78
>changes</emphasis> to this file (including adding and removing
79
clients) will, at startup, override changes done during runtime.
91
80
</para>
92
81
<para>
93
82
The format starts with a <literal>[<replaceable>section
117
106
start time expansion, see <xref linkend="expansion"/>.
118
107
</para>
119
108
<para>
120
Uknown options are ignored. The used options are as follows:
109
Unknown options are ignored. The used options are as follows:
121
110
</para>
122
111
123
112
<variablelist>
124
125
<varlistentry>
126
<term><literal><varname>timeout</varname></literal></term>
127
<listitem>
128
<synopsis><literal>timeout = </literal><replaceable
129
>TIME</replaceable>
130
</synopsis>
131
<para>
132
The timeout is how long the server will wait for a
133
successful checker run until a client is considered
134
invalid - that is, ineligible to get the data this server
135
holds. By default Mandos will use 1 hour.
136
</para>
137
<para>
138
The <replaceable>TIME</replaceable> is specified as a
139
space-separated number of values, each of which is a
140
number and a one-character suffix. The suffix must be one
141
of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
142
<quote>h</quote>, and <quote>w</quote> for days, seconds,
143
minutes, hours, and weeks, respectively. The values are
144
added together to give the total time value, so all of
145
<quote><literal>330s</literal></quote>,
146
<quote><literal>110s 110s 110s</literal></quote>, and
147
<quote><literal>5m 30s</literal></quote> will give a value
148
of five minutes and thirty seconds.
149
</para>
150
</listitem>
151
</varlistentry>
152
153
<varlistentry>
154
<term><literal><varname>interval</varname></literal></term>
155
<listitem>
156
<synopsis><literal>interval = </literal><replaceable
157
>TIME</replaceable>
158
</synopsis>
159
<para>
160
How often to run the checker to confirm that a client is
161
still up. <emphasis>Note:</emphasis> a new checker will
162
not be started if an old one is still running. The server
163
will wait for a checker to complete until the above
164
<quote><varname>timeout</varname></quote> occurs, at which
165
time the client will be marked invalid, and any running
166
checker killed. The default interval is 5 minutes.
167
</para>
168
<para>
169
The format of <replaceable>TIME</replaceable> is the same
170
as for <varname>timeout</varname> above.
171
</para>
172
</listitem>
173
</varlistentry>
174
175
<varlistentry>
176
<term><literal>checker</literal></term>
177
<listitem>
178
<synopsis><literal>checker = </literal><replaceable
179
>COMMAND</replaceable>
180
</synopsis>
181
<para>
182
This option allows you to override the default shell
183
command that the server will use to check if the client is
184
still up. Any output of the command will be ignored, only
185
the exit code is checked: If the exit code of the command
186
is zero, the client is considered up. The command will be
187
run using <quote><command><filename>/bin/sh</filename>
113
114
<varlistentry>
115
<term><option>approval_delay<literal> = </literal><replaceable
116
>TIME</replaceable></option></term>
117
<listitem>
118
<para>
119
This option is <emphasis>optional</emphasis>.
120
</para>
121
<para>
122
How long to wait for external approval before resorting to
123
use the <option>approved_by_default</option> value. The
124
default is <quote>PT0S</quote>, i.e. not to wait.
125
</para>
126
<para>
127
The format of <replaceable>TIME</replaceable> is the same
128
as for <varname>timeout</varname> below.
129
</para>
130
</listitem>
131
</varlistentry>
132
133
<varlistentry>
134
<term><option>approval_duration<literal> = </literal
135
><replaceable>TIME</replaceable></option></term>
136
<listitem>
137
<para>
138
This option is <emphasis>optional</emphasis>.
139
</para>
140
<para>
141
How long an external approval lasts. The default is 1
142
second.
143
</para>
144
<para>
145
The format of <replaceable>TIME</replaceable> is the same
146
as for <varname>timeout</varname> below.
147
</para>
148
</listitem>
149
</varlistentry>
150
151
<varlistentry>
152
<term><option>approved_by_default<literal> = </literal
153
>{ <literal >1</literal> | <literal>yes</literal> | <literal
154
>true</literal> | <literal>on</literal> | <literal
155
>0</literal> | <literal>no</literal> | <literal
156
>false</literal> | <literal>off</literal> }</option></term>
157
<listitem>
158
<para>
159
Whether to approve a client by default after
160
the <option>approval_delay</option>. The default
161
is <quote>True</quote>.
162
</para>
163
</listitem>
164
</varlistentry>
165
166
<varlistentry>
167
<term><option>checker<literal> = </literal><replaceable
168
>COMMAND</replaceable></option></term>
169
<listitem>
170
<para>
171
This option is <emphasis>optional</emphasis>.
172
</para>
173
<para>
174
This option overrides the default shell command that the
175
server will use to check if the client is still up. Any
176
output of the command will be ignored, only the exit code
177
is checked: If the exit code of the command is zero, the
178
client is considered up. The command will be run using
179
<quote><command><filename>/bin/sh</filename>
188
180
<option>-c</option></command></quote>, so
189
181
<varname>PATH</varname> will be searched. The default
190
182
value for the checker command is <quote><literal
191
183
><command>fping</command> <option>-q</option> <option
192
>--</option> %(host)s</literal></quote>.
184
>--</option> %%(host)s</literal></quote>. Note that
185
<command>mandos-keygen</command>, when generating output
186
to be inserted into this file, normally looks for an SSH
187
server on the Mandos client, and, if it find one, outputs
188
a <option>checker</option> option to check for the
189
client’s key fingerprint – this is more secure against
190
spoofing.
193
191
</para>
194
192
<para>
195
193
In addition to normal start time expansion, this option
200
198
</varlistentry>
201
199
202
200
<varlistentry>
203
<term><literal>fingerprint</literal></term>
204
<listitem>
205
<synopsis><literal>fingerprint = </literal><replaceable
206
>HEXSTRING</replaceable>
207
</synopsis>
201
<term><option>extended_timeout<literal> = </literal><replaceable
202
>TIME</replaceable></option></term>
203
<listitem>
204
<para>
205
This option is <emphasis>optional</emphasis>.
206
</para>
207
<para>
208
Extended timeout is an added timeout that is given once
209
after a password has been sent successfully to a client.
210
The timeout is by default longer than the normal timeout,
211
and is used for handling the extra long downtime while a
212
machine is booting up. Time to take into consideration
213
when changing this value is file system checks and quota
214
checks. The default value is 15 minutes.
215
</para>
216
<para>
217
The format of <replaceable>TIME</replaceable> is the same
218
as for <varname>timeout</varname> below.
219
</para>
220
</listitem>
221
</varlistentry>
222
223
<varlistentry>
224
<term><option>fingerprint<literal> = </literal
225
><replaceable>HEXSTRING</replaceable></option></term>
226
<listitem>
227
<para>
228
This option is <emphasis>required</emphasis>.
229
</para>
208
230
<para>
209
231
This option sets the OpenPGP fingerprint that identifies
210
232
the public key that clients authenticate themselves with
215
237
</varlistentry>
216
238
217
239
<varlistentry>
218
<term><literal>secret</literal></term>
219
<listitem>
220
<synopsis><literal>secret = </literal><replaceable
221
>BASE64_ENCODED_DATA</replaceable>
222
</synopsis>
240
<term><option><literal>host = </literal><replaceable
241
>STRING</replaceable></option></term>
242
<listitem>
243
<para>
244
This option is <emphasis>optional</emphasis>, but highly
245
<emphasis>recommended</emphasis> unless the
246
<option>checker</option> option is modified to a
247
non-standard value without <quote>%%(host)s</quote> in it.
248
</para>
249
<para>
250
Host name for this client. This is not used by the server
251
directly, but can be, and is by default, used by the
252
checker. See the <option>checker</option> option.
253
</para>
254
</listitem>
255
</varlistentry>
256
257
<varlistentry>
258
<term><option>interval<literal> = </literal><replaceable
259
>TIME</replaceable></option></term>
260
<listitem>
261
<para>
262
This option is <emphasis>optional</emphasis>.
263
</para>
264
<para>
265
How often to run the checker to confirm that a client is
266
still up. <emphasis>Note:</emphasis> a new checker will
267
not be started if an old one is still running. The server
268
will wait for a checker to complete until the below
269
<quote><varname>timeout</varname></quote> occurs, at which
270
time the client will be disabled, and any running checker
271
killed. The default interval is 2 minutes.
272
</para>
273
<para>
274
The format of <replaceable>TIME</replaceable> is the same
275
as for <varname>timeout</varname> below.
276
</para>
277
</listitem>
278
</varlistentry>
279
280
<varlistentry>
281
<term><option>secfile<literal> = </literal><replaceable
282
>FILENAME</replaceable></option></term>
283
<listitem>
284
<para>
285
This option is only used if <option>secret</option> is not
286
specified, in which case this option is
287
<emphasis>required</emphasis>.
288
</para>
289
<para>
290
Similar to the <option>secret</option>, except the secret
291
data is in an external file. The contents of the file
292
should <emphasis>not</emphasis> be base64-encoded, but
293
will be sent to clients verbatim.
294
</para>
295
<para>
296
File names of the form <filename>~user/foo/bar</filename>
297
and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
298
are supported.
299
</para>
300
</listitem>
301
</varlistentry>
302
303
<varlistentry>
304
<term><option>secret<literal> = </literal><replaceable
305
>BASE64_ENCODED_DATA</replaceable></option></term>
306
<listitem>
307
<para>
308
If this option is not specified, the <option
309
>secfile</option> option is <emphasis>required</emphasis>
310
to be present.
311
</para>
223
312
<para>
224
313
If present, this option must be set to a string of
225
314
base64-encoded binary data. It will be decoded and sent
238
327
lines is that a line beginning with white space adds to
239
328
the value of the previous line, RFC 822-style.
240
329
</para>
241
<para>
242
If this option is not specified, the <option
243
>secfile</option> option is used instead, but one of them
244
<emphasis>must</emphasis> be present.
245
</para>
246
</listitem>
247
</varlistentry>
248
249
<varlistentry>
250
<term><literal>secfile</literal></term>
251
<listitem>
252
<synopsis><literal>secfile = </literal><replaceable
253
>FILENAME</replaceable>
254
</synopsis>
255
<para>
256
The same as <option>secret</option>, but the secret data
257
is in an external file. The contents of the file should
258
<emphasis>not</emphasis> be base64-encoded, but will be
259
sent to clients verbatim.
260
</para>
261
<para>
262
This option is only used, and <emphasis>must</emphasis> be
263
present, if <option>secret</option> is not specified.
264
</para>
265
</listitem>
266
</varlistentry>
267
268
<varlistentry>
269
<term><literal>host</literal></term>
270
<listitem>
271
<synopsis><literal>host = </literal><replaceable
272
>STRING</replaceable>
273
</synopsis>
274
<para>
275
Host name for this client. This is not used by the server
276
directly, but can be, and is by default, used by the
277
checker. See the <option>checker</option> option.
330
</listitem>
331
</varlistentry>
332
333
<varlistentry>
334
<term><option>timeout<literal> = </literal><replaceable
335
>TIME</replaceable></option></term>
336
<listitem>
337
<para>
338
This option is <emphasis>optional</emphasis>.
339
</para>
340
<para>
341
The timeout is how long the server will wait, after a
342
successful checker run, until a client is disabled and not
343
allowed to get the data this server holds. By default
344
Mandos will use 5 minutes. See also the
345
<option>extended_timeout</option> option.
346
</para>
347
<para>
348
The <replaceable>TIME</replaceable> is specified as an RFC
349
3339 duration; for example
350
<quote><literal>P1Y2M3DT4H5M6S</literal></quote> meaning
351
one year, two months, three days, four hours, five
352
minutes, and six seconds. Some values can be omitted, see
353
RFC 3339 Appendix A for details.
354
</para>
355
</listitem>
356
</varlistentry>
357
358
<varlistentry>
359
<term><option>enabled<literal> = </literal>{ <literal
360
>1</literal> | <literal>yes</literal> | <literal>true</literal
361
> | <literal >on</literal> | <literal>0</literal> | <literal
362
>no</literal> | <literal>false</literal> | <literal
363
>off</literal> }</option></term>
364
<listitem>
365
<para>
366
Whether this client should be enabled by default. The
367
default is <quote>true</quote>.
278
368
</para>
279
369
</listitem>
280
370
</varlistentry>
281
371
282
372
</variablelist>
283
</refsect1>
373
</refsect1>
284
374
285
375
<refsect1 id="expansion">
286
376
<title>EXPANSION</title>
317
407
<quote><literal>%%(<replaceable>foo</replaceable>)s</literal
318
408
></quote> will be replaced by the value of the attribute
319
409
<varname>foo</varname> of the internal
320
<quote><classname>Client</classname></quote> object. See the
321
source code for details, and let the authors know of any
322
attributes that are useful so they may be preserved to any new
323
versions of this software.
410
<quote><classname>Client</classname></quote> object in the
411
Mandos server. The currently allowed values for
412
<replaceable>foo</replaceable> are:
413
<quote><literal>approval_delay</literal></quote>,
414
<quote><literal>approval_duration</literal></quote>,
415
<quote><literal>created</literal></quote>,
416
<quote><literal>enabled</literal></quote>,
417
<quote><literal>expires</literal></quote>,
418
<quote><literal>fingerprint</literal></quote>,
419
<quote><literal>host</literal></quote>,
420
<quote><literal>interval</literal></quote>,
421
<quote><literal>last_approval_request</literal></quote>,
422
<quote><literal>last_checked_ok</literal></quote>,
423
<quote><literal>last_enabled</literal></quote>,
424
<quote><literal>name</literal></quote>,
425
<quote><literal>timeout</literal></quote>, and, if using
426
D-Bus, <quote><literal>dbus_object_path</literal></quote>.
427
See the source code for details. <emphasis role="strong"
428
>Currently, <emphasis>none</emphasis> of these attributes
429
except <quote><literal>host</literal></quote> are guaranteed
430
to be valid in future versions.</emphasis> Therefore, please
431
let the authors know of any attributes that are useful so they
432
may be preserved to any new versions of this software.
324
433
</para>
325
434
<para>
326
435
Note that this means that, in order to include an actual
329
438
percent characters in a row (<quote>%%%%</quote>) must be
330
439
entered. Also, a bad format here will lead to an immediate
331
440
but <emphasis>silent</emphasis> run-time fatal exit; debug
332
mode is needed to track down an error of this kind.
441
mode is needed to expose an error of this kind.
333
442
</para>
334
443
</refsect2>
335
336
</refsect1>
444
445
</refsect1>
337
446
338
447
<refsect1 id="files">
339
448
<title>FILES</title>
361
470
<informalexample>
362
471
<programlisting>
363
472
[DEFAULT]
364
timeout = 1h
365
interval = 5m
366
checker = fping -q -- %(host)s
473
timeout = PT5M
474
interval = PT2M
475
checker = fping -q -- %%(host)s
367
476
368
477
# Client "foo"
369
478
[foo]
385
494
4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
386
495
QlnHIvPzEArRQLo=
387
496
host = foo.example.org
388
interval = 1m
497
interval = PT1M
389
498
390
499
# Client "bar"
391
500
[bar]
392
501
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
393
502
secfile = /etc/mandos/bar-secret
394
timeout = 15m
395
503
timeout = PT15M
504
approved_by_default = False
505
approval_delay = PT30S
396
506
</programlisting>
397
507
</informalexample>
398
</refsect1>
508
</refsect1>
399
509
400
510
<refsect1 id="see_also">
401
511
<title>SEE ALSO</title>
402
512
<para>
403
<citerefentry>
404
<refentrytitle>mandos</refentrytitle>
405
<manvolnum>8</manvolnum></citerefentry>, <citerefentry>
406
<refentrytitle>mandos-keygen</refentrytitle>
407
<manvolnum>8</manvolnum></citerefentry>, <citerefentry>
408
<refentrytitle>mandos.conf</refentrytitle>
409
<manvolnum>5</manvolnum></citerefentry>
513
<citerefentry><refentrytitle>intro</refentrytitle>
514
<manvolnum>8mandos</manvolnum></citerefentry>,
515
<citerefentry><refentrytitle>mandos-keygen</refentrytitle>
516
<manvolnum>8</manvolnum></citerefentry>,
517
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
518
<manvolnum>5</manvolnum></citerefentry>,
519
<citerefentry><refentrytitle>mandos</refentrytitle>
520
<manvolnum>8</manvolnum></citerefentry>,
521
<citerefentry><refentrytitle>fping</refentrytitle>
522
<manvolnum>8</manvolnum></citerefentry>
410
523
</para>
524
<variablelist>
525
<varlistentry>
526
<term>
527
RFC 3339: <citetitle>Date and Time on the Internet:
528
Timestamps</citetitle>
529
</term>
530
<listitem>
531
<para>
532
The time intervals are in the "duration" format, as
533
specified in ABNF in Appendix A of RFC 3339.
534
</para>
535
</listitem>
536
</varlistentry>
537
</variablelist>
411
538
</refsect1>
412
539
</refentry>
413
540
<!-- Local Variables: -->
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0