/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

* DBUS-API: Document new "Expires" and "ExtendedTimeout" properties.
* README: Refer to the installed manual page more simply.
* mandos (Client.extended_timeout, Client.expires): New attributes.
  (Client.extended_timeout_milliseconds): New.
  (Client.__init__, Client.enable, Client.disable): Set new attributes.
  (Client.checked_ok): Take new "timeout" argument.
  (ClientDBus.expires): Transform into a property which sends a D-Bus
                        signal when changed.
  (ClientDBus._datetime_to_dbus): Return empty D-Bus string on None.
                                  All callers changed to use this.

  (ClientDBus.ApprovedByDefault_dbus_property,
  ClientDBus.ApprovalDelay_dbus_property,
  ClientDBus.ApprovalDuration_dbus_property,
  ClientDBus.Host_dbus_property, ClientDBus.Timeout_dbus_property,
  ClientDBus.Interval_dbus_property,
  ClientDBus.Checker_dbus_property): Bug fix: Only send D-Bus signal
                                     if new value is different.
  (ClientDBus.Timeout_dbus_property): Use new "expires" attribute.
  (ClientDBus.Expires_dbus_property,
  ClientDBus.ExtendedTimeout_dbus_property): New D-Bus properties.
  (ClientHandler.handle): Bump time using extended_timeout value.
  (main.client_defaults): Change default values of "timeout" and
                          "interval", added new default value for
                          "extended_timeout".
* mandos-clients.conf.xml (OPTIONS): Changed default values of
                                     "interval" and "timeout".  Add
                                     new "extended_timeout" option.
  (EXAMPLE): Updated default values.
* mandos-ctl: Show new "ExtendedTimeout" D-Bus property and change it
              using new "--extended-timeout" option.
* mandos-ctl.xml (SYNOPSIS, OPTIONS): Document new
                                      "--extended-timeout" option.
* mandos-monitor (MandosClientWidget.update): Use new "Expires" D-Bus
                                              property.
* mandos.xml (DESCRIPTION): Add reference to intro(8mandos) manual
                            page.
  (CHECKING): Refer to the new "extended_timeout" option in
  clients.conf.

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-02-27">
 
6
<!ENTITY TIMESTAMP "2011-08-08">
7
7
<!ENTITY % common SYSTEM "common.ent">
8
8
%common;
9
9
]>
229
229
            will wait for a checker to complete until the below
230
230
            <quote><varname>timeout</varname></quote> occurs, at which
231
231
            time the client will be disabled, and any running checker
232
 
            killed.  The default interval is 5 minutes.
 
232
            killed.  The default interval is 2 minutes.
233
233
          </para>
234
234
          <para>
235
235
            The format of <replaceable>TIME</replaceable> is the same
302
302
            The timeout is how long the server will wait (for either a
303
303
            successful checker run or a client receiving its secret)
304
304
            until a client is disabled and not allowed to get the data
305
 
            this server holds.  By default Mandos will use 1 hour.
 
305
            this server holds.  By default Mandos will use 5 minutes.
306
306
          </para>
307
307
          <para>
308
308
            The <replaceable>TIME</replaceable> is specified as a
319
319
          </para>
320
320
        </listitem>
321
321
      </varlistentry>
 
322
 
 
323
      <varlistentry>
 
324
        <term><option>extended_timeout<literal> = </literal><replaceable
 
325
        >TIME</replaceable></option></term>
 
326
        <listitem>
 
327
          <para>
 
328
            This option is <emphasis>optional</emphasis>.
 
329
          </para>
 
330
          <para>
 
331
            Extended timeout is an added timeout that is given once
 
332
            after a password has been sent sucessfully to a client.
 
333
            The timeout is by default longer than the normal timeout,
 
334
            and is used for handling the extra long downtime while a
 
335
            matchine is booting up.  Time to take into consideration
 
336
            when changing this value is system file checks and quota
 
337
            checks.  The default value is 15 minutes.
 
338
          </para>
 
339
          <para>
 
340
            The format of <replaceable>TIME</replaceable> is the same
 
341
            as for <varname>timeout</varname> above.
 
342
          </para>
 
343
        </listitem>
 
344
      </varlistentry>
322
345
      
323
346
    </variablelist>
324
347
  </refsect1>
420
443
    <informalexample>
421
444
      <programlisting>
422
445
[DEFAULT]
423
 
timeout = 1h
424
 
interval = 5m
 
446
timeout = 5m
 
447
interval = 2m
425
448
checker = fping -q -- %%(host)s
426
449
 
427
450
# Client "foo"
460
483
  <refsect1 id="see_also">
461
484
    <title>SEE ALSO</title>
462
485
    <para>
 
486
      <citerefentry><refentrytitle>intro</refentrytitle>
 
487
      <manvolnum>8mandos</manvolnum></citerefentry>,
463
488
      <citerefentry><refentrytitle>mandos-keygen</refentrytitle>
464
489
      <manvolnum>8</manvolnum></citerefentry>,
465
490
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>