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-10">
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>
47
35
<holder>Teddy Hogeborn</holder>
48
36
<holder>Björn Påhlsson</holder>
50
<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/"/>.
54
64
<refentrytitle>&CONFNAME;</refentrytitle>
55
65
<manvolnum>5</manvolnum>
73
85
><refentrytitle>mandos</refentrytitle>
74
86
<manvolnum>8</manvolnum></citerefentry>, read by it at startup.
75
87
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.
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
85
93
The format starts with a <literal>[<replaceable>section
109
117
start time expansion, see <xref linkend="expansion"/>.
112
Unknown options are ignored. The used options are as follows:
120
Uknown options are ignored. The used options are as follows:
118
<term><option>approval_delay<literal> = </literal><replaceable
119
>TIME</replaceable></option></term>
122
This option is <emphasis>optional</emphasis>.
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.
130
The format of <replaceable>TIME</replaceable> is the same
131
as for <varname>timeout</varname> below.
137
<term><option>approval_duration<literal> = </literal
138
><replaceable>TIME</replaceable></option></term>
141
This option is <emphasis>optional</emphasis>.
144
How long an external approval lasts. The default is 1
148
The format of <replaceable>TIME</replaceable> is the same
149
as for <varname>timeout</varname> below.
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>
162
Whether to approve a client by default after
163
the <option>approval_delay</option>. The default
164
is <quote>True</quote>.
170
<term><option>checker<literal> = </literal><replaceable
171
>COMMAND</replaceable></option></term>
174
This option is <emphasis>optional</emphasis>.
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>
126
<term><literal><varname>timeout</varname></literal></term>
128
<synopsis><literal>timeout = </literal><replaceable
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.
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.
154
<term><literal><varname>interval</varname></literal></term>
156
<synopsis><literal>interval = </literal><replaceable
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.
169
The format of <replaceable>TIME</replaceable> is the same
170
as for <varname>timeout</varname> above.
176
<term><literal>checker</literal></term>
178
<synopsis><literal>checker = </literal><replaceable
179
>COMMAND</replaceable>
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>
183
188
<option>-c</option></command></quote>, so
184
189
<varname>PATH</varname> will be searched. The default
185
190
value for the checker command is <quote><literal
186
191
><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
192
>--</option> %(host)s</literal></quote>.
196
195
In addition to normal start time expansion, this option
204
<term><option>extended_timeout<literal> = </literal><replaceable
205
>TIME</replaceable></option></term>
208
This option is <emphasis>optional</emphasis>.
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.
220
The format of <replaceable>TIME</replaceable> is the same
221
as for <varname>timeout</varname> below.
227
<term><option>fingerprint<literal> = </literal
228
><replaceable>HEXSTRING</replaceable></option></term>
231
This option is <emphasis>required</emphasis>.
203
<term><literal>fingerprint</literal></term>
205
<synopsis><literal>fingerprint = </literal><replaceable
206
>HEXSTRING</replaceable>
234
209
This option sets the OpenPGP fingerprint that identifies
235
210
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.
243
<term><option>key_id<literal> = </literal
244
><replaceable>HEXSTRING</replaceable></option></term>
247
This option is <emphasis>optional</emphasis>.
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.
259
<term><option><literal>host = </literal><replaceable
260
>STRING</replaceable></option></term>
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.
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.
277
<term><option>interval<literal> = </literal><replaceable
278
>TIME</replaceable></option></term>
281
This option is <emphasis>optional</emphasis>.
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.
293
The format of <replaceable>TIME</replaceable> is the same
294
as for <varname>timeout</varname> below.
300
<term><option>secfile<literal> = </literal><replaceable
301
>FILENAME</replaceable></option></term>
304
This option is only used if <option>secret</option> is not
305
specified, in which case this option is
306
<emphasis>required</emphasis>.
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.
315
File names of the form <filename>~user/foo/bar</filename>
316
and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
323
<term><option>secret<literal> = </literal><replaceable
324
>BASE64_ENCODED_DATA</replaceable></option></term>
327
If this option is not specified, the <option
328
>secfile</option> option is <emphasis>required</emphasis>
211
through TLS. The string needs to be in hexidecimal form,
212
but spaces or upper/lower case are not significant.
218
<term><literal>secret</literal></term>
220
<synopsis><literal>secret = </literal><replaceable
221
>BASE64_ENCODED_DATA</replaceable>
332
224
If present, this option must be set to a string of
333
225
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.
226
to the client matching the above
227
<option>fingerprint</option>. This should, of course, be
228
OpenPGP encrypted data, decryptable only by the client.
337
229
The program <citerefentry><refentrytitle><command
338
230
>mandos-keygen</command></refentrytitle><manvolnum
339
231
>8</manvolnum></citerefentry> can, using its
346
238
lines is that a line beginning with white space adds to
347
239
the value of the previous line, RFC 822-style.
353
<term><option>timeout<literal> = </literal><replaceable
354
>TIME</replaceable></option></term>
357
This option is <emphasis>optional</emphasis>.
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.
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.
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>
385
Whether this client should be enabled by default. The
386
default is <quote>true</quote>.
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.
250
<term><literal>secfile</literal></term>
252
<synopsis><literal>secfile = </literal><replaceable
253
>FILENAME</replaceable>
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.
262
This option is only used, and <emphasis>must</emphasis> be
263
present, if <option>secret</option> is not specified.
269
<term><literal>host</literal></term>
271
<synopsis><literal>host = </literal><replaceable
272
>STRING</replaceable>
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.
426
317
<quote><literal>%%(<replaceable>foo</replaceable>)s</literal
427
318
></quote> will be replaced by the value of the attribute
428
319
<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.
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.
455
326
Note that this means that, in order to include an actual
533
400
<refsect1 id="see_also">
534
401
<title>SEE ALSO</title>
536
<citerefentry><refentrytitle>intro</refentrytitle>
537
<manvolnum>8mandos</manvolnum></citerefentry>,
538
403
<citerefentry><refentrytitle>mandos-keygen</refentrytitle>
539
404
<manvolnum>8</manvolnum></citerefentry>,
540
405
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
541
406
<manvolnum>5</manvolnum></citerefentry>,
542
407
<citerefentry><refentrytitle>mandos</refentrytitle>
543
<manvolnum>8</manvolnum></citerefentry>,
544
<citerefentry><refentrytitle>fping</refentrytitle>
545
408
<manvolnum>8</manvolnum></citerefentry>
550
RFC 3339: <citetitle>Date and Time on the Internet:
551
Timestamps</citetitle>
555
The time intervals are in the "duration" format, as
556
specified in ABNF in Appendix A of RFC 3339.
563
412
<!-- Local Variables: -->