xeps/xep-0309.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>Service Directories</title>
  <abstract>This specification shows how to combine and extend a number of existing XMPP protocols for improved sharing of information about XMPP servers.</abstract>
  &LEGALNOTICE;
  <number>0309</number>
  <status>Experimental</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;
  <revision>
    <version>0.1</version>
    <date>2012-01-10</date>
    <initials>psa</initials>
    <remark><p>Initial published version.</p></remark>
  </revision>
  <revision>
    <version>0.0.3</version>
    <date>2012-01-09</date>
    <initials>psa</initials>
    <remark><p>Defined ad-hoc command for triggering outbound presence subscription.</p></remark>
  </revision>
  <revision>
    <version>0.0.2</version>
    <date>2012-01-09</date>
    <initials>psa</initials>
    <remark><p>Defined data sharing via PEP.</p></remark>
  </revision>
  <revision>
    <version>0.0.1</version>
    <date>2011-12-12</date>
    <initials>psa</initials>
    <remark><p>First draft.</p></remark>
  </revision>
</header>

<section1 topic='Introduction' anchor='introduction'>
  <p>Several directories (e.g., at xmpp.org and jabberes.org) have long provided information about public XMPP services so that end users can more easily find servers to register with, add-on components to use for features such as &xep0045;, etc. These service directories tend to rely on humans to gather and in some cases verify the information they publish before providing it via the World Wide Web or the XMPP network for use by end users and IM client software. However, relying on humans to gather and verify such information can result in significant delays and errors. It would be better to automate the information-gathering functions as much as possible.</p>
  <p>This document shows how to combine and extend a number of existing XMPP protocols for (mostly) automated gathering of information about public XMPP services. Widespread deployment of this specification will result in more timely, accurate information about the services available on the XMPP network.</p>
</section1>

