/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to clients.conf.xml

  • Committer: Björn Påhlsson
  • Date: 2008-08-08 01:51:58 UTC
  • mto: (237.7.1 mandos) (24.1.154 mandos)
  • mto: This revision was merged to the branch mainline in revision 50.
  • Revision ID: belorn@braxen-20080808015158-gudud63aet3l8jlw
minor edits

Show diffs side-by-side

added added

removed removed

Lines of Context:
clients.conf.xml
1
 
<?xml version="1.0" encoding="UTF-8"?>
 
1
<?xml version='1.0' encoding='UTF-8'?>
 
2
<?xml-stylesheet type="text/xsl"
 
3
        href="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl"?>
2
4
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
5
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
 
6
<!ENTITY VERSION "1.0">
4
7
<!ENTITY CONFNAME "mandos-clients.conf">
5
8
<!ENTITY CONFPATH "<filename>/etc/mandos/clients.conf</filename>">
6
 
<!ENTITY TIMESTAMP "2011-11-26">
7
 
<!ENTITY % common SYSTEM "common.ent">
8
 
%common;
9
9
]>
10
10
 
11
 
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
 
11
<refentry>
12
12
  <refentryinfo>
13
 
    <title>Mandos Manual</title>
14
 
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
15
 
    <productname>Mandos</productname>
16
 
    <productnumber>&version;</productnumber>
17
 
    <date>&TIMESTAMP;</date>
 
13
    <title>&CONFNAME;</title>
 
14
    <!-- NWalsh's docbook scripts use this to generate the footer: -->
 
15
    <productname>&CONFNAME;</productname>
 
16
    <productnumber>&VERSION;</productnumber>
18
17
    <authorgroup>
19
18
      <author>
20
19
        <firstname>Björn</firstname>
21
20
        <surname>Påhlsson</surname>
22
21
        <address>
23
 
          <email>belorn@recompile.se</email>
 
22
          <email>belorn@fukt.bsnet.se</email>
24
23
        </address>
25
24
      </author>
26
25
      <author>
27
26
        <firstname>Teddy</firstname>
28
27
        <surname>Hogeborn</surname>
29
28
        <address>
30
 
          <email>teddy@recompile.se</email>
 
29
          <email>teddy@fukt.bsnet.se</email>
31
30
        </address>
32
31
      </author>
33
32
    </authorgroup>
34
33
    <copyright>
35
34
      <year>2008</year>
36
 
      <year>2009</year>
37
 
      <year>2010</year>
38
 
      <year>2011</year>
39
 
      <holder>Teddy Hogeborn</holder>
40
 
      <holder>Björn Påhlsson</holder>
 
35
      <holder>Teddy Hogeborn &amp; Björn Påhlsson</holder>
41
36
    </copyright>
42
 
    <xi:include href="legalnotice.xml"/>
 
37
    <legalnotice>
 
38
      <para>
 
39
        This manual page is free software: you can redistribute it
 
40
        and/or modify it under the terms of the GNU General Public
 
41
        License as published by the Free Software Foundation,
 
42
        either version 3 of the License, or (at your option) any
 
43
        later version.
 
44
      </para>
 
45
 
 
46
      <para>
 
47
        This manual page is distributed in the hope that it will
 
48
        be useful, but WITHOUT ANY WARRANTY; without even the
 
49
        implied warranty of MERCHANTABILITY or FITNESS FOR A
 
50
        PARTICULAR PURPOSE.  See the GNU General Public License
 
51
        for more details.
 
52
      </para>
 
53
 
 
54
      <para>
 
55
        You should have received a copy of the GNU General Public
 
56
        License along with this program; If not, see
 
57
        <ulink url="http://www.gnu.org/licenses/"/>.
 
58
      </para>
 
59
    </legalnotice>
43
60
  </refentryinfo>
44
 
  
 
61
 
45
62
  <refmeta>
46
63
    <refentrytitle>&CONFNAME;</refentrytitle>
47
64
    <manvolnum>5</manvolnum>
50
67
  <refnamediv>
51
68
    <refname><filename>&CONFNAME;</filename></refname>
52
69
    <refpurpose>
