/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-24 19:09:29 UTC
  • mto: (518.2.5 persistent-state-gpgme)
  • mto: This revision was merged to the branch mainline in revision 524.
  • Revision ID: belorn@fukt.bsnet.se-20111124190929-9gmyfy7tyzuztjzx
restructured logger
added documentation about NewRequest dbus signal

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 "2016-03-05">
 
5
<!ENTITY TIMESTAMP "2011-10-22">
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>
39
 
      <year>2013</year>
40
 
      <year>2014</year>
41
 
      <year>2015</year>
42
 
      <year>2016</year>
43
38
      <holder>Teddy Hogeborn</holder>
44
39
      <holder>Björn Påhlsson</holder>
45
40
    </copyright>
101
96
      <arg><option>--no-ipv6</option></arg>
102
97
      <sbr/>
103
98
      <arg><option>--no-restore</option></arg>
104
 
      <sbr/>
105
 
      <arg><option>--statedir
106
 
      <replaceable>DIRECTORY</replaceable></option></arg>
107
 
      <sbr/>
108
 
      <arg><option>--socket
109
 
      <replaceable>FD</replaceable></option></arg>
110
 
      <sbr/>
111
 
      <arg><option>--foreground</option></arg>
112
 
      <sbr/>
113
 
      <arg><option>--no-zeroconf</option></arg>
114
99
    </cmdsynopsis>
115
100
    <cmdsynopsis>
116
101
      <command>&COMMANDNAME;</command>
297
282
        <term><option>--no-restore</option></term>
298
283
        <listitem>
299
284
          <xi:include href="mandos-options.xml" xpointer="restore"/>
300
 
          <para>
301
 
            See also <xref linkend="persistent_state"/>.
302
 
          </para>
303
 
        </listitem>
304
 
      </varlistentry>
305
 
      
306
 
      <varlistentry>
307
 
        <term><option>--statedir
308
 
        <replaceable>DIRECTORY</replaceable></option></term>
309
 
        <listitem>
310
 
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
311
 
        </listitem>
312
 
      </varlistentry>
313
 
      
314
 
      <varlistentry>
315
 
        <term><option>--socket
316
 
        <replaceable>FD</replaceable></option></term>
317
 
        <listitem>
318
 
          <xi:include href="mandos-options.xml" xpointer="socket"/>
319
 
        </listitem>
320
 
      </varlistentry>
321
 
      
322
 
      <varlistentry>
323
 
        <term><option>--foreground</option></term>
324
 
        <listitem>
325
 
          <xi:include href="mandos-options.xml"
326
 
                      xpointer="foreground"/>
327
 
        </listitem>
328
 
      </varlistentry>
329
 
      
330
 
      <varlistentry>
331
 
        <term><option>--no-zeroconf</option></term>
332
 
        <listitem>
333
 
          <xi:include href="mandos-options.xml" xpointer="zeroconf"/>
334
 
        </listitem>
335
 
      </varlistentry>
336
 
      
 
285
        </listitem>
 
286
      </varlistentry>
337
287
    </variablelist>
338
288
  </refsect1>
339
289
  
416
366
      extended timeout, checker program, and interval between checks
417
367
      can be configured both globally and per client; see
418
368
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
419
 
      <manvolnum>5</manvolnum></citerefentry>.
 
369
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
 
370
      receiving its password will also be treated as a successful
 
371
      checker run.
420
372
    </para>
421
373
  </refsect1>
422
374
  
444
396
    <title>LOGGING</title>
445
397
    <para>
446
398
      The server will send log message with various severity levels to
447
 
      <filename class="devicefile">/dev/log</filename>.  With the
 
399
      <filename>/dev/log</filename>.  With the
448
400
      <option>--debug</option> option, it will log even more messages,
449
401
      and also show them on the console.
450
402
    </para>
451
403
  </refsect1>
452
404
  
453
 
  <refsect1 id="persistent_state">
454
 
    <title>PERSISTENT STATE</title>
455
 
    <para>
456
 
      Client settings, initially read from
457
 
      <filename>clients.conf</filename>, are persistent across
458
 
      restarts, and run-time changes will override settings in
459
 
      <filename>clients.conf</filename>.  However, if a setting is
