/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 mandos-clients.conf.xml

  • Committer: Björn Påhlsson
  • Date: 2011-09-24 14:19:06 UTC
  • mfrom: (237.7.48 trunk)
  • mto: (237.7.50 mandos)
  • mto: This revision was merged to the branch mainline in revision 286.
  • Revision ID: belorn@fukt.bsnet.se-20110924141906-006qlpk9wy1x3kz5
Merge from teddy.

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 "2010-09-25">
 
6
<!ENTITY TIMESTAMP "2011-09-19">
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>
37
39
      <holder>Teddy Hogeborn</holder>
38
40
      <holder>Björn Påhlsson</holder>
39
41
    </copyright>
180
182
      </varlistentry>
181
183
      
182
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 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>
183
208
        <term><option>fingerprint<literal> = </literal
184
209
        ><replaceable>HEXSTRING</replaceable></option></term>
185
210
        <listitem>
227
252
            will wait for a checker to complete until the below
228
253
            <quote><varname>timeout</varname></quote> occurs, at which
229
254
            time the client will be disabled, and any running checker
230
 
            killed.  The default interval is 5 minutes.
 
255
            killed.  The default interval is 2 minutes.
231
256
          </para>
232
257
          <para>
233
258
            The format of <replaceable>TIME</replaceable> is the same
300
325
            The timeout is how long the server will wait (for either a
301
326
            successful checker run or a client receiving its secret)
302
327
            until a client is disabled and not allowed to get the data
303
 
            this server holds.  By default Mandos will use 1 hour.
 
328
            this server holds.  By default Mandos will use 5 minutes.
304
329
          </para>
305
330
          <para>
306
331
            The <replaceable>TIME</replaceable> is specified as a
356
381
        <quote><literal>%%(<replaceable>foo</replaceable>)s</literal
357
382
        ></quote> will be replaced by the value of the attribute
358
383
        <varname>foo</varname> of the internal
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.
 
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.
363
406
      </para>
364
407
      <para>
365
408
        Note that this means that, in order to include an actual
400
443
    <informalexample>
401
444
      <programlisting>
402
445
[DEFAULT]
403
 
timeout = 1h
404
 
interval = 5m
 
446
timeout = 5m
 
447
interval = 2m
405
448
checker = fping -q -- %%(host)s
406
449
 
407
450
# Client "foo"
440
483
  <refsect1 id="see_also">
441
484
    <title>SEE ALSO</title>
442
485
    <para>
 
486
      <citerefentry><refentrytitle>intro</refentrytitle>
 
487
      <manvolnum>8mandos</manvolnum></citerefentry>,
443
488
      <citerefentry><refentrytitle>mandos-keygen</refentrytitle>
444
489
      <manvolnum>8</manvolnum></citerefentry>,
445
490
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>