53
 
      Configuration file for the Mandos server
 
70
      Configuration file for Mandos clients
54
71
    </refpurpose>
55
72
  </refnamediv>
56
 
  
 
73
 
57
74
  <refsynopsisdiv>
58
 
    <synopsis>&CONFPATH;</synopsis>
 
75
    <synopsis>
 
76
      &CONFPATH;
 
77
    </synopsis>
59
78
  </refsynopsisdiv>
60
 
  
 
79
 
61
80
  <refsect1 id="description">
62
81
    <title>DESCRIPTION</title>
63
82
    <para>
64
 
      The file &CONFPATH; is a configuration file for <citerefentry
65
 
      ><refentrytitle>mandos</refentrytitle>
66
 
      <manvolnum>8</manvolnum></citerefentry>, read by it at startup.
67
 
      The file needs to list all clients that should be able to use
68
 
      the service.  All clients listed will be regarded as enabled,
69
 
      even if a client was disabled in a previous run of the server.
70
 
    </para>
71
 
    <para>
72
 
      The format starts with a <literal>[<replaceable>section
73
 
      header</replaceable>]</literal> which is either
74
 
      <literal>[DEFAULT]</literal> or <literal>[<replaceable>client
75
 
      name</replaceable>]</literal>.  The <replaceable>client
76
 
      name</replaceable> can be anything, and is not tied to a host
77
 
      name.  Following the section header is any number of
78
 
      <quote><varname><replaceable>option</replaceable
79
 
      ></varname>=<replaceable>value</replaceable></quote> entries,
80
 
      with continuations in the style of RFC 822.  <quote><varname
81
 
      ><replaceable>option</replaceable></varname>: <replaceable
82
 
      >value</replaceable></quote> is also accepted.  Note that
83
 
      leading whitespace is removed from values.  Values can contain
84
 
      format strings which refer to other values in the same section,
85
 
      or values in the <quote>DEFAULT</quote> section (see <xref
86
 
      linkend="expansion"/>).  Lines beginning with <quote>#</quote>
87
 
      or <quote>;</quote> are ignored and may be used to provide
88
 
      comments.
 
83
      The file &CONFPATH; is the configuration file for mandos where
 
84
      each client that will be abel to use the service need to be
 
85
      specified. The configuration file is looked on at the startup of
 
86
      the service, so to reenable timedout clients one need to only
 
87
      restart the server. The format starts with a section under []
 
88
      which is eather <literal>[DEFAULT]</literal> or a client
 
89
      name. Values is set through the use of VAR = VALUE pair. Values
 
90
      may not be empty.
89
91
    </para>
90
92
  </refsect1>
91
 
  
92
 
  <refsect1 id="options">
93
 
    <title>OPTIONS</title>
94
 
    <para>
95
 
      <emphasis>Note:</emphasis> all option values are subject to
96
 
      start time expansion, see <xref linkend="expansion"/>.
97
 
    </para>
98
 
    <para>
99
 
      Unknown options are ignored.  The used options are as follows:
100
 
    </para>
101
 
    
 
93
 
 
94
  <refsect1 id="default">
 
95
    <title>DEFAULTS</title>
 
96
    <para>
 
97
      The paramters for <literal>[DEFAULT]</literal> are:
 
98
    </para>
 
99
 
102
100
    <variablelist>
103
101
      
104
102
      <varlistentry>
105
 
        <term><option>approval_delay<literal> = </literal><replaceable
106
 
        >TIME</replaceable></option></term>
107
 
        <listitem>
108
 
          <para>
109
 
            This option is <emphasis>optional</emphasis>.
110
 
          </para>
111
 
          <para>
112
 
            How long to wait for external approval before resorting to
113
 
            use the <option>approved_by_default</option> value.  The
114
 
            default is <quote>0s</quote>, i.e. not to wait.
115
 
          </para>
116
 
          <para>
117
 
            The format of <replaceable>TIME</replaceable> is the same
118
 
            as for <varname>timeout</varname> below.
119
 
          </para>
120
 
        </listitem>
121
 
      </varlistentry>
122
 
      
123
 
      <varlistentry>