460
 
      <emphasis>changed</emphasis> (or a client added, or removed) in
461
 
      <filename>clients.conf</filename>, this will take precedence.
462
 
    </para>
463
 
  </refsect1>
464
 
  
465
405
  <refsect1 id="dbus_interface">
466
406
    <title>D-BUS INTERFACE</title>
467
407
    <para>
529
469
        </listitem>
530
470
      </varlistentry>
531
471
      <varlistentry>
532
 
        <term><filename>/run/mandos.pid</filename></term>
 
472
        <term><filename>/var/run/mandos.pid</filename></term>
533
473
        <listitem>
534
474
          <para>
535
475
            The file containing the process id of the
536
476
            <command>&COMMANDNAME;</command> process started last.
537
 
            <emphasis >Note:</emphasis> If the <filename
538
 
            class="directory">/run</filename> directory does not
539
 
            exist, <filename>/var/run/mandos.pid</filename> will be
540
 
            used instead.
541
 
          </para>
542
 
        </listitem>
543
 
      </varlistentry>
544
 
      <varlistentry>
545
 
        <term><filename
546
 
        class="directory">/var/lib/mandos</filename></term>
547
 
        <listitem>
548
 
          <para>
549
 
            Directory where persistent state will be saved.  Change
550
 
            this with the <option>--statedir</option> option.  See
551
 
            also the <option>--no-restore</option> option.
552
 
          </para>
553
 
        </listitem>
554
 
      </varlistentry>
555
 
      <varlistentry>
556
 
        <term><filename class="devicefile">/dev/log</filename></term>
 
477
          </para>
 
478
        </listitem>
 
479
      </varlistentry>
 
480
      <varlistentry>
 
481
        <term><filename>/dev/log</filename></term>
557
482
        <listitem>
558
483
          <para>
559
484
            The Unix domain socket to where local syslog messages are
582
507
      backtrace.  This could be considered a feature.
583
508
    </para>
584
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>
585
515
      There is no fine-grained control over logging and debug output.
586
516
    </para>
587
517
    <para>
 
518
      Debug mode is conflated with running in the foreground.
 
519
    </para>
 
520
    <para>
588
521
      This server does not check the expire time of clients’ OpenPGP
589
522
      keys.
590
523
    </para>
591
 
    <xi:include href="bugs.xml"/>
592
524
  </refsect1>
593
525
  
594
526
  <refsect1 id="example">
604
536
    <informalexample>
605
537
      <para>
606
538
        Run the server in debug mode, read configuration files from
607
 
        the <filename class="directory">~/mandos</filename> directory,
608
 
        and use the Zeroconf service name <quote>Test</quote> to not
609
 
        collide with any other official Mandos server on this host:
 
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:
610
542
      </para>
611
543
      <para>
612
544
 
661
593
        compromised if they are gone for too long.
662
594
      </para>
663
595
      <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>
664
611
        For more details on client-side security, see
665
612
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
666
613
        <manvolnum>8mandos</manvolnum></citerefentry>.
707
654
      </varlistentry>
708
655
      <varlistentry>
709
656
        <term>
710
 
          <ulink url="http://gnutls.org/">GnuTLS</ulink>
 
657
          <ulink url="http://www.gnu.org/software/gnutls/"
 
658
          >GnuTLS</ulink>
711
659
        </term>
712
660
      <listitem>
713
661
        <para>
751
699
      </varlistentry>
752
700
      <varlistentry>
753
701
        <term>
754
 
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
755
 
          Protocol Version 1.2</citetitle>
 
702
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
703
          Protocol Version 1.1</citetitle>
756
704
        </term>
757
705
      <listitem>
758
706
        <para>
759
 
          TLS 1.2 is the protocol implemented by GnuTLS.
 
707
          TLS 1.1 is the protocol implemented by GnuTLS.
760
708
        </para>
761
709
      </listitem>
762
710
      </varlistentry>
772
720
      </varlistentry>
773
721
      <varlistentry>
774
722
        <term>
775
 
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
776
 
          Security (TLS) Authentication</citetitle>
 
723
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
 
724
          Security</citetitle>
777
725
        </term>
778
726
      <listitem>
779
727
        <para>