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">
4
5
<!ENTITY CONFNAME "mandos-clients.conf">
5
6
<!ENTITY CONFPATH "<filename>/etc/mandos/clients.conf</filename>">
6
<!ENTITY TIMESTAMP "2019-02-09">
7
<!ENTITY % common SYSTEM "common.ent">
7
<!ENTITY TIMESTAMP "2008-08-30">
11
<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>
20
19
<firstname>Björn</firstname>
21
20
<surname>Påhlsson</surname>
23
<email>belorn@recompile.se</email>
22
<email>belorn@fukt.bsnet.se</email>
27
26
<firstname>Teddy</firstname>
28
27
<surname>Hogeborn</surname>
30
<email>teddy@recompile.se</email>
29
<email>teddy@fukt.bsnet.se</email>
46
35
<holder>Teddy Hogeborn</holder>
47
36
<holder>Björn Påhlsson</holder>
49
<xi:include href="legalnotice.xml"/>
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
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
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/"/>.
53
64
<refentrytitle>&CONFNAME;</refentrytitle>
54
65
<manvolnum>5</manvolnum>
72
83
><refentrytitle>mandos</refentrytitle>
73
84
<manvolnum>8</manvolnum></citerefentry>, read by it at startup.
74
85
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.
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
84
91
The format starts with a <literal>[<replaceable>section
108
115
start time expansion, see <xref linkend="expansion"/>.
111
Unknown options are ignored. The used options are as follows:
118
Uknown options are ignored. The used options are as follows:
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>.
124
<term><option>timeout<literal> = </literal><replaceable
125
>TIME</replaceable></option></term>
128
The timeout is how long the server will wait for a
129
successful checker run until a client is considered
130
invalid - that is, ineligible to get the data this server
131
holds. By default Mandos will use 1 hour.
134
The <replaceable>TIME</replaceable> is specified as a
135
space-separated number of values, each of which is a
136
number and a one-character suffix. The suffix must be one
137
of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
138
<quote>h</quote>, and <quote>w</quote> for days, seconds,
139
minutes, hours, and weeks, respectively. The values are
140
added together to give the total time value, so all of
141
<quote><literal>330s</literal></quote>,
142
<quote><literal>110s 110s 110s</literal></quote>, and
143
<quote><literal>5m 30s</literal></quote> will give a value
144
of five minutes and thirty seconds.
150
<term><option>interval<literal> = </literal><replaceable
151
>TIME</replaceable></option></term>
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.
169
170
<term><option>checker<literal> = </literal><replaceable
170
171
>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
181
<quote><command><filename>/bin/sh</filename>
174
This option allows you to override the default shell
175
command that the server will use to check if the client is
176
still up. Any output of the command will be ignored, only
177
the exit code is checked: If the exit code of the command
178
is zero, the client is considered up. The command will be
179
run using <quote><command><filename>/bin/sh</filename>
182
180
<option>-c</option></command></quote>, so
183
181
<varname>PATH</varname> will be searched. The default
184
182
value for the checker command is <quote><literal
185
183
><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
184
>--</option> %(host)s</literal></quote>.
195
187
In addition to normal start time expansion, this option
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
195
<term><option>fingerprint<literal> = </literal
227
196
><replaceable>HEXSTRING</replaceable></option></term>
230
This option is <emphasis>required</emphasis>.
233
199
This option sets the OpenPGP fingerprint that identifies
234
200
the public key that clients authenticate themselves with
235
through TLS. The string needs to be in hexadecimal form,
236
but spaces or upper/lower case are not significant.
242
<term><option>key_id<literal> = </literal
243
><replaceable>HEXSTRING</replaceable></option></term>
246
This option is <emphasis>optional</emphasis>.
249
This option sets the certificate key ID that identifies
250
the public key that clients authenticate themselves with
251
through TLS. The string needs to be in hexadecimal form,
252
but spaces or upper/lower case are not significant.
258
<term><option><literal>host = </literal><replaceable
259
>STRING</replaceable></option></term>
262
This option is <emphasis>optional</emphasis>, but highly
263
<emphasis>recommended</emphasis> unless the
264
<option>checker</option> option is modified to a
265
non-standard value without <quote>%%(host)s</quote> in it.
268
Host name for this client. This is not used by the server
269
directly, but can be, and is by default, used by the
270
checker. See the <option>checker</option> option.
276
<term><option>interval<literal> = </literal><replaceable
277
>TIME</replaceable></option></term>
280
This option is <emphasis>optional</emphasis>.
283
How often to run the checker to confirm that a client is
284
still up. <emphasis>Note:</emphasis> a new checker will
285
not be started if an old one is still running. The server
286
will wait for a checker to complete until the below
287
<quote><varname>timeout</varname></quote> occurs, at which
288
time the client will be disabled, and any running checker
289
killed. The default interval is 2 minutes.
292
The format of <replaceable>TIME</replaceable> is the same
293
as for <varname>timeout</varname> below.
299
<term><option>secfile<literal> = </literal><replaceable
300
>FILENAME</replaceable></option></term>
303
This option is only used if <option>secret</option> is not
304
specified, in which case this option is
305
<emphasis>required</emphasis>.
308
Similar to the <option>secret</option>, except the secret
309
data is in an external file. The contents of the file
310
should <emphasis>not</emphasis> be base64-encoded, but
311
will be sent to clients verbatim.
314
File names of the form <filename>~user/foo/bar</filename>
315
and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
201
through TLS. The string needs to be in hexidecimal form,
202
but spaces or upper/lower case are not significant.
323
209
>BASE64_ENCODED_DATA</replaceable></option></term>
326
If this option is not specified, the <option
327
>secfile</option> option is <emphasis>required</emphasis>
331
212
If present, this option must be set to a string of
332
213
base64-encoded binary data. It will be decoded and sent
333
to the client matching the above <option>key_id</option>
334
or <option>fingerprint</option>. This should, of course,
335
be OpenPGP encrypted data, decryptable only by the client.
214
to the client matching the above
215
<option>fingerprint</option>. This should, of course, be
216
OpenPGP encrypted data, decryptable only by the client.
336
217
The program <citerefentry><refentrytitle><command
337
218
>mandos-keygen</command></refentrytitle><manvolnum
338
219
>8</manvolnum></citerefentry> can, using its
345
226
lines is that a line beginning with white space adds to
346
227
the value of the previous line, RFC 822-style.
352
<term><option>timeout<literal> = </literal><replaceable
353
>TIME</replaceable></option></term>
356
This option is <emphasis>optional</emphasis>.
359
The timeout is how long the server will wait, after a
360
successful checker run, until a client is disabled and not
361
allowed to get the data this server holds. By default
362
Mandos will use 5 minutes. See also the
363
<option>extended_timeout</option> option.
366
The <replaceable>TIME</replaceable> is specified as an RFC
367
3339 duration; for example
368
<quote><literal>P1Y2M3DT4H5M6S</literal></quote> meaning
369
one year, two months, three days, four hours, five
370
minutes, and six seconds. Some values can be omitted, see
371
RFC 3339 Appendix A for details.
377
<term><option>enabled<literal> = </literal>{ <literal
378
>1</literal> | <literal>yes</literal> | <literal>true</literal
379
> | <literal >on</literal> | <literal>0</literal> | <literal
380
>no</literal> | <literal>false</literal> | <literal
381
>off</literal> }</option></term>
384
Whether this client should be enabled by default. The
385
default is <quote>true</quote>.
230
If this option is not specified, the <option
231
>secfile</option> option is used instead, but one of them
232
<emphasis>must</emphasis> be present.
238
<term><option>secfile<literal> = </literal><replaceable
239
>FILENAME</replaceable></option></term>
242
Similar to the <option>secret</option>, except the secret
243
data is in an external file. The contents of the file
244
should <emphasis>not</emphasis> be base64-encoded, but
245
will be sent to clients verbatim.
248
This option is only used, and <emphasis>must</emphasis> be
249
present, if <option>secret</option> is not specified.
255
<term><option><literal>host = </literal><replaceable
256
>STRING</replaceable></option></term>
259
Host name for this client. This is not used by the server
260
directly, but can be, and is by default, used by the
261
checker. See the <option>checker</option> option.
425
301
<quote><literal>%%(<replaceable>foo</replaceable>)s</literal
426
302
></quote> will be replaced by the value of the attribute
427
303
<varname>foo</varname> of the internal
428
<quote><classname>Client</classname></quote> object in the
429
Mandos server. The currently allowed values for
430
<replaceable>foo</replaceable> are:
431
<quote><literal>approval_delay</literal></quote>,
432
<quote><literal>approval_duration</literal></quote>,
433
<quote><literal>created</literal></quote>,
434
<quote><literal>enabled</literal></quote>,
435
<quote><literal>expires</literal></quote>,
436
<quote><literal>key_id</literal></quote>,
437
<quote><literal>fingerprint</literal></quote>,
438
<quote><literal>host</literal></quote>,
439
<quote><literal>interval</literal></quote>,
440
<quote><literal>last_approval_request</literal></quote>,
441
<quote><literal>last_checked_ok</literal></quote>,
442
<quote><literal>last_enabled</literal></quote>,
443
<quote><literal>name</literal></quote>,
444
<quote><literal>timeout</literal></quote>, and, if using
445
D-Bus, <quote><literal>dbus_object_path</literal></quote>.
446
See the source code for details. <emphasis role="strong"
447
>Currently, <emphasis>none</emphasis> of these attributes
448
except <quote><literal>host</literal></quote> are guaranteed
449
to be valid in future versions.</emphasis> Therefore, please
450
let the authors know of any attributes that are useful so they
451
may be preserved to any new versions of this software.
304
<quote><classname>Client</classname></quote> object. See the
305
source code for details, and let the authors know of any
306
attributes that are useful so they may be preserved to any new
307
versions of this software.
454
310
Note that this means that, in order to include an actual
532
384
<refsect1 id="see_also">
533
385
<title>SEE ALSO</title>
535
<citerefentry><refentrytitle>intro</refentrytitle>
536
<manvolnum>8mandos</manvolnum></citerefentry>,
537
387
<citerefentry><refentrytitle>mandos-keygen</refentrytitle>
538
388
<manvolnum>8</manvolnum></citerefentry>,
539
389
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
540
390
<manvolnum>5</manvolnum></citerefentry>,
541
391
<citerefentry><refentrytitle>mandos</refentrytitle>
542
<manvolnum>8</manvolnum></citerefentry>,
543
<citerefentry><refentrytitle>fping</refentrytitle>
544
392
<manvolnum>8</manvolnum></citerefentry>
549
RFC 3339: <citetitle>Date and Time on the Internet:
550
Timestamps</citetitle>
554
The time intervals are in the "duration" format, as
555
specified in ABNF in Appendix A of RFC 3339.
562
396
<!-- Local Variables: -->