/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 07:34:37 UTC
  • Revision ID: teddy@recompile.se-20150810073437-3m8jgt13nqric6vf
Revert change to D-Bus API.

The D-Bus API signal CheckerCompleted is documented to provide a
wait(2) status value.  Since the server switched to using subprocess
to run checkers, it no longer has access to a wait(2) status value.  A
previous change to work around this made the D-Bus API incompatible.
Revert this change by constructing a fake wait(2) status value; this
keeps the D-Bus API stable.

* DBUS-API (CheckerCompleted): Revert incompatible change.
* mandos (ClientDBus.checker_callback): Construct fake wait(2) status.
* mandos-monitor (MandosClientWidget.checker_completed): Revert to
                                                         using
                                                         original API
                                                         with wait(2)
                                                         condition
                                                         value.

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 "2019-02-09">
 
5
<!ENTITY TIMESTAMP "2015-07-20">
6
6
<!ENTITY % common SYSTEM "common.ent">
7
7
%common;
8
8
]>
39
39
      <year>2013</year>
40
40
      <year>2014</year>
41
41
      <year>2015</year>
42
 
      <year>2016</year>
43
 
      <year>2017</year>
44
 
      <year>2018</year>
45
42
      <holder>Teddy Hogeborn</holder>
46
43
      <holder>Björn Påhlsson</holder>
47
44
    </copyright>
361
358
      start a TLS protocol handshake with a slight quirk: the Mandos
362
359
      server program acts as a TLS <quote>client</quote> while the
363
360
      connecting Mandos client acts as a TLS <quote>server</quote>.
364
 
      The Mandos client must supply a TLS public key, and the key ID
365
 
      of this public key is used by the Mandos server to look up (in a
366
 
      list read from <filename>clients.conf</filename> at start time)
367
 
      which binary blob to give the client.  No other authentication
368
 
      or authorization is done by the server.
 
361
      The Mandos client must supply an OpenPGP certificate, and the
 
362
      fingerprint of this certificate is used by the Mandos server to
 
363
      look up (in a list read from <filename>clients.conf</filename>
 
364
      at start time) which binary blob to give the client.  No other
 
365
      authentication or authorization is done by the server.
369
366
    </para>
370
367
    <table>
371
368
      <title>Mandos Protocol (Version 1)</title><tgroup cols="3"><thead>
391
388
        </emphasis></entry>
392
389
      </row>
393
390
      <row>
394
 
        <entry>Public key (part of TLS handshake)</entry>
 
391
        <entry>OpenPGP public key (part of TLS handshake)</entry>
395
392
        <entry>-><!-- &rarr; --></entry>
396
393
      </row>
397
394
      <row>
544
541
        </listitem>
545
542
      </varlistentry>
546
543
      <varlistentry>
 
544
        <term><filename class="devicefile">/dev/log</filename></term>
 
545
      </varlistentry>
 
546
      <varlistentry>
547
547
        <term><filename
548
548
        class="directory">/var/lib/mandos</filename></term>
549
549
        <listitem>
555
555
        </listitem>
556
556
      </varlistentry>
557
557
      <varlistentry>
558
 
        <term><filename class="devicefile">/dev/log</filename></term>
 
558
        <term><filename>/dev/log</filename></term>
559
559
        <listitem>
560
560
          <para>
561
561
            The Unix domain socket to where local syslog messages are
586
586
    <para>
587
587
      There is no fine-grained control over logging and debug output.
588
588
    </para>
589
 
    <xi:include href="bugs.xml"/>
 
589
    <para>
 
590
      This server does not check the expire time of clients’ OpenPGP
 
591
      keys.
 
592
    </para>
590
593
  </refsect1>
591
594
  
592
595
  <refsect1 id="example">
642
645
      <title>CLIENTS</title>
643
646
      <para>
644
647
        The server only gives out its stored data to clients which
645
 
        does have the correct key ID of the stored key ID.  This is
646
 
        guaranteed by the fact that the client sends its public key in
647
 
        the TLS handshake; this ensures it to be genuine.  The server
648
 
        computes the key ID of the key itself and looks up the key ID
649
 
        in its list of clients. The <filename>clients.conf</filename>
650
 
        file (see
 
648
        does have the OpenPGP key of the stored fingerprint.  This is
 
649
        guaranteed by the fact that the client sends its OpenPGP
 
650
        public key in the TLS handshake; this ensures it to be
 
651
        genuine.  The server computes the fingerprint of the key
 
652
        itself and looks up the fingerprint in its list of
 
653
        clients. The <filename>clients.conf</filename> file (see
651
654
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
652
655
        <manvolnum>5</manvolnum></citerefentry>)
653
656
        <emphasis>must</emphasis> be made non-readable by anyone
705
708
      </varlistentry>
706
709
      <varlistentry>
707
710
        <term>
708
 
          <ulink url="https://gnutls.org/">GnuTLS</ulink>
 
711
          <ulink url="http://gnutls.org/">GnuTLS</ulink>
709
712
        </term>
710
713
      <listitem>
711
714
        <para>
712
715
          GnuTLS is the library this server uses to implement TLS for
713
716
          communicating securely with the client, and at the same time
714
 
          confidently get the client’s public key.
 
717
          confidently get the client’s public OpenPGP key.
715
718
        </para>
716
719
      </listitem>
717
720
      </varlistentry>
770
773
      </varlistentry>
771
774
      <varlistentry>
772
775
        <term>
773
 
          RFC 7250: <citetitle>Using Raw Public Keys in Transport
774
 
          Layer Security (TLS) and Datagram Transport Layer Security
775
 
          (DTLS)</citetitle>
776
 
        </term>
777
 
      <listitem>
778
 
        <para>
779
 
          This is implemented by GnuTLS version 3.6.6 and is, if
780
 
          present, used by this server so that raw public keys can be
781
 
          used.
782
 
        </para>
783
 
      </listitem>
784
 
      </varlistentry>
785
 
      <varlistentry>
786
 
        <term>
787
776
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
788
777
          Security (TLS) Authentication</citetitle>
789
778
        </term>
790
779
      <listitem>
791
780
        <para>
792
 
          This is implemented by GnuTLS before version 3.6.0 and is,
793
 
          if present, used by this server so that OpenPGP keys can be
794
 
          used.
 
781
          This is implemented by GnuTLS and used by this server so
 
782
          that OpenPGP keys can be used.
795
783
        </para>
796
784
      </listitem>
797
785
      </varlistentry>