/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: 2010-09-26 17:44:43 UTC
  • Revision ID: teddy@fukt.bsnet.se-20100926174443-452k363uuvczuuzg
* mandos-ctl: Also show "LastApprovalRequest" property.

Show diffs side-by-side

added added

removed removed

Lines of Context:
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-08-08">
 
6
<!ENTITY TIMESTAMP "2010-09-25">
7
7
<!ENTITY % common SYSTEM "common.ent">
8
8
%common;
9
9
]>
34
34
    <copyright>
35
35
      <year>2008</year>
36
36
      <year>2009</year>
37
 
      <year>2010</year>
38
 
      <year>2011</year>
39
37
      <holder>Teddy Hogeborn</holder>
40
38
      <holder>Björn Påhlsson</holder>
41
39
    </copyright>
229
227
            will wait for a checker to complete until the below
230
228
            <quote><varname>timeout</varname></quote> occurs, at which
231
229
            time the client will be disabled, and any running checker
232
 
            killed.  The default interval is 2 minutes.
 
230
            killed.  The default interval is 5 minutes.
233
231
          </para>
234
232
          <para>
235
233
            The format of <replaceable>TIME</replaceable> is the same
302
300
            The timeout is how long the server will wait (for either a
303
301
            successful checker run or a client receiving its secret)
304
302
            until a client is disabled and not allowed to get the data
305
 
            this server holds.  By default Mandos will use 5 minutes.
 
303
            this server holds.  By default Mandos will use 1 hour.
306
304
          </para>
307
305
          <para>
308
306
            The <replaceable>TIME</replaceable> is specified as a
319
317
          </para>
320
318
        </listitem>
321
319
      </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>
345
320
      
346
321
    </variablelist>
347
322
  </refsect1>
381
356
        <quote><literal>%%(<replaceable>foo</replaceable>)s</literal
382
357
        ></quote> will be replaced by the value of the attribute
383
358
        <varname>foo</varname> of the internal
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.
 
359
        <quote><classname>Client</classname></quote> object.  See the
 
360
        source code for details, and let the authors know of any
 
361
        attributes that are useful so they may be preserved to any new
 
362
        versions of this software.
406
363
      </para>
407
364
      <para>
408
365
        Note that this means that, in order to include an actual
443
400
    <informalexample>
444
401
      <programlisting>
445
402
[DEFAULT]
446
 
timeout = 5m
447
 
interval = 2m
 
403
timeout = 1h
 
404
interval = 5m
448
405
checker = fping -q -- %%(host)s
449
406
 
450
407
# Client "foo"
483
440
  <refsect1 id="see_also">
484
441
    <title>SEE ALSO</title>
485
442
    <para>
486
 
      <citerefentry><refentrytitle>intro</refentrytitle>
487
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
488
443
      <citerefentry><refentrytitle>mandos-keygen</refentrytitle>
489
444
      <manvolnum>8</manvolnum></citerefentry>,
490
445
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>