124
 
        <term><option>approval_duration<literal> = </literal
125
 
        ><replaceable>TIME</replaceable></option></term>
126
 
        <listitem>
127
 
          <para>
128
 
            This option is <emphasis>optional</emphasis>.
129
 
          </para>
130
 
          <para>
131
 
            How long an external approval lasts.  The default is 1
132
 
            second.
133
 
          </para>
134
 
          <para>
135
 
            The format of <replaceable>TIME</replaceable> is the same
136
 
            as for <varname>timeout</varname> below.
137
 
          </para>
138
 
        </listitem>
139
 
      </varlistentry>
140
 
      
141
 
      <varlistentry>
142
 
        <term><option>approved_by_default<literal> = </literal
143
 
          >{ <literal >1</literal> | <literal>yes</literal> | <literal
144
 
          >true</literal> | <literal>on</literal> | <literal
145
 
          >0</literal> | <literal>no</literal> | <literal
146
 
          >false</literal> | <literal>off</literal> }</option></term>
147
 
        <listitem>
148
 
          <para>
149
 
            Whether to approve a client by default after
150
 
            the <option>approval_delay</option>.  The default
151
 
            is <quote>True</quote>.
152
 
          </para>
153
 
        </listitem>
154
 
      </varlistentry>
155
 
      
156
 
      <varlistentry>
157
 
        <term><option>checker<literal> = </literal><replaceable
158
 
        >COMMAND</replaceable></option></term>
159
 
        <listitem>
160
 
          <para>
161
 
            This option is <emphasis>optional</emphasis>.
162
 
          </para>
 
103
        <term><literal>timeout</literal></term>
 
104
        <listitem>
 
105
          <para>
 
106
            This option allows you to override the default timeout
 
107
            that clients will get. By default mandos will use 1hr.
 
108
          </para>
 
109
        </listitem>
 
110
      </varlistentry>
 
111
 
 
112
      <varlistentry>
 
113
        <term><literal>interval</literal></term>
 
114
        <listitem>
 
115
          <para>
 
116
            This option allows you to override the default interval
 
117
            used between checkups for disconnected clients. By default
 
118
            mandos will use 5m.
 
119
          </para>
 
120
        </listitem>
 
121
      </varlistentry>      
 
122
 
 
123
      <varlistentry>
 
124
        <term><literal>checker</literal></term>
 
125
        <listitem>
163
126
          <para>
164
127
            This option allows you to override the default shell
165
 
            command that the server will use to check if the client is
166
 
            still up.  Any output of the command will be ignored, only
167
 
            the exit code is checked:  If the exit code of the command
168
 
            is zero, the client is considered up.  The command will be
169
 
            run using <quote><command><filename>/bin/sh</filename>
170
 
            <option>-c</option></command></quote>, so
171
 
            <varname>PATH</varname> will be searched.  The default
172
 
            value for the checker command is <quote><literal
173
 
            ><command>fping</command> <option>-q</option> <option
174
 
            >--</option> %%(host)s</literal></quote>.
175
 
          </para>
176
 
          <para>
177
 
            In addition to normal start time expansion, this option
178
 
            will also be subject to runtime expansion; see <xref
179
 
            linkend="expansion"/>.
180
 
          </para>
181
 
        </listitem>
182
 
      </varlistentry>
183
 
      
184
 
      <varlistentry>
185
 
        <term><option>extended_timeout<literal> = </literal><replaceable
186
 
        >TIME</replaceable></option></term>
187
 
        <listitem>
188
 
          <para>
189
 
            This option is <emphasis>optional</emphasis>.
190
 
          </para>
191
 
          <para>
192
 
            Extended timeout is an added timeout that is given once
193
 
            after a password has been sent successfully to a client.
194
 
            The timeout is by default longer than the normal timeout,
195
 
            and is used for handling the extra long downtime while a
196
 
            machine is booting up.  Time to take into consideration
197
 
            when changing this value is file system checks and quota
198
 
            checks.  The default value is 15 minutes.
199
 
          </para>
200
 
          <para>
201
 
            The format of <replaceable>TIME</replaceable> is the same
202
 
            as for <varname>timeout</varname> below.
