/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to mandos.xml

merge persistent state

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