/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: 2016-03-05 21:46:00 UTC
  • Revision ID: teddy@recompile.se-20160305214600-2d7peg8qb5xhpi64
Fix incorrect documentation of minor limitation

* mandos-monitor.xml (BUGS): The name which is hard-coded is the D-Bus
                             *bus* name, not the service name.  Fix
                             the documentation.

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 "2016-03-05">
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>
38
43
      <holder>Teddy Hogeborn</holder>
39
44
      <holder>Björn Påhlsson</holder>
40
45
    </copyright>
96
101
      <arg><option>--no-ipv6</option></arg>
97
102
      <sbr/>
98
103
      <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>
99
114
    </cmdsynopsis>
100
115
    <cmdsynopsis>
101
116
      <command>&COMMANDNAME;</command>
282
297
        <term><option>--no-restore</option></term>
283
298
        <listitem>
284
299
          <xi:include href="mandos-options.xml" xpointer="restore"/>
285
 
        </listitem>
286
 
      </varlistentry>
 
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
      
287
337
    </variablelist>
288
338
  </refsect1>
289
339
  
366
416
      extended timeout, checker program, and interval between checks
367
417
      can be configured both globally and per client; see
368
418
      <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.
 
419
      <manvolnum>5</manvolnum></citerefentry>.
372
420
    </para>
373
421
  </refsect1>
374
422
  
396
444
    <title>LOGGING</title>
397
445
    <para>
398
446
      The server will send log message with various severity levels to
399
 
      <filename>/dev/log</filename>.  With the
 
447
      <filename class="devicefile">/dev/log</filename>.  With the
400
448
      <option>--debug</option> option, it will log even more messages,
401
449
      and also show them on the console.
402
450
    </para>
403
451
  </refsect1>
404
452
  
 
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
  
405
465
  <refsect1 id="dbus_interface">
406
466
    <title>D-BUS INTERFACE</title>
407
467
    <para>
469
529
        </listitem>
470
530
      </varlistentry>
471
531
      <varlistentry>
472
 
        <term><filename>/var/run/mandos.pid</filename></term>
 
532
        <term><filename>/run/mandos.pid</filename></term>
473
533
        <listitem>
474
534
          <para>
475
535
            The file containing the process id of the
476
536
            <command>&COMMANDNAME;</command> process started last.
477
 
          </para>
478
 
        </listitem>
479
 
      </varlistentry>
480
 
      <varlistentry>
481
 
        <term><filename>/dev/log</filename></term>
 
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>
482
557
        <listitem>
483
558
          <para>
484
559
            The Unix domain socket to where local syslog messages are
507
582
      backtrace.  This could be considered a feature.
508
583
    </para>
509
584
    <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
585
      There is no fine-grained control over logging and debug output.
516
586
    </para>
517
587
    <para>
518
 
      Debug mode is conflated with running in the foreground.
519
 
    </para>
520
 
    <para>
521
588
      This server does not check the expire time of clients’ OpenPGP
522
589
      keys.
523
590
    </para>
 
591
    <xi:include href="bugs.xml"/>
524
592
  </refsect1>
525
593
  
526
594
  <refsect1 id="example">
536
604
    <informalexample>
537
605
      <para>
538
606
        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:
 
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:
542
610
      </para>
543
611
      <para>
544
612
 
593
661
        compromised if they are gone for too long.
594
662
      </para>
595
663
      <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
664
        For more details on client-side security, see
612
665
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
613
666
        <manvolnum>8mandos</manvolnum></citerefentry>.
654
707
      </varlistentry>
655
708
      <varlistentry>
656
709
        <term>
657
 
          <ulink url="http://www.gnu.org/software/gnutls/"
658
 
          >GnuTLS</ulink>
 
710
          <ulink url="http://gnutls.org/">GnuTLS</ulink>
659
711
        </term>
660
712
      <listitem>
661
713
        <para>
699
751
      </varlistentry>
700
752
      <varlistentry>
701
753
        <term>
702
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
703
 
          Protocol Version 1.1</citetitle>
 
754
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
 
755
          Protocol Version 1.2</citetitle>
704
756
        </term>
705
757
      <listitem>
706
758
        <para>
707
 
          TLS 1.1 is the protocol implemented by GnuTLS.
 
759
          TLS 1.2 is the protocol implemented by GnuTLS.
708
760
        </para>
709
761
      </listitem>
710
762
      </varlistentry>
720
772
      </varlistentry>
721
773
      <varlistentry>
722
774
        <term>
723
 
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
724
 
          Security</citetitle>
 
775
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
 
776
          Security (TLS) Authentication</citetitle>
725
777
        </term>
726
778
      <listitem>
727
779
        <para>