/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

* DBUS-API (se.recompile.Mandos.Client.LastCheckerStatus): New
                                                           property.
* mandos (Client.last_checker_status): Use -2 instead of None to match
                                       D-Bus property.  All users
                                       changed.
  (Client.checked_ok): Remove "timeout" argument and call
                       "self.bump_timeout()" instead.
  (Client.bump_timeout): New; separated out from "checked_ok".
  (ClientDBus.last_checker_status): Hook to a D-Bus property.
  (ClientDBus.LastCheckerStatus_dbus_property): New D-Bus property.
  (ClientHandler.handle): Call client.bump_timeout() instead of
                          client.checked_ok().

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 "2017-02-23">
 
5
<!ENTITY TIMESTAMP "2012-01-01">
6
6
<!ENTITY % common SYSTEM "common.ent">
7
7
%common;
8
8
]>
36
36
      <year>2010</year>
37
37
      <year>2011</year>
38
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
39
      <holder>Teddy Hogeborn</holder>
45
40
      <holder>Björn Påhlsson</holder>
46
41
    </copyright>
105
100
      <sbr/>
106
101
      <arg><option>--statedir
107
102
      <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>
115
103
    </cmdsynopsis>
116
104
    <cmdsynopsis>
117
105
      <command>&COMMANDNAME;</command>
311
299
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
312
300
        </listitem>
313
301
      </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
 
      
338
302
    </variablelist>
339
303
  </refsect1>
340
304
  
417
381
      extended timeout, checker program, and interval between checks
418
382
      can be configured both globally and per client; see
419
383
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
420
 
      <manvolnum>5</manvolnum></citerefentry>.
 
384
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
 
385
      receiving its password will also be treated as a successful
 
386
      checker run.
421
387
    </para>
422
388
  </refsect1>
423
389
  
530
496
        </listitem>
531
497
      </varlistentry>
532
498
      <varlistentry>
533
 
        <term><filename>/run/mandos.pid</filename></term>
 
499
        <term><filename>/var/run/mandos.pid</filename></term>
534
500
        <listitem>
535
501
          <para>
536
502
            The file containing the process id of the
537
503
            <command>&COMMANDNAME;</command> process started last.
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
504
          </para>
543
505
        </listitem>
544
506
      </varlistentry>
545
507
      <varlistentry>
 
508
        <term><filename class="devicefile">/dev/log</filename></term>
 
509
      </varlistentry>
 
510
      <varlistentry>
546
511
        <term><filename
547
512
        class="directory">/var/lib/mandos</filename></term>
548
513
        <listitem>
554
519
        </listitem>
555
520
      </varlistentry>
556
521
      <varlistentry>
557
 
        <term><filename class="devicefile">/dev/log</filename></term>
 
522
        <term><filename>/dev/log</filename></term>
558
523
        <listitem>
559
524
          <para>
560
525
            The Unix domain socket to where local syslog messages are
586
551
      There is no fine-grained control over logging and debug output.
587
552
    </para>
588
553
    <para>
 
554
      Debug mode is conflated with running in the foreground.
 
555
    </para>
 
556
    <para>
589
557
      This server does not check the expire time of clients’ OpenPGP
590
558
      keys.
591
559
    </para>
592
 
    <xi:include href="bugs.xml"/>
593
560
  </refsect1>
594
561
  
595
562
  <refsect1 id="example">
708
675
      </varlistentry>
709
676
      <varlistentry>
710
677
        <term>
711
 
          <ulink url="https://gnutls.org/">GnuTLS</ulink>
 
678
          <ulink url="http://www.gnu.org/software/gnutls/"
 
679
          >GnuTLS</ulink>
712
680
        </term>
713
681
      <listitem>
714
682
        <para>
752
720
      </varlistentry>
753
721
      <varlistentry>
754
722
        <term>
755
 
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
756
 
          Protocol Version 1.2</citetitle>
 
723
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
724
          Protocol Version 1.1</citetitle>
757
725
        </term>
758
726
      <listitem>
759
727
        <para>
760
 
          TLS 1.2 is the protocol implemented by GnuTLS.
 
728
          TLS 1.1 is the protocol implemented by GnuTLS.
761
729
        </para>
762
730
      </listitem>
763
731
      </varlistentry>
773
741
      </varlistentry>
774
742
      <varlistentry>
775
743
        <term>
776
 
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
777
 
          Security (TLS) Authentication</citetitle>
 
744
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
 
745
          Security</citetitle>
778
746
        </term>
779
747
      <listitem>
780
748
        <para>