/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

Added more method support for mandos clients through mandos-ctl

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 "2008-12-28">
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>
37
35
      <holder>Teddy Hogeborn</holder>
38
36
      <holder>Björn Påhlsson</holder>
39
37
    </copyright>
88
86
      <arg><option>--debug</option></arg>
89
87
      <sbr/>
90
88
      <arg><option>--no-dbus</option></arg>
91
 
      <sbr/>
92
 
      <arg><option>--no-ipv6</option></arg>
93
89
    </cmdsynopsis>
94
90
    <cmdsynopsis>
95
91
      <command>&COMMANDNAME;</command>
240
236
        <listitem>
241
237
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
242
238
          <para>
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"/>
 
239
            See also <xref linkend="dbus"/>.
252
240
        </listitem>
253
241
      </varlistentry>
254
242
    </variablelist>
328
316
      The server will, by default, continually check that the clients
329
317
      are still up.  If a client has not been confirmed as being up
330
318
      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,
 
319
      longer eligible to receive the encrypted password.  The timeout,
333
320
      checker program, and interval between checks can be configured
334
321
      both globally and per client; see <citerefentry>
335
322
      <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
 
    
 
323
      <manvolnum>5</manvolnum></citerefentry>.
 
324
    </para>
360
325
  </refsect1>
361
326
  
362
327
  <refsect1 id="logging">
369
334
    </para>
370
335
  </refsect1>
371
336
  
372
 
  <refsect1 id="dbus_interface">
 
337
  <refsect1 id="dbus">
373
338
    <title>D-BUS INTERFACE</title>
374
339
    <para>
375
340
      The server will by default provide a D-Bus system bus interface.
376
341
      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>.
 
342
      Mandos-specific user, if such a user exists.
 
343
      <!-- XXX -->
379
344
    </para>
380
345
  </refsect1>
381
 
  
 
346
 
382
347
  <refsect1 id="exit_status">
383
348
    <title>EXIT STATUS</title>
384
349
    <para>
439
404
        <term><filename>/var/run/mandos.pid</filename></term>
440
405
        <listitem>
441
406
          <para>
442
 
            The file containing the process id of the
443
 
            <command>&COMMANDNAME;</command> process started last.
 
407
            The file containing the process id of
 
408
            <command>&COMMANDNAME;</command>.
444
409
          </para>
445
410
        </listitem>
446
411
      </varlistentry>
474
439
      backtrace.  This could be considered a feature.
475
440
    </para>
476
441
    <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"/>.
 
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.
480
451
    </para>
481
452
    <para>
482
453
      There is no fine-grained control over logging and debug output.
485
456
      Debug mode is conflated with running in the foreground.
486
457
    </para>
487
458
    <para>
488
 
      The console log messages do not show a time stamp.
 
459
      The console log messages does not show a time stamp.
489
460
    </para>
490
461
    <para>
491
462
      This server does not check the expire time of clients’ OpenPGP
564
535
      </para>
565
536
      <para>
566
537
        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.
 
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.
579
551
      </para>
580
552
      <para>
581
553
        For more details on client-side security, see