/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: teddy at bsnet
  • Date: 2011-02-11 19:02:24 UTC
  • mto: (237.7.13 mandos)
  • mto: This revision was merged to the branch mainline in revision 282.
  • Revision ID: teddy@fukt.bsnet.se-20110211190224-62celso7mswtep65
* mandos-monitor: Use unicode string literals.  Update __future__
                  import line to use all available and applicable
                  imports.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-clients.conf.xml
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 "2012-01-01">
 
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
 
      <year>2012</year>
40
38
      <holder>Teddy Hogeborn</holder>
41
39
      <holder>Björn Påhlsson</holder>
42
40
    </copyright>
66
64
      ><refentrytitle>mandos</refentrytitle>
67
65
      <manvolnum>8</manvolnum></citerefentry>, read by it at startup.
68
66
      The file needs to list all clients that should be able to use
69
 
      the service.  The settings in this file can be overridden by
70
 
      runtime changes to the server, which it saves across restarts.
71
 
      (See the section called <quote>PERSISTENT STATE</quote> in
72
 
      <citerefentry><refentrytitle>mandos</refentrytitle><manvolnum
73
 
      >8</manvolnum></citerefentry>.)  However, any <emphasis
74
 
      >changes</emphasis> to this file (including adding and removing
75
 
      clients) will, at startup, override changes done during runtime.
 
67
      the service.  All clients listed will be regarded as enabled,
 
68
      even if a client was disabled in a previous run of the server.
76
69
    </para>
77
70
    <para>
78
71
      The format starts with a <literal>[<replaceable>section
188
181
      </varlistentry>
189
182
      
190
183
      <varlistentry>
191
 
        <term><option>extended_timeout<literal> = </literal><replaceable
192
 
        >TIME</replaceable></option></term>
193
 
        <listitem>
194
 
          <para>
195
 
            This option is <emphasis>optional</emphasis>.
196
 
          </para>
197
 
          <para>
198
 
            Extended timeout is an added timeout that is given once
199
 
            after a password has been sent successfully to a client.
200
 
            The timeout is by default longer than the normal timeout,
201
 
            and is used for handling the extra long downtime while a
202
 
            machine is booting up.  Time to take into consideration
203
 
            when changing this value is file system checks and quota
204
 
            checks.  The default value is 15 minutes.
205
 
          </para>
206
 
          <para>
207
 
            The format of <replaceable>TIME</replaceable> is the same
208
 
            as for <varname>timeout</varname> below.
209
 
          </para>
210
 
        </listitem>
211
 
      </varlistentry>
212
 
      
213
 
      <varlistentry>
214
184
        <term><option>fingerprint<literal> = </literal
215
185
        ><replaceable>HEXSTRING</replaceable></option></term>
216
186
        <listitem>
258
228
            will wait for a checker to complete until the below
259
229
            <quote><varname>timeout</varname></quote> occurs, at which
260
230
            time the client will be disabled, and any running checker
261
 
            killed.  The default interval is 2 minutes.
 
231
            killed.  The default interval is 5 minutes.
262
232
          </para>
263
233
          <para>
264
234
            The format of <replaceable>TIME</replaceable> is the same
328
298
            This option is <emphasis>optional</emphasis>.
329
299
          </para>
330
300
          <para>
331
 
            The timeout is how long the server will wait, after a
332
 
            successful checker run, until a client is disabled and not
333
 
            allowed to get the data this server holds.  By default
334
 
            Mandos will use 5 minutes.  See also the
335
 
            <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.
336
305
          </para>
337
306
          <para>
338
307
            The <replaceable>TIME</replaceable> is specified as a
350
319
        </listitem>
351
320
      </varlistentry>
352
321
      
353
 
      <varlistentry>
354
 
        <term><option>enabled<literal> = </literal>{ <literal
355
 
        >1</literal> | <literal>yes</literal> | <literal>true</literal
356
 
        > | <literal >on</literal> | <literal>0</literal> | <literal
357
 
        >no</literal> | <literal>false</literal> | <literal
358
 
        >off</literal> }</option></term>
359
 
        <listitem>
360
 
          <para>
361
 
            Whether this client should be enabled by default.  The
362
 
            default is <quote>true</quote>.
363
 
          </para>
364
 
        </listitem>
365
 
      </varlistentry>
366
 
      
367
322
    </variablelist>
368
323
  </refsect1>
369
324
  
464
419
    <informalexample>
465
420
      <programlisting>
466
421
[DEFAULT]
467
 
timeout = 5m
468
 
interval = 2m
 
422
timeout = 1h
 
423
interval = 5m
469
424
checker = fping -q -- %%(host)s
470
425
 
471
426
# Client "foo"
504
459
  <refsect1 id="see_also">
505
460
    <title>SEE ALSO</title>
506
461
    <para>
507
 
      <citerefentry><refentrytitle>intro</refentrytitle>
508
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
509
462
      <citerefentry><refentrytitle>mandos-keygen</refentrytitle>
510
463
      <manvolnum>8</manvolnum></citerefentry>,
511
464
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>