/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

Merge from release branch.

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 "2010-09-12">
 
6
<!ENTITY TIMESTAMP "2009-09-17">
7
7
<!ENTITY % common SYSTEM "common.ent">
8
8
%common;
9
9
]>
63
63
      ><refentrytitle>mandos</refentrytitle>
64
64
      <manvolnum>8</manvolnum></citerefentry>, read by it at startup.
65
65
      The file needs to list all clients that should be able to use
66
 
      the service.  All clients listed will be regarded as enabled,
67
 
      even if a client was disabled in a previous run of the server.
 
66
      the service.  All clients listed will be regarded as valid, even
 
67
      if a client was declared invalid in a previous run of the
 
68
      server.
68
69
    </para>
69
70
    <para>
70
71
      The format starts with a <literal>[<replaceable>section
109
110
          <para>
110
111
            The timeout is how long the server will wait (for either a
111
112
            successful checker run or a client receiving its secret)
112
 
            until a client is disabled and not allowed to get the data
113
 
            this server holds.  By default Mandos will use 1 hour.
 
113
            until a client is considered invalid - that is, ineligible
 
114
            to get the data this server holds.  By default Mandos will
 
115
            use 1 hour.
114
116
          </para>
115
117
          <para>
116
118
            The <replaceable>TIME</replaceable> is specified as a
141
143
            not be started if an old one is still running.  The server
142
144
            will wait for a checker to complete until the above
143
145
            <quote><varname>timeout</varname></quote> occurs, at which
144
 
            time the client will be disabled, and any running checker
145
 
            killed.  The default interval is 5 minutes.
 
146
            time the client will be marked invalid, and any running
 
147
            checker killed.  The default interval is 5 minutes.
146
148
          </para>
147
149
          <para>
148
150
            The format of <replaceable>TIME</replaceable> is the same
266
268
        </listitem>
267
269
      </varlistentry>
268
270
      
269
 
      <varlistentry>
270
 
        <term><option>approved_by_default<literal> = </literal
271
 
          >{ <literal >1</literal> | <literal>yes</literal> | <literal
272
 
          >true</literal> | <literal>on</literal> | <literal
273
 
          >0</literal> | <literal>no</literal> | <literal
274
 
          >false</literal> | <literal>off</literal> }</option></term>
275
 
        <listitem>
276
 
          <para>
277
 
            Whether to approve a client by default after
278
 
            the <option>approval_delay</option>.  The default
279
 
            is <quote>True</quote>.
280
 
          </para>
281
 
        </listitem>
282
 
      </varlistentry>
283
 
      
284
 
      <varlistentry>
285
 
        <term><option>approval_delay<literal> = </literal><replaceable
286
 
        >TIME</replaceable></option></term>
287
 
        <listitem>
288
 
          <para>
289
 
            This option is <emphasis>optional</emphasis>.
290
 
          </para>
291
 
          <para>
292
 
            How long to wait for external approval before resorting to
293
 
            use the <option>approved_by_default</option> value.  The
294
 
            default is <quote>0s</quote>, i.e. not to wait.
295
 
          </para>
296
 
          <para>
297
 
            The format of <replaceable>TIME</replaceable> is the same
298
 
            as for <varname>timeout</varname> above.
299
 
          </para>
300
 
        </listitem>
301
 
      </varlistentry>
302
 
      
303
 
      <varlistentry>
304
 
        <term><option>approval_duration<literal> = </literal
305
 
        ><replaceable>TIME</replaceable></option></term>
306
 
        <listitem>
307
 
          <para>
308
 
            This option is <emphasis>optional</emphasis>.
309
 
          </para>
310
 
          <para>
311
 
            How long an external approval lasts.  The default is 1
312
 
            second.
313
 
          </para>
314
 
          <para>
315
 
            The format of <replaceable>TIME</replaceable> is the same
316
 
            as for <varname>timeout</varname> above.
317
 
          </para>
318
 
        </listitem>
319
 
      </varlistentry>
320
 
      
321
271
    </variablelist>
322
272
  </refsect1>
323
273
  
431
381
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
432
382
secfile = /etc/mandos/bar-secret
433
383
timeout = 15m
434
 
approved_by_default = False
435
 
approval_delay = 30s
436
384
      </programlisting>
437
385
    </informalexample>
438
386
  </refsect1>