/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-06-23 00:58:49 UTC
  • Revision ID: teddy@recompile.se-20120623005849-02wj82cng433rt2k
* clients.conf: Convert all time intervals to new RFC 3339 syntax.
* mandos: All client options for time intervals now take an RFC 3339
          duration.
  (rfc3339_duration_to_delta): New function.
  (string_to_delta): Try rfc3339_duration_to_delta first.
* mandos-clients.conf.xml (OPTIONS/timeout): Document new format.
  (EXAMPLE): Update to new interval format.
  (SEE ALSO): Reference RFC 3339.

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-03">
 
5
<!ENTITY TIMESTAMP "2012-06-17">
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>
 
103
      <sbr/>
 
104
      <arg><option>--socket
 
105
      <replaceable>FD</replaceable></option></arg>
 
106
      <sbr/>
 
107
      <arg><option>--foreground</option></arg>
99
108
    </cmdsynopsis>
100
109
    <cmdsynopsis>
101
110
      <command>&COMMANDNAME;</command>
282
291
        <term><option>--no-restore</option></term>
283
292
        <listitem>
284
293
          <xi:include href="mandos-options.xml" xpointer="restore"/>
285
 
        </listitem>
286
 
      </varlistentry>
 
294
          <para>
 
295
            See also <xref linkend="persistent_state"/>.
 
296
          </para>
 
297
        </listitem>
 
298
      </varlistentry>
 
299
      
 
300
      <varlistentry>
 
301
        <term><option>--statedir
 
302
        <replaceable>DIRECTORY</replaceable></option></term>
 
303
        <listitem>
 
304
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
 
305
        </listitem>
 
306
      </varlistentry>
 
307
      
 
308
      <varlistentry>
 
309
        <term><option>--socket
 
310
        <replaceable>FD</replaceable></option></term>
 
311
        <listitem>
 
312
          <xi:include href="mandos-options.xml" xpointer="socket"/>
 
313
        </listitem>
 
314
      </varlistentry>
 
315
      
 
316
      <varlistentry>
 
317
        <term><option>--foreground</option></term>
 
318
        <listitem>
 
319
          <xi:include href="mandos-options.xml"
 
320
                      xpointer="foreground"/>
 
321
        </listitem>
 
322
      </varlistentry>
 
323
      
287
324
    </variablelist>
288
325
  </refsect1>
289
326
  
366
403
      extended timeout, checker program, and interval between checks
367
404
      can be configured both globally and per client; see
368
405
      <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.
 
406
      <manvolnum>5</manvolnum></citerefentry>.
372
407
    </para>
373
408
  </refsect1>
374
409
  
396
431
    <title>LOGGING</title>
397
432
    <para>
398
433
      The server will send log message with various severity levels to
399
 
      <filename>/dev/log</filename>.  With the
 
434
      <filename class="devicefile">/dev/log</filename>.  With the
400
435
      <option>--debug</option> option, it will log even more messages,
401
436
      and also show them on the console.
402
437
    </para>
403
438
  </refsect1>
404
439
  
 
440
  <refsect1 id="persistent_state">
 
441
    <title>PERSISTENT STATE</title>
 
442
    <para>
 
443
      Client settings, initially read from
 
444
      <filename>clients.conf</filename>, are persistent across
 
445
      restarts, and run-time changes will override settings in
 
446
      <filename>clients.conf</filename>.  However, if a setting is
 
447
      <emphasis>changed</emphasis> (or a client added, or removed) in
 
448
      <filename>clients.conf</filename>, this will take precedence.
 
449
    </para>
 
450
  </refsect1>
 
451
  
405
452
  <refsect1 id="dbus_interface">
406
453
    <title>D-BUS INTERFACE</title>
407
454
    <para>
478
525
        </listitem>
479
526
      </varlistentry>
480
527
      <varlistentry>
 
528
        <term><filename class="devicefile">/dev/log</filename></term>
 
529
      </varlistentry>
 
530
      <varlistentry>
 
531
        <term><filename
 
532
        class="directory">/var/lib/mandos</filename></term>
 
533
        <listitem>
 
534
          <para>
 
535
            Directory where persistent state will be saved.  Change
 
536
            this with the <option>--statedir</option> option.  See
 
537
            also the <option>--no-restore</option> option.
 
538
          </para>
 
539
        </listitem>
 
540
      </varlistentry>
 
541
      <varlistentry>
481
542
        <term><filename>/dev/log</filename></term>
482
543
        <listitem>
483
544
          <para>
507
568
      backtrace.  This could be considered a feature.
508
569
    </para>
509
570
    <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
571
      There is no fine-grained control over logging and debug output.
516
572
    </para>
517
573
    <para>
518
 
      Debug mode is conflated with running in the foreground.
519
 
    </para>
520
 
    <para>
521
 
      The console log messages do not show a time stamp.
522
 
    </para>
523
 
    <para>
524
574
      This server does not check the expire time of clients’ OpenPGP
525
575
      keys.
526
576
    </para>
539
589
    <informalexample>
540
590
      <para>
541
591
        Run the server in debug mode, read configuration files from
542
 
        the <filename>~/mandos</filename> directory, and use the
543
 
        Zeroconf service name <quote>Test</quote> to not collide with
544
 
        any other official Mandos server on this host:
 
592
        the <filename class="directory">~/mandos</filename> directory,
 
593
        and use the Zeroconf service name <quote>Test</quote> to not
 
594
        collide with any other official Mandos server on this host:
545
595
      </para>
546
596
      <para>
547
597
 
596
646
        compromised if they are gone for too long.
597
647
      </para>
598
648
      <para>
599
 
        If a client is compromised, its downtime should be duly noted
600
 
        by the server which would therefore disable the client.  But
601
 
        if the server was ever restarted, it would re-read its client
602
 
        list from its configuration file and again regard all clients
603
 
        therein as enabled, and hence eligible to receive their
604
 
        passwords.  Therefore, be careful when restarting servers if
605
 
        it is suspected that a client has, in fact, been compromised
606
 
        by parties who may now be running a fake Mandos client with
607
 
        the keys from the non-encrypted initial <acronym>RAM</acronym>
608
 
        image of the client host.  What should be done in that case
609
 
        (if restarting the server program really is necessary) is to
610
 
        stop the server program, edit the configuration file to omit
611
 
        any suspect clients, and restart the server program.
612
 
      </para>
613
 
      <para>
614
649
        For more details on client-side security, see
615
650
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
616
651
        <manvolnum>8mandos</manvolnum></citerefentry>.