/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-ctl: Also show "LastApprovalRequest" property.

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-25">
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>
86
87
      <arg><option>--debug</option></arg>
87
88
      <sbr/>
88
89
      <arg><option>--no-dbus</option></arg>
 
90
      <sbr/>
 
91
      <arg><option>--no-ipv6</option></arg>
89
92
    </cmdsynopsis>
90
93
    <cmdsynopsis>
91
94
      <command>&COMMANDNAME;</command>
236
239
        <listitem>
237
240
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
238
241
          <para>
239
 
            See also <xref linkend="dbus"/>.
 
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"/>
240
251
        </listitem>
241
252
      </varlistentry>
242
253
    </variablelist>
316
327
      The server will, by default, continually check that the clients
317
328
      are still up.  If a client has not been confirmed as being up
318
329
      for some time, the client is assumed to be compromised and is no
319
 
      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,
320
332
      checker program, and interval between checks can be configured
321
333
      both globally and per client; see <citerefentry>
322
334
      <refentrytitle>mandos-clients.conf</refentrytitle>
323
 
      <manvolnum>5</manvolnum></citerefentry>.
324
 
    </para>
 
335
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
 
336
      receiving its password will also be treated as a successful
 
337
      checker run.
 
338
    </para>
 
339
  </refsect1>
 
340
  
 
341
  <refsect1 id="approval">
 
342
    <title>APPROVAL</title>
 
343
    <para>
 
344
      The server can be configured to require manual approval for a
 
345
      client before it is sent its secret.  The delay to wait for such
 
346
      approval and the default action (approve or deny) can be
 
347
      configured both globally and per client; see <citerefentry>
 
348
      <refentrytitle>mandos-clients.conf</refentrytitle>
 
349
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
 
350
      will be approved immediately without delay.
 
351
    </para>
 
352
    <para>
 
353
      This can be used to deny a client its secret if not manually
 
354
      approved within a specified time.  It can also be used to make
 
355
      the server delay before giving a client its secret, allowing
 
356
      optional manual denying of this specific client.
 
357
    </para>
 
358
    
325
359
  </refsect1>
326
360
  
327
361
  <refsect1 id="logging">
334
368
    </para>
335
369
  </refsect1>
336
370
  
337
 
  <refsect1 id="dbus">
 
371
  <refsect1 id="dbus_interface">
338
372
    <title>D-BUS INTERFACE</title>
339
373
    <para>
340
374
      The server will by default provide a D-Bus system bus interface.
341
375
      This interface will only be accessible by the root user or a
342
 
      Mandos-specific user, if such a user exists.
343
 
      <!-- XXX -->
 
376
      Mandos-specific user, if such a user exists.  For documentation
 
377
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
344
378
    </para>
345
379
  </refsect1>
346
 
 
 
380
  
347
381
  <refsect1 id="exit_status">
348
382
    <title>EXIT STATUS</title>
349
383
    <para>
404
438
        <term><filename>/var/run/mandos.pid</filename></term>
405
439
        <listitem>
406
440
          <para>
407
 
            The file containing the process id of
408
 
            <command>&COMMANDNAME;</command>.
 
441
            The file containing the process id of the
 
442
            <command>&COMMANDNAME;</command> process started last.
409
443
          </para>
410
444
        </listitem>
411
445
      </varlistentry>
439
473
      backtrace.  This could be considered a feature.
440
474
    </para>
441
475
    <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.
 
476
      Currently, if a client is disabled due to having timed out, the
 
477
      server does not record this fact onto permanent storage.  This
 
478
      has some security implications, see <xref linkend="clients"/>.
451
479
    </para>
452
480
    <para>
453
481
      There is no fine-grained control over logging and debug output.
456
484
      Debug mode is conflated with running in the foreground.
457
485
    </para>
458
486
    <para>
459
 
      The console log messages does not show a time stamp.
 
487
      The console log messages do not show a time stamp.
460
488
    </para>
461
489
    <para>
462
490
      This server does not check the expire time of clients’ OpenPGP
535
563
      </para>
536
564
      <para>
537
565
        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.
 
566
        by the server which would therefore disable the client.  But
 
567
        if the server was ever restarted, it would re-read its client
 
568
        list from its configuration file and again regard all clients
 
569
        therein as enabled, and hence eligible to receive their
 
570
        passwords.  Therefore, be careful when restarting servers if
 
571
        it is suspected that a client has, in fact, been compromised
 
572
        by parties who may now be running a fake Mandos client with
 
573
        the keys from the non-encrypted initial <acronym>RAM</acronym>
 
574
        image of the client host.  What should be done in that case
 
575
        (if restarting the server program really is necessary) is to
 
576
        stop the server program, edit the configuration file to omit
 
577
        any suspect clients, and restart the server program.
551
578
      </para>
552
579
      <para>
553
580
        For more details on client-side security, see