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 "2018-02-08">
7
<!ENTITY % common SYSTEM "common.ent">
11
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
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>
17
20
<firstname>Björn</firstname>
18
21
<surname>Påhlsson</surname>
20
<email>belorn@fukt.bsnet.se</email>
23
<email>belorn@recompile.se</email>
24
27
<firstname>Teddy</firstname>
25
28
<surname>Hogeborn</surname>
27
<email>teddy@fukt.bsnet.se</email>
30
<email>teddy@recompile.se</email>
33
46
<holder>Teddy Hogeborn</holder>
34
47
<holder>Björn Påhlsson</holder>
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
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
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/"/>.
49
<xi:include href="legalnotice.xml"/>
62
53
<refentrytitle>&CONFNAME;</refentrytitle>
63
54
<manvolnum>5</manvolnum>
69
60
Configuration file for the Mandos server
65
<synopsis>&CONFPATH;</synopsis>
79
68
<refsect1 id="description">
80
69
<title>DESCRIPTION</title>
82
The file &CONFPATH; is the configuration file for <citerefentry
71
The file &CONFPATH; is a configuration file for <citerefentry
83
72
><refentrytitle>mandos</refentrytitle>
84
<manvolnum>8</manvolnum></citerefentry>, read by it at startup,
85
where each client that will be able to use the service needs to
86
be listed. All clients listed will be regarded as valid, even
87
if a client was declared invalid in a previous run of the
73
<manvolnum>8</manvolnum></citerefentry>, read by it at startup.
74
The file needs to list all clients that should be able to use
75
the service. The settings in this file can be overridden by
76
runtime changes to the server, which it saves across restarts.
77
(See the section called <quote>PERSISTENT STATE</quote> in
78
<citerefentry><refentrytitle>mandos</refentrytitle><manvolnum
79
>8</manvolnum></citerefentry>.) However, any <emphasis
80
>changes</emphasis> to this file (including adding and removing
81
clients) will, at startup, override changes done during runtime.
91
84
The format starts with a <literal>[<replaceable>section
111
104
<refsect1 id="options">
112
105
<title>OPTIONS</title>
114
The possible options are:
107
<emphasis>Note:</emphasis> all option values are subject to
108
start time expansion, see <xref linkend="expansion"/>.
111
Unknown options are ignored. The used options are as follows:
120
<term><literal><varname>timeout</varname></literal></term>
122
<synopsis><literal>timeout = </literal><replaceable
126
The timeout is how long the server will wait for a
127
successful checker run until a client is considered
128
invalid - that is, ineligible to get the data this server
129
holds. By default Mandos will use 1 hour.
132
The <replaceable>TIME</replaceable> is specified as a
133
space-separated number of values, each of which is a
134
number and a one-character suffix. The suffix must be one
135
of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
136
<quote>h</quote>, and <quote>w</quote> for days, seconds,
137
minutes, hours, and weeks, respectively. The values are
138
added together to give the total time value, so all of
139
<quote><literal>330s</literal></quote>,
140
<quote><literal>110s 110s 110s</literal></quote>, and
141
<quote><literal>5m 30s</literal></quote> will give a value
142
of five minutes and thirty seconds.
148
<term><literal><varname>interval</varname></literal></term>
150
<synopsis><literal>interval = </literal><replaceable
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.
163
The format of <replaceable>TIME</replaceable> is the same
164
as for <varname>timeout</varname> above.
170
<term><literal>checker</literal></term>
172
<synopsis><literal>checker = </literal><replaceable
173
>COMMAND</replaceable>
176
This option allows you to override the default shell
177
command that the server will use to check if the client is
178
still up. The output of the command will be ignored, only
179
the exit code is checked. The command will be run using
117
<term><option>approval_delay<literal> = </literal><replaceable
118
>TIME</replaceable></option></term>
121
This option is <emphasis>optional</emphasis>.
124
How long to wait for external approval before resorting to
125
use the <option>approved_by_default</option> value. The
126
default is <quote>PT0S</quote>, i.e. not to wait.
129
The format of <replaceable>TIME</replaceable> is the same
130
as for <varname>timeout</varname> below.
136
<term><option>approval_duration<literal> = </literal
137
><replaceable>TIME</replaceable></option></term>
140
This option is <emphasis>optional</emphasis>.
143
How long an external approval lasts. The default is 1
147
The format of <replaceable>TIME</replaceable> is the same
148
as for <varname>timeout</varname> below.
154
<term><option>approved_by_default<literal> = </literal
155
>{ <literal >1</literal> | <literal>yes</literal> | <literal
156
>true</literal> | <literal>on</literal> | <literal
157
>0</literal> | <literal>no</literal> | <literal
158
>false</literal> | <literal>off</literal> }</option></term>
161
Whether to approve a client by default after
162
the <option>approval_delay</option>. The default
163
is <quote>True</quote>.
169
<term><option>checker<literal> = </literal><replaceable
170
>COMMAND</replaceable></option></term>
173
This option is <emphasis>optional</emphasis>.
176
This option overrides the default shell command that the
177
server will use to check if the client is still up. Any
178
output of the command will be ignored, only the exit code
179
is checked: If the exit code of the command is zero, the
180
client is considered up. The command will be run using
180
181
<quote><command><filename>/bin/sh</filename>
181
<option>-c</option></command></quote>. The default
182
command is <quote><literal><command>fping</command>
183
<option>-q</option> <option>--</option>
184
%(host)s</literal></quote>.
182
<option>-c</option></command></quote>, so
183
<varname>PATH</varname> will be searched. The default
184
value for the checker command is <quote><literal
185
><command>fping</command> <option>-q</option> <option
186
>--</option> %%(host)s</literal></quote>. Note that
187
<command>mandos-keygen</command>, when generating output
188
to be inserted into this file, normally looks for an SSH
189
server on the Mandos client, and, if it find one, outputs
190
a <option>checker</option> option to check for the
191
client’s key fingerprint – this is more secure against
187
195
In addition to normal start time expansion, this option
195
<term><literal>fingerprint</literal></term>
197
<synopsis><literal>fingerprint = </literal><replaceable
198
>HEXSTRING</replaceable>
203
<term><option>extended_timeout<literal> = </literal><replaceable
204
>TIME</replaceable></option></term>
207
This option is <emphasis>optional</emphasis>.
210
Extended timeout is an added timeout that is given once
211
after a password has been sent successfully to a client.
212
The timeout is by default longer than the normal timeout,
213
and is used for handling the extra long downtime while a
214
machine is booting up. Time to take into consideration
215
when changing this value is file system checks and quota
216
checks. The default value is 15 minutes.
219
The format of <replaceable>TIME</replaceable> is the same
220
as for <varname>timeout</varname> below.
226
<term><option>fingerprint<literal> = </literal
227
><replaceable>HEXSTRING</replaceable></option></term>
230
This option is <emphasis>required</emphasis>.
201
233
This option sets the OpenPGP fingerprint that identifies
202
234
the public key that clients authenticate themselves with
203
through TLS. The string needs to be in hexidecimal form,
235
through TLS. The string needs to be in hexadecimal form,
204
236
but spaces or upper/lower case are not significant.
210
<term><literal>secret</literal></term>
212
<synopsis><literal>secret = </literal><replaceable
213
>BASE64_ENCODED_DATA</replaceable>
242
<term><option><literal>host = </literal><replaceable
243
>STRING</replaceable></option></term>
246
This option is <emphasis>optional</emphasis>, but highly
247
<emphasis>recommended</emphasis> unless the
248
<option>checker</option> option is modified to a
249
non-standard value without <quote>%%(host)s</quote> in it.
252
Host name for this client. This is not used by the server
253
directly, but can be, and is by default, used by the
254
checker. See the <option>checker</option> option.
260
<term><option>interval<literal> = </literal><replaceable
261
>TIME</replaceable></option></term>
264
This option is <emphasis>optional</emphasis>.
267
How often to run the checker to confirm that a client is
268
still up. <emphasis>Note:</emphasis> a new checker will
269
not be started if an old one is still running. The server
270
will wait for a checker to complete until the below
271
<quote><varname>timeout</varname></quote> occurs, at which
272
time the client will be disabled, and any running checker
273
killed. The default interval is 2 minutes.
276
The format of <replaceable>TIME</replaceable> is the same
277
as for <varname>timeout</varname> below.
283
<term><option>secfile<literal> = </literal><replaceable
284
>FILENAME</replaceable></option></term>
287
This option is only used if <option>secret</option> is not
288
specified, in which case this option is
289
<emphasis>required</emphasis>.
292
Similar to the <option>secret</option>, except the secret
293
data is in an external file. The contents of the file
294
should <emphasis>not</emphasis> be base64-encoded, but
295
will be sent to clients verbatim.
298
File names of the form <filename>~user/foo/bar</filename>
299
and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
306
<term><option>secret<literal> = </literal><replaceable
307
>BASE64_ENCODED_DATA</replaceable></option></term>
310
If this option is not specified, the <option
311
>secfile</option> option is <emphasis>required</emphasis>
216
315
If present, this option must be set to a string of
217
316
base64-encoded binary data. It will be decoded and sent
218
317
to the client matching the above
219
318
<option>fingerprint</option>. This should, of course, be
220
319
OpenPGP encrypted data, decryptable only by the client.
221
<!-- The program <citerefentry><refentrytitle><command -->
222
<!-- >mandos-keygen</command></refentrytitle><manvolnum -->
223
<!-- >8</manvolnum></citerefentry> can be used to generate it, -->
227
Note: this value of this option will probably run over
228
many lines, and will then have to use the fact that a line
229
beginning with white space adds to the value of the
230
previous line, RFC 822-style.
236
<term><literal>secfile</literal></term>
239
Base 64 encoded OpenPGP encrypted password encrypted by
240
the clients openpgp certificate as a binary file.
246
<term><literal>host</literal></term>
249
Host name that can be used in for checking that the client is up.
255
<term><literal>checker</literal></term>
258
Shell command that the server will use to check up if a
265
<term><literal>timeout</literal></term>
268
Duration that a client can be down whitout be removed from
320
The program <citerefentry><refentrytitle><command
321
>mandos-keygen</command></refentrytitle><manvolnum
322
>8</manvolnum></citerefentry> can, using its
323
<option>--password</option> option, be used to generate
327
Note: this value of this option will probably be very
328
long. A useful feature to avoid having unreadably-long
329
lines is that a line beginning with white space adds to
330
the value of the previous line, RFC 822-style.
336
<term><option>timeout<literal> = </literal><replaceable
337
>TIME</replaceable></option></term>
340
This option is <emphasis>optional</emphasis>.
343
The timeout is how long the server will wait, after a
344
successful checker run, until a client is disabled and not
345
allowed to get the data this server holds. By default
346
Mandos will use 5 minutes. See also the
347
<option>extended_timeout</option> option.
350
The <replaceable>TIME</replaceable> is specified as an RFC
351
3339 duration; for example
352
<quote><literal>P1Y2M3DT4H5M6S</literal></quote> meaning
353
one year, two months, three days, four hours, five
354
minutes, and six seconds. Some values can be omitted, see
355
RFC 3339 Appendix A for details.
361
<term><option>enabled<literal> = </literal>{ <literal
362
>1</literal> | <literal>yes</literal> | <literal>true</literal
363
> | <literal >on</literal> | <literal>0</literal> | <literal
364
>no</literal> | <literal>false</literal> | <literal
365
>off</literal> }</option></term>
368
Whether this client should be enabled by default. The
369
default is <quote>true</quote>.
277
377
<refsect1 id="expansion">
278
378
<title>EXPANSION</title>
309
409
<quote><literal>%%(<replaceable>foo</replaceable>)s</literal
310
410
></quote> will be replaced by the value of the attribute
311
411
<varname>foo</varname> of the internal
312
<quote><classname>Client</classname></quote> object. See the
313
source code for details, and let the authors know of any
314
attributes that are useful so they may be preserved to any new
315
versions of this software.
412
<quote><classname>Client</classname></quote> object in the
413
Mandos server. The currently allowed values for
414
<replaceable>foo</replaceable> are:
415
<quote><literal>approval_delay</literal></quote>,
416
<quote><literal>approval_duration</literal></quote>,
417
<quote><literal>created</literal></quote>,
418
<quote><literal>enabled</literal></quote>,
419
<quote><literal>expires</literal></quote>,
420
<quote><literal>fingerprint</literal></quote>,
421
<quote><literal>host</literal></quote>,
422
<quote><literal>interval</literal></quote>,
423
<quote><literal>last_approval_request</literal></quote>,
424
<quote><literal>last_checked_ok</literal></quote>,
425
<quote><literal>last_enabled</literal></quote>,
426
<quote><literal>name</literal></quote>,
427
<quote><literal>timeout</literal></quote>, and, if using
428
D-Bus, <quote><literal>dbus_object_path</literal></quote>.
429
See the source code for details. <emphasis role="strong"
430
>Currently, <emphasis>none</emphasis> of these attributes
431
except <quote><literal>host</literal></quote> are guaranteed
432
to be valid in future versions.</emphasis> Therefore, please
433
let the authors know of any attributes that are useful so they
434
may be preserved to any new versions of this software.
318
437
Note that this means that, in order to include an actual
319
438
percent character (<quote>%</quote>) in a
320
<varname>checker</varname> options, <emphasis>four</emphasis>
439
<varname>checker</varname> option, <emphasis>four</emphasis>
321
440
percent characters in a row (<quote>%%%%</quote>) must be
322
441
entered. Also, a bad format here will lead to an immediate
323
442
but <emphasis>silent</emphasis> run-time fatal exit; debug
324
mode is needed to track down an error of this kind.
443
mode is needed to expose an error of this kind.
330
449
<refsect1 id="files">
331
450
<title>FILES</title>
376
496
5MHdW9AYsNJZAQSOpirE4Xi31CSlWAi9KV+cUCmWF5zOFy1x23P6PjdaRm
377
497
4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
380
499
host = foo.example.org
385
504
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
386
secfile = /etc/mandos/bar-secret.txt.asc
505
secfile = /etc/mandos/bar-secret
507
approved_by_default = False
508
approval_delay = PT30S
388
509
</programlisting>
389
510
</informalexample>
513
<refsect1 id="see_also">
514
<title>SEE ALSO</title>
516
<citerefentry><refentrytitle>intro</refentrytitle>
517
<manvolnum>8mandos</manvolnum></citerefentry>,
518
<citerefentry><refentrytitle>mandos-keygen</refentrytitle>
519
<manvolnum>8</manvolnum></citerefentry>,
520
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
521
<manvolnum>5</manvolnum></citerefentry>,
522
<citerefentry><refentrytitle>mandos</refentrytitle>
523
<manvolnum>8</manvolnum></citerefentry>,
524
<citerefentry><refentrytitle>fping</refentrytitle>
525
<manvolnum>8</manvolnum></citerefentry>
530
RFC 3339: <citetitle>Date and Time on the Internet:
531
Timestamps</citetitle>
535
The time intervals are in the "duration" format, as
536
specified in ABNF in Appendix A of RFC 3339.
543
<!-- Local Variables: -->
544
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
545
<!-- time-stamp-end: "[\"']>" -->
546
<!-- time-stamp-format: "%:y-%02m-%02d" -->