/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 Hogeborn
  • Date: 2011-09-19 09:25:06 UTC
  • Revision ID: teddy@fukt.bsnet.se-20110919092506-klwkjwizzdnza2il
* clients.conf ([DEFAULT]/timeout): Changed default value to "5m".
  ([DEFAULT]/interval): Changed default value to "2m".
  ([DEFAULT]/extenden_timeout): New.
  ([bar]/interval): Changed to "1m".

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 "2010-09-26">
 
6
<!ENTITY TIMESTAMP "2011-08-08">
7
7
<!ENTITY % common SYSTEM "common.ent">
8
8
%common;
9
9
]>
35
35
      <year>2008</year>
36
36
      <year>2009</year>
37
37
      <year>2010</year>
 
38
      <year>2011</year>
38
39
      <holder>Teddy Hogeborn</holder>
39
40
      <holder>Björn Påhlsson</holder>
40
41
    </copyright>
228
229
            will wait for a checker to complete until the below
229
230
            <quote><varname>timeout</varname></quote> occurs, at which
230
231
            time the client will be disabled, and any running checker
231
 
            killed.  The default interval is 5 minutes.
 
232
            killed.  The default interval is 2 minutes.
232
233
          </para>
233
234
          <para>
234
235
            The format of <replaceable>TIME</replaceable> is the same
301
302
            The timeout is how long the server will wait (for either a
302
303
            successful checker run or a client receiving its secret)
303
304
            until a client is disabled and not allowed to get the data
304
 
            this server holds.  By default Mandos will use 1 hour.
 
305
            this server holds.  By default Mandos will use 5 minutes.
305
306
          </para>
306
307
          <para>
307
308
            The <replaceable>TIME</replaceable> is specified as a
318
319
          </para>
319
320
        </listitem>
320
321
      </varlistentry>
 
322
 
 
323
      <varlistentry>
 
324
        <term><option>extended_timeout<literal> = </literal><replaceable
 
325
        >TIME</replaceable></option></term>
 
326
        <listitem>
 
327
          <para>
 
328
            This option is <emphasis>optional</emphasis>.
 
329
          </para>
 
330
          <para>
 
331
            Extended timeout is an added timeout that is given once
 
332
            after a password has been sent sucessfully to a client.
 
333
            The timeout is by default longer than the normal timeout,
 
334
            and is used for handling the extra long downtime while a
 
335
            matchine is booting up.  Time to take into consideration
 
336
            when changing this value is system file checks and quota
 
337
            checks.  The default value is 15 minutes.
 
338
          </para>
 
339
          <para>
 
340
            The format of <replaceable>TIME</replaceable> is the same
 
341
            as for <varname>timeout</varname> above.
 
342
          </para>
 
343
        </listitem>
 
344
      </varlistentry>
321
345
      
322
346
    </variablelist>
323
347
  </refsect1>
357
381
        <quote><literal>%%(<replaceable>foo</replaceable>)s</literal
358
382
        ></quote> will be replaced by the value of the attribute
359
383
        <varname>foo</varname> of the internal
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.
 
384
        <quote><classname>Client</classname></quote> object in the
 
385
        Mandos server.  The currently allowed values for
 
386
        <replaceable>foo</replaceable> are:
 
387
        <quote><literal>approval_delay</literal></quote>,
 
388
        <quote><literal>approval_duration</literal></quote>,
 
389
        <quote><literal>created</literal></quote>,
 
390
        <quote><literal>enabled</literal></quote>,
 
391
        <quote><literal>fingerprint</literal></quote>,
 
392
        <quote><literal>host</literal></quote>,
 
393
        <quote><literal>interval</literal></quote>,
 
394
        <quote><literal>last_approval_request</literal></quote>,
 
395
        <quote><literal>last_checked_ok</literal></quote>,
 
396
        <quote><literal>last_enabled</literal></quote>,
 
397
        <quote><literal>name</literal></quote>,
 
398
        <quote><literal>timeout</literal></quote>, and, if using
 
399
        D-Bus, <quote><literal>dbus_object_path</literal></quote>.
 
400
        See the source code for details.  <emphasis role="strong"
 
401
        >Currently, <emphasis>none</emphasis> of these attributes
 
402
        except <quote><literal>host</literal></quote> are guaranteed
 
403
        to be valid in future versions.</emphasis> Therefore, please
 
404
        let the authors know of any attributes that are useful so they
 
405
        may be preserved to any new versions of this software.
364
406
      </para>
365
407
      <para>
366
408
        Note that this means that, in order to include an actual
401
443
    <informalexample>
402
444
      <programlisting>
403
445
[DEFAULT]
404
 
timeout = 1h
405
 
interval = 5m
 
446
timeout = 5m
 
447
interval = 2m
406
448
checker = fping -q -- %%(host)s
407
449
 
408
450
# Client "foo"
441
483
  <refsect1 id="see_also">
442
484
    <title>SEE ALSO</title>
443
485
    <para>
 
486
      <citerefentry><refentrytitle>intro</refentrytitle>
 
487
      <manvolnum>8mandos</manvolnum></citerefentry>,
444
488
      <citerefentry><refentrytitle>mandos-keygen</refentrytitle>
445
489
      <manvolnum>8</manvolnum></citerefentry>,
446
490
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>