/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: 2010-09-26 18:32:58 UTC
  • Revision ID: teddy@fukt.bsnet.se-20100926183258-n31ux2r8d06m1hi1
Update copyright year to "2010" wherever appropriate.

* DBUS-API: Added copyright and license statement.
* README: Mention new "plymouth" plugin.
* debian/control: Depend on python-2.6 or python-multiprocessing.
* debian/mandos-client.README.Debian: Update info about DEVICE setting
                                      of initramfs.conf.
* mandos-ctl: Added copyright and license statement.
* mandos-monitor: - '' -
* plugins.d/plymouth.c: - '' -

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-12-28">
 
5
<!ENTITY TIMESTAMP "2010-09-26">
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>
 
36
      <year>2010</year>
35
37
      <holder>Teddy Hogeborn</holder>
36
38
      <holder>Björn Påhlsson</holder>
37
39
    </copyright>
86
88
      <arg><option>--debug</option></arg>
87
89
      <sbr/>
88
90
      <arg><option>--no-dbus</option></arg>
 
91
      <sbr/>
 
92
      <arg><option>--no-ipv6</option></arg>
89
93
    </cmdsynopsis>
90
94
    <cmdsynopsis>
91
95
      <command>&COMMANDNAME;</command>
236
240
        <listitem>
237
241
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
238
242
          <para>
239
 
            See also <xref linkend="dbus"/>.
 
243
            See also <xref linkend="dbus_interface"/>.
 
244
          </para>
 
245
        </listitem>
 
246
      </varlistentry>
 
247
      
 
248
      <varlistentry>
 
249
        <term><option>--no-ipv6</option></term>
 
250
        <listitem>
 
251
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
240
252
        </listitem>
241
253
      </varlistentry>
242
254
    </variablelist>
316
328
      The server will, by default, continually check that the clients
317
329
      are still up.  If a client has not been confirmed as being up
318
330
      for some time, the client is assumed to be compromised and is no
319
 
      longer eligible to receive the encrypted password.  The timeout,
 
331
      longer eligible to receive the encrypted password.  (Manual
 
332
      intervention is required to re-enable a client.)  The timeout,
320
333
      checker program, and interval between checks can be configured
321
334
      both globally and per client; see <citerefentry>
322
335
      <refentrytitle>mandos-clients.conf</refentrytitle>
323
 
      <manvolnum>5</manvolnum></citerefentry>.
324
 
    </para>
 
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
360
  </refsect1>
326
361
  
327
362
  <refsect1 id="logging">
334
369
    </para>
335
370
  </refsect1>
336
371
  
337
 
  <refsect1 id="dbus">
 
372
  <refsect1 id="dbus_interface">
338
373
    <title>D-BUS INTERFACE</title>
339
374
    <para>
340
375
      The server will by default provide a D-Bus system bus interface.
341
376
      This interface will only be accessible by the root user or a
342
 
      Mandos-specific user, if such a user exists.
343
 
      <!-- XXX -->
 
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
379
    </para>
345
380
  </refsect1>
346
 
 
 
381
  
347
382
  <refsect1 id="exit_status">
348
383
    <title>EXIT STATUS</title>
349
384
    <para>
404
439
        <term><filename>/var/run/mandos.pid</filename></term>
405
440
        <listitem>
406
441
          <para>
407
 
            The file containing the process id of
408
 
            <command>&COMMANDNAME;</command>.
 
442
            The file containing the process id of the
 
443
            <command>&COMMANDNAME;</command> process started last.
409
444
          </para>
410
445
        </listitem>
411
446
      </varlistentry>
439
474
      backtrace.  This could be considered a feature.
440
475
    </para>
441
476
    <para>
442
 
      Currently, if a client is declared <quote>invalid</quote> due to
443
 
      having timed out, the server does not record this fact onto
444
 
      permanent storage.  This has some security implications, see
445
 
      <xref linkend="clients"/>.
446
 
    </para>
447
 
    <para>
448
 
      There is currently no way of querying the server of the current
449
 
      status of clients, other than analyzing its <systemitem
450
 
      class="service">syslog</systemitem> output.
 
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"/>.
451
480
    </para>
452
481
    <para>
453
482
      There is no fine-grained control over logging and debug output.
456
485
      Debug mode is conflated with running in the foreground.
457
486
    </para>
458
487
    <para>
459
 
      The console log messages does not show a time stamp.
 
488
      The console log messages do not show a time stamp.
460
489
    </para>
461
490
    <para>
462
491
      This server does not check the expire time of clients’ OpenPGP
535
564
      </para>
536
565
      <para>
537
566
        If a client is compromised, its downtime should be duly noted
538
 
        by the server which would therefore declare the client
539
 
        invalid.  But if the server was ever restarted, it would
540
 
        re-read its client list from its configuration file and again
541
 
        regard all clients therein as valid, and hence eligible to
542
 
        receive their passwords.  Therefore, be careful when
543
 
        restarting servers if it is suspected that a client has, in
544
 
        fact, been compromised by parties who may now be running a
545
 
        fake Mandos client with the keys from the non-encrypted
546
 
        initial <acronym>RAM</acronym> image of the client host.  What
547
 
        should be done in that case (if restarting the server program
548
 
        really is necessary) is to stop the server program, edit the
549
 
        configuration file to omit any suspect clients, and restart
550
 
        the server program.
 
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.
551
579
      </para>
552
580
      <para>
553
581
        For more details on client-side security, see