/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: 2012-05-12 18:33:24 UTC
  • Revision ID: teddy@recompile.se-20120512183324-5kbaq316kyj329jk
* mandos (Client.start_checker): Remove undocumented support for "%%s"
                                 in the clients.conf "checker" option.
  (main): Use new .errno attribute of OSError.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos.xml
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 "2011-10-22">
 
5
<!ENTITY TIMESTAMP "2012-01-15">
6
6
<!ENTITY % common SYSTEM "common.ent">
7
7
%common;
8
8
]>
35
35
      <year>2009</year>
36
36
      <year>2010</year>
37
37
      <year>2011</year>
 
38
      <year>2012</year>
38
39
      <holder>Teddy Hogeborn</holder>
39
40
      <holder>Björn Påhlsson</holder>
40
41
    </copyright>
96
97
      <arg><option>--no-ipv6</option></arg>
97
98
      <sbr/>
98
99
      <arg><option>--no-restore</option></arg>
 
100
      <sbr/>
 
101
      <arg><option>--statedir
 
102
      <replaceable>DIRECTORY</replaceable></option></arg>
99
103
    </cmdsynopsis>
100
104
    <cmdsynopsis>
101
105
      <command>&COMMANDNAME;</command>
282
286
        <term><option>--no-restore</option></term>
283
287
        <listitem>
284
288
          <xi:include href="mandos-options.xml" xpointer="restore"/>
 
289
          <para>
 
290
            See also <xref linkend="persistent_state"/>.
 
291
          </para>
 
292
        </listitem>
 
293
      </varlistentry>
 
294
      
 
295
      <varlistentry>
 
296
        <term><option>--statedir
 
297
        <replaceable>DIRECTORY</replaceable></option></term>
 
298
        <listitem>
 
299
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
285
300
        </listitem>
286
301
      </varlistentry>
287
302
    </variablelist>
366
381
      extended timeout, checker program, and interval between checks
367
382
      can be configured both globally and per client; see
368
383
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
369
 
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
370
 
      receiving its password will also be treated as a successful
371
 
      checker run.
 
384
      <manvolnum>5</manvolnum></citerefentry>.
372
385
    </para>
373
386
  </refsect1>
374
387
  
396
409
    <title>LOGGING</title>
397
410
    <para>
398
411
      The server will send log message with various severity levels to
399
 
      <filename>/dev/log</filename>.  With the
 
412
      <filename class="devicefile">/dev/log</filename>.  With the
400
413
      <option>--debug</option> option, it will log even more messages,
401
414
      and also show them on the console.
402
415
    </para>
403
416
  </refsect1>
404
417
  
 
418
  <refsect1 id="persistent_state">
 
419
    <title>PERSISTENT STATE</title>
 
420
    <para>
 
421
      Client settings, initially read from
 
422
      <filename>clients.conf</filename>, are persistent across
 
423
      restarts, and run-time changes will override settings in
 
424
      <filename>clients.conf</filename>.  However, if a setting is
 
425
      <emphasis>changed</emphasis> (or a client added, or removed) in
 
426
      <filename>clients.conf</filename>, this will take precedence.
 
427
    </para>
 
428
  </refsect1>
 
429
  
405
430
  <refsect1 id="dbus_interface">
406
431
    <title>D-BUS INTERFACE</title>
407
432
    <para>
478
503
        </listitem>
479
504
      </varlistentry>
480
505
      <varlistentry>
 
506
        <term><filename class="devicefile">/dev/log</filename></term>
 
507
      </varlistentry>
 
508
      <varlistentry>
 
509
        <term><filename
 
510
        class="directory">/var/lib/mandos</filename></term>
 
511
        <listitem>
 
512
          <para>
 
513
            Directory where persistent state will be saved.  Change
 
514
            this with the <option>--statedir</option> option.  See
 
515
            also the <option>--no-restore</option> option.
 
516
          </para>
 
517
        </listitem>
 
518
      </varlistentry>
 
519
      <varlistentry>
481
520
        <term><filename>/dev/log</filename></term>
482
521
        <listitem>
483
522
          <para>
507
546
      backtrace.  This could be considered a feature.
508
547
    </para>
509
548
    <para>
510
 
      Currently, if a client is disabled due to having timed out, the
511
 
      server does not record this fact onto permanent storage.  This
512
 
      has some security implications, see <xref linkend="clients"/>.
513
 
    </para>
514
 
    <para>
515
549
      There is no fine-grained control over logging and debug output.
516
550
    </para>
517
551
    <para>
536
570
    <informalexample>
537
571
      <para>
538
572
        Run the server in debug mode, read configuration files from
539
 
        the <filename>~/mandos</filename> directory, and use the
540
 
        Zeroconf service name <quote>Test</quote> to not collide with
541
 
        any other official Mandos server on this host:
 
573
        the <filename class="directory">~/mandos</filename> directory,
 
574
        and use the Zeroconf service name <quote>Test</quote> to not
 
575
        collide with any other official Mandos server on this host:
542
576
      </para>
543
577
      <para>
544
578
 
593
627
        compromised if they are gone for too long.
594
628
      </para>
595
629
      <para>
596
 
        If a client is compromised, its downtime should be duly noted
597
 
        by the server which would therefore disable the client.  But
598
 
        if the server was ever restarted, it would re-read its client
599
 
        list from its configuration file and again regard all clients
600
 
        therein as enabled, and hence eligible to receive their
601
 
        passwords.  Therefore, be careful when restarting servers if
602
 
        it is suspected that a client has, in fact, been compromised
603
 
        by parties who may now be running a fake Mandos client with
604
 
        the keys from the non-encrypted initial <acronym>RAM</acronym>
605
 
        image of the client host.  What should be done in that case
606
 
        (if restarting the server program really is necessary) is to
607
 
        stop the server program, edit the configuration file to omit
608
 
        any suspect clients, and restart the server program.
609
 
      </para>
610
 
      <para>
611
630
        For more details on client-side security, see
612
631
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
613
632
        <manvolnum>8mandos</manvolnum></citerefentry>.