/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-01-29 19:21:23 UTC
  • Revision ID: teddy@recompile.se-20180129192123-y6brq6tnnnxm2oi2
http://bugs.debian.org/886595
Fix memory leak in plugin-runner (this fixes Debian bug #886595)

* plugin-runner.c (free_plugin): Bug fix: Also free() plugin name.

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