<?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>External Service Discovery</title>
  <abstract>This document specifies an XMPP protocol extension for discovering services external to the XMPP network.</abstract>
  &LEGALNOTICE;
  <number>0215</number>
  <status>Deferred</status>
  <type>Standards Track</type>
  <sig>Standards</sig>
  <approver>Council</approver>
  <dependencies>
    <spec>XMPP Core</spec>
  </dependencies>
  <supersedes/>
  <supersededby/>
  <shortname>NOT YET ASSIGNED</shortname>
  &stpeter;
  &seanegan;
  <revision>
    <version>0.3</version>
    <date>2007-08-30</date>
    <initials>psa</initials>
    <remark><p>Added name attribute for human-readable labels; added internationalization considerations; added security considerations.</p></remark>
  </revision>
  <revision>
    <version>0.2</version>
    <date>2007-08-28</date>
    <initials>psa</initials>
    <remark><p>Broadened scope from discovery of STUN servers to discovery of any external (non-XMPP) service.</p></remark>
  </revision>
  <revision>
    <version>0.1</version>
    <date>2007-05-16</date>
    <initials>psa/se</initials>
    <remark><p>Initial published version.</p></remark>
  </revision>
  <revision>
    <version>0.0.5</version>
    <date>2007-05-10</date>
    <initials>psa</initials>
    <remark><p>Added attributes for username and password; reverted to IQ method since credentials are individualized.</p></remark>
  </revision>
  <revision>
    <version>0.0.4</version>
    <date>2007-04-18</date>
    <initials>psa</initials>
    <remark><p>Modified to use a well-known publish-subscribe node instead of a dedicated IQ exchange.</p></remark>
  </revision>
  <revision>
    <version>0.0.3</version>
    <date>2007-03-30</date>
    <initials>psa</initials>
    <remark><p>Made port mandatory since spec assumes that SRV is not available; added XML schema.</p></remark>
  </revision>
  <revision>
    <version>0.0.2</version>
    <date>2007-03-27</date>
    <initials>psa</initials>
    <remark><p>Made port optional.</p></remark>
  </revision>
  <revision>
    <version>0.0.1</version>
    <date>2007-03-23</date>
    <initials>psa/se</initials>
    <remark><p>First draft.</p></remark>
  </revision>
</header>

<section1 topic='Introduction' anchor='intro'>
  <p>An XMPP client or other entity may need to discover services external to the XMPP network in order to complete certain XMPP-related use cases. One example is the discovery of STUN servers (see &rfc5389;) and STUN relays (see &turn;) for the sake of negotiating media exchanges via &xep0176;. <note>The protocol specified herein is functionally equivalent to the protocol currently used in the Google Talk service for discovery of STUN servers, as documented at &lt;<link url='http://code.google.com/apis/talk/jep_extensions/jingleinfo.html'>http://code.google.com/apis/talk/jep_extensions/jingleinfo.html</link>&gt;, but has been broadened in scope to address additional use cases if desired.</note> An XMPP entity can already discover such external services in several ways, including:</p>
  <ol>
    <li>The service is specified in the application's default settings.</li>
    <li>The service is manually added into the application's configuration by a human user.</li>
    <li>The service is discovered via non-XMPP service discovery protocols, such as:
      <ul>
        <li>DNS SRV records (&rfc2782;)</li>
        <li>Service Location Protocol (SLP; &rfc2608;)</li>
        <li>The Dynamic Delegation Discovery System (DDDS; &rfc3401;)</li>
        <li>The NAPTR profile of DDDS (&rfc3403;)</li>
        <li>The S-NAPTR profile of DDDS (&rfc3958;)</li>
        <li>The U-NAPTR profile of DDDS (&rfc4848;)</li>
      </ul>
    </li>
  </ol>
  <p>Unfortunately, some of the foregoing methods are subject to human error and others are either not widely available or cannot be deployed in wide range of scenarios (e.g., when the administrators of an XMPP service do not have access to DNS SRV records). Therefore, this document defines a way for an XMPP server or discovery service to provide information about external services, which may include extended information such as temporary credentials for authentication at such services. This method should be used only as a fallback when the relevant service discovery technologies (DNS SRV, DDDS, SLP, S-NAPTR, U-NAPTR, etc.) are not available to the XMPP entities involved (typically a client and server). This method does not use &xep0030; since that technology is designed for discovery of XMPP entities, not entities outside an XMPP network.</p>
