/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: 2015-08-10 10:42:52 UTC
  • Revision ID: teddy@recompile.se-20150810104252-1r6yyfwkvh5t60bz
Server Bug fix: Make D-Bus introspection work again.

* mandos (DBusObjectWithObjectManager.Introspect): Bug fix; call
                                                   method Introspect,
                                                   not class
                                                   DBusObjectWithAnnotations.
  (alternate_dbus_interfaces/wrapper/fixscope): Make wrapped D-Bus
                                                signal function look
                                                like a D-Bus signal so
                                                Introspect can see it.

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-11-26">
 
5
<!ENTITY TIMESTAMP "2015-07-20">
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>
38
42
      <holder>Teddy Hogeborn</holder>
39
43
      <holder>Björn Påhlsson</holder>
40
44
    </copyright>
99
103
      <sbr/>
100
104
      <arg><option>--statedir
101
105
      <replaceable>DIRECTORY</replaceable></option></arg>
 
106
      <sbr/>
 
107
      <arg><option>--socket
 
108
      <replaceable>FD</replaceable></option></arg>
 
109
      <sbr/>
 
110
      <arg><option>--foreground</option></arg>
 
111
      <sbr/>
 
112
      <arg><option>--no-zeroconf</option></arg>
102
113
    </cmdsynopsis>
103
114
    <cmdsynopsis>
104
115
      <command>&COMMANDNAME;</command>
285
296
        <term><option>--no-restore</option></term>
286
297
        <listitem>
287
298
          <xi:include href="mandos-options.xml" xpointer="restore"/>
 
299
          <para>
 
300
            See also <xref linkend="persistent_state"/>.
 
301
          </para>
288
302
        </listitem>
289
303
      </varlistentry>
290
304
      
295
309
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
296
310
        </listitem>
297
311
      </varlistentry>
 
312
      
 
313
      <varlistentry>
 
314
        <term><option>--socket
 
315
        <replaceable>FD</replaceable></option></term>
 
316
        <listitem>
 
317
          <xi:include href="mandos-options.xml" xpointer="socket"/>
 
318
        </listitem>
 
319
      </varlistentry>
 
320
      
 
321
      <varlistentry>
 
322
        <term><option>--foreground</option></term>
 
323
        <listitem>
 
324
          <xi:include href="mandos-options.xml"
 
325
                      xpointer="foreground"/>
 
326
        </listitem>
 
327
      </varlistentry>
 
328
      
 
329
      <varlistentry>
 
330
        <term><option>--no-zeroconf</option></term>
 
331
        <listitem>
 
332
          <xi:include href="mandos-options.xml" xpointer="zeroconf"/>
 
333
        </listitem>
 
334
      </varlistentry>
 
335
      
298
336
    </variablelist>
299
337
  </refsect1>
300
338
  
377
415
      extended timeout, checker program, and interval between checks
378
416
      can be configured both globally and per client; see
379
417
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
380
 
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
381
 
      receiving its password will also be treated as a successful
382
 
      checker run.
 
418
      <manvolnum>5</manvolnum></citerefentry>.
383
419
    </para>
384
420
  </refsect1>
385
421
  
407
443
    <title>LOGGING</title>
408
444
    <para>
409
445
      The server will send log message with various severity levels to
410
 
      <filename>/dev/log</filename>.  With the
 
446
      <filename class="devicefile">/dev/log</filename>.  With the
411
447
      <option>--debug</option> option, it will log even more messages,
412
448
      and also show them on the console.
413
449
    </para>
414
450
  </refsect1>
415
451
  
 
452
  <refsect1 id="persistent_state">
 
453
    <title>PERSISTENT STATE</title>
 
454
    <para>
 
455
      Client settings, initially read from
 
456
      <filename>clients.conf</filename>, are persistent across
 
457
      restarts, and run-time changes will override settings in
 
458
      <filename>clients.conf</filename>.  However, if a setting is
 
459
      <emphasis>changed</emphasis> (or a client added, or removed) in
 
460
      <filename>clients.conf</filename>, this will take precedence.
 
461
    </para>
 
462
  </refsect1>
 
463
  
416
464
  <refsect1 id="dbus_interface">
417
465
    <title>D-BUS INTERFACE</title>
418
466
    <para>
480
528
        </listitem>
481
529
      </varlistentry>
482
530
      <varlistentry>
483
 
        <term><filename>/var/run/mandos.pid</filename></term>
 
531
        <term><filename>/run/mandos.pid</filename></term>
484
532
        <listitem>
485
533
          <para>
486
534
            The file containing the process id of the
487
535
            <command>&COMMANDNAME;</command> process started last.
 
536
            <emphasis >Note:</emphasis> If the <filename
 
537
            class="directory">/run</filename> directory does not
 
538
            exist, <filename>/var/run/mandos.pid</filename> will be
 
539
            used instead.
488
540
          </para>
489
541
        </listitem>
490
542
      </varlistentry>
491
543
      <varlistentry>
 
544
        <term><filename class="devicefile">/dev/log</filename></term>
 
545
      </varlistentry>
 
546
      <varlistentry>
492
547
        <term><filename
493
548
        class="directory">/var/lib/mandos</filename></term>
494
549
        <listitem>
532
587
      There is no fine-grained control over logging and debug output.
533
588
    </para>
534
589
    <para>
535
 
      Debug mode is conflated with running in the foreground.
536
 
    </para>
537
 
    <para>
538
590
      This server does not check the expire time of clients’ OpenPGP
539
591
      keys.
540
592
    </para>
656
708
      </varlistentry>
657
709
      <varlistentry>
658
710
        <term>
659
 
          <ulink url="http://www.gnu.org/software/gnutls/"
660
 
          >GnuTLS</ulink>
 
711
          <ulink url="http://gnutls.org/">GnuTLS</ulink>
661
712
        </term>
662
713
      <listitem>
663
714
        <para>
701
752
      </varlistentry>
702
753
      <varlistentry>
703
754
        <term>
704
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
705
 
          Protocol Version 1.1</citetitle>
 
755
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
 
756
          Protocol Version 1.2</citetitle>
706
757
        </term>
707
758
      <listitem>
708
759
        <para>
709
 
          TLS 1.1 is the protocol implemented by GnuTLS.
 
760
          TLS 1.2 is the protocol implemented by GnuTLS.
710
761
        </para>
711
762
      </listitem>
712
763
      </varlistentry>
722
773
      </varlistentry>
723
774
      <varlistentry>
724
775
        <term>
725
 
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
726
 
          Security</citetitle>
 
776
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
 
777
          Security (TLS) Authentication</citetitle>
727
778
        </term>
728
779
      <listitem>
729
780
        <para>