<section1 topic='Gathering Information' anchor='gather'>
  <p>The following scenario involves two entities:</p>
  <ul>
    <li>A server directory: xmpp.net</li>
    <li>A public XMPP service: jabber.org</li>
  </ul>
  <p>Note: Although the entity that gathers information for a directory could be a client or a component, here we assume that it is a server ("xmpp.net").</p>
  <p>These two entities use &xep0267;, &xep0030;, and &xep0292; in the following ways.</p>
  <code><![CDATA[
Directory                      Server
(xmpp.net)                   (jabber.org)
    |                             |
    |   [first, server learns     |
    |    identity of directory]   |
    |                             |
    |<---disco info request-------|
    |----disco info response----->|
    |                             |
    |   [second, entities become  |
    |    "buddies" per XEP-0267]  |
    |                             |
    |<---presence subscribe-------|
    |----presence subscribed----->|
    |----presence subscribe------>|
    |<---presence subscribed------|
    |                             |
    |   [third, directory         |
    |    gathers server data]     |
    |                             |
    |----disco info request------>|
    |<---disco info response------|
    |                             |
    |----vcard request----------->|
    |<---vcard response-----------|
    |                             |
  ]]></code>
  <section2 topic='Server Discovers Directory' anchor='gather-disco'>
    <p>In order to determine the exact identity of the directory, the server sends a service discovery information request to the directory.</p>
    <example caption='Server Queries Directory'><![CDATA[
<iq type='get'
    from='jabber.org'
    to='xmpp.net'
    id='xh1f37n5'>
  <query xmlns='http://jabber.org/protocol/disco#info'/>
</iq>
    ]]></example>
    <example caption='Directory Returns Disco Info'><![CDATA[
<iq type='result'
    from='xmpp.net'
    to='jabber.org'
    id='xh1f37n5'>
  <query xmlns='http://jabber.org/protocol/disco#info'>
    <identity category='directory' type='server'/>
    <feature var='http://jabber.org/protocol/disco#info'/>
    <feature var='http://jabber.org/protocol/disco#items'/>
    <feature var='urn:xmpp:server-presence'/>
  </query>
</iq>
    ]]></example>
  </section2>

  <section2 topic='Server Subscribes to Directory' anchor='gather-buddy'>
    <p>If the server wishes to have its information aggregated, it sends a presence subscription request to the directory as described in XEP-0267.</p>
    <example caption="Server Sends Subscription Request to Directory"><![CDATA[
<presence from='jabber.org'
          to='xmpp.net'
          type='subscribe'/>
    ]]></example>
    <p>Upon receiving such the presence subscription request, the directory approves it.</p>
    <example caption="Directory Sends Approval to Server"><![CDATA[
<presence from='xmpp.net'
          to='jabber.org'
          type='subscribed'/>
    ]]></example>
    <p>The directory also sends a subscription request to the server.</p>
    <example caption="Directory Sends Subscription Request to Server"><![CDATA[
<presence from='xmpp.net'
          to='jabber.org'
          type='subscribe'/>
    ]]></example>
    <p>The server then approves that subscription request, as well.</p>
    <example caption="Services Sends Approval to Directory"><![CDATA[
<presence from='jabber.org'
          to='xmpp.net'
          type='subscribed'/>
    ]]></example>
    <section3 topic='Administrator Triggers Presence Subscription' anchor='gather-buddy-trigger'>
      <p>The server administator needs a way to trigger the server to send a presence subscription to the directory. This can be done by using &xep0050; as in &xep0133;. Therefore we define a new server administration use case. The command node for this use case SHOULD be "http://jabber.org/protocol/admin#server-buddy".</p>
      <p>A sample protocol flow for this use case is shown below.</p>
      <example caption='Admin Requests to Add Server Buddy'><![CDATA[
<iq from='stpeter@jabber.org/squire'
    id='server-buddy-1'
    to='jabber.org'
    type='set'
    xml:lang='en'>
  <command xmlns='http://jabber.org/protocol/commands' 
           action='execute'
           node='http://jabber.org/protocol/admin#server-buddy'/>
</iq>
      ]]></example>
      <p>Unless an error occurs, the service SHOULD return the appropriate form.</p>
      <example caption='Service Returns Server Buddy Form to Admin'><![CDATA[
<iq from='jabber.org'
    id='server-buddy-1'
    to='stpeter@jabber.org/squire'
    type='result'
    xml:lang='en'>
  <command xmlns='http://jabber.org/protocol/commands' 
           node='http://jabber.org/protocol/admin#server-buddy'
           sessionid='server-buddy:20120109T0310Z'
           status='executing'>
    <x xmlns='jabber:x:data' type='form'>
      <title>Adding a Server Buddy</title>
      <instructions>Fill out this form to add a "server buddy".</instructions>
      <field type='hidden' var='FORM_TYPE'>
        <value>http://jabber.org/protocol/admin</value>
      </field>
      <field label='The server to add'
             type='jid-single'
             var='peerjid'>
        <required/>
      </field>
    </x>
  </command>
</iq>
      ]]></example>
      <example caption='Admin Submits Server Buddy Form to Service'><![CDATA[
<iq from='stpeter@jabber.org/squire'
    id='server-buddy-2'
    to='xmpp.net'
    type='set'
    xml:lang='en'>
  <command xmlns='http://jabber.org/protocol/commands' 
           node='http://jabber.org/protocol/admin#server-buddy'
           sessionid='server-buddy:20120109T0310Z'>
    <x xmlns='jabber:x:data' type='submit'>
      <field type='hidden' var='FORM_TYPE'>
        <value>http://jabber.org/protocol/admin</value>
      </field>
      <field var='peerjid'>
        <value>xmpp.net</value>
      </field>
    </x>
  </command>
</iq>
      ]]></example>
      <example caption='Service Informs Admin of Completion'><![CDATA[
<iq from='jabber.org'
    id='server-buddy-2'
    to='stpeter@jabber.org/squire'
    type='result'
    xml:lang='en'>
  <command xmlns='http://jabber.org/protocol/commands' 
           node='http://jabber.org/protocol/admin#server-buddy'
           sessionid='server-buddy:20120109T0310Z'
           status='completed'/>
</iq>
      ]]></example>
    </section3>
  </section2>

  <section2 topic='Directory Queries Server' anchor='gather-query'>
    <p>After the subscription handshake has been completed, the directory queries the server for information. There are two aspects: service discovery information and vCard information.</p>
    <section3 topic='Disco Query' anchor='gather-query-disco'>
      <p>In order to determine the exact identity of the server, the directory sends a service discovery information request to the server.</p>
      <example caption='Directory Queries Server'><![CDATA[
<iq type='get'
    from='xmpp.net'
    to='jabber.org'
    id='i3vs51b9'>
  <query xmlns='http://jabber.org/protocol/disco#info'/>
</iq>
      ]]></example>
      <example caption='Server Returns Disco Info'><![CDATA[
<iq type='result'
    from='jabber.org'
    to='xmpp.net'
    id='i3vs51b9'>
  <query xmlns='http://jabber.org/protocol/disco#info'>
    <identity category='server' type='im'/>
    <feature var='http://jabber.org/protocol/disco#info'/>
    <feature var='http://jabber.org/protocol/disco#items'/>
    <feature var='jabber:iq:register'/>
    <feature var='urn:xmpp:server-presence'/>
    <feature var='urn:xmpp:public-server'/>
  </query>
</iq>
      ]]></example>
      <p>Note: If the server is a public node on the XMPP network, it includes a service discovery feature of "urn:xmpp:public-server". This feature is defined below.</p>
      <p>Note: If the server allows &xep0077;, it includes a service discovery feature of "jabber:iq:register". If the server does not allow in-band registration but allows account registration at a website, it includes the registration URL in its vCard as described below.</p>
      <p>The foregoing examples show the gathering of disco#info data (identity and supported features). An directory MAY also gather disco#items data about components and other services associated with the base XMPP server at a domain.</p>
    </section3>
    <section3 topic='vCard Query' anchor='gather-query-vcard'>
      <p>In order to gather additional information about the server, the directory sends a vCard information request to the server.</p>
      <p>Note: Because vCard4 enables the XMPP community to more easily define extensions to vCard (e.g., for registration URLs), it is RECOMMENDED for servers to support &xep0292; in addition to, or instead of, &xep0054;.</p>
      <example caption="Directory Requests vCard Data from Server"><![CDATA[
<iq from='xmpp.net'
    id='lw71bs73'
    to='jabber.org'
    type='get'>
  <vcard xmlns='urn:ietf:params:xml:ns:vcard-4.0'/>
</iq>
      ]]></example>
      <example caption="Server Returns vCard Data"><![CDATA[
<iq from='jabber.org'
    id='lw71bs73'
    to='xmpp.net'
    type='result'>
  <vcard xmlns='urn:ietf:params:xml:ns:vcard-4.0'>
    <fn><text>jabber.org IM service</text></fn>
    <url><uri>http://www.jabber.org/</uri></url>
    <lang>
      <parameters><pref>1</pref></parameters>
      <language-tag>en</language-tag>
    </lang>
    <adr>
      <region>IA</region>
      <country>US</country>
    </adr>
    <email><text>xmpp@jabber.org</text></email>
    <impp><uri>xmpp:jabber.org</uri></impp>
    <logo><uri>http://www.jabber.org/images/logo.png</uri></logo>
    <geo><uri>geo:42.25,-91.05</uri></geo>
    <tz><text>America/Chicago</text></tz>
    <kind><text>application</text></kind>
    <registration xmlns='urn:xmpp:vcard:registration'>
      <url>https://register.jabber.org/</url>
    </registration>
  </vcard>
</iq>
      ]]></example>
      <p>It is RECOMMENDED for public server vCards to include the following information:</p>
      <ul>
        <li>A friendly name for the service (&lt;fn/&gt;)</li>
        <li>A URL for general information about the service (&lt;url/&gt;)</li>
        <li>The country where the service is located (&lt;adr&gt;&lt;country/&gt;&lt;/adr&gt;)</li>
        <li>An email address or alias for contacting the administrators (&lt;email/&gt;)</li>
        <li>The XMPP address for the service (&lt;impp/&gt;)</li>
        <li>A vCard KIND of "application" (&lt;kind&gt;&lt;text&gt;application&lt;/text&gt;&lt;/kind&gt;)</li>
      </ul>
      <p>It is OPTIONAL for public server vCards to include the following information:</p>
      <ul>
        <li>Preferred language of communication with the administrators (&lt;lang/&gt;)</li>
        <li>Region where the service is located (&lt;adr&gt;&lt;region/&gt;&lt;/adr&gt;)</li>
        <li>Logo for the service (&lt;logo/&gt;)</li>
        <li>Geographical coordinates for the service (&lt;geo/&gt;)</li>
        <li>Registration URL (&lt;registration xmlns='urn:xmpp:vcard:registration'/&gt;)</li>
      </ul>
    </section3>
  </section2>
