/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: 2018-08-19 16:23:29 UTC
  • mfrom: (958 trunk)
  • mto: This revision was merged to the branch mainline in revision 959.
  • Revision ID: teddy@recompile.se-20180819162329-3ojewd46p0t1thuo
http://bugs.debian.org/904899
Merge from trunk

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 "2018-02-08">
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>
38
45
      <holder>Teddy Hogeborn</holder>
39
46
      <holder>Björn Påhlsson</holder>
40
47
    </copyright>
96
103
      <arg><option>--no-ipv6</option></arg>
97
104
      <sbr/>
98
105
      <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>
99
116
    </cmdsynopsis>
100
117
    <cmdsynopsis>
101
118
      <command>&COMMANDNAME;</command>
282
299
        <term><option>--no-restore</option></term>
283
300
        <listitem>
284
301
          <xi:include href="mandos-options.xml" xpointer="restore"/>
285
 
        </listitem>
286
 
      </varlistentry>
 
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
      
287
339
    </variablelist>
288
340
  </refsect1>
289
341
  
366
418
      extended timeout, checker program, and interval between checks
367
419
      can be configured both globally and per client; see
368
420
      <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.
 
421
      <manvolnum>5</manvolnum></citerefentry>.
372
422
    </para>
373
423
  </refsect1>
374
424
  
396
446
    <title>LOGGING</title>
397
447
    <para>
398
448
      The server will send log message with various severity levels to
399
 
      <filename>/dev/log</filename>.  With the
 
449
      <filename class="devicefile">/dev/log</filename>.  With the
400
450
      <option>--debug</option> option, it will log even more messages,
401
451
      and also show them on the console.
402
452
    </para>
403
453
  </refsect1>
404
454
  
 
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
  
405
467
  <refsect1 id="dbus_interface">
406
468
    <title>D-BUS INTERFACE</title>
407
469
    <para>
469
531
        </listitem>
470
532
      </varlistentry>
471
533
      <varlistentry>
472
 
        <term><filename>/var/run/mandos.pid</filename></term>
 
534
        <term><filename>/run/mandos.pid</filename></term>
473
535
        <listitem>
474
536
          <para>
475
537
            The file containing the process id of the
476
538
            <command>&COMMANDNAME;</command> process started last.
477
 
          </para>
478
 
        </listitem>
479
 
      </varlistentry>
480
 
      <varlistentry>
481
 
        <term><filename>/dev/log</filename></term>
 
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>
482
559
        <listitem>
483
560
          <para>
484
561
            The Unix domain socket to where local syslog messages are
507
584
      backtrace.  This could be considered a feature.
508
585
    </para>
509
586
    <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
587
      There is no fine-grained control over logging and debug output.
516
588
    </para>
517
589
    <para>
518
 
      Debug mode is conflated with running in the foreground.
519
 
    </para>
520
 
    <para>
521
 
      The console log messages do not show a time stamp.
522
 
    </para>
523
 
    <para>
524
590
      This server does not check the expire time of clients’ OpenPGP
525
591
      keys.
526
592
    </para>
 
593
    <xi:include href="bugs.xml"/>
527
594
  </refsect1>
528
595
  
529
596
  <refsect1 id="example">
539
606
    <informalexample>
540
607
      <para>
541
608
        Run the server in debug mode, read configuration files from
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:
 
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:
545
612
      </para>
546
613
      <para>
547
614
 
596
663
        compromised if they are gone for too long.
597
664
      </para>
598
665
      <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>
614
666
        For more details on client-side security, see
615
667
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
616
668
        <manvolnum>8mandos</manvolnum></citerefentry>.
657
709
      </varlistentry>
658
710
      <varlistentry>
659
711
        <term>
660
 
          <ulink url="http://www.gnu.org/software/gnutls/"
661
 
          >GnuTLS</ulink>
 
712
          <ulink url="https://gnutls.org/">GnuTLS</ulink>
662
713
        </term>
663
714
      <listitem>
664
715
        <para>
702
753
      </varlistentry>
703
754
      <varlistentry>
704
755
        <term>
705
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
706
 
          Protocol Version 1.1</citetitle>
 
756
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
 
757
          Protocol Version 1.2</citetitle>
707
758
        </term>
708
759
      <listitem>
709
760
        <para>
710
 
          TLS 1.1 is the protocol implemented by GnuTLS.
 
761
          TLS 1.2 is the protocol implemented by GnuTLS.
711
762
        </para>
712
763
      </listitem>
713
764
      </varlistentry>
723
774
      </varlistentry>
724
775
      <varlistentry>
725
776
        <term>
726
 
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
727
 
          Security</citetitle>
 
777
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
 
778
          Security (TLS) Authentication</citetitle>
728
779
        </term>
729
780
      <listitem>
730
781
        <para>