/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-monitor.xml: New.
* Makefile (PROGS): Add "mandos-monitor".
  (DOCS): Add "mandos-monitor.xml".
  (mandos-monitor.8, mandos-monitor.8.xhtml, mandos-monitor): New.
  (install-server): Install "mandos-ctl" and "mandos-monitor" too.
  (uninstall-server): Remove "mandos-ctl" and "mandos-monitor" too.
* mandos-monitor: Don't log uninteresting messages.

Show diffs side-by-side

added added

removed removed

Lines of Context:
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 "2009-01-04">
 
5
<!ENTITY TIMESTAMP "2010-09-11">
6
6
<!ENTITY % common SYSTEM "common.ent">
7
7
%common;
8
8
]>
87
87
      <arg><option>--debug</option></arg>
88
88
      <sbr/>
89
89
      <arg><option>--no-dbus</option></arg>
 
90
      <sbr/>
 
91
      <arg><option>--no-ipv6</option></arg>
90
92
    </cmdsynopsis>
91
93
    <cmdsynopsis>
92
94
      <command>&COMMANDNAME;</command>
241
243
          </para>
242
244
        </listitem>
243
245
      </varlistentry>
 
246
      
 
247
      <varlistentry>
 
248
        <term><option>--no-ipv6</option></term>
 
249
        <listitem>
 
250
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
 
251
        </listitem>
 
252
      </varlistentry>
244
253
    </variablelist>
245
254
  </refsect1>
246
255
  
318
327
      The server will, by default, continually check that the clients
319
328
      are still up.  If a client has not been confirmed as being up
320
329
      for some time, the client is assumed to be compromised and is no
321
 
      longer eligible to receive the encrypted password.  The timeout,
 
330
      longer eligible to receive the encrypted password.  (Manual
 
331
      intervention is required to re-enable a client.)  The timeout,
322
332
      checker program, and interval between checks can be configured
323
333
      both globally and per client; see <citerefentry>
324
334
      <refentrytitle>mandos-clients.conf</refentrytitle>
325
 
      <manvolnum>5</manvolnum></citerefentry>.
 
335
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
 
336
      receiving its password will also be treated as a successful
 
337
      checker run.
326
338
    </para>
327
339
  </refsect1>
328
340
  
341
353
    <para>
342
354
      The server will by default provide a D-Bus system bus interface.
343
355
      This interface will only be accessible by the root user or a
344
 
      Mandos-specific user, if such a user exists.
345
 
      <!-- XXX -->
 
356
      Mandos-specific user, if such a user exists.  For documentation
 
357
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
346
358
    </para>
347
359
  </refsect1>
348
 
 
 
360
  
349
361
  <refsect1 id="exit_status">
350
362
    <title>EXIT STATUS</title>
351
363
    <para>
441
453
      backtrace.  This could be considered a feature.
442
454
    </para>
443
455
    <para>
444
 
      Currently, if a client is declared <quote>invalid</quote> due to
445
 
      having timed out, the server does not record this fact onto
446
 
      permanent storage.  This has some security implications, see
447
 
      <xref linkend="clients"/>.
448
 
    </para>
449
 
    <para>
450
 
      There is currently no way of querying the server of the current
451
 
      status of clients, other than analyzing its <systemitem
452
 
      class="service">syslog</systemitem> output.
 
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"/>.
453
459
    </para>
454
460
    <para>
455
461
      There is no fine-grained control over logging and debug output.
458
464
      Debug mode is conflated with running in the foreground.
459
465
    </para>
460
466
    <para>
461
 
      The console log messages does not show a time stamp.
 
467
      The console log messages do not show a time stamp.
462
468
    </para>
463
469
    <para>
464
470
      This server does not check the expire time of clients’ OpenPGP
537
543
      </para>
538
544
      <para>
539
545
        If a client is compromised, its downtime should be duly noted
540
 
        by the server which would therefore declare the client
541
 
        invalid.  But if the server was ever restarted, it would
542
 
        re-read its client list from its configuration file and again
543
 
        regard all clients therein as valid, and hence eligible to
544
 
        receive their passwords.  Therefore, be careful when
545
 
        restarting servers if it is suspected that a client has, in
546
 
        fact, been compromised by parties who may now be running a
547
 
        fake Mandos client with the keys from the non-encrypted
548
 
        initial <acronym>RAM</acronym> image of the client host.  What
549
 
        should be done in that case (if restarting the server program
550
 
        really is necessary) is to stop the server program, edit the
551
 
        configuration file to omit any suspect clients, and restart
552
 
        the server program.
 
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.
553
558
      </para>
554
559
      <para>
555
560
        For more details on client-side security, see