/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: Björn Påhlsson
  • Date: 2011-11-09 11:16:17 UTC
  • mto: (518.2.5 persistent-state-gpgme)
  • mto: This revision was merged to the branch mainline in revision 520.
  • Revision ID: belorn@fukt.bsnet.se-20111109111617-jpey2sy4dupqzabc
Persistent state: New feature. Client state is now stored when mandos
                  server exits, and restored when starting up. Secrets
                  are encrypted with key based on clients config file.
--no-restore: New argument to mandos server. Disables restore
              functionallity
minor changes: clients are now dicts!

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-11-26">
 
5
<!ENTITY TIMESTAMP "2011-10-03">
6
6
<!ENTITY % common SYSTEM "common.ent">
7
7
%common;
8
8
]>
96
96
      <arg><option>--no-ipv6</option></arg>
97
97
      <sbr/>
98
98
      <arg><option>--no-restore</option></arg>
99
 
      <sbr/>
100
 
      <arg><option>--statedir
101
 
      <replaceable>DIRECTORY</replaceable></option></arg>
102
99
    </cmdsynopsis>
103
100
    <cmdsynopsis>
104
101
      <command>&COMMANDNAME;</command>
287
284
          <xi:include href="mandos-options.xml" xpointer="restore"/>
288
285
        </listitem>
289
286
      </varlistentry>
290
 
      
291
 
      <varlistentry>
292
 
        <term><option>--statedir
293
 
        <replaceable>DIRECTORY</replaceable></option></term>
294
 
        <listitem>
295
 
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
296
 
        </listitem>
297
 
      </varlistentry>
298
287
    </variablelist>
299
288
  </refsect1>
300
289
  
407
396
    <title>LOGGING</title>
408
397
    <para>
409
398
      The server will send log message with various severity levels to
410
 
      <filename class="devicefile">/dev/log</filename>.  With the
 
399
      <filename>/dev/log</filename>.  With the
411
400
      <option>--debug</option> option, it will log even more messages,
412
401
      and also show them on the console.
413
402
    </para>
489
478
        </listitem>
490
479
      </varlistentry>
491
480
      <varlistentry>
492
 
        <term><filename class="devicefile">/dev/log</filename></term>
493
 
      </varlistentry>
494
 
      <varlistentry>
495
 
        <term><filename
496
 
        class="directory">/var/lib/mandos</filename></term>
497
 
        <listitem>
498
 
          <para>
499
 
            Directory where persistent state will be saved.  Change
500
 
            this with the <option>--statedir</option> option.  See
501
 
            also the <option>--no-restore</option> option.
502
 
          </para>
503
 
        </listitem>
504
 
      </varlistentry>
505
 
      <varlistentry>
506
481
        <term><filename>/dev/log</filename></term>
507
482
        <listitem>
508
483
          <para>
532
507
      backtrace.  This could be considered a feature.
533
508
    </para>
534
509
    <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>
535
515
      There is no fine-grained control over logging and debug output.
536
516
    </para>
537
517
    <para>
538
518
      Debug mode is conflated with running in the foreground.
539
519
    </para>
540
520
    <para>
 
521
      The console log messages do not show a time stamp.
 
522
    </para>
 
523
    <para>
541
524
      This server does not check the expire time of clients’ OpenPGP
542
525
      keys.
543
526
    </para>
556
539
    <informalexample>
557
540
      <para>
558
541
        Run the server in debug mode, read configuration files from
559
 
        the <filename class="directory">~/mandos</filename> directory,
560
 
        and use the Zeroconf service name <quote>Test</quote> to not
561
 
        collide with any other official Mandos server on this host:
 
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:
562
545
      </para>
563
546
      <para>
564
547
 
613
596
        compromised if they are gone for too long.
614
597
      </para>
615
598
      <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>
616
614
        For more details on client-side security, see
617
615
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
618
616
        <manvolnum>8mandos</manvolnum></citerefentry>.