</section1>

<section1 topic='Publishing Information' anchor='publish'>
  <p>Currently, service directories such as xmpp.org and jabberes.org publish their information on the World Wide Web, typically via a human-friendly website and sometimes also via machine-readable files at a well-known URI for use by IM clients to pre-populate drop-down boxes showing XMPP servers that allow in-band registration. (For example, the xmpp.org service publishes a file listing registered public servers using the &xep0030; format.)</p>
  <p>In addition to publishing such information on the web, this document defines a second publishing path: the XMPP network itself. The directory can do this by creating a public &xep0060; node at the directory's bare domain (e.g., xmpp.net) that pushes data in the vCard4 format shown above, as described more fully in XEP-0292. Other entities can then subscribe to this node to receive updated information about services that are added to or removed from the directory.</p>
  <p>For example, the following stanza shows an information push from the xmpp.net directory about the jabber.org service, sent to a subscriber at example.com.</p>
  <example caption='Directory Pushes Server Data to Subscriber'><![CDATA[
<message from='xmpp.net'
         to='example.com'
         type='headline'
         id='hx61cs8k'>
  <event xmlns='http://jabber.org/protocol/pubsub#event'>
    <items node='urn:xmpp:contacts'>
      <item id='3B55FBC7-8149-4693-A1A1-5367E2A49C83'>
        <vcard xmlns='urn:ietf:params:xml:ns:vcard-4.0'>
          <fn><text>jabber.org IM service</text></fn>
          <url><uri>http://www.jabber.org/</uri></url>
          <lang>
            <parameters><pref>1</pref></parameters>
            <language-tag>en</language-tag>
          </lang>
          <adr>
            <region>IA</region>
            <country>US</country>
          </adr>
          <email><text>xmpp@jabber.org</text></email>
          <impp><uri>xmpp:jabber.org</uri></impp>
          <logo><uri>http://www.jabber.org/images/logo.png</uri></logo>
          <geo><uri>geo:42.25,-91.05</uri></geo>
          <tz><text>America/Chicago</text></tz>
          <kind><text>application</text></kind>
          <registration xmlns='urn:xmpp:vcard:registration'>
            <url>https://register.jabber.org/</url>
          </registration>
        </vcard>
      </item>
    </items>
  </event>
</message>
  ]]></example>
