/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.xml

* mandos (Client.timeout, Client.interval): Changed from being a
                                            property to be a normal
                                            attribute.
  (Client._timeout, Client._interval): Removed.
  (Client._timeout_milliseconds): Changed from being an attribute to
                                  be a method "timeout_milliseconds".
                                  All users changed.
  (Client._interval_milliseconds): Changed from being an attribute to
                                   be method "interval_milliseconds".
                                   All users changed.
  (Client.__init__): Take additional "use_dbus" keyword argument.
                     Only provide D-Bus interface if "use_dbus" is
                     True.
  (Client.use_dbus): New attribute.
  (Client.dbus_object_path): Changed to only be set if "self.use_dbus"
                             is True.
  (Client.enable, Client.disable, Client.checker_callback,
  Client.bump_timeout, Client.start_checker, Client.stop_checker):
  Only emit D-Bus signals if "self.use_dbus".
  (Client.SetChecker, Client.SetHost, Client.Enable): Bug fix: Emit
                                                      D-Bus signals.
  (Client.SetInterval, Client.SetTimeout): Changed to emit D-Bus
                                           signals.

  (main): Remove deprecated "default" keyword argument to "--check"
          option.  Added new "--no-dbus" option.  Added corresponding
          "use_dbus" server configuration option.  Only provide D-Bus
          interface and emit D-Bus signals if "use_dbus".  Pass
          "use_dbus" on to Client constructor.

* mandos-options.xml ([@id="dbus"]): New option.

* mandos.conf (use_dbus): New option.

* mandos.conf.xml (OPTIONS): New option "use_dbus".
  (EXAMPLE): - '' -

* mandos.xml (SYNOPSIS): New option "--no-dbus".
  (D-BUS INTERFACE): New section.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
<?xml version="1.0" encoding="UTF-8"?>
2
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
3
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
 
<!ENTITY VERSION "1.0">
5
4
<!ENTITY COMMANDNAME "mandos">
6
 
<!ENTITY TIMESTAMP "2008-09-12">
 
5
<!ENTITY TIMESTAMP "2008-12-28">
 
6
<!ENTITY % common SYSTEM "common.ent">
 
7
%common;
7
8
]>
8
9
 
9
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
10
 
  <refentryinfo>
 
11
   <refentryinfo>
11
12
    <title>Mandos Manual</title>
12
13
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
13
14
    <productname>Mandos</productname>
14
 
    <productnumber>&VERSION;</productnumber>
 
15
    <productnumber>&version;</productnumber>
15
16
    <date>&TIMESTAMP;</date>
16
17
    <authorgroup>
17
18
      <author>
83
84
      <replaceable>DIRECTORY</replaceable></option></arg>
84
85
      <sbr/>
85
86
      <arg><option>--debug</option></arg>
 
87
      <sbr/>
 
88
      <arg><option>--no-dbus</option></arg>
86
89
    </cmdsynopsis>
87
90
    <cmdsynopsis>
88
91
      <command>&COMMANDNAME;</command>
227
230
          </para>
228
231
        </listitem>
229
232
      </varlistentry>
 
233
      
 
234
      <varlistentry>
 
235
        <term><option>--no-dbus</option></term>
 
236
        <listitem>
 
237
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
 
238
          <para>
 
239
            See also <xref linkend="dbus"/>.
 
240
        </listitem>
 
241
      </varlistentry>
230
242
    </variablelist>
231
243
  </refsect1>
232
244
  
322
334
    </para>
323
335
  </refsect1>
324
336
  
 
337
  <refsect1 id="dbus">
 
338
    <title>D-BUS INTERFACE</title>
 
339
    <para>
 
340
      The server will by default provide a D-Bus system bus interface.
 
341
      This interface will only be accessible by the root user or a
 
342
      Mandos-specific user, if such a user exists.
 
343
      <!-- XXX -->
 
344
    </para>
 
345
  </refsect1>
 
346
 
325
347
  <refsect1 id="exit_status">
326
348
    <title>EXIT STATUS</title>
327
349
    <para>
350
372
    </variablelist>
351
373
  </refsect1>
352
374
  
353
 
  <refsect1 id="file">
 
375
  <refsect1 id="files">
354
376
    <title>FILES</title>
355
377
    <para>
356
378
      Use the <option>--configdir</option> option to change where
420
442
      Currently, if a client is declared <quote>invalid</quote> due to
421
443
      having timed out, the server does not record this fact onto
422
444
      permanent storage.  This has some security implications, see
423
 
      <xref linkend="CLIENTS"/>.
 
445
      <xref linkend="clients"/>.
424
446
    </para>
425
447
    <para>
426
448
      There is currently no way of querying the server of the current
482
504
  
483
505
  <refsect1 id="security">
484
506
    <title>SECURITY</title>
485
 
    <refsect2 id="SERVER">
 
507
    <refsect2 id="server">
486
508
      <title>SERVER</title>
487
509
      <para>
488
510
        Running this <command>&COMMANDNAME;</command> server program
491
513
        soon after startup.
492
514
      </para>
493
515
    </refsect2>
494
 
    <refsect2 id="CLIENTS">
 
516
    <refsect2 id="clients">
495
517
      <title>CLIENTS</title>
496
518
      <para>
497
519
        The server only gives out its stored data to clients which
504
526
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
505
527
        <manvolnum>5</manvolnum></citerefentry>)
506
528
        <emphasis>must</emphasis> be made non-readable by anyone
507
 
        except the user running the server.
 
529
        except the user starting the server (usually root).
508
530
      </para>
509
531
      <para>
510
532
        As detailed in <xref linkend="checking"/>, the status of all