extensions/Channel_Type_Server_TLS_Connection.xml

   1 <?xml version="1.0" ?>
   2 <node name="/Channel_Type_Server_TLS_Connection"
   3     xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
   4   <tp:copyright> Copyright © 2010 Collabora Limited </tp:copyright>
   5   <tp:license>
   6     This library is free software; you can redistribute it and/or
   7     modify it under the terms of the GNU Lesser General Public
   8     License as published by the Free Software Foundation; either
   9     version 2.1 of the License, or (at your option) any later version.
  10
  11     This library is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14     Lesser General Public License for more details.
  15
  16     You should have received a copy of the GNU Lesser General Public
  17     License along with this library; if not, write to the Free Software
  18     Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  19   </tp:license>
  20
  21   <interface name="org.freedesktop.Telepathy.Channel.Type.ServerTLSConnection">
  22     <tp:added version="0.19.13">(as stable API)</tp:added>
  23
  24     <tp:requires interface="org.freedesktop.Telepathy.Channel"/>
  25
  26     <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  27       <p>A channel type that carries a TLS certificate between a server
  28       and a client connecting to it.</p>
  29       <p>Channels of this kind always have <tp:dbus-ref
  30       namespace="org.freedesktop.Telepathy.Channel">Requested</tp:dbus-ref> = False,
  31       <tp:dbus-ref namespace="org.freedesktop.Telepathy.Channel">TargetHandleType</tp:dbus-ref>
  32       = None and <tp:dbus-ref namespace="org.freedesktop.Telepathy.Channel">TargetHandle</tp:dbus-ref>
  33       = 0, and cannot be requested with methods such as <tp:dbus-ref
  34       namespace="org.freedesktop.Telepathy.Connection.Interface.Requests">CreateChannel</tp:dbus-ref>.
  35       Also, they SHOULD be dispatched while the
  36       <tp:dbus-ref namespace="org.freedesktop.Telepathy">Connection</tp:dbus-ref>
  37       owning them is in the CONNECTING state.</p>
  38       <p>In this case, handlers SHOULD accept or reject the certificate, using
  39       the relevant methods on the provided object, or MAY just <tp:dbus-ref
  40       namespace="org.freedesktop.Telepathy.Channel">Close</tp:dbus-ref> the channel before doing so, to fall
  41       back to a non-interactive verification process done inside the CM.</p>
  42       <p>For example, channels of this kind can pop up while a client is
  43       connecting to an XMPP server.</p>
  44     </tp:docstring>
  45
  46     <property name="ServerCertificate" type="o" access="read"
  47               tp:name-for-bindings="ServerCertificate">
  48       <tp:docstring>
  49         <p>A <tp:dbus-ref
  50         namespace="org.freedesktop.Telepathy.Authentication">TLSCertificate</tp:dbus-ref>
  51         containing the certificate chain as sent by the server,
  52         and other relevant information.</p>
  53         <p>This property is immutable.</p>
  54       </tp:docstring>
  55     </property>
  56
  57     <property name="Hostname" type="s" access="read"
  58               tp:name-for-bindings="Hostname">
  59       <tp:added version="0.19.12"/>
  60       <tp:docstring>
  61         The hostname of the server we expect <tp:member-ref>ServerCertificate</tp:member-ref>
  62         to certify; clients SHOULD verify <tp:member-ref>ServerCertificate</tp:member-ref> against
  63         this hostname when checking its validity.
  64       </tp:docstring>
  65     </property>
  66
  67   </interface>
  68 </node>
  69 <!-- vim:set sw=2 sts=2 et ft=xml: -->