</section1>

<section1 topic='Protocol' anchor='protocol'>
  <p>In order to learn about external services known to an XMPP server or discovery service, a requesting entity (typically a client) sends an IQ-get containing an empty &lt;services/&gt; element qualified by the 'http://www.xmpp.org/extensions/xep-0215.html#ns' namespace &NSNOTE;, typically to its own server but perhaps alternatively to a dedicated discovery service.</p>
  <p>The responding entity (XMPP server or discovery service) SHOULD return the list of external services it is aware of, but MAY instead return an appropriate error, such as &unavailable; if the responding entity does not support this protocol or &forbidden; if the requesting entity does not have permission to receive the list of external services. Each service is encapsulated via a &lt;service/&gt; element.</p>
  <p>Note: The processes by which a responding entity discovers external services for "proxying" to XMPP entities are out of scope for this specification.</p>
  <p>The &lt;service/&gt; element MAY be empty or MAY include extended information about the service as described in the <link url='#extended'>Extended Information</link> section of this document.</p>
  <p>The attributes of the &lt;service/&gt; element are summarized in the following table.</p>
  <table caption='Attributes'>
    <tr>
      <th>Name</th>
      <th>Definition</th>
      <th>Inclusion</th>
    </tr>
    <tr>
      <td>host</td>
      <td>Either a fully qualified domain name (FQDN) or an IP address (IPv4 or IPv6).</td>
      <td>REQUIRED</td>
    </tr>
    <tr>
      <td>name</td>
      <td>A friendly (human-readable) name or label for the service.</td>
      <td>OPTIONAL</td>
    </tr>
    <tr>
      <td>password</td>
      <td>A service- or server-generated password for use at the service. *</td>
      <td>OPTIONAL</td>
    </tr>
    <tr>
      <td>port</td>
      <td>The communications port to be used at the host.</td>
      <td>RECOMMENDED</td>
    </tr>
    <tr>
      <td>transport</td>
      <td>The underlying transport protocol to be used when communicating with the service (typically either TCP or UDP).</td>
      <td>RECOMMENDED</td>
    </tr>
    <tr>
      <td>type</td>
      <td>The service type as registered with the &REGISTRAR;.</td>
      <td>REQUIRED</td>
    </tr>
    <tr>
      <td>username</td>
      <td>A service- or server-generated username for use at the service. *</td>
      <td>OPTIONAL</td>
    </tr>
  </table>
  <p>* Note: The processes by which an external service might generate or an XMPP server might negotiate the username and password are outside the scope of this specification. One possible approach is for the XMPP server to generate a short-term authentication credential based on a private key shared with the external service.</p>
</section1>

