/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 18:57:12 UTC
  • Revision ID: teddy@fukt.bsnet.se-20100927185712-d4t34t3y002xr44x
* mandos-clients.conf.xml (EXPANSION/RUNTIME EXPANSION): List possible
                                                         keys.

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-11-26">
 
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 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>
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
344
319
        </listitem>
345
320
      </varlistentry>
346
321
      
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
 
      
361
322
    </variablelist>
362
323
  </refsect1>
363
324
  
458
419
    <informalexample>
459
420
      <programlisting>
460
421
[DEFAULT]
461
 
timeout = 5m
462
 
interval = 2m
 
422
timeout = 1h
 
423
interval = 5m
463
424
checker = fping -q -- %%(host)s
464
425
 
465
426
# Client "foo"
498
459
  <refsect1 id="see_also">
499
460
    <title>SEE ALSO</title>
500
461
    <para>
501
 
      <citerefentry><refentrytitle>intro</refentrytitle>
502
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
503
462
      <citerefentry><refentrytitle>mandos-keygen</refentrytitle>
504
463
      <manvolnum>8</manvolnum></citerefentry>,
505
464
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>