203
 
          </para>
204
 
        </listitem>
205
 
      </varlistentry>
206
 
      
207
 
      <varlistentry>
208
 
        <term><option>fingerprint<literal> = </literal
209
 
        ><replaceable>HEXSTRING</replaceable></option></term>
210
 
        <listitem>
211
 
          <para>
212
 
            This option is <emphasis>required</emphasis>.
213
 
          </para>
214
 
          <para>
215
 
            This option sets the OpenPGP fingerprint that identifies
216
 
            the public key that clients authenticate themselves with
217
 
            through TLS.  The string needs to be in hexidecimal form,
218
 
            but spaces or upper/lower case are not significant.
219
 
          </para>
220
 
        </listitem>
221
 
      </varlistentry>
222
 
      
223
 
      <varlistentry>
224
 
        <term><option><literal>host = </literal><replaceable
225
 
        >STRING</replaceable></option></term>
226
 
        <listitem>
227
 
          <para>
228
 
            This option is <emphasis>optional</emphasis>, but highly
229
 
            <emphasis>recommended</emphasis> unless the
230
 
            <option>checker</option> option is modified to a
231
 
            non-standard value without <quote>%%(host)s</quote> in it.
232
 
          </para>
233
 
          <para>
234
 
            Host name for this client.  This is not used by the server
235
 
            directly, but can be, and is by default, used by the
236
 
            checker.  See the <option>checker</option> option.
237
 
          </para>
238
 
        </listitem>
239
 
      </varlistentry>
240
 
      
241
 
      <varlistentry>
242
 
        <term><option>interval<literal> = </literal><replaceable
243
 
        >TIME</replaceable></option></term>
244
 
        <listitem>
245
 
          <para>
246
 
            This option is <emphasis>optional</emphasis>.
247
 
          </para>
248
 
          <para>
249
 
            How often to run the checker to confirm that a client is
250
 
            still up.  <emphasis>Note:</emphasis> a new checker will
251
 
            not be started if an old one is still running.  The server
252
 
            will wait for a checker to complete until the below
253
 
            <quote><varname>timeout</varname></quote> occurs, at which
254
 
            time the client will be disabled, and any running checker
255
 
            killed.  The default interval is 2 minutes.
256
 
          </para>
257
 
          <para>
258
 
            The format of <replaceable>TIME</replaceable> is the same
259
 
            as for <varname>timeout</varname> below.
260
 
          </para>
261
 
        </listitem>
262
 
      </varlistentry>
263
 
      
264
 
      <varlistentry>
265
 
        <term><option>secfile<literal> = </literal><replaceable
266
 
        >FILENAME</replaceable></option></term>
267
 
        <listitem>
268
 
          <para>
269
 
            This option is only used if <option>secret</option> is not
270
 
            specified, in which case this option is
271
 
            <emphasis>required</emphasis>.
272
 
          </para>
273
 
          <para>
274
 
            Similar to the <option>secret</option>, except the secret
275
 
            data is in an external file.  The contents of the file
276
 
            should <emphasis>not</emphasis> be base64-encoded, but
277
 
            will be sent to clients verbatim.
278
 
          </para>
279
 
          <para>
280
 
            File names of the form <filename>~user/foo/bar</filename>
281
 
            and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
282
 
            are supported.
283
 
          </para>
284
 
        </listitem>
285
 
      </varlistentry>
286
 
      
287
 
      <varlistentry>
288
 
        <term><option>secret<literal> = </literal><replaceable
289
 
        >BASE64_ENCODED_DATA</replaceable></option></term>
290
 
        <listitem>
291
 
          <para>
292
 
            If this option is not specified, the <option
293
 
            >secfile</option> option is <emphasis>required</emphasis>
294
 
            to be present.
295
 
          </para>
296
 
          <para>
297
 
            If present, this option must be set to a string of
298
 
            base64-encoded binary data.  It will be decoded and sent
299
 
            to the client matching the above
300
 
            <option>fingerprint</option>.  This should, of course, be
301
 
            OpenPGP encrypted data, decryptable only by the client.
302
 
            The program <citerefentry><refentrytitle><command