<section1 topic='Use Cases' anchor='usecases'>
  <section2 topic='Requesting All Services' anchor='all'>
    <p>A requesting entity requests all services by sending a &lt;services/&gt; element to its server or a discovery service.</p>
    <example caption='Entity Requests All External Services'><![CDATA[
<iq type='get'
    from='bard@shakespeare.lit/globe'
    to='shakespeare.lit'
    id='all1'>
  <services xmlns='http://www.xmpp.org/extensions/xep-0215.html#ns'/>
</iq>
    ]]></example>
    <example caption='XMPP Server Returns List'><![CDATA[
<iq type='result'
    from='shakespeare.lit'
    to='bard@shakespeare.lit/globe'
    id='all1'>
  <services xmlns='http://www.xmpp.org/extensions/xep-0215.html#ns'>
    <service host='stun.shakespeare.lit' port='9998' transport='udp' type='stun'/>
    <service host='stun.shakespeare.lit'
             password='jj929jkj5sadjfj93v3n'
             port='9999'
             type='stun-relay'
             username='nb78932lkjlskjfdb7g8'/>
    <service host='192.0.2.1' port='8888' transport='udp' type='stun'/>
    <service host='192.0.2.1'
             port='8889'
             password='93jn3bakj9s832lrjbbz'
             type='stun-relay'
             username='auu98sjl2wk3e9fjdsl7'/>
    <service host='ftp.shakespeare.lit' 
             name='Shakespearean File Server'
             password='guest' 
             port='20' 
             transport='tcp' 
             type='ftp' 
             username='guest'/>
  </services>
</iq>
    ]]></example>
  </section2>
  <section2 topic='Requesting Selected Services' anchor='select'>
    <p>A requesting entity requests selected services by sending a &lt;services/&gt; element including a 'type' attribute specifying the service type of interest.</p>
    <example caption='Entity Requests Selected Services'><![CDATA[
<iq type='get'
    from='bard@shakespeare.lit/globe'
    to='shakespeare.lit'
    id='selected1'>
  <services xmlns='http://www.xmpp.org/extensions/xep-0215.html#ns'
            type='stun-relay'/>
</iq>
    ]]></example>
    <example caption='XMPP Server Returns List'><![CDATA[
<iq type='result'
    from='shakespeare.lit'
    to='bard@shakespeare.lit/globe'
    id='selected1'>
  <services xmlns='http://www.xmpp.org/extensions/xep-0215.html#ns'
            type='stun-relay'>
    <service host='stun.shakespeare.lit'
             password='jj929jkj5sadjfj93v3n'
             port='9999'
             type='stun-relay'
             username='nb78932lkjlskjfdb7g8'/>
    <service host='192.0.2.1'
             port='8889'
             password='93jn3bakj9s832lrjbbz'
             type='stun-relay'
             username='auu98sjl2wk3e9fjdsl7'/>
  </services>
</iq>
    ]]></example>
    <p>If a requesting entity requests selected services, the responding service MAY as needed send an updated list of the relevant services by "pushing" the list to a requesting entity that has previously requested the list. However, it MUST NOT push updates to the requesting entity unless it has presence information about the requesting entity (e.g., because the requesting entity is connected to the XMPP server or because the requesting entity has shared presence with a remote discovery service).</p>
    <example caption='Services Push'><![CDATA[
<iq type='set'
    from='shakespeare.lit'
    to='bard@shakespeare.lit/globe'
    id='push1'>
  <services xmlns='http://www.xmpp.org/extensions/xep-0215.html#ns'
            type='stun-relay'>
    <server host='stun.shakespeare.lit' 
            port='9999' 
            username='1nas9dlm3hzl89d0b9v' 
            password='gh9023ljjdk109iajqn'>
    <server host='192.0.2.2' 
            port='7778' 
            username='bnsv120afg48snsdozp' 
            password='zxp023na98dsfahn1kk'/>
  </services>
</iq>
    ]]></example>
  </section2>
</section1>

<section1 topic='Extended Information' anchor='extended'>
  <p>If a server or service needs to include extended information, it SHOULD do so by including each bit of information as the XML character data of the &lt;value/&gt; child of a distinct &lt;field/&gt; element, with the entire set of fields contained within an &lt;x/&gt; element of type "result" qualified by the 'jabber:x:data' namespace (see &xep0004;); this &lt;x/&gt; element SHOULD be a child of the &lt;service/&gt; element qualified by the 'http://www.xmpp.org/extensions/xep-0215.html#ns' namespace &NSNOTE;. Thus the IQ result SHOULD be of the following form:</p>
  <code><![CDATA[
<iq type='result'>
  <services xmlns='http://www.xmpp.org/extensions/xep-0215.html#ns'>
    <service>
      <x type='result' xmlns='jabber:x:data'>
        <field var='[var-name]' label='[optional]'>
          <value>[var-value]</value>
        </field>
        [ ... ]
      </x>
    </service>
  </services>
</iq>]]></code>
  <p>Note: A &lt;field/&gt; element MAY contain more than one &lt;value/&gt; child if appropriate.</p>
  <p>If the data fields are to be used in the context of a protocol approved by the XMPP Standards Foundation, they SHOULD be registered in accordance with the rules defined in XEP-0068, resulting in the inclusion of a &lt;field/&gt; element whose 'var' attribute has a value of "FORM_TYPE" and whose 'type' attribute has a value of "hidden".</p>
  <p>Note: Although &xep0128; specifies that an XMPP entity MUST NOT supply extended information about associated children communicated via the 'http://www.xmpp.org/extensions/xep-0215.html#ns' namespace, that rule does not apply to External Service Discovery since services external to the XMPP network cannot communicate via XMPP.</p>
