/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: 2011-12-30 17:14:15 UTC
  • mto: This revision was merged to the branch mainline in revision 541.
  • Revision ID: teddy@recompile.se-20111230171415-a5qso0vx7ps3d4a5
* network-hooks.d/wireless: Bug fix: Make executable.
* plugins.d/mandos-client.c (run_network_hooks): Bug fix: Set
                                                 "VERBOSITY", not
                                                 "VERBOSE".

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 "2011-11-26">
6
6
<!ENTITY % common SYSTEM "common.ent">
7
7
%common;
8
8
]>
94
94
      <arg><option>--no-dbus</option></arg>
95
95
      <sbr/>
96
96
      <arg><option>--no-ipv6</option></arg>
 
97
      <sbr/>
 
98
      <arg><option>--no-restore</option></arg>
 
99
      <sbr/>
 
100
      <arg><option>--statedir
 
101
      <replaceable>DIRECTORY</replaceable></option></arg>
97
102
    </cmdsynopsis>
98
103
    <cmdsynopsis>
99
104
      <command>&COMMANDNAME;</command>
275
280
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
276
281
        </listitem>
277
282
      </varlistentry>
 
283
      
 
284
      <varlistentry>
 
285
        <term><option>--no-restore</option></term>
 
286
        <listitem>
 
287
          <xi:include href="mandos-options.xml" xpointer="restore"/>
 
288
        </listitem>
 
289
      </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>
278
298
    </variablelist>
279
299
  </refsect1>
280
300
  
387
407
    <title>LOGGING</title>
388
408
    <para>
389
409
      The server will send log message with various severity levels to
390
 
      <filename>/dev/log</filename>.  With the
 
410
      <filename class="devicefile">/dev/log</filename>.  With the
391
411
      <option>--debug</option> option, it will log even more messages,
392
412
      and also show them on the console.
393
413
    </para>
469
489
        </listitem>
470
490
      </varlistentry>
471
491
      <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>
472
506
        <term><filename>/dev/log</filename></term>
473
507
        <listitem>
474
508
          <para>
498
532
      backtrace.  This could be considered a feature.
499
533
    </para>
500
534
    <para>
501
 
      Currently, if a client is disabled due to having timed out, the
502
 
      server does not record this fact onto permanent storage.  This
503
 
      has some security implications, see <xref linkend="clients"/>.
504
 
    </para>
505
 
    <para>
506
535
      There is no fine-grained control over logging and debug output.
507
536
    </para>
508
537
    <para>
509
538
      Debug mode is conflated with running in the foreground.
510
539
    </para>
511
540
    <para>
512
 
      The console log messages do not show a time stamp.
513
 
    </para>
514
 
    <para>
515
541
      This server does not check the expire time of clients’ OpenPGP
516
542
      keys.
517
543
    </para>
530
556
    <informalexample>
531
557
      <para>
532
558
        Run the server in debug mode, read configuration files from
533
 
        the <filename>~/mandos</filename> directory, and use the
534
 
        Zeroconf service name <quote>Test</quote> to not collide with
535
 
        any other official Mandos server on this host:
 
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:
536
562
      </para>
537
563
      <para>
538
564
 
587
613
        compromised if they are gone for too long.
588
614
      </para>
589
615
      <para>
590
 
        If a client is compromised, its downtime should be duly noted
591
 
        by the server which would therefore disable the client.  But
592
 
        if the server was ever restarted, it would re-read its client
593
 
        list from its configuration file and again regard all clients
594
 
        therein as enabled, and hence eligible to receive their
595
 
        passwords.  Therefore, be careful when restarting servers if
596
 
        it is suspected that a client has, in fact, been compromised
597
 
        by parties who may now be running a fake Mandos client with
598
 
        the keys from the non-encrypted initial <acronym>RAM</acronym>
599
 
        image of the client host.  What should be done in that case
600
 
        (if restarting the server program really is necessary) is to
601
 
        stop the server program, edit the configuration file to omit
602
 
        any suspect clients, and restart the server program.
603
 
      </para>
604
 
      <para>
605
616
        For more details on client-side security, see
606
617
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
607
618
        <manvolnum>8mandos</manvolnum></citerefentry>.