303
 
            >mandos-keygen</command></refentrytitle><manvolnum
304
 
            >8</manvolnum></citerefentry> can, using its
305
 
            <option>--password</option> option, be used to generate
306
 
            this, if desired.
307
 
          </para>
308
 
          <para>
309
 
            Note: this value of this option will probably be very
310
 
            long.  A useful feature to avoid having unreadably-long
311
 
            lines is that a line beginning with white space adds to
312
 
            the value of the previous line, RFC 822-style.
313
 
          </para>
314
 
        </listitem>
315
 
      </varlistentry>
316
 
      
317
 
      <varlistentry>
318
 
        <term><option>timeout<literal> = </literal><replaceable
319
 
        >TIME</replaceable></option></term>
320
 
        <listitem>
321
 
          <para>
322
 
            This option is <emphasis>optional</emphasis>.
323
 
          </para>
324
 
          <para>
325
 
            The timeout is how long the server will wait, after a
326
 
            successful checker run, until a client is disabled and not
327
 
            allowed to get the data this server holds.  By default
328
 
            Mandos will use 5 minutes.  See also the
329
 
            <option>extended_timeout</option> option.
330
 
          </para>
331
 
          <para>
332
 
            The <replaceable>TIME</replaceable> is specified as a
333
 
            space-separated number of values, each of which is a
334
 
            number and a one-character suffix.  The suffix must be one
335
 
            of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
336
 
            <quote>h</quote>, and <quote>w</quote> for days, seconds,
337
 
            minutes, hours, and weeks, respectively.  The values are
338
 
            added together to give the total time value, so all of
339
 
            <quote><literal>330s</literal></quote>,
340
 
            <quote><literal>110s 110s 110s</literal></quote>, and
341
 
            <quote><literal>5m 30s</literal></quote> will give a value
342
 
            of five minutes and thirty seconds.
343
 
          </para>
344
 
        </listitem>
345
 
      </varlistentry>
346
 
      
347
 
      <varlistentry>
348
 
        <term><option>enabled<literal> = </literal>{ <literal
349
 
        >1</literal> | <literal>yes</literal> | <literal>true</literal
350
 
        > | <literal >on</literal> | <literal>0</literal> | <literal
351
 
        >no</literal> | <literal>false</literal> | <literal
352
 
        >off</literal> }</option></term>
353
 
        <listitem>
354
 
          <para>
355
 
            Whether this client should be enabled by default.  The
356
 
            default is <quote>true</quote>.
357
 
          </para>
358
 
        </listitem>
359
 
      </varlistentry>
360
 
      
361
 
    </variablelist>
362
 
  </refsect1>
363
 
  
364
 
  <refsect1 id="expansion">
365
 
    <title>EXPANSION</title>
366
 
    <para>
367
 
      There are two forms of expansion: Start time expansion and
368
 
      runtime expansion.
369
 
    </para>
370
 
    <refsect2 id="start_time_expansion">
371
 
      <title>START TIME EXPANSION</title>
372
 
      <para>
373
 
        Any string in an option value of the form
374
 
        <quote><literal>%(<replaceable>foo</replaceable>)s</literal
375
 
        ></quote> will be replaced by the value of the option
376
 
        <varname>foo</varname> either in the same section, or, if it
377
 
        does not exist there, the <literal>[DEFAULT]</literal>
378
 
        section.  This is done at start time, when the configuration
379
 
        file is read.
380
 
      </para>
381
 
      <para>
382
 
        Note that this means that, in order to include an actual
383
 
        percent character (<quote>%</quote>) in an option value, two
384
 
        percent characters in a row (<quote>%%</quote>) must be
385
 
        entered.
386
 
      </para>
387
 
    </refsect2>
388
 
    <refsect2 id="runtime_expansion">
389
 
      <title>RUNTIME EXPANSION</title>
390
 
      <para>
391
 
        This is currently only done for the <varname>checker</varname>
392
 
        option.
393
 
      </para>
394
 
      <para>
395
 
        Any string in an option value of the form
396
 
        <quote><literal>%%(<replaceable>foo</replaceable>)s</literal
397
 
        ></quote> will be replaced by the value of the attribute