</section1>

<section1 topic='Determining Support' anchor='disco'>
  <p>If an entity supports the STUN Server Discovery protocol, it MUST report that fact by including a service discovery feature of "http://www.xmpp.org/extensions/xep-0215.html#ns" &NSNOTE; in response to a &xep0030; information request:</p>
  <example caption="Service Discovery Information Request"><![CDATA[
<iq type='get'
    from='romeo@montague.lit/orchard'
    to='montague.lit'
    id='disco1'>
  <query xmlns='http://jabber.org/protocol/disco#info'/>
</iq>
  ]]></example>
  <example caption="Service Discovery Information Response"><![CDATA[
<iq type='result'
    from='montague.lit'
    to='romeo@montague.lit/orchard'
    id='disco1'>
  <query xmlns='http://jabber.org/protocol/disco#info'>
    ...
    <feature var='http://www.xmpp.org/extensions/xep-0215.html#ns'/>
    ...
  </query>
</iq>
  ]]></example>
</section1>

<section1 topic='Internationalization Considerations' anchor='i18n'>
  <p>If the requesting entity includes an 'xml:lang' attribute with its request, the responding entity SHUOLD include appropriately internationalized text as the value of the 'name' attribute. No other attributes are human-readable.</p>
</section1>

<section1 topic='Security Considerations' anchor='security'>
  <p>Because the responding entity (XMPP server or discovery service) functions as a "proxy" from external services to the XMPP network, it could modify the information it receives before passing it on to the requesting entity.</p>
</section1>

<section1 topic='XMPP Registrar Considerations' anchor='registrar'>
  <section2 topic='Protocol Namespaces' anchor='ns'>
    <p>Until this specification advances to a status of Draft, its associated namespace shall be "http://www.xmpp.org/extensions/xep-0215.html#ns"; upon advancement of this specification, the XMPP Registrar shall issue a permanent namespace in accordance with the process defined in Section 4 of &xep0053;.</p>
  </section2>
  <section2 topic='External Service Types Registry' anchor='registrar-services'>
    <p>The XMPP Registrar shall maintain a registry of external service types and their associated transport protocol(s). Such service types will probably be derived from the &ianaports;, defined DNS SRV record types, defined DDDS records for NAPTR, S-NAPTR, and U-NAPTR, and &ianaslp;.  A future version of this specification shall define the relevant actions requested of the XMPP Registrar.</p>
  </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-0215.html#ns'
    xmlns='http://www.xmpp.org/extensions/xep-0215.html#ns'
    elementFormDefault='qualified'>

  <xs:import
      namespace='jabber:x:data'
      schemaLocation='http://www.xmpp.org/schemas/x-data.xsd'/>

  <xs:element name='services'>
    <xs:complexType>
      <xs:sequence minOccurs='0'>
        <xs:element ref='service'/>
      </xs:sequence>
      <xs:attribute name='type' type='xs:NCName' use='optional'/>
    </xs:complexType>
  </xs:element>

  <xs:element name='service'>
    <xs:complexType>
      <xs:simpleContent>
        <xs:extension base='empty'>
          <xs:attribute name='host' type='xs:string' use='required'/>
          <xs:attribute name='name' type='xs:string' use='optional'/>
          <xs:attribute name='password' type='xs:string' use='optional'/>
          <xs:attribute name='port' type='xs:string' use='required'/>
          <xs:attribute name='transport' type='xs:NCName' use='optional'/>
          <xs:attribute name='type' type='xs:NCName' use='required'/>
          <xs:attribute name='username' type='xs:string' use='optional'/>
        </xs:extension>
      </xs:simpleContent>
    </xs:complexType>
  </xs:element>

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

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

</xep>
