/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

Update copyright year to "2010" wherever appropriate.

* plugin-runner.c: - '' -
* plugins.d/mandos-client.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 "2009-01-04">
 
5
<!ENTITY TIMESTAMP "2010-09-26">
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>
36
37
      <holder>Teddy Hogeborn</holder>
37
38
      <holder>Björn Påhlsson</holder>
38
39
    </copyright>
87
88
      <arg><option>--debug</option></arg>
88
89
      <sbr/>
89
90
      <arg><option>--no-dbus</option></arg>
 
91
      <sbr/>
 
92
      <arg><option>--no-ipv6</option></arg>
90
93
    </cmdsynopsis>
91
94
    <cmdsynopsis>
92
95
      <command>&COMMANDNAME;</command>
241
244
          </para>
242
245
        </listitem>
243
246
      </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>
244
254
    </variablelist>
245
255
  </refsect1>
246
256
  
318
328
      The server will, by default, continually check that the clients
319
329
      are still up.  If a client has not been confirmed as being up
320
330
      for some time, the client is assumed to be compromised and is no
321
 
      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,
322
333
      checker program, and interval between checks can be configured
323
334
      both globally and per client; see <citerefentry>
324
335
      <refentrytitle>mandos-clients.conf</refentrytitle>
325
 
      <manvolnum>5</manvolnum></citerefentry>.
326
 
    </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
    
327
360
  </refsect1>
328
361
  
329
362
  <refsect1 id="logging">
341
374
    <para>
342
375
      The server will by default provide a D-Bus system bus interface.
343
376
      This interface will only be accessible by the root user or a
344
 
      Mandos-specific user, if such a user exists.
345
 
      <!-- 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>.
346
379
    </para>
347
380
  </refsect1>
348
 
 
 
381
  
349
382
  <refsect1 id="exit_status">
350
383
    <title>EXIT STATUS</title>
351
384
    <para>
406
439
        <term><filename>/var/run/mandos.pid</filename></term>
407
440
        <listitem>
408
441
          <para>
409
 
            The file containing the process id of
410
 
            <command>&COMMANDNAME;</command>.
 
442
            The file containing the process id of the
 
443
            <command>&COMMANDNAME;</command> process started last.
411
444
          </para>
412
445
        </listitem>
413
446
      </varlistentry>
441
474
      backtrace.  This could be considered a feature.
442
475
    </para>
443
476
    <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.
 
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"/>.
453
480
    </para>
454
481
    <para>
455
482
      There is no fine-grained control over logging and debug output.
458
485
      Debug mode is conflated with running in the foreground.
459
486
    </para>
460
487
    <para>
461
 
      The console log messages does not show a time stamp.
 
488
      The console log messages do not show a time stamp.
462
489
    </para>
463
490
    <para>
464
491
      This server does not check the expire time of clients’ OpenPGP
537
564
      </para>
538
565
      <para>
539
566
        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.
 
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.
553
579
      </para>
554
580
      <para>
555
581
        For more details on client-side security, see