/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: Björn Påhlsson
  • Date: 2011-12-21 00:29:33 UTC
  • mfrom: (518.1.15 mandos-persistent)
  • Revision ID: belorn@recompile.se-20111221002933-6sc0a64o1ns2s2s8
Working persistant state

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-26">
 
6
<!ENTITY TIMESTAMP "2011-11-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@fukt.bsnet.se</email>
 
23
          <email>belorn@recompile.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@fukt.bsnet.se</email>
 
30
          <email>teddy@recompile.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>
38
39
      <holder>Teddy Hogeborn</holder>
39
40
      <holder>Björn Påhlsson</holder>
40
41
    </copyright>
181
182
      </varlistentry>
182
183
      
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>
184
208
        <term><option>fingerprint<literal> = </literal
185
209
        ><replaceable>HEXSTRING</replaceable></option></term>
186
210
        <listitem>
228
252
            will wait for a checker to complete until the below
229
253
            <quote><varname>timeout</varname></quote> occurs, at which
230
254
            time the client will be disabled, and any running checker
231
 
            killed.  The default interval is 5 minutes.
 
255
            killed.  The default interval is 2 minutes.
232
256
          </para>
233
257
          <para>
234
258
            The format of <replaceable>TIME</replaceable> is the same
298
322
            This option is <emphasis>optional</emphasis>.
299
323
          </para>
300
324
          <para>
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.
 
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.
305
330
          </para>
306
331
          <para>
307
332
            The <replaceable>TIME</replaceable> is specified as a
319
344
        </listitem>
320
345
      </varlistentry>
321
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
      
322
361
    </variablelist>
323
362
  </refsect1>
324
363
  
419
458
    <informalexample>
420
459
      <programlisting>
421
460
[DEFAULT]
422
 
timeout = 1h
423
 
interval = 5m
 
461
timeout = 5m
 
462
interval = 2m
424
463
checker = fping -q -- %%(host)s
425
464
 
426
465
# Client "foo"
459
498
  <refsect1 id="see_also">
460
499
    <title>SEE ALSO</title>
461
500
    <para>
 
501
      <citerefentry><refentrytitle>intro</refentrytitle>
 
502
      <manvolnum>8mandos</manvolnum></citerefentry>,
462
503
      <citerefentry><refentrytitle>mandos-keygen</refentrytitle>
463
504
      <manvolnum>8</manvolnum></citerefentry>,
464
505
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>