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 "2012-01-01">
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
40
<holder>Teddy Hogeborn</holder>
34
41
<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/"/>.
43
<xi:include href="legalnotice.xml"/>
62
47
<refentrytitle>&CONFNAME;</refentrytitle>
63
48
<manvolnum>5</manvolnum>
111
93
<refsect1 id="options">
112
94
<title>OPTIONS</title>
114
The possible options are:
96
<emphasis>Note:</emphasis> all option values are subject to
97
start time expansion, see <xref linkend="expansion"/>.
100
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>
106
<term><option>approval_delay<literal> = </literal><replaceable
107
>TIME</replaceable></option></term>
110
This option is <emphasis>optional</emphasis>.
113
How long to wait for external approval before resorting to
114
use the <option>approved_by_default</option> value. The
115
default is <quote>0s</quote>, i.e. not to wait.
118
The format of <replaceable>TIME</replaceable> is the same
119
as for <varname>timeout</varname> below.
125
<term><option>approval_duration<literal> = </literal
126
><replaceable>TIME</replaceable></option></term>
129
This option is <emphasis>optional</emphasis>.
132
How long an external approval lasts. The default is 1
136
The format of <replaceable>TIME</replaceable> is the same
137
as for <varname>timeout</varname> below.
143
<term><option>approved_by_default<literal> = </literal
144
>{ <literal >1</literal> | <literal>yes</literal> | <literal
145
>true</literal> | <literal>on</literal> | <literal
146
>0</literal> | <literal>no</literal> | <literal
147
>false</literal> | <literal>off</literal> }</option></term>
150
Whether to approve a client by default after
151
the <option>approval_delay</option>. The default
152
is <quote>True</quote>.
158
<term><option>checker<literal> = </literal><replaceable
159
>COMMAND</replaceable></option></term>
162
This option is <emphasis>optional</emphasis>.
176
165
This option allows you to override the default shell
177
166
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
180
<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>.
167
still up. Any output of the command will be ignored, only
168
the exit code is checked: If the exit code of the command
169
is zero, the client is considered up. The command will be
170
run using <quote><command><filename>/bin/sh</filename>
171
<option>-c</option></command></quote>, so
172
<varname>PATH</varname> will be searched. The default
173
value for the checker command is <quote><literal
174
><command>fping</command> <option>-q</option> <option
175
>--</option> %%(host)s</literal></quote>.
187
178
In addition to normal start time expansion, this option
195
<term><literal>fingerprint</literal></term>
197
<synopsis><literal>fingerprint = </literal><replaceable
198
>HEXSTRING</replaceable>
186
<term><option>extended_timeout<literal> = </literal><replaceable
187
>TIME</replaceable></option></term>
190
This option is <emphasis>optional</emphasis>.
193
Extended timeout is an added timeout that is given once
194
after a password has been sent successfully to a client.
195
The timeout is by default longer than the normal timeout,
196
and is used for handling the extra long downtime while a
197
machine is booting up. Time to take into consideration
198
when changing this value is file system checks and quota
199
checks. The default value is 15 minutes.
202
The format of <replaceable>TIME</replaceable> is the same
203
as for <varname>timeout</varname> below.
209
<term><option>fingerprint<literal> = </literal
210
><replaceable>HEXSTRING</replaceable></option></term>
213
This option is <emphasis>required</emphasis>.
201
216
This option sets the OpenPGP fingerprint that identifies
202
217
the public key that clients authenticate themselves with
210
<term><literal>secret</literal></term>
212
<synopsis><literal>secret = </literal><replaceable
213
>BASE64_ENCODED_DATA</replaceable>
225
<term><option><literal>host = </literal><replaceable
226
>STRING</replaceable></option></term>
229
This option is <emphasis>optional</emphasis>, but highly
230
<emphasis>recommended</emphasis> unless the
231
<option>checker</option> option is modified to a
232
non-standard value without <quote>%%(host)s</quote> in it.
235
Host name for this client. This is not used by the server
236
directly, but can be, and is by default, used by the
237
checker. See the <option>checker</option> option.
243
<term><option>interval<literal> = </literal><replaceable
244
>TIME</replaceable></option></term>
247
This option is <emphasis>optional</emphasis>.
250
How often to run the checker to confirm that a client is
251
still up. <emphasis>Note:</emphasis> a new checker will
252
not be started if an old one is still running. The server
253
will wait for a checker to complete until the below
254
<quote><varname>timeout</varname></quote> occurs, at which
255
time the client will be disabled, and any running checker
256
killed. The default interval is 2 minutes.
259
The format of <replaceable>TIME</replaceable> is the same
260
as for <varname>timeout</varname> below.
266
<term><option>secfile<literal> = </literal><replaceable
267
>FILENAME</replaceable></option></term>
270
This option is only used if <option>secret</option> is not
271
specified, in which case this option is
272
<emphasis>required</emphasis>.
275
Similar to the <option>secret</option>, except the secret
276
data is in an external file. The contents of the file
277
should <emphasis>not</emphasis> be base64-encoded, but
278
will be sent to clients verbatim.
281
File names of the form <filename>~user/foo/bar</filename>
282
and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
289
<term><option>secret<literal> = </literal><replaceable
290
>BASE64_ENCODED_DATA</replaceable></option></term>
293
If this option is not specified, the <option
294
>secfile</option> option is <emphasis>required</emphasis>
216
298
If present, this option must be set to a string of
217
299
base64-encoded binary data. It will be decoded and sent
218
300
to the client matching the above
219
301
<option>fingerprint</option>. This should, of course, be
220
302
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
303
The program <citerefentry><refentrytitle><command
304
>mandos-keygen</command></refentrytitle><manvolnum
305
>8</manvolnum></citerefentry> can, using its
306
<option>--password</option> option, be used to generate
310
Note: this value of this option will probably be very
311
long. A useful feature to avoid having unreadably-long
312
lines is that a line beginning with white space adds to
313
the value of the previous line, RFC 822-style.
319
<term><option>timeout<literal> = </literal><replaceable
320
>TIME</replaceable></option></term>
323
This option is <emphasis>optional</emphasis>.
326
The timeout is how long the server will wait, after a
327
successful checker run, until a client is disabled and not
328
allowed to get the data this server holds. By default
329
Mandos will use 5 minutes. See also the
330
<option>extended_timeout</option> option.
333
The <replaceable>TIME</replaceable> is specified as a
334
space-separated number of values, each of which is a
335
number and a one-character suffix. The suffix must be one
336
of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
337
<quote>h</quote>, and <quote>w</quote> for days, seconds,
338
minutes, hours, and weeks, respectively. The values are
339
added together to give the total time value, so all of
340
<quote><literal>330s</literal></quote>,
341
<quote><literal>110s 110s 110s</literal></quote>, and
342
<quote><literal>5m 30s</literal></quote> will give a value
343
of five minutes and thirty seconds.
349
<term><option>enabled<literal> = </literal>{ <literal
350
>1</literal> | <literal>yes</literal> | <literal>true</literal
351
> | <literal >on</literal> | <literal>0</literal> | <literal
352
>no</literal> | <literal>false</literal> | <literal
353
>off</literal> }</option></term>
356
Whether this client should be enabled by default. The
357
default is <quote>true</quote>.
277
365
<refsect1 id="expansion">
278
366
<title>EXPANSION</title>
309
397
<quote><literal>%%(<replaceable>foo</replaceable>)s</literal
310
398
></quote> will be replaced by the value of the attribute
311
399
<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.
400
<quote><classname>Client</classname></quote> object in the
401
Mandos server. The currently allowed values for
402
<replaceable>foo</replaceable> are:
403
<quote><literal>approval_delay</literal></quote>,
404
<quote><literal>approval_duration</literal></quote>,
405
<quote><literal>created</literal></quote>,
406
<quote><literal>enabled</literal></quote>,
407
<quote><literal>fingerprint</literal></quote>,
408
<quote><literal>host</literal></quote>,
409
<quote><literal>interval</literal></quote>,
410
<quote><literal>last_approval_request</literal></quote>,
411
<quote><literal>last_checked_ok</literal></quote>,
412
<quote><literal>last_enabled</literal></quote>,
413
<quote><literal>name</literal></quote>,
414
<quote><literal>timeout</literal></quote>, and, if using
415
D-Bus, <quote><literal>dbus_object_path</literal></quote>.
416
See the source code for details. <emphasis role="strong"
417
>Currently, <emphasis>none</emphasis> of these attributes
418
except <quote><literal>host</literal></quote> are guaranteed
419
to be valid in future versions.</emphasis> Therefore, please
420
let the authors know of any attributes that are useful so they
421
may be preserved to any new versions of this software.
318
424
Note that this means that, in order to include an actual
319
425
percent character (<quote>%</quote>) in a
320
<varname>checker</varname> options, <emphasis>four</emphasis>
426
<varname>checker</varname> option, <emphasis>four</emphasis>
321
427
percent characters in a row (<quote>%%%%</quote>) must be
322
428
entered. Also, a bad format here will lead to an immediate
323
429
but <emphasis>silent</emphasis> run-time fatal exit; debug
324
mode is needed to track down an error of this kind.
430
mode is needed to expose an error of this kind.
330
436
<refsect1 id="files">
331
437
<title>FILES</title>
376
482
5MHdW9AYsNJZAQSOpirE4Xi31CSlWAi9KV+cUCmWF5zOFy1x23P6PjdaRm
377
483
4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
380
485
host = foo.example.org
385
490
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
386
secfile = /etc/mandos/bar-secret.txt.asc
491
secfile = /etc/mandos/bar-secret
493
approved_by_default = False
388
495
</programlisting>
389
496
</informalexample>
499
<refsect1 id="see_also">
500
<title>SEE ALSO</title>
502
<citerefentry><refentrytitle>intro</refentrytitle>
503
<manvolnum>8mandos</manvolnum></citerefentry>,
504
<citerefentry><refentrytitle>mandos-keygen</refentrytitle>
505
<manvolnum>8</manvolnum></citerefentry>,
506
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
507
<manvolnum>5</manvolnum></citerefentry>,
508
<citerefentry><refentrytitle>mandos</refentrytitle>
509
<manvolnum>8</manvolnum></citerefentry>
513
<!-- Local Variables: -->
514
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
515
<!-- time-stamp-end: "[\"']>" -->
516
<!-- time-stamp-format: "%:y-%02m-%02d" -->