398
 
        <varname>foo</varname> of the internal
399
 
        <quote><classname>Client</classname></quote> object in the
400
 
        Mandos server.  The currently allowed values for
401
 
        <replaceable>foo</replaceable> are:
402
 
        <quote><literal>approval_delay</literal></quote>,
403
 
        <quote><literal>approval_duration</literal></quote>,
404
 
        <quote><literal>created</literal></quote>,
405
 
        <quote><literal>enabled</literal></quote>,
406
 
        <quote><literal>fingerprint</literal></quote>,
407
 
        <quote><literal>host</literal></quote>,
408
 
        <quote><literal>interval</literal></quote>,
409
 
        <quote><literal>last_approval_request</literal></quote>,
410
 
        <quote><literal>last_checked_ok</literal></quote>,
411
 
        <quote><literal>last_enabled</literal></quote>,
412
 
        <quote><literal>name</literal></quote>,
413
 
        <quote><literal>timeout</literal></quote>, and, if using
414
 
        D-Bus, <quote><literal>dbus_object_path</literal></quote>.
415
 
        See the source code for details.  <emphasis role="strong"
416
 
        >Currently, <emphasis>none</emphasis> of these attributes
417
 
        except <quote><literal>host</literal></quote> are guaranteed
418
 
        to be valid in future versions.</emphasis> Therefore, please
419
 
        let the authors know of any attributes that are useful so they
420
 
        may be preserved to any new versions of this software.
421
 
      </para>
422
 
      <para>
423
 
        Note that this means that, in order to include an actual
424
 
        percent character (<quote>%</quote>) in a
425
 
        <varname>checker</varname> option, <emphasis>four</emphasis>
426
 
        percent characters in a row (<quote>%%%%</quote>) must be
427
 
        entered.  Also, a bad format here will lead to an immediate
428
 
        but <emphasis>silent</emphasis> run-time fatal exit; debug
429
 
        mode is needed to expose an error of this kind.
430
 
      </para>
431
 
    </refsect2>
432
 
    
433
 
  </refsect1>
434
 
  
435
 
  <refsect1 id="files">
436
 
    <title>FILES</title>
437
 
    <para>
438
 
      The file described here is &CONFPATH;
439
 
    </para>
440
 
  </refsect1>
441
 
  
442
 
  <refsect1 id="bugs">
443
 
    <title>BUGS</title>
444
 
    <para>
445
 
      The format for specifying times for <varname>timeout</varname>
446
 
      and <varname>interval</varname> is not very good.
447
 
    </para>
448
 
    <para>
449
 
      The difference between
450
 
      <literal>%%(<replaceable>foo</replaceable>)s</literal> and
451
 
      <literal>%(<replaceable>foo</replaceable>)s</literal> is
452
 
      obscure.
453
 
    </para>
454
 
  </refsect1>
455
 
  
456
 
  <refsect1 id="example">
457
 
    <title>EXAMPLE</title>
 
128
            command that the server will use to check up if the client
 
129
            is still up. By default mandos will "fping -q -- %%(fqdn)s"
 
130
          </para>
 
131
        </listitem>
 
132
      </varlistentry>
 
133
      
 
134
    </variablelist>
 
135
  </refsect1>
 
136
 
 
137
  <refsect1 id="clients">
 
138
    <title>CLIENTS</title>
 
139
    <para>
 
140
      The paramters for clients are:
 
141
    </para>
 
142
 
 
143
    <variablelist>
 
144
      
 
145
      <varlistentry>
 
146
        <term><literal>fingerprint</literal></term>
 
147
        <listitem>
 
148
          <para>
 
149
            This option sets the openpgp fingerprint that identifies
 
150
            the public certificate that clients authenticates themself
 
151
            through gnutls. The string need to be in hex-decimal form.
 
152
          </para>
 
153
        </listitem>
 
154
      </varlistentry>
 
155
      
 
156
      <varlistentry>
 
157
        <term><literal>secret</literal></term>
 
158
        <listitem>
 
159
          <para>
 
160
            Base 64 encoded OpenPGP encrypted password encrypted by
 
161
            the clients openpgp certificate.
 
162
          </para>
 
