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 "2008-10-07">
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>
33
36
<holder>Teddy Hogeborn</holder>
34
37
<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/"/>.
39
<xi:include href="legalnotice.xml"/>
62
43
<refentrytitle>&CONFNAME;</refentrytitle>
63
44
<manvolnum>5</manvolnum>
115
94
start time expansion, see <xref linkend="expansion"/>.
118
Uknown options are ignored. The used options are as follows:
97
Unknown options are ignored. The used options are as follows:
124
<term><literal><varname>timeout</varname></literal></term>
103
<term><option>timeout<literal> = </literal><replaceable
104
>TIME</replaceable></option></term>
126
<synopsis><literal>timeout = </literal><replaceable
107
This option is <emphasis>optional</emphasis>.
130
110
The timeout is how long the server will wait for a
131
111
successful checker run until a client is considered
152
<term><literal><varname>interval</varname></literal></term>
132
<term><option>interval<literal> = </literal><replaceable
133
>TIME</replaceable></option></term>
154
<synopsis><literal>interval = </literal><replaceable
136
This option is <emphasis>optional</emphasis>.
158
139
How often to run the checker to confirm that a client is
159
140
still up. <emphasis>Note:</emphasis> a new checker will
168
149
as for <varname>timeout</varname> above.
174
<term><literal>checker</literal></term>
155
<term><option>checker<literal> = </literal><replaceable
156
>COMMAND</replaceable></option></term>
176
<synopsis><literal>checker = </literal><replaceable
177
>COMMAND</replaceable>
159
This option is <emphasis>optional</emphasis>.
180
162
This option allows you to override the default shell
181
163
command that the server will use to check if the client is
201
<term><literal>fingerprint</literal></term>
183
<term><option>fingerprint<literal> = </literal
184
><replaceable>HEXSTRING</replaceable></option></term>
203
<synopsis><literal>fingerprint = </literal><replaceable
204
>HEXSTRING</replaceable>
187
This option is <emphasis>required</emphasis>.
207
190
This option sets the OpenPGP fingerprint that identifies
208
191
the public key that clients authenticate themselves with
216
<term><literal>secret</literal></term>
199
<term><option>secret<literal> = </literal><replaceable
200
>BASE64_ENCODED_DATA</replaceable></option></term>
218
<synopsis><literal>secret = </literal><replaceable
219
>BASE64_ENCODED_DATA</replaceable>
203
If this option is not specified, the <option
204
>secfile</option> option is <emphasis>required</emphasis>
222
208
If present, this option must be set to a string of
223
209
base64-encoded binary data. It will be decoded and sent
236
222
lines is that a line beginning with white space adds to
237
223
the value of the previous line, RFC 822-style.
240
If this option is not specified, the <option
241
>secfile</option> option is used instead, but one of them
242
<emphasis>must</emphasis> be present.
248
<term><literal>secfile</literal></term>
250
<synopsis><literal>secfile = </literal><replaceable
251
>FILENAME</replaceable>
254
The same as <option>secret</option>, but the secret data
255
is in an external file. The contents of the file should
256
<emphasis>not</emphasis> be base64-encoded, but will be
257
sent to clients verbatim.
260
This option is only used, and <emphasis>must</emphasis> be
261
present, if <option>secret</option> is not specified.
267
<term><literal>host</literal></term>
269
<synopsis><literal>host = </literal><replaceable
270
>STRING</replaceable>
229
<term><option>secfile<literal> = </literal><replaceable
230
>FILENAME</replaceable></option></term>
233
This option is only used if <option>secret</option> is not
234
specified, in which case this option is
235
<emphasis>required</emphasis>.
238
Similar to the <option>secret</option>, except the secret
239
data is in an external file. The contents of the file
240
should <emphasis>not</emphasis> be base64-encoded, but
241
will be sent to clients verbatim.
244
File names of the form <filename>~user/foo/bar</filename>
245
and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
252
<term><option><literal>host = </literal><replaceable
253
>STRING</replaceable></option></term>
256
This option is <emphasis>optional</emphasis>, but highly
257
<emphasis>recommended</emphasis> unless the
258
<option>checker</option> option is modified to a
259
non-standard value without <quote>%(host)s</quote> in it.
273
262
Host name for this client. This is not used by the server
274
263
directly, but can be, and is by default, used by the
327
316
percent characters in a row (<quote>%%%%</quote>) must be
328
317
entered. Also, a bad format here will lead to an immediate
329
318
but <emphasis>silent</emphasis> run-time fatal exit; debug
330
mode is needed to track down an error of this kind.
319
mode is needed to expose an error of this kind.
336
325
<refsect1 id="files">
337
326
<title>FILES</title>
390
379
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
391
380
secfile = /etc/mandos/bar-secret
394
382
</programlisting>
395
383
</informalexample>
398
386
<refsect1 id="see_also">
399
387
<title>SEE ALSO</title>
402
<refentrytitle>mandos</refentrytitle>
403
<manvolnum>8</manvolnum></citerefentry>, <citerefentry>
404
<refentrytitle>mandos-keygen</refentrytitle>
405
<manvolnum>8</manvolnum></citerefentry>, <citerefentry>
406
<refentrytitle>mandos.conf</refentrytitle>
407
<manvolnum>5</manvolnum></citerefentry>
389
<citerefentry><refentrytitle>mandos-keygen</refentrytitle>
390
<manvolnum>8</manvolnum></citerefentry>,
391
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
392
<manvolnum>5</manvolnum></citerefentry>,
393
<citerefentry><refentrytitle>mandos</refentrytitle>
394
<manvolnum>8</manvolnum></citerefentry>
398
<!-- Local Variables: -->
399
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
400
<!-- time-stamp-end: "[\"']>" -->
401
<!-- time-stamp-format: "%:y-%02m-%02d" -->
added
removed
mandos-clients.conf.xml
