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

Merge from trunk.  Notable changes:

1. Fix version numbers in manual pages.
2. Bug fix: Do not depend on GNU awk.
3. Dependency on Python 2.5 documented.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos.xml
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
4
<!ENTITY COMMANDNAME "mandos">
5
 
<!ENTITY TIMESTAMP "2010-09-11">
 
5
<!ENTITY TIMESTAMP "2009-02-24">
6
6
<!ENTITY % common SYSTEM "common.ent">
7
7
%common;
8
8
]>
86
86
      <sbr/>
87
87
      <arg><option>--debug</option></arg>
88
88
      <sbr/>
89
 
      <arg><option>--no-dbus</option></arg>
90
 
      <sbr/>
91
89
      <arg><option>--no-ipv6</option></arg>
92
90
    </cmdsynopsis>
93
91
    <cmdsynopsis>
235
233
      </varlistentry>
236
234
      
237
235
      <varlistentry>
238
 
        <term><option>--no-dbus</option></term>
239
 
        <listitem>
240
 
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
241
 
          <para>
242
 
            See also <xref linkend="dbus_interface"/>.
243
 
          </para>
244
 
        </listitem>
245
 
      </varlistentry>
246
 
      
247
 
      <varlistentry>
248
236
        <term><option>--no-ipv6</option></term>
249
237
        <listitem>
250
238
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
327
315
      The server will, by default, continually check that the clients
328
316
      are still up.  If a client has not been confirmed as being up
329
317
      for some time, the client is assumed to be compromised and is no
330
 
      longer eligible to receive the encrypted password.  (Manual
331
 
      intervention is required to re-enable a client.)  The timeout,
 
318
      longer eligible to receive the encrypted password.  The timeout,
332
319
      checker program, and interval between checks can be configured
333
320
      both globally and per client; see <citerefentry>
334
321
      <refentrytitle>mandos-clients.conf</refentrytitle>
335
 
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
336
 
      receiving its password will also be treated as a successful
337
 
      checker run.
 
322
      <manvolnum>5</manvolnum></citerefentry>.
338
323
    </para>
339
324
  </refsect1>
340
325
  
348
333
    </para>
349
334
  </refsect1>
350
335
  
351
 
  <refsect1 id="dbus_interface">
352
 
    <title>D-BUS INTERFACE</title>
353
 
    <para>
354
 
      The server will by default provide a D-Bus system bus interface.
355
 
      This interface will only be accessible by the root user or a
356
 
      Mandos-specific user, if such a user exists.  For documentation
357
 
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
358
 
    </para>
359
 
  </refsect1>
360
 
  
361
336
  <refsect1 id="exit_status">
362
337
    <title>EXIT STATUS</title>
363
338
    <para>
453
428
      backtrace.  This could be considered a feature.
454
429
    </para>
455
430
    <para>
456
 
      Currently, if a client is disabled due to having timed out, the
457
 
      server does not record this fact onto permanent storage.  This
458
 
      has some security implications, see <xref linkend="clients"/>.
 
431
      Currently, if a client is declared <quote>invalid</quote> due to
 
432
      having timed out, the server does not record this fact onto
 
433
      permanent storage.  This has some security implications, see
 
434
      <xref linkend="clients"/>.
 
435
    </para>
 
436
    <para>
 
437
      There is currently no way of querying the server of the current
 
438
      status of clients, other than analyzing its <systemitem
 
439
      class="service">syslog</systemitem> output.
459
440
    </para>
460
441
    <para>
461
442
      There is no fine-grained control over logging and debug output.
543
524
      </para>
544
525
      <para>
545
526
        If a client is compromised, its downtime should be duly noted
546
 
        by the server which would therefore disable the client.  But
547
 
        if the server was ever restarted, it would re-read its client
548
 
        list from its configuration file and again regard all clients
549
 
        therein as enabled, and hence eligible to receive their
550
 
        passwords.  Therefore, be careful when restarting servers if
551
 
        it is suspected that a client has, in fact, been compromised
552
 
        by parties who may now be running a fake Mandos client with
553
 
        the keys from the non-encrypted initial <acronym>RAM</acronym>
554
 
        image of the client host.  What should be done in that case
555
 
        (if restarting the server program really is necessary) is to
556
 
        stop the server program, edit the configuration file to omit
557
 
        any suspect clients, and restart the server program.
 
527
        by the server which would therefore declare the client
 
528
        invalid.  But if the server was ever restarted, it would
 
529
        re-read its client list from its configuration file and again
 
530
        regard all clients therein as valid, and hence eligible to
 
531
        receive their passwords.  Therefore, be careful when
 
532
        restarting servers if it is suspected that a client has, in
 
533
        fact, been compromised by parties who may now be running a
 
534
        fake Mandos client with the keys from the non-encrypted
 
535
        initial <acronym>RAM</acronym> image of the client host.  What
 
536
        should be done in that case (if restarting the server program
 
537
        really is necessary) is to stop the server program, edit the
 
538
        configuration file to omit any suspect clients, and restart
 
539
        the server program.
558
540
      </para>
559
541
      <para>
560
542
        For more details on client-side security, see