163
        </listitem>
 
164
      </varlistentry>
 
165
 
 
166
      <varlistentry>
 
167
        <term><literal>secfile</literal></term>
 
168
        <listitem>
 
169
          <para>
 
170
            Base 64 encoded OpenPGP encrypted password encrypted by
 
171
            the clients openpgp certificate as a binary file.
 
172
          </para>
 
173
        </listitem>
 
174
      </varlistentry>
 
175
 
 
176
      <varlistentry>
 
177
        <term><literal>fqdn</literal></term>
 
178
        <listitem>
 
179
          <para>
 
180
            FQDN, that can be used in for checking that the client is up.
 
181
          </para>
 
182
        </listitem>
 
183
      </varlistentry>
 
184
 
 
185
      <varlistentry>
 
186
        <term><literal>checker</literal></term>
 
187
        <listitem>
 
188
          <para>
 
189
            Shell command that the server will use to check up if a
 
190
            client is still up.
 
191
          </para>
 
192
        </listitem>
 
193
      </varlistentry>      
 
194
 
 
195
      <varlistentry>
 
196
        <term><literal>timeout</literal></term>
 
197
        <listitem>
 
198
          <para>
 
199
            Duration that a client can be down whitout be removed from
 
200
            the client list.
 
201
          </para>
 
202
        </listitem>
 
203
      </varlistentry> 
 
204
      
 
205
    </variablelist>
 
206
  </refsect1>  
 
207
 
 
208
  <refsect1 id="examples">
 
209
    <title>EXAMPLES</title>
458
210
    <informalexample>
459
211
      <programlisting>
460
212
[DEFAULT]
461
 
timeout = 5m
462
 
interval = 2m
463
 
checker = fping -q -- %%(host)s
 
213
timeout = 1h
 
214
interval = 5m
 
215
checker = fping -q -- %%(fqdn)s
464
216
 
465
 
# Client "foo"
466
 
[foo]
 
217
[example_client]
467
218
fingerprint =  7788 2722 5BA7 DE53 9C5A  7CFA 59CF F7CD BD9A 5920
 
219
 
468
220
secret =
469
221
        hQIOA6QdEjBs2L/HEAf/TCyrDe5Xnm9esa+Pb/vWF9CUqfn4srzVgSu234
470
222
        REJMVv7lBSrPE2132Lmd2gqF1HeLKDJRSVxJpt6xoWOChGHg+TMyXDxK+N
481
233
        5MHdW9AYsNJZAQSOpirE4Xi31CSlWAi9KV+cUCmWF5zOFy1x23P6PjdaRm
482
234
        4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
483
235
        QlnHIvPzEArRQLo=
484
 
host = foo.example.org
485
 
interval = 1m
 
236
        =iHhv
486
237
 
487
 
# Client "bar"
488
 
[bar]
489
 
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
490
 
secfile = /etc/mandos/bar-secret
491
 
timeout = 15m
492
 
approved_by_default = False
493
 
approval_delay = 30s
 
238
fqdn = localhost
 
239
interval = 5m
494
240
      </programlisting>
495
241
    </informalexample>
496
 
  </refsect1>
 
242
  </refsect1>  
497
243
  
498
 
  <refsect1 id="see_also">
499
 
    <title>SEE ALSO</title>
 
244
  <refsect1 id="files">
 
245
    <title>FILES</title>
500
246
    <para>
501
 
      <citerefentry><refentrytitle>intro</refentrytitle>
502
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
503
 
      <citerefentry><refentrytitle>mandos-keygen</refentrytitle>
504
 
      <manvolnum>8</manvolnum></citerefentry>,
505
 
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
506
 
      <manvolnum>5</manvolnum></citerefentry>,
507
 
      <citerefentry><refentrytitle>mandos</refentrytitle>
508
 
      <manvolnum>8</manvolnum></citerefentry>
 
247
      The file described here is &CONFPATH;
509
248
    </para>
510
249
  </refsect1>
511
250
</refentry>
512
 
<!-- Local Variables: -->
513
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
514
 
<!-- time-stamp-end: "[\"']>" -->
515
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
516
 
<!-- End: -->