</section1>

<section1 topic='Security Considerations' anchor='security'>
  <p>Because a service directory does not know about an XMPP server unless the administrator of the server initiates a presence subscription to the directory, information leakage is minimized.</p>
  <p>Use of the "urn:xmpp:public-server" service discovery feature provides a way for an XMPP server to explicitly indicate that its information is public.</p>
  <p>Use of the "directory/server" service discovery identity provides a way for a service directory to explicitly indicate that it gathers service information obtained from XMPP servers that contact it.</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='registrar-namespaces'>
    <p>This document specifies that the 'urn:xmpp:vcard:registration' namespace is used to qualify the XMPP-specific vCard4 extension for account registration URLs.</p>
    <p>The XMPP Registrar shall add this namespace to its registry at &NAMESPACES;.</p>
  </section2>
  <section2 topic='Service Discovery Category/Type' anchor='registrar-discocat'>
    <p>This document specifies that a service directory is identified by the "directory" category and the "server" type within XMPP Service Discovery.</p>
    <p>The XMPP Registrar shall add the "server" type to the "directory" category already listed in the registry at &DISCOCATEGORIES;. The registration is as follows.</p>
    <code caption='Registry Submission'><![CDATA[
<category>
  <name>directory</name>
  <type>
    <name>server</name>
    <desc>A directory of XMPP servers</desc>
    <doc>[TBD]</doc>
  </type>
</category>
    ]]></code>
  </section2>
  <section2 topic='Service Discovery Features' anchor='registrar-features'>
    <p>This document specifies that a public server on the XMPP network is identified by the "urn:xmpp:public-server" Service Discovery feature.</p>
    <p>The XMPP Registrar shall add this feature to its registry at &DISCOFEATURES;. The registration is as follows.</p>
    <code caption='Registry Submission'><![CDATA[
<var>
  <name>urn:xmpp:public-server</name>
  <desc>The server is a public node on the XMPP network</desc>
  <doc>[TBD}/doc>
</var>
    ]]></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='urn:xmpp:vcard:registration'
    xmlns='urn:xmpp:vcard:registration'
    elementFormDefault='qualified'>

  <xs:element name='registration'>
    <xs:complexType>
      <xs:sequence>
        <xs:element name='url' type='xs:anyURI'/>
      </xs:choice>
    </xs:complexType>
  </xs:element>

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

</xep>