/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

  • Committer: Teddy Hogeborn
  • Date: 2009-01-04 22:15:01 UTC
  • Revision ID: teddy@fukt.bsnet.se-20090104221501-23vutw4cnmb575rq
* debian/mandos.README.Debian: Updated to reflect code changes.

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 "2010-09-26">
 
5
<!ENTITY TIMESTAMP "2009-01-04">
6
6
<!ENTITY % common SYSTEM "common.ent">
7
7
%common;
8
8
]>
33
33
    <copyright>
34
34
      <year>2008</year>
35
35
      <year>2009</year>
36
 
      <year>2010</year>
37
36
      <holder>Teddy Hogeborn</holder>
38
37
      <holder>Björn Påhlsson</holder>
39
38
    </copyright>
88
87
      <arg><option>--debug</option></arg>
89
88
      <sbr/>
90
89
      <arg><option>--no-dbus</option></arg>
91
 
      <sbr/>
92
 
      <arg><option>--no-ipv6</option></arg>
93
90
    </cmdsynopsis>
94
91
    <cmdsynopsis>
95
92
      <command>&COMMANDNAME;</command>
244
241
          </para>
245
242
        </listitem>
246
243
      </varlistentry>
247
 
      
248
 
      <varlistentry>
249
 
        <term><option>--no-ipv6</option></term>
250
 
        <listitem>
251
 
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
252
 
        </listitem>
253
 
      </varlistentry>
254
244
    </variablelist>
255
245
  </refsect1>
256
246
  
328
318
      The server will, by default, continually check that the clients
329
319
      are still up.  If a client has not been confirmed as being up
330
320
      for some time, the client is assumed to be compromised and is no
331
 
      longer eligible to receive the encrypted password.  (Manual
332
 
      intervention is required to re-enable a client.)  The timeout,
 
321
      longer eligible to receive the encrypted password.  The timeout,
333
322
      checker program, and interval between checks can be configured
334
323
      both globally and per client; see <citerefentry>
335
324
      <refentrytitle>mandos-clients.conf</refentrytitle>
336
 
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
337
 
      receiving its password will also be treated as a successful
338
 
      checker run.
339
 
    </para>
340
 
  </refsect1>
341
 
  
342
 
  <refsect1 id="approval">
343
 
    <title>APPROVAL</title>
344
 
    <para>
345
 
      The server can be configured to require manual approval for a
346
 
      client before it is sent its secret.  The delay to wait for such
347
 
      approval and the default action (approve or deny) can be
348
 
      configured both globally and per client; see <citerefentry>
349
 
      <refentrytitle>mandos-clients.conf</refentrytitle>
350
 
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
351
 
      will be approved immediately without delay.
352
 
    </para>
353
 
    <para>
354
 
      This can be used to deny a client its secret if not manually
355
 
      approved within a specified time.  It can also be used to make
356
 
      the server delay before giving a client its secret, allowing
357
 
      optional manual denying of this specific client.
358
 
    </para>
359
 
    
 
325
      <manvolnum>5</manvolnum></citerefentry>.
 
326
    </para>
360
327
  </refsect1>
361
328
  
362
329
  <refsect1 id="logging">
374
341
    <para>
375
342
      The server will by default provide a D-Bus system bus interface.
376
343
      This interface will only be accessible by the root user or a
377
 
      Mandos-specific user, if such a user exists.  For documentation
378
 
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
 
344
      Mandos-specific user, if such a user exists.
 
345
      <!-- XXX -->
379
346
    </para>
380
347
  </refsect1>
381
 
  
 
348
 
382
349
  <refsect1 id="exit_status">
383
350
    <title>EXIT STATUS</title>
384
351
    <para>
439
406
        <term><filename>/var/run/mandos.pid</filename></term>
440
407
        <listitem>
441
408
          <para>
442
 
            The file containing the process id of the
443
 
            <command>&COMMANDNAME;</command> process started last.
 
409
            The file containing the process id of
 
410
            <command>&COMMANDNAME;</command>.
444
411
          </para>
445
412
        </listitem>
446
413
      </varlistentry>
474
441
      backtrace.  This could be considered a feature.
475
442
    </para>
476
443
    <para>
477
 
      Currently, if a client is disabled due to having timed out, the
478
 
      server does not record this fact onto permanent storage.  This
479
 
      has some security implications, see <xref linkend="clients"/>.
 
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.
480
453
    </para>
481
454
    <para>
482
455
      There is no fine-grained control over logging and debug output.
485
458
      Debug mode is conflated with running in the foreground.
486
459
    </para>
487
460
    <para>
488
 
      The console log messages do not show a time stamp.
 
461
      The console log messages does not show a time stamp.
489
462
    </para>
490
463
    <para>
491
464
      This server does not check the expire time of clients’ OpenPGP
564
537
      </para>
565
538
      <para>
566
539
        If a client is compromised, its downtime should be duly noted
567
 
        by the server which would therefore disable the client.  But
568
 
        if the server was ever restarted, it would re-read its client
569
 
        list from its configuration file and again regard all clients
570
 
        therein as enabled, and hence eligible to receive their
571
 
        passwords.  Therefore, be careful when restarting servers if
572
 
        it is suspected that a client has, in fact, been compromised
573
 
        by parties who may now be running a fake Mandos client with
574
 
        the keys from the non-encrypted initial <acronym>RAM</acronym>
575
 
        image of the client host.  What should be done in that case
576
 
        (if restarting the server program really is necessary) is to
577
 
        stop the server program, edit the configuration file to omit
578
 
        any suspect clients, and restart the server program.
 
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.
579
553
      </para>
580
554
      <para>
581
555
        For more details on client-side security, see