xeps/xep-0208.xml

<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE xep SYSTEM 'xep.dtd' [
  <!ENTITY % ents SYSTEM 'xep.ent'>
%ents;
]>
<?xml-stylesheet type='text/xsl' href='xep.xsl'?>
<xep>
<header>
  <title>Bootstrapping Implementation of Jingle</title>
  <abstract>This document provides guidelines to client developers for bootstrapping implementation of Jingle technologies.</abstract>
  &LEGALNOTICE;
  <number>0208</number>
  <status>Experimental</status>
  <type>Informational</type>
  <sig>Standards</sig>
  <approver>Council</approver>
  <dependencies>
    <spec>XMPP Core</spec>
    <spec>XEP-0166</spec>
  </dependencies>
  <supersedes/>
  <supersededby/>
  <shortname>N/A</shortname>
  &stpeter;
  <revision>
    <version>0.1</version>
    <date>2007-04-10</date>
    <initials>psa</initials>
    <remark><p>Initial published version.</p></remark>
  </revision>
  <revision>
    <version>0.0.2</version>
    <date>2007-03-23</date>
    <initials>psa</initials>
    <remark><p>Changed echo namespace to be a content description format only; defined basic direct-tcp transport for bootstrapping purposes only.</p></remark>
  </revision>
  <revision>
    <version>0.0.1</version>
    <date>2007-02-27</date>
    <initials>psa</initials>
    <remark><p>First draft.</p></remark>
  </revision>
</header>

<section1 topic='Introduction' anchor='intro'>
  <p>&xep0166; defines a framework for negotiating and managing out-of-band data exchange sessions over XMPP. Unfortunately, most developers of XMPP clients have limited experience with multimedia applications such as voice and video, making it difficult to get started with implementation of Jingle technologies. Therefore this document provides a simple transport and session type that client developers can use to bootstrap Jingle implementations.</p>
  <p><em>Note: The methods specified herein are provided for experimental use only and are not intended for inclusion in released software or production environments.</em></p>
</section1>

<section1 topic='Protocol Flow' anchor='protocol'>
  <p>The intent of this simple Jingle profile is to enable exchange of data using the Echo Protocol specified in &rfc0862;. The protocol flow is as follows. (The following examples use &xep0177; as the transport protocol; although it is possible to complete echo protocol exchanges via TCP, that is deemed less useful and there is no Jingle transport for direct TCP exchanges.)</p>
  <example caption='Initiation'><![CDATA[
<iq from='romeo@montague.net/orchard' to='juliet@capulet.com/balcony' id='jingle1' type='set'>
  <jingle xmlns='http://www.xmpp.org/extensions/xep-0166.html#ns'
          action='session-initiate'
          initiator='romeo@montague.net/orchard'
          sid='a73sjjvkla37jfea'>
    <content creator='initiator' name='echo-this'>
      <description xmlns='http://www.xmpp.org/extensions/xep-0208.html#ns'/>
      <transport xmlns='http://www.xmpp.org/extensions/xep-0177.html#ns'>
        <candidate ip='10.1.1.104' port='13540' generation='0'/>
      </transport>
    </content>
  </jingle>
</iq>
  ]]></example>
  <p>Note: The standard port for the echo protocol is 7. However, since access to that port may be restricted, any other port MAY be negotiated.</p>
  <example caption='Receiver Provisionally Accepts the Session Request'><![CDATA[
<iq from='juliet@capulet.com/balcony' to='romeo@montague.net/orchard' type='result' id='jingle1'/>
  ]]></example>
  <p>If no negotiation is required (e.g., to modify the port number or transport protocol), the receiver simply accepts the session request.</p>
  <example caption='Receiver Definitively Accepts the Session Request'><![CDATA[
<iq from='juliet@capulet.com/balcony' to='romeo@montague.net/orchard' id='jingle2' type='set'>
  <jingle xmlns='http://www.xmpp.org/extensions/xep-0166.html#ns'
          action='session-accept'
          initiator='romeo@montague.net/orchard'
          sid='a73sjjvkla37jfea'>
    <content creator='initiator' name='echo-this'>
      <description xmlns='http://www.xmpp.org/extensions/xep-0208.html#ns'/>
      <transport xmlns='http://www.xmpp.org/extensions/xep-0177.html#ns'>
        <candidate ip='10.1.1.104' port='13540' generation='0'/>
      </transport>
    </content>
  </jingle>
</iq>
  ]]></example>
  <example caption='Initiating Entity Acknowledges Definitive Acceptance'><![CDATA[
<iq type='result' to='juliet@capulet.com/balcony' from='romeo@montague.net/orchard' id='accept1'/>
  ]]></example>
  <p>The parties may now exchange data using the echo protocol in order to test the connection.</p>
  <p>Note: Protocol flows for additional use cases (e.g., renegotiation) will be added to future versions of this specification.</p>
</section1>

<section1 topic='Security Considerations' anchor='security'>
  <p>As noted, the methods specified herein are provided for experimental use only and are not intended for inclusion in released software or production environments.</p>
  <p>On some operating systems, access to the root or administrative user may be necessary in order to use the echo protocol over TCP or UDP port 7. Therefore it is recommended to negotiate use of the echo protocol on a different port if necessary.</p>
</section1>

<section1 topic='IANA Considerations' anchor='iana'>
  <p>This document requires no interaction with &IANA;.</p>
</section1>

<section1 topic='XMPP Registrar Considerations' anchor='registrar'>
  <section2 topic='Protocol Namespaces' anchor='ns'>
    <p>Because this specification defines an experimental protocol that is to be used only for bootstrapping purposes, the &REGISTRAR; shall not issue a permanent namespace upon approval of this specification. Therefore, its associated namespace shall always be "http://www.xmpp.org/extensions/xep-0208.html#ns".</p>
  </section2>
  <section2 topic='Jingle Content Description Formats' anchor='registrar-content'>
    <p>The XMPP Registrar shall include "echo" in its registry of Jingle content description formats. The registry submission is as follows:</p>
    <code><![CDATA[
<content>
  <name>echo</name>
  <desc>A bootstrapping method for exchanging echo protocol data (see RFC 862).</desc>
  <doc>XEP-0208</doc>
</content>
    ]]></code>
  </section2>
</section1>

<section1 topic='XML Schema' anchor='schema'>
  <code><![CDATA[
<?xml version='1.0' encoding='UTF-8'?>

<xs:schema
    xmlns:xs='http://www.w3.org/2001/XMLSchema'
    targetNamespace='http://www.xmpp.org/extensions/xep-0208.html#ns'
    xmlns='http://www.xmpp.org/extensions/xep-0208.html#ns'
    elementFormDefault='qualified'>

  <xs:element name='description' type='empty'/>

  <xs:simpleType name='empty'>
    <xs:restriction base='xs:string'>
      <xs:enumeration value=''/>
    </xs:restriction>
  </xs:simpleType>

</xs:schema>
  ]]></code>
</section1>
</xep>