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 "2016-02-28">
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>
44
35
<holder>Teddy Hogeborn</holder>
45
36
<holder>Björn Påhlsson</holder>
47
<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/"/>.
51
64
<refentrytitle>&CONFNAME;</refentrytitle>
52
65
<manvolnum>5</manvolnum>
70
85
><refentrytitle>mandos</refentrytitle>
71
86
<manvolnum>8</manvolnum></citerefentry>, read by it at startup.
72
87
The file needs to list all clients that should be able to use
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.
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
82
93
The format starts with a <literal>[<replaceable>section
106
117
start time expansion, see <xref linkend="expansion"/>.
109
Unknown options are ignored. The used options are as follows:
120
Uknown options are ignored. The used options are as follows:
115
<term><option>approval_delay<literal> = </literal><replaceable
116
>TIME</replaceable></option></term>
119
This option is <emphasis>optional</emphasis>.
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.
127
The format of <replaceable>TIME</replaceable> is the same
128
as for <varname>timeout</varname> below.
134
<term><option>approval_duration<literal> = </literal
135
><replaceable>TIME</replaceable></option></term>
138
This option is <emphasis>optional</emphasis>.
141
How long an external approval lasts. The default is 1
145
The format of <replaceable>TIME</replaceable> is the same
146
as for <varname>timeout</varname> below.
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>
159
Whether to approve a client by default after
160
the <option>approval_delay</option>. The default
161
is <quote>True</quote>.
167
<term><option>checker<literal> = </literal><replaceable
168
>COMMAND</replaceable></option></term>
171
This option is <emphasis>optional</emphasis>.
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>
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>
180
188
<option>-c</option></command></quote>, so
181
189
<varname>PATH</varname> will be searched. The default
182
190
value for the checker command is <quote><literal
183
191
><command>fping</command> <option>-q</option> <option
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
192
>--</option> %(host)s</literal></quote>.
193
195
In addition to normal start time expansion, this option
201
<term><option>extended_timeout<literal> = </literal><replaceable
202
>TIME</replaceable></option></term>
205
This option is <emphasis>optional</emphasis>.
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.
217
The format of <replaceable>TIME</replaceable> is the same
218
as for <varname>timeout</varname> below.
224
<term><option>fingerprint<literal> = </literal
225
><replaceable>HEXSTRING</replaceable></option></term>
228
This option is <emphasis>required</emphasis>.
203
<term><literal>fingerprint</literal></term>
205
<synopsis><literal>fingerprint = </literal><replaceable
206
>HEXSTRING</replaceable>
231
209
This option sets the OpenPGP fingerprint that identifies
232
210
the public key that clients authenticate themselves with
240
<term><option><literal>host = </literal><replaceable
241
>STRING</replaceable></option></term>
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.
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.
258
<term><option>interval<literal> = </literal><replaceable
259
>TIME</replaceable></option></term>
262
This option is <emphasis>optional</emphasis>.
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.
274
The format of <replaceable>TIME</replaceable> is the same
275
as for <varname>timeout</varname> below.
281
<term><option>secfile<literal> = </literal><replaceable
282
>FILENAME</replaceable></option></term>
285
This option is only used if <option>secret</option> is not
286
specified, in which case this option is
287
<emphasis>required</emphasis>.
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.
296
File names of the form <filename>~user/foo/bar</filename>
297
and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
304
<term><option>secret<literal> = </literal><replaceable
305
>BASE64_ENCODED_DATA</replaceable></option></term>
308
If this option is not specified, the <option
309
>secfile</option> option is <emphasis>required</emphasis>
218
<term><literal>secret</literal></term>
220
<synopsis><literal>secret = </literal><replaceable
221
>BASE64_ENCODED_DATA</replaceable>
313
224
If present, this option must be set to a string of
314
225
base64-encoded binary data. It will be decoded and sent
327
238
lines is that a line beginning with white space adds to
328
239
the value of the previous line, RFC 822-style.
334
<term><option>timeout<literal> = </literal><replaceable
335
>TIME</replaceable></option></term>
338
This option is <emphasis>optional</emphasis>.
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.
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.
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>
366
Whether this client should be enabled by default. The
367
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.
407
317
<quote><literal>%%(<replaceable>foo</replaceable>)s</literal
408
318
></quote> will be replaced by the value of the attribute
409
319
<varname>foo</varname> of the internal
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.
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.
435
326
Note that this means that, in order to include an actual
510
400
<refsect1 id="see_also">
511
401
<title>SEE ALSO</title>
513
<citerefentry><refentrytitle>intro</refentrytitle>
514
<manvolnum>8mandos</manvolnum></citerefentry>,
515
403
<citerefentry><refentrytitle>mandos-keygen</refentrytitle>
516
404
<manvolnum>8</manvolnum></citerefentry>,
517
405
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
518
406
<manvolnum>5</manvolnum></citerefentry>,
519
407
<citerefentry><refentrytitle>mandos</refentrytitle>
520
<manvolnum>8</manvolnum></citerefentry>,
521
<citerefentry><refentrytitle>fping</refentrytitle>
522
408
<manvolnum>8</manvolnum></citerefentry>
527
RFC 3339: <citetitle>Date and Time on the Internet:
528
Timestamps</citetitle>
532
The time intervals are in the "duration" format, as
533
specified in ABNF in Appendix A of RFC 3339.
540
412
<!-- Local Variables: -->