/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

* debian/mandos.dirs: Added "etc/dbus-1/system.d".

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 "2008-09-30">
 
5
<!ENTITY TIMESTAMP "2010-09-11">
6
6
<!ENTITY % common SYSTEM "common.ent">
7
7
%common;
8
8
]>
32
32
    </authorgroup>
33
33
    <copyright>
34
34
      <year>2008</year>
 
35
      <year>2009</year>
35
36
      <holder>Teddy Hogeborn</holder>
36
37
      <holder>Björn Påhlsson</holder>
37
38
    </copyright>
84
85
      <replaceable>DIRECTORY</replaceable></option></arg>
85
86
      <sbr/>
86
87
      <arg><option>--debug</option></arg>
 
88
      <sbr/>
 
89
      <arg><option>--no-dbus</option></arg>
 
90
      <sbr/>
 
91
      <arg><option>--no-ipv6</option></arg>
87
92
    </cmdsynopsis>
88
93
    <cmdsynopsis>
89
94
      <command>&COMMANDNAME;</command>
228
233
          </para>
229
234
        </listitem>
230
235
      </varlistentry>
 
236
      
 
237
      <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
        <term><option>--no-ipv6</option></term>
 
249
        <listitem>
 
250
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
 
251
        </listitem>
 
252
      </varlistentry>
231
253
    </variablelist>
232
254
  </refsect1>
233
255
  
305
327
      The server will, by default, continually check that the clients
306
328
      are still up.  If a client has not been confirmed as being up
307
329
      for some time, the client is assumed to be compromised and is no
308
 
      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,
309
332
      checker program, and interval between checks can be configured
310
333
      both globally and per client; see <citerefentry>
311
334
      <refentrytitle>mandos-clients.conf</refentrytitle>
312
 
      <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.
313
338
    </para>
314
339
  </refsect1>
315
340
  
323
348
    </para>
324
349
  </refsect1>
325
350
  
 
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
  
326
361
  <refsect1 id="exit_status">
327
362
    <title>EXIT STATUS</title>
328
363
    <para>
351
386
    </variablelist>
352
387
  </refsect1>
353
388
  
354
 
  <refsect1 id="file">
 
389
  <refsect1 id="files">
355
390
    <title>FILES</title>
356
391
    <para>
357
392
      Use the <option>--configdir</option> option to change where
418
453
      backtrace.  This could be considered a feature.
419
454
    </para>
420
455
    <para>
421
 
      Currently, if a client is declared <quote>invalid</quote> due to
422
 
      having timed out, the server does not record this fact onto
423
 
      permanent storage.  This has some security implications, see
424
 
      <xref linkend="CLIENTS"/>.
425
 
    </para>
426
 
    <para>
427
 
      There is currently no way of querying the server of the current
428
 
      status of clients, other than analyzing its <systemitem
429
 
      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"/>.
430
459
    </para>
431
460
    <para>
432
461
      There is no fine-grained control over logging and debug output.
435
464
      Debug mode is conflated with running in the foreground.
436
465
    </para>
437
466
    <para>
438
 
      The console log messages does not show a time stamp.
 
467
      The console log messages do not show a time stamp.
439
468
    </para>
440
469
    <para>
441
470
      This server does not check the expire time of clients’ OpenPGP
483
512
  
484
513
  <refsect1 id="security">
485
514
    <title>SECURITY</title>
486
 
    <refsect2 id="SERVER">
 
515
    <refsect2 id="server">
487
516
      <title>SERVER</title>
488
517
      <para>
489
518
        Running this <command>&COMMANDNAME;</command> server program
492
521
        soon after startup.
493
522
      </para>
494
523
    </refsect2>
495
 
    <refsect2 id="CLIENTS">
 
524
    <refsect2 id="clients">
496
525
      <title>CLIENTS</title>
497
526
      <para>
498
527
        The server only gives out its stored data to clients which
514
543
      </para>
515
544
      <para>
516
545
        If a client is compromised, its downtime should be duly noted
517
 
        by the server which would therefore declare the client
518
 
        invalid.  But if the server was ever restarted, it would
519
 
        re-read its client list from its configuration file and again
520
 
        regard all clients therein as valid, and hence eligible to
521
 
        receive their passwords.  Therefore, be careful when
522
 
        restarting servers if it is suspected that a client has, in
523
 
        fact, been compromised by parties who may now be running a
524
 
        fake Mandos client with the keys from the non-encrypted
525
 
        initial <acronym>RAM</acronym> image of the client host.  What
526
 
        should be done in that case (if restarting the server program
527
 
        really is necessary) is to stop the server program, edit the
528
 
        configuration file to omit any suspect clients, and restart
529
 
        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.
530
558
      </para>
531
559
      <para>
532
560
        For more details on client-side security, see