/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-12-31 23:05:34 UTC
  • Revision ID: teddy@recompile.se-20111231230534-o5w0uhwx30gwhmk7
Updated year in copyright notices.

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 "2012-01-01">
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>
34
34
    <copyright>
35
35
      <year>2008</year>
36
36
      <year>2009</year>
 
37
      <year>2010</year>
 
38
      <year>2011</year>
 
39
      <year>2012</year>
37
40
      <holder>Teddy Hogeborn</holder>
38
41
      <holder>Björn Påhlsson</holder>
39
42
    </copyright>
180
183
      </varlistentry>
181
184
      
182
185
      <varlistentry>
 
186
        <term><option>extended_timeout<literal> = </literal><replaceable
 
187
        >TIME</replaceable></option></term>
 
188
        <listitem>
 
189
          <para>
 
190
            This option is <emphasis>optional</emphasis>.
 
191
          </para>
 
192
          <para>
 
193
            Extended timeout is an added timeout that is given once
 
194
            after a password has been sent successfully to a client.
 
195
            The timeout is by default longer than the normal timeout,
 
196
            and is used for handling the extra long downtime while a
 
197
            machine is booting up.  Time to take into consideration
 
198
            when changing this value is file system checks and quota
 
199
            checks.  The default value is 15 minutes.
 
200
          </para>
 
201
          <para>
 
202
            The format of <replaceable>TIME</replaceable> is the same
 
203
            as for <varname>timeout</varname> below.
 
204
          </para>
 
205
        </listitem>
 
206
      </varlistentry>
 
207
      
 
208
      <varlistentry>
183
209
        <term><option>fingerprint<literal> = </literal
184
210
        ><replaceable>HEXSTRING</replaceable></option></term>
185
211
        <listitem>
227
253
            will wait for a checker to complete until the below
228
254
            <quote><varname>timeout</varname></quote> occurs, at which
229
255
            time the client will be disabled, and any running checker
230
 
            killed.  The default interval is 5 minutes.
 
256
            killed.  The default interval is 2 minutes.
231
257
          </para>
232
258
          <para>
233
259
            The format of <replaceable>TIME</replaceable> is the same
297
323
            This option is <emphasis>optional</emphasis>.
298
324
          </para>
299
325
          <para>
300
 
            The timeout is how long the server will wait (for either a
301
 
            successful checker run or a client receiving its secret)
302
 
            until a client is disabled and not allowed to get the data
303
 
            this server holds.  By default Mandos will use 1 hour.
 
326
            The timeout is how long the server will wait, after a
 
327
            successful checker run, until a client is disabled and not
 
328
            allowed to get the data this server holds.  By default
 
329
            Mandos will use 5 minutes.  See also the
 
330
            <option>extended_timeout</option> option.
304
331
          </para>
305
332
          <para>
306
333
            The <replaceable>TIME</replaceable> is specified as a
318
345
        </listitem>
319
346
      </varlistentry>
320
347
      
 
348
      <varlistentry>
 
349
        <term><option>enabled<literal> = </literal>{ <literal
 
350
        >1</literal> | <literal>yes</literal> | <literal>true</literal
 
351
        > | <literal >on</literal> | <literal>0</literal> | <literal
 
352
        >no</literal> | <literal>false</literal> | <literal
 
353
        >off</literal> }</option></term>
 
354
        <listitem>
 
355
          <para>
 
356
            Whether this client should be enabled by default.  The
 
357
            default is <quote>true</quote>.
 
358
          </para>
 
359
        </listitem>
 
360
      </varlistentry>
 
361
      
321
362
    </variablelist>
322
363
  </refsect1>
323
364
  
356
397
        <quote><literal>%%(<replaceable>foo</replaceable>)s</literal
357
398
        ></quote> will be replaced by the value of the attribute
358
399
        <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.
 
400
        <quote><classname>Client</classname></quote> object in the
 
401
        Mandos server.  The currently allowed values for
 
402
        <replaceable>foo</replaceable> are:
 
403
        <quote><literal>approval_delay</literal></quote>,
 
404
        <quote><literal>approval_duration</literal></quote>,
 
405
        <quote><literal>created</literal></quote>,
 
406
        <quote><literal>enabled</literal></quote>,
 
407
        <quote><literal>fingerprint</literal></quote>,
 
408
        <quote><literal>host</literal></quote>,
 
409
        <quote><literal>interval</literal></quote>,
 
410
        <quote><literal>last_approval_request</literal></quote>,
 
411
        <quote><literal>last_checked_ok</literal></quote>,
 
412
        <quote><literal>last_enabled</literal></quote>,
 
413
        <quote><literal>name</literal></quote>,
 
414
        <quote><literal>timeout</literal></quote>, and, if using
 
415
        D-Bus, <quote><literal>dbus_object_path</literal></quote>.
 
416
        See the source code for details.  <emphasis role="strong"
 
417
        >Currently, <emphasis>none</emphasis> of these attributes
 
418
        except <quote><literal>host</literal></quote> are guaranteed
 
419
        to be valid in future versions.</emphasis> Therefore, please
 
420
        let the authors know of any attributes that are useful so they
 
421
        may be preserved to any new versions of this software.
363
422
      </para>
364
423
      <para>
365
424
        Note that this means that, in order to include an actual
400
459
    <informalexample>
401
460
      <programlisting>
402
461
[DEFAULT]
403
 
timeout = 1h
404
 
interval = 5m
 
462
timeout = 5m
 
463
interval = 2m
405
464
checker = fping -q -- %%(host)s
406
465
 
407
466
# Client "foo"
440
499
  <refsect1 id="see_also">
441
500
    <title>SEE ALSO</title>
442
501
    <para>
 
502
      <citerefentry><refentrytitle>intro</refentrytitle>
 
503
      <manvolnum>8mandos</manvolnum></citerefentry>,
443
504
      <citerefentry><refentrytitle>mandos-keygen</refentrytitle>
444
505
      <manvolnum>8</manvolnum></citerefentry>,
445
506
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>