/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos-clients.conf.xml

  • Committer: teddy at bsnet
  • Date: 2010-09-27 17:53:53 UTC
  • Revision ID: teddy@fukt.bsnet.se-20100927175353-skms2ds4cjswpf4t
* debian/mandos-client.README.Debian: Remove warning about --connect
                                      not looping, since it now does.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-clients.conf.xml
3
3
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
4
<!ENTITY CONFNAME "mandos-clients.conf">
5
5
<!ENTITY CONFPATH "<filename>/etc/mandos/clients.conf</filename>">
6
 
<!ENTITY TIMESTAMP "2011-10-03">
 
6
<!ENTITY TIMESTAMP "2010-09-26">
7
7
<!ENTITY % common SYSTEM "common.ent">
8
8
%common;
9
9
]>
20
20
        <firstname>Björn</firstname>
21
21
        <surname>Påhlsson</surname>
22
22
        <address>
23
 
          <email>belorn@recompile.se</email>
 
23
          <email>belorn@fukt.bsnet.se</email>
24
24
        </address>
25
25
      </author>
26
26
      <author>
27
27
        <firstname>Teddy</firstname>
28
28
        <surname>Hogeborn</surname>
29
29
        <address>
30
 
          <email>teddy@recompile.se</email>
 
30
          <email>teddy@fukt.bsnet.se</email>
31
31
        </address>
32
32
      </author>
33
33
    </authorgroup>
35
35
      <year>2008</year>
36
36
      <year>2009</year>
37
37
      <year>2010</year>
38
 
      <year>2011</year>
39
38
      <holder>Teddy Hogeborn</holder>
40
39
      <holder>Björn Påhlsson</holder>
41
40
    </copyright>
182
181
      </varlistentry>
183
182
      
184
183
      <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 sucessfully 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
184
        <term><option>fingerprint<literal> = </literal
209
185
        ><replaceable>HEXSTRING</replaceable></option></term>
210
186
        <listitem>
252
228
            will wait for a checker to complete until the below
253
229
            <quote><varname>timeout</varname></quote> occurs, at which
254
230
            time the client will be disabled, and any running checker
255
 
            killed.  The default interval is 2 minutes.
 
231
            killed.  The default interval is 5 minutes.
256
232
          </para>
257
233
          <para>
258
234
            The format of <replaceable>TIME</replaceable> is the same
322
298
            This option is <emphasis>optional</emphasis>.
323
299
          </para>
324
300
          <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.
 
301
            The timeout is how long the server will wait (for either a
 
302
            successful checker run or a client receiving its secret)
 
303
            until a client is disabled and not allowed to get the data
 
304
            this server holds.  By default Mandos will use 1 hour.
330
305
          </para>
331
306
          <para>
332
307
            The <replaceable>TIME</replaceable> is specified as a
382
357
        <quote><literal>%%(<replaceable>foo</replaceable>)s</literal
383
358
        ></quote> will be replaced by the value of the attribute
384
359
        <varname>foo</varname> of the internal
385
 
        <quote><classname>Client</classname></quote> object in the
386
 
        Mandos server.  The currently allowed values for
387
 
        <replaceable>foo</replaceable> are:
388
 
        <quote><literal>approval_delay</literal></quote>,
389
 
        <quote><literal>approval_duration</literal></quote>,
390
 
        <quote><literal>created</literal></quote>,
391
 
        <quote><literal>enabled</literal></quote>,
392
 
        <quote><literal>fingerprint</literal></quote>,
393
 
        <quote><literal>host</literal></quote>,
394
 
        <quote><literal>interval</literal></quote>,
395
 
        <quote><literal>last_approval_request</literal></quote>,
396
 
        <quote><literal>last_checked_ok</literal></quote>,
397
 
        <quote><literal>last_enabled</literal></quote>,
398
 
        <quote><literal>name</literal></quote>,
399
 
        <quote><literal>timeout</literal></quote>, and, if using
400
 
        D-Bus, <quote><literal>dbus_object_path</literal></quote>.
401
 
        See the source code for details.  <emphasis role="strong"
402
 
        >Currently, <emphasis>none</emphasis> of these attributes
403
 
        except <quote><literal>host</literal></quote> are guaranteed
404
 
        to be valid in future versions.</emphasis> Therefore, please
405
 
        let the authors know of any attributes that are useful so they
406
 
        may be preserved to any new versions of this software.
 
360
        <quote><classname>Client</classname></quote> object.  See the
 
361
        source code for details, and let the authors know of any
 
362
        attributes that are useful so they may be preserved to any new
 
363
        versions of this software.
407
364
      </para>
408
365
      <para>
409
366
        Note that this means that, in order to include an actual
444
401
    <informalexample>
445
402
      <programlisting>
446
403
[DEFAULT]
447
 
timeout = 5m
448
 
interval = 2m
 
404
timeout = 1h
 
405
interval = 5m
449
406
checker = fping -q -- %%(host)s
450
407
 
451
408
# Client "foo"
484
441
  <refsect1 id="see_also">
485
442
    <title>SEE ALSO</title>
486
443
    <para>
487
 
      <citerefentry><refentrytitle>intro</refentrytitle>
488
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
489
444
      <citerefentry><refentrytitle>mandos-keygen</refentrytitle>
490
445
      <manvolnum>8</manvolnum></citerefentry>,
491
446
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>