view Side-By-Side changes
XMPPNetwork Working Group P. Saint-Andre, Ed. Internet-DraftXSFXMPP Standards Foundation Obsoletes: 3920 (if approved) July 17, 2007 Intended status: Standards TrackApril 17, 2007Expires:October 19, 2007January 18, 2008 Extensible Messaging and Presence Protocol (XMPP): Coredraft-saintandre-rfc3920bis-02draft-saintandre-rfc3920bis-03 Status of this Memo By submitting this Internet-Draft, each author represents that any applicable patent or other IPR claims of which he or she is aware have been or will be disclosed, and any of which he or she becomes aware will be disclosed, in accordance with Section 6 of BCP 79. Internet-Drafts are working documents of the Internet Engineering Task Force (IETF), its areas, and its working groups. Note that other groups may also distribute working documents as Internet- Drafts. Internet-Drafts are draft documents valid for a maximum of six months and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use Internet-Drafts as reference material or to cite them other than as "work in progress." The list of current Internet-Drafts can be accessed at http://www.ietf.org/ietf/1id-abstracts.txt. The list of Internet-Draft Shadow Directories can be accessed at http://www.ietf.org/shadow.html. This Internet-Draft will expire onOctober 19, 2007.January 18, 2008. Copyright Notice Copyright (C) The IETF Trust (2007). Abstract Thismemodocument defines the core features of the Extensible Messaging and Presence Protocol (XMPP), a technology for streaming Extensible Markup Language (XML) elements in order to exchange structured information in close to real time between any two network-aware entities. XMPP provides a generalized, extensible framework for incrementally exchanging XML data, upon which a variety of applications can be built. The framework includes methods for stream Saint-Andre Expires January 18, 2008 [Page 1] Internet-Draft XMPP Core July 2007 setup and teardown, channel encryption, authentication of a client toSaint-Andre Expires October 19, 2007 [Page 1] Internet-Draft XMPP Core April 2007a server and of one server to another server, and primitives for push-style messages, publication ofpresence andnetwork availabilityinformation,information ("presence"), and request-response interactions between any two XMPP entities. This document also specifies the format for XMPP addresses, which are fully internationalizable. This document obsoletes RFC 3920. Table of Contents 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 5 1.1. Overview . . . . . . . . . . . . . . . . . . . . . . . . 5 1.2. Functional Summary . . . . . . . . . . . . . . . . . . . 5 1.3. Conventions . . . . . . . . . . . . . . . . . . . . . .67 2. Architecture . . . . . . . . . . . . . . . . . . . . . . . .67 2.1. Overview . . . . . . . . . . . . . . . . . . . . . . . .67 2.2. Server . . . . . . . . . . . . . . . . . . . . . . . . .78 2.3. Client . . . . . . . . . . . . . . . . . . . . . . . . .78 2.4. Network . . . . . . . . . . . . . . . . . . . . . . . .79 3. Addresses . . . . . . . . . . . . . . . . . . . . . . . . . .89 3.1. Overview . . . . . . . . . . . . . . . . . . . . . . . .89 3.2. Domain Identifier . . . . . . . . . . . . . . . . . . .910 3.3. Node Identifier . . . . . . . . . . . . . . . . . . . .1011 3.4. Resource Identifier . . . . . . . . . . . . . . . . . .1011 3.5. Determination of Addresses . . . . . . . . . . . . . . .1112 4. TCP Binding . . . . . . . . . . . . . . . . . . . . . . . . .1112 5. XML Streams . . . . . . . . . . . . . . . . . . . . . . . . .1213 5.1. Overview . . . . . . . . . . . . . . . . . . . . . . . .1213 5.2. Stream Security . . . . . . . . . . . . . . . . . . . .1415 5.3. Stream Attributes . . . . . . . . . . . . . . . . . . .1516 5.4. Namespace Declarations . . . . . . . . . . . . . . . . .1822 5.5. Stream Features . . . . . . . . . . . . . . . . . . . .1822 5.6. Closing Streams . . . . . . . . . . . . . . . . . . . .1823 5.7. Reconnection . . . . . . . . . . . . . . . . . . . . . .1924 5.8. Stream Errors . . . . . . . . . . . . . . . . . . . . .1924 5.9. Simplified Stream Examples . . . . . . . . . . . . . . .2341 6.TLSSTARTTLS Negotiation . . . . . . . . . . . . . . . . . . . .. . . 2543 6.1. Overview . . . . . . . . . . . . . . . . . . . . . . . .2543 6.2.Narrative . . .Rules . . . . . . . . . . . . . . . . . . . .28 7. SASL Negotiation. . . . . 44 6.3. Process . . . . . . . . . . . . . . . . .29 7.1. Overview. . . . . . . 44 6.4. Representation of JIDs in Certificates . . . . . . . . . 48 7. SASL Negotiation . . . . . . . .29 7.2. Narrative. . . . . . . . . . . . . . 49 7.1. Overview . . . . . . . . .31 7.3. SASL Definition. . . . . . . . . . . . . . . 49 7.2. Rules . . . . .33 7.4. SASL Errors. . . . . . . . . . . . . . . . . . . . 49 7.3. Process . .34 8. Resource Binding. . . . . . . . . . . . . . . . . . . . . .34 8.1. Binding Multiple Resources51 7.4. SASL Definition . . . . . . . . . . . . . . .38 9. XML Stanzas. . . . . 56 Saint-Andre Expires January 18, 2008 [Page 2] Internet-Draft XMPP Core July 2007 7.5. SASL Errors . . . . . . . . . . . . . . . . . . . .39 Saint-Andre Expires October 19, 2007 [Page 2] Internet-Draft XMPP Core April 2007 9.1. Common Attributes. . 57 8. Resource Binding . . . . . . . . . . . . . . . . .40 9.2. Basic Semantics. . . . . 60 8.1. Overview . . . . . . . . . . . . . . .42 9.3. Stanza Errors. . . . . . . . . 60 8.2. Advertising Support . . . . . . . . . . . .44 9.4. Extended Namespaces. . . . . . 60 8.3. Server-Generated Resource Identifier . . . . . . . . . . 61 8.4. Client-Generated Resource Identifier . .48 10. Examples. . . . . . . . 62 8.5. Binding Multiple Resources . . . . . . . . . . . . . . . 64 9. XML Stanzas . . .49 10.1. Client-to-Server. . . . . . . . . . . . . . . . . . . .49 10.2. Server-to-Server Examples. . 67 9.1. Common Attributes . . . . . . . . . . . . .55 11. Server Rules for Handling XML Stanzas. . . . . . 67 9.2. Basic Semantics . . . . . .58 11.1. No 'to' Address. . . . . . . . . . . . . . 71 9.3. Stanza Errors . . . . . .59 11.2. Foreign Domain. . . . . . . . . . . . . . . 73 9.4. Extended Content . . . . . .59 11.3. Local Domain. . . . . . . . . . . . . . 88 10. Examples . . . . . . . .60 11.4. Mere Domain or Specific Resource. . . . . . . . . . . .60 11.5. Node in Same Domain. . . . . . 89 10.1. Client-to-Server . . . . . . . . . . . .60 12. XML Usage. . . . . . . . 89 10.2. Server-to-Server Examples . . . . . . . . . . . . . . . 95 11. Server Rules for Processing XML Stanzas . . .61 12.1. Restrictions. . . . . . . . 99 11.1. No 'to' Address . . . . . . . . . . . . . .61 12.2. XML Namespace Names and Prefixes. . . . . . 99 11.2. Local Domain . . . . . .61 12.3. Validation. . . . . . . . . . . . . . . . 100 11.3. Resource at Local Domain . . . . . . .63 12.4. Inclusion of Text Declaration. . . . . . . . . 100 11.4. Node at Local Domain . . . .63 12.5. Character Encoding. . . . . . . . . . . . . . 101 11.5. Foreign Domain . . . . .63 12.6. White Space. . . . . . . . . . . . . . . . 101 12. XML Usage . . . . . .63 13. Compliance Requirements. . . . . . . . . . . . . . . . . . .63 13.1. Servers. 102 12.1. Restrictions . . . . . . . . . . . . . . . . . . . . . . 102 12.2. XML Namespace Names and Prefixes .64 13.2. Clients. . . . . . . . . . . 103 12.3. Validation . . . . . . . . . . . . .64 14. Internationalization Considerations. . . . . . . . . . 105 12.4. Inclusion of Text Declaration . . .65 15. Security Considerations. . . . . . . . . . 106 12.5. Character Encoding . . . . . . . . .65 15.1. High Security. . . . . . . . . . 106 12.6. White Space . . . . . . . . . . .65 15.2. Certificate Validation. . . . . . . . . . . 106 13. Compliance Requirements . . . . . .65 15.3. Client-to-Server Communications. . . . . . . . . . . .66 15.4. Server-to-Server Communications. 106 13.1. Servers . . . . . . . . . . .67 15.5. Order of Layers. . . . . . . . . . . . . 107 13.2. Clients . . . . . . .67 15.6. Lack of SASL Channel Binding to TLS. . . . . . . . . .68 15.7. Mandatory-to-Implement Technologies. . . . . . . 107 14. Internationalization Considerations . . .68 15.8. Firewalls. . . . . . . . . . 107 15. Security Considerations . . . . . . . . . . . . .68 15.9. Use of base64 in SASL. . . . . . 108 15.1. High Security . . . . . . . . . . .69 15.10. Stringprep Profiles. . . . . . . . . . 108 15.2. Certificate Validation . . . . . . . .69 16. IANA Considerations. . . . . . . . . 108 15.3. Client-to-Server Communication . . . . . . . . . . . .70 16.1. XML Namespace Name for TLS Data. 109 15.4. Server-to-Server Communication . . . . . . . . . . .70 16.2. XML Namespace Name for SASL Data. . 110 15.5. Order of Layers . . . . . . . . . .70 16.3. XML Namespace Name for Stream Errors. . . . . . . . . .70 16.4. XML Namespace Name for Resource110 15.6. Lack of SASL Channel Binding to TLS . . . . . . . .71 16.5. XML Namespace Name for Stanza Errors. . 110 15.7. Mandatory-to-Implement Technologies . . . . . . . .71 16.6. Nodeprep Profile of Stringprep. . 111 15.8. Firewalls . . . . . . . . . . .71 16.7. Resourceprep Profile of Stringprep. . . . . . . . . . .72 16.8. GSSAPI Service Name. 111 15.9. Use of base64 in SASL . . . . . . . . . . . . . . . . .72 16.9. Port Numbers111 15.10. Stringprep Profiles . . . . . . . . . . . . . . . . . . 111 15.11. Address Spoofing . . . .72 17. References. . . . . . . . . . . . . . . . 112 15.12. Denial of Service . . . . . . . . .72 17.1. Normative References. . . . . . . . . . 114 15.13. Presence Leaks . . . . . . . .72 17.2. Informative References. . . . . . . . . . . . . 115 15.14. Directory Harvesting . . . .75 Saint-Andre Expires October 19, 2007 [Page 3] Internet-Draft XMPP Core April 2007 Appendix A. Nodeprep. . . . . . . . . . . . . . 116 16. IANA Considerations . . . . . . . .77 A.1. Introduction. . . . . . . . . . . . . 116 Saint-Andre Expires January 18, 2008 [Page 3] Internet-Draft XMPP Core July 2007 16.1. XML Namespace Name for TLS Data . . . . . . . . .77 A.2. Character Repertoire. . . 116 16.2. XML Namespace Name for SASL Data . . . . . . . . . . . . 116 16.3. XML Namespace Name for Stream Errors . . .78 A.3. Mapping. . . . . . . 116 16.4. XML Namespace Name for Resource Binding . . . . . . . . 117 16.5. XML Namespace Name for Stanza Errors . . . . . . . . .78 A.4. Normalization. 117 16.6. Nodeprep Profile of Stringprep . . . . . . . . . . . . . 117 16.7. Resourceprep Profile of Stringprep . . . . . . .78 A.5. Prohibited Output. . . . 118 16.8. GSSAPI Service Name . . . . . . . . . . . . . . .78 A.6. Bidirectional Characters. . . 118 16.9. Port Numbers . . . . . . . . . . . . .79 Appendix B. Resourceprep. . . . . . . . . 118 17. References . . . . . . . . . . .79 B.1. Introduction. . . . . . . . . . . . . . 118 17.1. Normative References . . . . . . . .79 B.2. Character Repertoire. . . . . . . . . . 118 17.2. Informative References . . . . . . . .79 B.3. Mapping. . . . . . . . . 120 Appendix A. Nodeprep . . . . . . . . . . . . . . .80 B.4. Normalization. . . . . . . 124 A.1. Introduction . . . . . . . . . . . . . .80 B.5. Prohibited Output. . . . . . . . 124 A.2. Character Repertoire . . . . . . . . . . .80 B.6. Bidirectional Characters. . . . . . . 124 A.3. Mapping . . . . . . . . .80 Appendix C. Server Dialback. . . . . . . . . . . . . . . 124 A.4. Normalization . . .80 C.1. Overview. . . . . . . . . . . . . . . . . . 124 A.5. Prohibited Output . . . . . .80 C.2. Order of Events. . . . . . . . . . . . . 125 A.6. Bidirectional Characters . . . . . . .82 C.3. Protocol. . . . . . . . . 125 Appendix B. Resourceprep . . . . . . . . . . . . . . .82 C.4. Reuse of Negotiated Connections. . . . . 125 B.1. Introduction . . . . . . .88 C.5. Dialback Key Generation. . . . . . . . . . . . . . . 125 B.2. Character Repertoire .89 C.6. Advertisement. . . . . . . . . . . . . . . . . 126 B.3. Mapping . . . .90 Appendix D. XML Schemas. . . . . . . . . . . . . . . . . . . .92 D.1. Streams namespace126 B.4. Normalization . . . . . . . . . . . . . . . . . . .92 D.2. Stream error namespace. . 126 B.5. Prohibited Output . . . . . . . . . . . . . . .93 D.3. TLS namespace. . . . 126 B.6. Bidirectional Characters . . . . . . . . . . . . . . . . 127 Appendix C. XML Schemas .95 D.4. SASL namespace. . . . . . . . . . . . . . . . . . . 127 C.1. Streams namespace . .95 D.5. Resource binding namespace. . . . . . . . . . . . . . .97 D.6. Dialback namespace. . 127 C.2. Stream error namespace . . . . . . . . . . . . . . . . .99 D.7. Server dialback stream feature128 C.3. TLS namespace . . . . . . . .101 D.8. Stanza error namespace. . . . . . . . . . . . . 131 C.4. SASL namespace . . . .101 Appendix E. Contact Addresses. . . . . . . . . . . . . . . . .103 Appendix F. Differences From RFC 3920131 C.5. Resource binding namespace . . . . . . . . . . . . .103 Author's Address. . 133 C.6. Stanza error namespace . . . . . . . . . . . . . . . . . 135 Appendix D. Contact Addresses . . . . .104 Intellectual Property and Copyright Statements. . . . . . . . .105. . . 136 Appendix E. Account Provisioning . . . . . . . . . . . . . . . . 137 Appendix F. Differences From RFC 3920 . . . . . . . . . . . . . 137 Appendix G. Copying Conditions . . . . . . . . . . . . . . . . . 138 Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138 Author's Address . . . . . . . . . . . . . . . . . . . . . . . . 139 Intellectual Property and Copyright Statements . . . . . . . . . 140 Saint-Andre ExpiresOctober 19, 2007January 18, 2008 [Page 4] Internet-Draft XMPP CoreAprilJuly 2007 1. Introduction 1.1. Overview The Extensible Messaging and Presence Protocol (XMPP) is an Extensible Markup LanguageXML[XML] technology for near-real-time messaging, presence, and request-response services. The basic syntax and semantics were developed originally within the Jabber open-source community, mainly in 1999. In late 2002, the XMPPWGWorking Group was chartered with developing an adaptation of the core Jabber protocol that would be suitable as an IETF instant messaging (IM) and presence technology. As a result of work by the XMPPWGWG, [RFC3920] was published in October 2004. As a result of extensive implementation and deployment experience with XMPP since that time, as well asimplementation experience andmore formal interoperabilitytesting completed since the publication of RFC 3920,testing, this documentdefinesreflects consensus from thecore features ofXMPP1.0; the extensions required to provide the instant messaging and presence functionality defined in [IMP-REQS] are specified in [XMPP-IM]. Thisdeveloper community regarding XMPP's core XML streaming technology. In particular, this documentobsoletesincorporates the following backward- compatible changes from RFC3920. 1.2. Functional Summary The purpose3920: o Corrections and errata o Additional examples throughout o Clarifications and more complete specification of matters that were underspecified o Modifications to reflect updated technologies for which XMPP isto enablea using protocol (e.g., Transport Layer Security and theexchangeSimple Authentication and Security Layer) o Definition ofrelatively small piecesseveral additional error conditions o Addition ofstructured dataTLS plus SASL PLAIN as a mandatory-to-implement technology o Definition of optional support for multiple resources over the same connection o Removal of historical documentation for the server dialback protocol from this specification to a separate specification Therefore, this document defines the core features of XMPP 1.0 and obsoletes RFC 3920. Note: The XMPP extensions required to provide the basic instant messaging and presence functionality defined in [IMP-REQS] are specified in [XMPP-IM]. 1.2. Functional Summary This non-normative section provides a developer-friendly, functional summary of XMPP; refer to the sections that follow for a normative definition of XMPP. Saint-Andre Expires January 18, 2008 [Page 5] Internet-Draft XMPP Core July 2007 The purpose of XMPP is to enable the exchange of relatively small pieces of structured data (called "XML stanzas") over a network between any two (or more) entities. XMPP is implemented using a client-server architecture, wherein a client must connect to a server in order to gain access to the network and thus be allowed to exchange XML stanzas with other entities. The process whereby a client connects to a server, exchanges XML stanzas, and ends the connectionis as follows:is: 1. Determine the hostname and port at which to connect 2. Open a TCP connection 3. Open an XML stream 4. Complete TLS negotiation for channel encryption(RECOMMENDED)(recommended) 5. Complete SASL negotiation for authentication 6. Bind a resource to the stream 7. Exchange an unbounded number of XML stanzas with other entities on the network 8. Close the XML streamwhen further communications are not needed or desired9. Close the TCPconnection.connection In the sections following discussion of XMPP architecture and XMPP addresses, this document specifies how clients connect to servers and specifies the basic semantics of XMLstanzas, butstanzas. However, this document does not define the "payloads" of the XML stanzas that might be exchanged once a connection is successfully established; instead, definition of such semantics is provided byvariousXMPP extensions (e.g., [XMPP-IM] defines extensions forSaint-Andre Expires October 19, 2007 [Page 5] Internet-Draft XMPP Core April 2007basic instant messaging and presenceapplications).functionality, and various specifications produced in the XMPP Standards Foundation's XEP series define extensions for a wide range of more advanced functionality). Within the client-server architecture used by XMPP, one server may optionally connect to another server to enable inter-domain or inter- server communication. For this to happen, the two servers must negotiate a connection between themselves and then exchange XML stanzas; the process for doing sois as follows:is: 1. Determine the hostname and port at which to connect 2. Open a TCP connection 3. Open an XML stream 4. Complete TLS negotiation for channel encryption(RECOMMENDED)(recommended) 5. Complete SASL negotiation for authentication 6. Exchange an unbounded number of XML stanzas both directly for the servers and indirectly on behalf of entities associated with each server (e.g., connected clients) 7. Close the XML streamwhen further communications are not needed or desiredSaint-Andre Expires January 18, 2008 [Page 6] Internet-Draft XMPP Core July 2007 8. Close the TCPconnection.connection Note: Depending on local service policies, a service may wish to use the older server dialback protocol to provide weak identity verification in cases where SASL negotiation would not result in strong authentication (e.g., because the certificate presented by the peer service during TLS negotiation is self-signed and thus provides only weak identity); for details, seeAppendix C.[XEP-0220]. 1.3. Conventions The following keywords are to be interpreted as described in [TERMS]: "MUST", "SHALL", "REQUIRED"; "MUST NOT", "SHALL NOT"; "SHOULD", "RECOMMENDED"; "SHOULD NOT", "NOT RECOMMENDED"; "MAY", "OPTIONAL". In examples, lines have been wrapped for improvedreadability.readability, "[...]" means elision, and the following prepended strings are used: o C: = client o E: = any XMPP entity o I: = initiating entity o P: = peer server o R: = receiving entity o S: = server o S1: = server1 o S2: = server2 2. Architecture 2.1. Overview XMPP assumes a client-server architecture, wherein a client utilizing XMPP accesses a server (normally over a [TCP] connection) and servers can also communicate with each other over TCP connections.Architectures that use the syntax of XML stanzas (Section 9) but that establish peer-to-peer connections directly between clients using technologies based on [LINKLOCAL] have been deployed, but such architectures are not XMPP and are best described as "XMPP-like"; for details, see [XEP-0174]. Saint-Andre Expires October 19, 2007 [Page 6] Internet-Draft XMPP Core April 2007 AnA simplified architectural diagram for a typical deployment is shown here, where the entities have the following significance: o romeo@example.net -- an XMPP user. o example.net -- an XMPP server. ojuliet@example.comexample.com -- an XMPPuser.server. oexample.comjuliet@example.com -- an XMPPserver.user. example.net -------------------- example.com | | | | romeo@example.net juliet@example.com Saint-Andre Expires January 18, 2008 [Page 7] Internet-Draft XMPP Core July 2007 Note: Architectures that employ the syntax of XML stanzas (Section 9) but that establish peer-to-peer connections directly between clients using technologies based on [LINKLOCAL] have been deployed, but such architectures are not XMPP and are best described as "XMPP-like"; for details, see [XEP-0174]. 2.2. Server Aserver acts asSERVER is anintelligent abstraction layer for XMPP communications. Itsentity whose primary responsibilitiesare:are to: oto manage connections from other entities, in the form ofManage XML streams (Section 5)to and from authorized clients, servers,with local clients andother entitiesdeliver XML stanzas (Section 9) to those clients over the negotiated XML streams. o Subject to local service policies on server-to-server communication, manage XML streams (Section 5) with foreign servers and routeappropriately-addressedXML stanzas (Section 9)among such entitiesto those servers over the negotiated XMLstreams Most XMPP-compliant servers also assume responsibility forstreams. Depending on thestorageapplication, the secondary responsibilities of an XMPP server may include: o Storing XML data that is used by clients (e.g., contact lists for users of XMPP-based instant messaging and presence applications); in this case, the relevant XMLdatastanza isprocessedhandled directly by the server itself on behalf of the client and is not routed toanother entity. 2.3. Client Most clients connect directly toa foreign serveroveror delivered to a[TCP] connection andlocal entity. o Hosting local services that also use XMPPto take full advantage ofas the basis for communication but that provide additional functionalityprovided by a server and any associated services. Multiple resources (e.g., devicesbeyond that defined in this document orlocations) MAY connect simultaneously to a server onin [XMPP-IM]; examples include multi-user conferencing services as specified in [XEP-0045] and publish-subscribe services as specified in [XEP-0060]. 2.3. Client A CLIENT is an entity that establiishes an XML stream with a server by authenticating using the credentials of a local account and that then completes resource binding (Section 8) in order to enable delivery of XML stanzas via the server to the client. A client then uses XMPP to communicate with its server, other clients, and any other accessible entities on a network. Multiple clients may connect simultaneously to a server on behalf ofeach authorized client,a local account, with eachresourceclient differentiated by the resource identifier portion of an XMPP address (e.g., <node@domain/home> vs.<node@domain/work>)<node@domain/work>), as defined underAddresses (Section 3)Section 3 andResource Binding (Section 8).Section 8. The RECOMMENDED port for TCP connections between a client and a server is 5222, as registered with the IANA (seePort Numbers (Section 16.9)).Section 16.9). Saint-Andre Expires January 18, 2008 [Page 8] Internet-Draft XMPP Core July 2007 2.4. Network Because each server is identified by a network address and because server-to-servercommunications arecommunication is a straightforward extension ofSaint-Andre Expires October 19, 2007 [Page 7] Internet-Draft XMPP Core April 2007the client-to-server protocol, inpractice,practice the system consists of a network of servers that inter-communicate. Thus, for example, <juliet@example.com> is able to exchange messages, presence, and other information with <romeo@example.net>. This pattern is familiar from messaging protocols (such as [SMTP]) that make use of network addressing standards.CommunicationsCommunication between any two serversareis OPTIONAL. If enabled, suchcommunicationscommunication SHOULD occur over XML streams that are bound to [TCP] connections. The RECOMMENDED port for tCP connections between servers is 5269, as registered with the IANA (seePort Numbers (Section 16.9)).Section 16.9. 3. Addresses 3.1. Overview AnentityENTITY is anything thatcan be considered a network endpoint (i.e., an ID on the network)is network-addressable and that can communicate using XMPP.All such entities are uniquely addressable on the network.For historical reasons, the native address of an XMPP entity is called aJabber IdentifierJABBER IDENTIFIER or JID. A valid JID contains a set of ordered elements formed ofaan XMPP domain identifier, node identifier, and resource identifier. The syntax for a JID is defined as follows using the Augmented Backus-Naur Form asdefinedspecified in [ABNF]. jid = [ node "@" ] domain [ "/" resource ] node = 1*(nodepoint) ; a "nodepoint" is a UTF-8 encoded Unicode code ; point that satisfies the Nodeprep profile of ; stringprep domain = fqdn / address-literal / idnlabel fqdn = (idnlabel 1*("." idnlabel)) ; an "idnlabel" is an internationalized label ; as described in RFC 3490 address-literal = IPv4address / IPv6address ; the "IPv4address" and "IPv6address" rules are ; defined in Appendix B of RFC 3513 resource = 1*(resourcepoint) ; a "resourcepoint" is a UTF-8 encoded Unicode ; code point that satisfies the Resourceprep ; profile of stringprep All JIDs are based on the foregoing structure. One common use of this structure is to identify a messaging and presence account, the Saint-Andre Expires January 18, 2008 [Page 9] Internet-Draft XMPP Core July 2007 server that hosts the account, and a connected resource (e.g., a specific device) in the form of <node@domain/resource>. However,Saint-Andre Expires October 19, 2007 [Page 8] Internet-Draft XMPP Core April 2007node types other than clients are possible; for example, a specific chat room offered by a multi-userchatconference service (see [XEP-0045]) could be addressed as <room@service> (where "room" is the name of the chat room and "service" is the hostname of the multi-userchatconference service) and a specific occupant of such a room could be addressed as <room@service/nick> (where "nick" is the occupant's room nickname). Many other JID types are possible (e.g., <domain/resource> could be a server-side script or service). Each allowable portion of a JID (node identifier, domain identifier, and resource identifier) MUST NOT be more than 1023 bytes in length, resulting in a maximum total size (including the '@' and '/' separators) of 3071 bytes. Note: While the format of a JID is consistent with [URI], an entity's address on an XMPP network MUST be a JID (without a URI scheme) and not a [URI] or [IRI] as specified in [XMPP-URI]; the latter specification is provided only for use by non-XMPP applications. 3.2. Domain Identifier The DOMAIN IDENTIFIER portion of a JID is that portion after the '@' character (if any) and before the '/' character (if any); it is the primary identifier and is the only REQUIRED element of a JID (a mere domain identifier is a valid JID).It usually representsTypically a domain identifier identifies thenetwork or"home" server to whichother entitiesclients connect for XML routing and data managementcapabilities. Note that afunctionality. (Note: A single server may host multiple domainidentifiers (local domains), and thatidentifiers, i.e., multiple local domains.) However, it is not necessary for an XMPP domainidentifiersidentifier toreference entitiesidentify an entity thatprovide traditionalprovides core XMPP server functionality (e.g., amulti-user chat service or adomain identifier may identity an entity such as a multi-user conference service, a publish-subscribe service, or a user directory). The domain identifier for every server or service that will communicate over a network SHOULD be a fully qualified domain name (see [DNS]) but MAY be either an IPv4 or IPv6 address or a text label (commonly called an "unqualified hostname") that is resolvable on a local network. If the domain identifier includes a final character considered to be a label separator (dot) by [IDNA] or [STD13], this character MUST be stripped from the domain identifier before the JID of which it is a part is used for the purpose of routing an XML stanza, comparing against another JID, or constructing an [XMPP-URI]; in particular, the character should be stripped before any other canonicalization steps are taken (such as application of the [NAMEPREP] profile of [STRINGPREP] or completion of the ToASCII operation as described in [IDNA]). Saint-Andre Expires January 18, 2008 [Page 10] Internet-Draft XMPP Core July 2007 A domain identifier MUST be an "internationalized domain name" as defined in [IDNA], that is, "a domain name in which every label is an internationalized label". When preparing a text label (consisting of a sequence of Unicode code points) for representation as anSaint-Andre Expires October 19, 2007 [Page 9] Internet-Draft XMPP Core April 2007internationalized label in the process of constructing an XMPP domain identifier or comparing two XMPP domain identifiers, an application MUST ensure that for each text label it is possible to apply without failing the ToASCII operation specified in [IDNA] with the UseSTD3ASCIIRules flag set (thus forbidding ASCII code points other than letters, digits, and hyphens). If the ToASCII operation can be applied without failing, then the label is an internationalized label. An internationalized domain name (and therefore an XMPP domain identifier) is constructed from its constituent internationalized labels by following the rules specified in [IDNA].Note:(Note: The ToASCII operation includes application of the [NAMEPREP] profile of [STRINGPREP] and encoding using the algorithm specified in [PUNYCODE]; for details, see[IDNA].[IDNA].) 3.3. Node Identifier The NODE IDENTIFIER portion of a JID is an optional secondary identifier placed before the domain identifier and separated from the latter by the '@' character.It usually representsTypically a node identifier uniquely identifies the entity requesting and using network access provided by a server (i.e., aclient),local account), although it can also represent other kinds of entities (e.g., a chat room associated with amulti-user chatmulti- user conference service). The entity represented byaan XMPP node identifier is addressed within the context of a specificdomain; within instant messaging and presence applications of XMPP, this addressdomain. When the domain iscalled a "bare JID"an XMPP server and the entity isofa local account on the server, the resulting address (of the form<node@domain>.<node@domain>) is called a BARE JID. A node identifier MUST be formatted such that the Nodeprep profile of [STRINGPREP] can be applied without failing (see Appendix A). Before comparing two node identifiers, an application MUST first apply the Nodeprep profile to each identifier. 3.4. Resource Identifier The RESOURCE IDENTIFIER portion of a JID is an optional tertiary identifier placed after the domain identifier and separated from the latter by the '/' character. A resource identifier may modify either a <node@domain> address or a mere <domain> address.It usually representsTypically a resource identifier uniquely identifies a specific connection (e.g., a device or location) or object (e.g., a participant in a multi-userchatconference room) belonging to the entity associated withaan XMPP nodeidentifier.identifier at a local domain. A resource identifier has no semantic meaning and is opaque to both servers andother clients, andclients. A resource Saint-Andre Expires January 18, 2008 [Page 11] Internet-Draft XMPP Core July 2007 identifier istypically defined bynegotiated between a clientimplementation when it provides the information necessary to complete Resource Binding (Section 8) (although it may be generated byand a serveron behalf of a client),during resource binding (Section 8), after which the entity is referred to as a"connected resource"CONNECTED RESOURCE and its address (of the form <node@domain/resource>) isreferrredreferred to as a"full JID" (<node@domain/resource>).FULL JID. An entity MAY maintain multiple connected resources simultaneously, with each connected resource differentiated by a distinct resource identifier.Saint-Andre Expires October 19, 2007 [Page 10] Internet-Draft XMPP Core April 2007A resource identifier MUST be formatted such that the Resourceprep profile of [STRINGPREP] can be applied without failing (see Appendix B). Before comparing two resource identifiers, an application MUST first apply the Resourceprep profile to each identifier. 3.5. Determination of Addresses After SASL negotiation (Section 7) and, if appropriate,Resource Bindingresource binding (Section 8), the receiving entity for a stream MUST determine the initiating entity's JID. For server-to-servercommunications,communication, the initiating entity's JID SHOULD be the authorization identity, derived from the authenticationidentity, asidentity (as defined by[SASL],[SASL]), if no authorization identity was specified during SASL negotiation (Section 7). For client-to-servercommunications,communication, the"bare JID"bare JID (<node@domain>) SHOULD be the authorization identity, derived from the authenticationidentity, asidentity (as definedin [SASL],by [SASL]), if no authorization identity was specified during SASL negotiation (Section 7); the resource identifier portion of the"full JID"full JID (<node@domain/resource>) SHOULD be the resource identifier negotiated by the client and server duringResource Bindingresource binding (Section 8). The receiving entity MUST ensure that the resulting JID (including node identifier, domain identifier, resource identifier, and separator characters) conforms to the rules and formats defined earlier in this section; to meet this restriction, the receiving entity may need to replace the JID sent by the initiating entity with the canonicalized JID as determined by the receiving entity. 4. TCP BindingAlthough thereAs XMPP isno necessary coupling ofdefined herein, anXML stream toinitiating entity (client or server) MUST open a[TCP] connection (e.g., two entities could connect to each other via another transport, e.g. [HTTP] as specified in [XEP-0124] and [XEP-0206]), this specification defines a binding of XMPP to TCP only. Therefore, as XMPP is defined herein, an initiating entity (client or server) MUST open a TCPTCP connection at the receiving entity (server) before it negotiates XML streams with the receiving entity. However, prior to opening the TCPconnectionconnection, the initiating entity first MUST resolve the Domain Name System (DNS) hostname associated with the receiving entity and determine the appropriate TCP port forcommunicationscommunication withthe receiving entity. The process is as follows:Saint-Andre ExpiresOctober 19, 2007January 18, 2008 [Page11]12] Internet-Draft XMPP CoreAprilJuly 2007 the receiving entity. The process is: 1. Attempt to resolve the hostname using a [DNS-SRV] Service of "xmpp-client" (for client-to-server connections) or "xmpp-server" (for server-to-server connections) and Proto of "tcp", resulting in resource records such as "_xmpp-client._tcp.example.com." or "_xmpp-server._tcp.example.com."; the IP address and port at which the initiating entity attempts to connect to the receiving entity shall be those specified in the SRV lookup result. 2. If the SRV lookup fails, the fallback SHOULD be a normal IPv4 or [IPv6] address record resolution to determine the IP address, where the port used is the "xmpp-client" port of 5222 for client- to-serverconnectionsnconnections or the "xmpp-server" port 5269 forclient-server- to-server connections. 3.However,For client-to-server connections, the fallback MAY be aDNS TXT[DNS-TXT] lookup(see [DNS-TXT])for alternative connection methods, for example as described in [XEP-0156]. TCP connections are handled differently in client-to-servercommunicationscommunication and server-to-servercommunications.ommunication. Specifically: o Because a client is subordinate to a server and therefore a client authenticates to the server but the server does not authenticate to the client, it is necessary to have only one TCP connection between client and server. Thus the server MUST allow the client to share a single TCP connection for XML stanzas sent from client to server and from server to client (i.e., the inital stream and response stream as specified underXML Streams (Section 5)).Section 5). o Because two servers are peers and therefore eachpeerspeer must authenticate with the other, the servers MUST use two TCP connections: one for XML stanzas sent from the first server to the second server and another (initiated by the second server) for stanzas from the second server to the first server. Note: There is no necessary coupling of an XML stream to a [TCP] connection. For example, two entities could connect to each other via another transport, such as [HTTP] as specified in [XEP-0124] and [XEP-0206]. However, this specification defines a binding of XMPP to TCP only. 5. XML Streams 5.1. Overview Two fundamental concepts make possible the rapid, asynchronous exchange of relatively small payloads of structured information between presence-aware entities: XML streams and XML stanzas. These Saint-Andre Expires January 18, 2008 [Page 13] Internet-Draft XMPP Core July 2007 terms are defined asfollows:follows. Definition of XML Stream: An XML STREAM is a container for the exchange of XML elements between any two entities over a network. The start of an XML stream is denoted unambiguously by an opening XML <stream> tag (with appropriate attributes and namespace declarations), while the end of the XML stream is denoted unambiguously by a closing XML </stream> tag. During the life ofSaint-Andre Expires October 19, 2007 [Page 12] Internet-Draft XMPP Core April 2007the stream, the entity that initiated it can send an unbounded number of XML elements over the stream, either elements used to negotiate the stream (e.g., to complete TLS negotiation (Section 6) or SASL negotiation (Section 7)) or XML stanzas. The"initial stream"INITIAL STREAM is negotiated from the initiating entity(usually(typically a client or server) to the receiving entity(usually(typically a server), and can be seen as corresponding to the initiating entity's "connection" or "session" with the receiving entity. The initial stream enables unidirectional communication from the initiating entity to the receiving entity; in order to enable information exchange from the receiving entity to the initiating entity, the receiving entity MUST negotiate a stream in the opposite direction (the"response stream").RESPONSE STREAM). Definition of XML Stanza: An XML STANZA is a discrete semantic unit of structured information that is sent from one entity to another over an XML stream, and is the basic unit of meaning in XMPP. An XML stanza exists at the direct child level of the root <stream/> element and is said to be well-balanced if it matches the production [43] content of [XML]. The start of any XML stanza is denoted unambiguously by the element start tag at depth=1 of the XML stream (e.g., <presence>), and the end of any XML stanza is denoted unambiguously by the corresponding close tag at depth=1 (e.g., </presence>); a server MUST NOTprocess, deliver, or routeprocess a partial stanza and MUST NOT attach meaning to the transmission timing of any part of a stanza (before receipt of the close tag). The only XML stanzas defined herein are the <message/>, <presence/>, and <iq/> elements qualified by the default namespace for the stream, as described underXML Stanzas (Section 9);Section 9; an XML element sent for the purpose of TLS negotiation (Section6),6) or SASL negotiation (Section7), or server dialback (Appendix C)7) is not considered to be an XML stanza. An XML stanza MAY contain child elements (with accompanying attributes, elements, and XML character data) as necessary in order to convey the desired information, which MAY be qualified by any XML namespace (see[XML-NAMES]).[XML-NAMES] as well as Section 9.4 herein). Consider the example of a client's connection to a server. In order to connect to a server, a client MUST initiate an XML stream by sending an opening <stream> tag to the server, optionally preceded by a text declaration specifying the XML version and the character encoding supported (seeInclusion of Text Declaration (Section 12.4)Section 12.4 andCharacter Encoding (Section 12.5)).Section 12.5). Subject to Saint-Andre Expires January 18, 2008 [Page 14] Internet-Draft XMPP Core July 2007 local policies and service provisioning, the server SHOULD then reply with a second XML stream back to the client, again optionally preceded by a text declaration. Once the client has completed SASL negotiation (Section7),7) and resource binding (Section 8), the client MAY send an unbounded number of XML stanzas over the stream toany recipient on the network.any. When the client desires to close the stream, it simply sends a closing </stream> tagSaint-Andre Expires October 19, 2007 [Page 13] Internet-Draft XMPP Core April 2007to theserver; for details, seeserver (see Section5.6. Those who are accustomed to thinking of5.6). In essence, then, an XMLin a document-centric manner may wish to view a client's connection to a serverstream acts asconsisting of two open-ended XML documents: one froman envelope for all the XML stanzas sent during a connection. We can represent this in a simplistic fashion as follows. +--------------------+ | <stream> | |--------------------| | <presence> | | <show/> | | </presence> | |--------------------| | <message to='foo'> | | <body/> | | </message> | |--------------------| | <iq to='bar'> | | <query/> | | </iq> | |--------------------| | [ ... ] | |--------------------| | </stream> | +--------------------+ Note: Those who are accustomed to thinking of XML in a document- centric manner may wish to view a client's connection to a server as consisting of two open-ended XML documents: one from the client to the server and one from the server to the client. From this perspective, the root <stream/> element can be considered the document entity for each "document", and the two "documents" are built up through the accumulation of XML stanzas sent over the two XML streams. However, this perspective is a convenience only; XMPP does not deal in documents but in XML streams and XML stanzas.In essence, then, an XML stream acts as an envelope for all the XML stanzas sent during a connection. We can represent this in a simplistic fashion as follows: |--------------------| | <stream> | |--------------------| | <presence> | | <show/> | | </presence> | |--------------------| | <message to='foo'> | | <body/> | | </message> | |--------------------| | <iq to='bar'> | | <query/> | | </iq> | |--------------------| | ... | |--------------------| | </stream> | |--------------------|5.2. Stream Security For the purpose of stream security, both Transport Layer Security (see Section 6) and the Simple Authentication and Security Layer (see Section 7) are mandatory to implement. Saint-Andre Expires January 18, 2008 [Page 15] Internet-Draft XMPP Core July 2007 When negotiating XML streams in XMPP 1.0, TLS SHOULD be used as defined underTLS negotiation (Section 6)Section 6 and SASL MUST be used as defined underSASL negotiation (Section 7).Section 7. The initial stream and the response stream MUST be secured separately, although security in both directions MAY be established via mechanisms that provide mutual authentication.AnThe initiating entity SHOULD NOT attempt to send XMLStanzasstanzas (Section 9) over the stream before the stream has beenauthenticated, butauthenticated. However, if itdoes, thendoes attempt to do so, theotherreceiving entity MUST NOT accept such stanzas andSHOULDMUST return a <not-authorized/> stream error and then terminate both the XML stream and the underlying TCPconnection; note well that Saint-Andre Expires October 19, 2007 [Page 14] Internet-Draft XMPP Core April 2007 thisconnection. Note: This applies to XML stanzas only (i.e., <message/>, <presence/>, and <iq/> elements qualified by the default namespace) and not to XML elements used for stream negotiation (e.g., elements used to complete TLS negotiation (Section 6) or SASL negotiation (Section 7)). 5.3. Stream Attributes The attributes of thestreamroot <stream/> element are asfollows: ofollows. 5.3.1. from--In client-to-servercommunications,communication, the 'from' attribute SHOULD be included in the XML stream header sent from the initiating entity to the receiving entity and (if included) MUST be set to the account name (i.e.,"bare JID"bare JID = <node@domain>) of the entity controlling the client. C: <?xml version='1.0'?> <stream:stream from='juliet@example.com' to='example.com' version='1.0' xml:lang='en' xmlns='jabber:client' xmlns:stream='http://etherx.jabber.org/streams'> In server-to-servercommunications,communication, the 'from' attribute SHOULD be included in the XML stream header sent from the initiating entity to the receiving entity and (if included) MUST be set to a hostname serviced by the initiating entity. Saint-Andre Expires January 18, 2008 [Page 16] Internet-Draft XMPP Core July 2007 P: <?xml version='1.0'?> <stream:stream from='example.net' to='example.com' version='1.0' xml:lang='en' xmlns='jabber:server' xmlns:stream='http://etherx.jabber.org/streams'> In both client-to-server and server-to-server communications, the 'from' attribute MUST be included in the XML stream header by which the receiving entity responds to the initiating entity and MUST be set to a hostname serviced by the receiving entity that is granting access to the initiating entity. S: <?xml version='1.0'?> <stream:stream from='example.com' id='++TR84Sm6A3hnt3Q065SnAbbk3Y=' to='juliet@example.com' version='1.0' xml:lang='en' xmlns='jabber:client' xmlns:stream='http://etherx.jabber.org/streams'> Note: Each entity MUST verify the identity of the other entity before exchanging XML stanzas with it (seethe Client-to-Server Communications (Section 15.3)Section 15.3 andServer-to-Server Communications (Section 15.4) sections of this document for details). oSection 15.4). 5.3.2. to--In both client-to-server and server-to-server communications, the 'to' attribute SHOULD be included in the XML stream header sent from the initiating entity to the receiving entity and (if included) MUST be set to a hostname serviced by the receiving entity. C: <?xml version='1.0'?> <stream:stream from='juliet@example.com' to='example.com' version='1.0' xml:lang='en' xmlns='jabber:client' xmlns:stream='http://etherx.jabber.org/streams'> In client-to-servercommunications,communication, if the client included a 'from' address in the initial stream header then the server SHOULD include a 'to' attribute in the XML stream header by which it replies to the client and (if included) MUST set the 'to' attribute to the bare JID Saint-Andre Expires January 18, 2008 [Page 17] Internet-Draft XMPP Core July 2007 specified in the 'from' attribute of the XML stream header sent from the initiating entity to the receiving entity. S: <?xml version='1.0'?> <stream:stream from='example.com' id='++TR84Sm6A3hnt3Q065SnAbbk3Y=' to='juliet@example.com' version='1.0' xml:lang='en' xmlns='jabber:client' xmlns:stream='http://etherx.jabber.org/streams'> In server-to-servercommunications,communication, if the initiating entity included a 'from' address in the initial stream header then the receiving entity SHOULD include a 'to' attribute in the XML stream header by which it replies to the initiating entity and (if included) MUST set the 'to' attribute to the hostname specified in the 'from' attribute of the XML stream header sent from the initiating entity to the receiving entity. S: <?xml version='1.0'?> <stream:stream from='example.com' id='g4qSvGvBxJ+xeAd7QKezOQJFFlw=' to='example.net' version='1.0' xml:lang='en' xmlns='jabber:server' xmlns:stream='http://etherx.jabber.org/streams'> Note: Each entity MUST verify the identity of the other entity before exchanging XML stanzas with it (seethe Client-to-Server Communications (Section 15.3)Section 15.3 andServer-to-Server Communications (Section 15.4) sections of this document for details).Section 15.4). 5.3.3. id There SHOULD NOT be an 'id' attribute on the XML stream header sent from the initiating entity to the receiving entity; however, if an 'id' attribute is included, it SHOULD be silently ignored by the receiving entity. C: <?xml version='1.0'?> <stream:stream from='juliet@example.com' to='example.com' version='1.0' xml:lang='en' xmlns='jabber:client' Saint-Andre ExpiresOctober 19, 2007January 18, 2008 [Page15]18] Internet-Draft XMPP CoreAprilJuly 2007o id --xmlns:stream='http://etherx.jabber.org/streams'> The 'id' attribute SHOULD be used only in the XML stream header from the receiving entity to the initiating entity. This attribute is a unique identifier created by the receiving entity to function as a identifier for the initiating entity's two streams with the receiving entity, and MUST be unique within the receiving application (normally a server).Note well that theS: <?xml version='1.0'?> <stream:stream from='example.com' id='++TR84Sm6A3hnt3Q065SnAbbk3Y=' to='juliet@example.com' version='1.0' xml:lang='en' xmlns='jabber:client' xmlns:stream='http://etherx.jabber.org/streams'> Note: The stream ID may be security-critical and therefore MUST be both unpredictable and nonrepeating (see [RANDOM] for recommendations regarding randomness for security purposes).There SHOULD NOT be an 'id' attribute on the XML stream header sent from the initiating entity to the receiving entity; however, if an 'id' attribute is included, it SHOULD be silently ignored by the receiving entity. o5.3.4. xml:lang--An 'xml:lang' attribute (as defined in Section 2.12 of [XML]) SHOULD be included by the initiating entity on the header for the initial stream to specify the default language of any human-readable XML character data it sends over that stream. C: <?xml version='1.0'?> <stream:stream from='juliet@example.com' to='example.com' version='1.0' xml:lang='en' xmlns='jabber:client' xmlns:stream='http://etherx.jabber.org/streams'> If the attribute is included, the receiving entity SHOULD remember that value as the default for both the initial stream and the response stream; if the attribute is not included, the receiving entity SHOULD use a configurable default value for both streams, which it MUST communicate in the header for the response stream. Saint-Andre Expires January 18, 2008 [Page 19] Internet-Draft XMPP Core July 2007 S: <?xml version='1.0'?> <stream:stream from='example.com' id='++TR84Sm6A3hnt3Q065SnAbbk3Y=' to='juliet@example.com' version='1.0' xml:lang='en' xmlns='jabber:client' xmlns:stream='http://etherx.jabber.org/streams'> For all stanzas sent over the initial stream, if the initiating entity does not include an 'xml:lang' attribute, the receiving entity SHOULD apply the default value; if the initiating entity does include an 'xml:lang' attribute, the receiving entity MUST NOT modify or delete it (see alsoxml:lang (Section 9.1.5)).Section 9.1.5). The value of the 'xml:lang' attribute MUSTbe anconform to the NMTOKEN datatype (as defined in Section 2.3 of [XML]) and MUST conform to the format defined in [LANGTAGS].o5.3.5. version--The presence of the version attribute set to a value of at least "1.0" signals support for the stream-related protocols (including stream features) defined in this specification.Detailed rules regarding the generation and handling of this attribute are defined in the text that follows. We can summarize as follows: +----------+--------------------------+-------------------------+ | | initiating to receiving | receiving to initiating | +----------+--------------------------+-------------------------+ | to | JID of receiver | JID of initiator | | from | JID of initiator | JID of receiver | | id | silently ignored | stream identifier | | xml:lang | default language | default language | | version | XMPP 1.0 supported | XMPP 1.0 supported | +----------+--------------------------+-------------------------+ Note: The attributes of the root <stream/> element are not prepended Saint-Andre Expires October 19, 2007 [Page 16] Internet-Draft XMPP Core April 2007 by a 'stream:' prefix because, in accordance with Section 5.3 of XML namespaces specification [XML-NAMES], the default namespace does not apply to attribute names. 5.3.1. Version SupportThe version of XMPP specified herein is "1.0"; in particular, this encapsulates the stream-related protocols (TLS negotiation (Section 6), SASL negotiation (Section 7), andStream Errorsstream errors (Section 5.8)), as well as the semantics of the three defined XML stanza types (<message/>, <presence/>, and <iq/>). The numbering scheme for XMPP versions is "<major>.<minor>". The major and minor numbers MUST be treated as separate integers and each number MAY be incremented higher than a single digit. Thus, "XMPP 2.4" would be a lower version than "XMPP 2.13", which in turn would be lower than "XMPP 12.3". Leading zeros (e.g., "XMPP 6.01") MUST be ignored by recipients and MUST NOT be sent. The major version number should be incremented only if the stream and stanza formats or required actions have changed so dramatically that an older version entity would not be able to interoperate with a newer version entity if it simply ignored the elements and attributes it did not understand and took the actions specified in the older specification. The minor version numberindicatesshould be incremented only if significant newcapabilities, andcapabilities have been added to the core protocol (e.g., a newly defined value of the 'type' attribute for message, presence, or IQ stanzas). The minor version number MUST be ignored by an entity with Saint-Andre Expires January 18, 2008 [Page 20] Internet-Draft XMPP Core July 2007 a smaller minor version number, but used for informational purposes by the entity with the larger minor versionnumber. For example, a minor versionnumbermight indicate the ability to process a newly defined value of the 'type' attribute for message, presence, or IQ stanzas;(e.g., the entity with the larger minor version number would simply note that its correspondent would not be able to understand that value of the 'type' attribute and therefore would not sendit.it). The following rules apply to the generation and handling of the 'version' attribute within streamheaders by implementations:headers: 1. The initiating entity MUST set the value of the 'version' attribute on the initial stream header to the highest version number it supports (e.g., if the highest version number it supports is that defined in this specification, it MUST set the value to "1.0"). 2. The receiving entity MUST set the value of the 'version' attribute on the response stream header to either the value supplied by the initiating entity or the highest version number supported by the receiving entity, whichever is lower. The receiving entity MUST perform a numeric comparison on the major and minor version numbers, not a string match on "<major>.<minor>".Saint-Andre Expires October 19, 2007 [Page 17] Internet-Draft XMPP Core April 20073. If the version number included in the response stream header is at least one major version lower than the version number included in the initial stream header and newer version entities cannot interoperate with older version entities asdescribed above,described, the initiating entity SHOULD generate an <unsupported-version/> stream error and terminate the XML stream and underlying TCP connection. 4. If either entity receives a stream header with no 'version' attribute, the entity MUST consider the version supported by the other entity to be "0.9" and SHOULD NOT include a 'version' attribute in the stream header it sends in reply.5.4. Namespace Declarations The stream5.3.6. Summary We can summarize the attributes of the root <stream/> elementMUST possess both a streams namespace declaration and a default namespace declarationas follows. +----------+--------------------------+-------------------------+ | | initiating to receiving | receiving to initiating | +----------+--------------------------+-------------------------+ | to | JID of receiver | JID of initiator | | from | JID of initiator | JID of receiver | | id | silently ignored | stream identifier | | xml:lang | default language | default language | | version | XMPP 1.0 supported | XMPP 1.0 supported | +----------+--------------------------+-------------------------+ Saint-Andre Expires January 18, 2008 [Page 21] Internet-Draft XMPP Core July 2007 Note: The attributes of the root <stream/> element are not prepended by a 'stream:' prefix because, in accordance with Section 5.3 of [XML-NAMES], the default namespace does not apply to attribute names. 5.4. Namespace Declarations The stream element MUST possess both a streams namespace declaration and a default namespace declaration (as "namespace declaration" is defined inthe[XML-NAMES]). For detailed information regarding the streams namespace and default namespace, seeNamespace Names and Prefixes (Section 12.2).Section 12.2. 5.5. Stream Features If the initiating entity includes the 'version' attribute set to a value of at least "1.0" in the initial stream header, after sending the header for the response stream the receiving entity MUST send a <features/> child element (prefixed by the streams namespace prefix) to the initiating entity in order to announce any stream-level features that can be negotiated (or capabilities that otherwise need to be advertised).Currently, this isS: <?xml version='1.0'?> <stream:stream from='example.com' id='++TR84Sm6A3hnt3Q065SnAbbk3Y=' to='juliet@example.com' version='1.0' xml:lang='en' xmlns='jabber:client' xmlns:stream='http://etherx.jabber.org/streams'> S: <stream:features> <starttls xmlns='urn:ietf:params:xml:ns:xmpp-tls'> <required/> </starttls> </stream:features> Stream features are usedonlymainly to advertise TLS negotiation (Section 6), SASL negotiation (Section 7), and resource binding (Section8), and server dialback (Appendix C) as defined herein;8); however,thestream featuresfunctionalityalso can be used to advertiseother negotiablefeaturesas well.associated with various XMPP extensions. If an entity does not understand or supportsome features,a feature, it SHOULD silently ignorethem.that feature. If one or more security features (e.g., TLS and SASL) need to be successfully negotiated before a non-security-related feature (e.g.,Resource Binding)resource binding) can be offered, thenon-security- relatednon-security-related feature SHOULD NOT be included in the stream features that are advertised before the relevant security features have been negotiated. Saint-Andre Expires January 18, 2008 [Page 22] Internet-Draft XMPP Core July 2007 If a feature must be negotiated before the initiating entity may proceed, that feature SHOULD include a <required/> child element.5.6. Closing Streams At any time after XML streams have been negotiated between two entities, either entity MAY close its streamIf there are no features tothe other entity (evenbe advertised (e.g., in theabsence of astreamerror) by sendingreset initiated after successful SASL negotiation for aclosing stream tag: Saint-Andre Expires October 19, 2007 [Page 18] Internet-Draft XMPP Core April 2007server-to-server connection, or after resource binding for a client-to-server stream) then the receiving entity MUST include an empty <stream:features/> element after sending a stream header to the initiating entity. S: <?xml version='1.0'?> <stream:stream from='example.com' id='++TR84Sm6A3hnt3Q065SnAbbk3Y=' to='juliet@example.com' version='1.0' xml:lang='en' xmlns='jabber:client' xmlns:stream='http://etherx.jabber.org/streams'> S: <stream:features/> 5.6. Closing Streams At any time after XML streams have been negotiated between two entities, either entity MAY close its stream to the other entity (even in the absence of a stream error) by sending a closing stream tag: C: </stream:stream> The entity that sends the closing stream tag SHOULD wait for the other entity to also close its stream: S: </stream:stream> However, the entity that sends the first closing stream tag MAY consider both streams to be void if the other entity does not send its closing stream tag within a reasonable amount of time (where the definition of "reasonable" is left up to the implementation or deployment). After an entity sends a closing stream tag, it MUST NOT send further data over that stream. After the entity that sent the first closing stream tag receives a reciprocal closing stream tag from the other entity, it MUST terminate the underlying TCP connection. Note: There is one TCP connection for client-to-server streams, but Saint-Andre Expires January 18, 2008 [Page 23] Internet-Draft XMPP Core July 2007 there are two TCP connections for server-to-server streams. 5.7. Reconnection It can happen that an XMPP server goes offline while servicing connections from clients and from other servers. Because the number of such connections can be quite large, the reconnection algorithm employed by entities that seek to reconnect can have a significant impact on software and network performance. The following guidelines are RECOMMENDED: o The time to live (TTL) specified in Domain Name System records SHOULD be honored, even if DNS results are cached; if the TTL has not expired, an entity that seeks to reconnect SHOULD NOT re- resolveDNSthe server hostname before reconnecting. o The time that expires before an entity first seeks to reconnect SHOULD be randomized (e.g., so that all clients do not attempt to reconnect 30 seconds after being disconnected). o If the first reconnection attempt does not succeed, an entity SHOULD back off exponentially on the time between subsequent reconnection attempts. 5.8. Stream Errors The root stream element MAY contain an <error/> child element that is prefixed by the streams namespace prefix. The error childMUSTshall be sent by a compliant entity(usually(typically a server rather than a client) if it perceives that a stream-level error has occurred.Saint-Andre Expires October 19, 2007 [Page 19] Internet-Draft XMPP Core April 20075.8.1. Rules The following rules apply to stream-levelerrors: o It is assumed that all stream-levelerrors. 5.8.1.1. Stream Errors Are Unrecoverable Stream-level errors areunrecoverable; therefore,unrecoverable. Therefore, if an error occurs at the level of the stream, the entity that detects the error MUST send a stream error to the other entity, send a closing </stream> tag, and terminate the underlying TCP connection.oC: <message><body></message> S: <stream:error> <xml-not-well-formed xmlns='urn:ietf:params:xml:ns:xmpp-streams'/> </stream:error> </stream:stream> Saint-Andre Expires January 18, 2008 [Page 24] Internet-Draft XMPP Core July 2007 5.8.1.2. Stream Errors Can Occur During Setup If the error occurs while the stream is being set up, the receiving entity MUST still send the opening <stream> tag, include the <error/> element as a child of the stream element, send the closing </stream> tag, and terminate the underlying TCP connection.In this case, ifC: <?xml version='1.0'?> <stream:stream from='juliet@example.com' to='example.com' version='1.0' xml:lang='en' xmlns='jabber:client' xmlns:stream='http://wrong.ns.example.org/'> S: <?xml version='1.0'?> <stream:stream from='example.com' id='++TR84Sm6A3hnt3Q065SnAbbk3Y=' to='juliet@example.com' version='1.0' xml:lang='en' xmlns='jabber:client' xmlns:stream='http://etherx.jabber.org/streams' <stream:error> <invalid-namespace xmlns='urn:ietf:params:xml:ns:xmpp-streams'/> </stream:error> </stream:stream> 5.8.1.3. Stream Errors When the Host is Unspecified If the initiating entity provides no 'to' attribute or provides an unknown host in the 'to' attribute(or provides no 'to' attribute at all),and theservererror occurs during stream setup, the receiving entity SHOULD providethe server'sits authoritative hostname in the 'from' attribute of the stream header sent before termination. Saint-Andre Expires January 18, 2008 [Page 25] Internet-Draft XMPP Core July 2007 C: <?xml version='1.0'?> <stream:stream from='juliet@example.com' version='1.0' xml:lang='en' xmlns='jabber:client' xmlns:stream='http://wrong.ns.example.org/'> S: <?xml version='1.0'?> <stream:stream from='example.com' id='++TR84Sm6A3hnt3Q065SnAbbk3Y=' to='juliet@example.com' version='1.0' xml:lang='en' xmlns='jabber:client' xmlns:stream='http://etherx.jabber.org/streams'> <stream:error> <invalid-namespace xmlns='urn:ietf:params:xml:ns:xmpp-streams'/> </stream:error> </stream:stream> 5.8.2. Syntax The syntax for stream errors is asfollows: <stream:error> <defined-conditionfollows, where "defined-condition" is a placeholder for one of the conditions defined under Section 5.8.3. <stream:error> <defined-condition xmlns='urn:ietf:params:xml:ns:xmpp-streams'/> [<text xmlns='urn:ietf:params:xml:ns:xmpp-streams' xml:lang='langcode'>OPTIONALdescriptive text </text>][OPTIONAL application-specific[application-specific condition element] </stream:error> The <error/> element: o MUST contain a child element corresponding to one of the definedstanzastream error conditionsdefined in the text that follows;(Section 5.8.3); this element MUST be qualified by the 'urn:ietf:params:xml:ns:xmpp-streams'namespacenamespace. o MAY contain a <text/> child element containing XML character data that describes the error in more detail; this element MUST be qualified by the 'urn:ietf:params:xml:ns:xmpp-streams' namespace and SHOULD possess an 'xml:lang' attribute specifying the natural language of the XML characterdatadata. Saint-Andre Expires January 18, 2008 [Page 26] Internet-Draft XMPP Core July 2007 o MAY contain a child element for an application-specific error condition; this element MUST be qualified by an application- defined namespace, and its structure is defined by that namespace (see Section 5.8.4). The <text/> element is OPTIONAL. If included, it SHOULD be used onlySaint-Andre Expires October 19, 2007 [Page 20] Internet-Draft XMPP Core April 2007to provide descriptive or diagnostic information that supplements the meaning of a defined condition or application-specific condition. It SHOULD NOT be interpreted programmatically by an application. It SHOULD NOT be used as the error message presented to a human user, but MAY be shown in addition to the error message associated with the included condition element (or elements). 5.8.3. Defined Stream Error Conditions The following stream-level error conditions aredefined: o <bad-format/> -- thedefined. 5.8.3.1. bad-format The entity has sent XML that cannot beprocessed; thisprocessed. C: <message><body></message> S: <stream:error> <bad-format xmlns='urn:ietf:params:xml:ns:xmpp-streams'/> </stream:error> </stream:stream> This error MAY be used instead of the more specific XML-related errors, such as <bad-namespace-prefix/>, <invalid-xml/>,<restricted-xml/>,<restricted- xml/>, <unsupported-encoding/>, and<xml-not-well- formed/>, although<xml-not-well-formed/>. However, the more specific errors are preferred.o <bad-namespace-prefix/> -- the5.8.3.2. bad-namespace-prefix The entity has sent a namespace prefix that is unsupported, or has sent no namespace prefix on an element that requires such a prefix (seeXML Namespace Names and Prefixes (Section 12.2)). o <conflict/> -- theSection 12.2). Saint-Andre Expires January 18, 2008 [Page 27] Internet-Draft XMPP Core July 2007 C: <?xml version='1.0'?> <stream:stream from='juliet@example.com' to='example.com' version='1.0' xmlns='jabber:client' xmlns:foobar='http://etherx.jabber.org/streams'> S: <?xml version='1.0'?> <stream:stream from='example.com' id='++TR84Sm6A3hnt3Q065SnAbbk3Y=' to='juliet@example.com' version='1.0' xml:lang='en' xmlns='jabber:client' xmlns:stream='http://etherx.jabber.org/streams'> <stream:error> <bad-namespace-prefix xmlns='urn:ietf:params:xml:ns:xmpp-streams'/> </stream:error> </stream:stream> 5.8.3.3. conflict The server is either (1) closing theactiveexisting stream for this entity because a new stream has been initiated that conflicts with the existingstream. o <connection-timeout/> --stream (2) is refusing a new stream for this entity because allowing the new stream would conflict with an existing stream (e.g., because the server allows only a certain number of connections for the same IP address). Saint-Andre Expires January 18, 2008 [Page 28] Internet-Draft XMPP Core July 2007 C: <?xml version='1.0'?> <stream:stream from='juliet@example.com' to='example.com' version='1.0' xmlns='jabber:client' xmlns:stream='http://etherx.jabber.org/streams'> S: <?xml version='1.0'?> <stream:stream from='example.com' id='++TR84Sm6A3hnt3Q065SnAbbk3Y=' to='juliet@example.com' version='1.0' xml:lang='en' xmlns='jabber:client' xmlns:stream='http://etherx.jabber.org/streams'> <stream:error> <conflict xmlns='urn:ietf:params:xml:ns:xmpp-streams'/> </stream:error> </stream:stream> 5.8.3.4. connection-timeout The entity has not generated any traffic over the stream for some period of time (configurable according to a local servicepolicy). o <host-gone/> --policy) and therefore the connection is being dropped. S: <stream:error> <connection-timeout xmlns='urn:ietf:params:xml:ns:xmpp-streams'/> </stream:error> </stream:stream> 5.8.3.5. host-gone The value of the 'to' attribute provided by the initiating entity in the stream header corresponds to a hostname that is no longer hosted by the server.o <host-unknown/> -- theSaint-Andre Expires January 18, 2008 [Page 29] Internet-Draft XMPP Core July 2007 P: <?xml version='1.0'?> <stream:stream from='example.net' to='foo.example.org' version='1.0' xmlns='jabber:server' xmlns:stream='http://etherx.jabber.org/streams'> S: <?xml version='1.0'?> <stream:stream from='example.com' id='g4qSvGvBxJ+xeAd7QKezOQJFFlw=' to='example.net' version='1.0' xml:lang='en' xmlns='jabber:server' xmlns:stream='http://etherx.jabber.org/streams'> <stream:error> <host-gone xmlns='urn:ietf:params:xml:ns:xmpp-streams'/> </stream:error> </stream:stream> 5.8.3.6. host-unknown The value of the 'to' attribute provided by the initiating entity in the stream header does not correspond to a hostname that is hosted by the server.o <improper-addressing/> -- a stanza sent between two servers lacks a 'to' or 'from' attribute (or theSaint-Andre Expires January 18, 2008 [Page 30] Internet-Draft XMPP Core July 2007 P: <?xml version='1.0'?> <stream:stream from='example.net' to='example.org' version='1.0' xmlns='jabber:server' xmlns:stream='http://etherx.jabber.org/streams'> S: <?xml version='1.0'?> <stream:stream from='example.com' id='g4qSvGvBxJ+xeAd7QKezOQJFFlw=' to='example.net' version='1.0' xml:lang='en' xmlns='jabber:server' xmlns:stream='http://etherx.jabber.org/streams'> <stream:error> <host-unknown xmlns='urn:ietf:params:xml:ns:xmpp-streams'/> </stream:error> </stream:stream> 5.8.3.7. improper-addressing A stanza sent between two servers lacks a 'to' or 'from' attribute (or the attribute has no value).o <internal-server-error/> -- theP: <message from='juliet@example.com'> <body>Wherefore art thou?</body> </message> S: <stream:error> <improper-addressing xmlns='urn:ietf:params:xml:ns:xmpp-streams'/> </stream:error> </stream:stream> 5.8.3.8. internal-server-error The server has experienced a misconfiguration or anotherwise-undefinedotherwise- undefined internal error that prevents it from servicing the stream.o <invalid-from/> -- theS: <stream:error> <internal-server-error xmlns='urn:ietf:params:xml:ns:xmpp-streams'/> </stream:error> </stream:stream> Saint-Andre Expires January 18, 2008 [Page 31] Internet-Draft XMPP Core July 2007 5.8.3.9. invalid-from The JID or hostname provided in a 'from' address does not match an authorized JID or validated domain negotiated between servers viaSASL or dialback,SASL, or between a client and a server via authentication and resource binding.o <invalid-id/> -- theP: <message from='romeo@example.org' to='juliet@example.com'> <body>Neither, fair saint, if either thee dislike.</body> </message> S: <stream:error> <improper-addressing xmlns='urn:ietf:params:xml:ns:xmpp-streams'/> </stream:error> </stream:stream> 5.8.3.10. invalid-id The stream ID or server dialback ID is invalid or does not match an ID previouslyprovided. o <invalid-namespace/> -- theprovided (the following example is from server dialback; see [XEP-0220]). P: <db:verify from='example.net' to='example.com' id='unknown-id-here' type='invalid'/> S: <stream:error> <invalid-id xmlns='urn:ietf:params:xml:ns:xmpp-streams'/> </stream:error> </stream:stream> 5.8.3.11. invalid-namespace The streams namespace name is something other than "http://etherx.jabber.org/streams"or the dialback namespace name is something other than "jabber:server:dialback"(seeXML Namespace Names and Prefixes (Section 12.2)).Section 12.2). Saint-Andre ExpiresOctober 19, 2007January 18, 2008 [Page21]32] Internet-Draft XMPP CoreAprilJuly 2007o <invalid-xml/> -- theC: <?xml version='1.0'?> <stream:stream from='juliet@example.com' to='example.com' version='1.0' xmlns='jabber:client' xmlns:stream='http://wrong.ns.example.org/'> S: <?xml version='1.0'?> <stream:stream from='example.com' id='++TR84Sm6A3hnt3Q065SnAbbk3Y=' to='juliet@example.com' version='1.0' xml:lang='en' xmlns='jabber:client' xmlns:stream='http://etherx.jabber.org/streams'> <stream:error> <invalid-namespace xmlns='urn:ietf:params:xml:ns:xmpp-streams'/> </stream:error> </stream:stream> 5.8.3.12. invalid-xml The entity has sent invalid XML over the stream to a server that performs validation (seeValidation (Section 12.3)). o <not-authorized/> --Section 12.3). (In the following example, a peer attempts to send an IQ stanza of type "subscribe" but there is no such value for the 'type' attribute.) P: <iq from='example.net' id='some-id' to='example.com' type='subscribe'> <ping xmlns='urn:xmpp:ping'/> </iq> S: <stream:error> <invalid-xml xmlns='urn:ietf:params:xml:ns:xmpp-streams'/> </stream:error> </stream:stream> 5.8.3.13. not-authorized The entity has attempted to send XML stanzas before the stream has been authenticated, or otherwise is not authorized to perform an action related to stream negotiation; the receiving entity MUST NOT Saint-Andre Expires January 18, 2008 [Page 33] Internet-Draft XMPP Core July 2007 process the offending stanza before sending the stream error.o <policy-violation/> -- the entity has violated some local service policy (e.g.,(In theentity is onfollowing example, aprovisioned blacklist); the server MAY chooseclient attempts tospecify the policy insend XML stanzas before authenticating with the<text/> element or anserver.) C: <?xml version='1.0'?> <stream:stream from='juliet@example.com' to='example.com' version='1.0' xmlns='jabber:client' xmlns:stream='http://etherx.jabber.org/streams'> S: <?xml version='1.0'?> <stream:stream from='example.com' id='++TR84Sm6A3hnt3Q065SnAbbk3Y=' to='juliet@example.com' version='1.0' xml:lang='en' xmlns='jabber:client' xmlns:stream='http://etherx.jabber.org/streams' C: <message to='romeo@example.net'> <body>Wherefore art thou?</body> </message> S: <stream:error> <not-authorized xmlns='urn:ietf:params:xml:ns:xmpp-streams'/> </stream:error> </stream:stream> 5.8.3.14. policy-violation The entity has violated some local service policy (e.g., the stanza exceeds a configured size limit); the server MAY choose to specify the policy in the <text/> element or an application-specific condition element.o <remote-connection-failed/> -- theC: <message to='juliet@example.com' id='foo'> <body>[ ... the-emacs-manual ... ]</body> </message> S: <stream:error> <policy-violation xmlns='urn:ietf:params:xml:ns:xmpp-streams'/> </stream:error> Saint-Andre Expires January 18, 2008 [Page 34] Internet-Draft XMPP Core July 2007 S: </stream:stream> 5.8.3.15. remote-connection-failed The server is unable to properly connect to a remote entity that is required for authentication or authorization.o <resource-constraint/> -- theC: <?xml version='1.0'?> <stream:stream from='juliet@example.com' to='example.com' version='1.0' xmlns='jabber:client' xmlns:stream='http://etherx.jabber.org/streams'> S: <?xml version='1.0'?> <stream:stream from='example.com' id='++TR84Sm6A3hnt3Q065SnAbbk3Y=' to='juliet@example.com' version='1.0' xml:lang='en' xmlns='jabber:client' xmlns:stream='http://etherx.jabber.org/streams'> <stream:error> <remote-connection-failed xmlns='urn:ietf:params:xml:ns:xmpp-streams'/> </stream:error> </stream:stream> 5.8.3.16. resource-constraint The server lacks the system resources necessary to service the stream.o <restricted-xml/> -- theSaint-Andre Expires January 18, 2008 [Page 35] Internet-Draft XMPP Core July 2007 C: <?xml version='1.0'?> <stream:stream from='juliet@example.com' to='example.com' version='1.0' xmlns='jabber:client' xmlns:stream='http://etherx.jabber.org/streams'> S: <?xml version='1.0'?> <stream:stream from='example.com' id='++TR84Sm6A3hnt3Q065SnAbbk3Y=' to='juliet@example.com' version='1.0' xml:lang='en' xmlns='jabber:client' xmlns:stream='http://etherx.jabber.org/streams'> <stream:error> <resource-constraint xmlns='urn:ietf:params:xml:ns:xmpp-streams'/> </stream:error> </stream:stream> 5.8.3.17. restricted-xml The entity has attempted to send restricted XML features such as a comment, processing instruction, DTD, entity reference, or unescaped character (seeRestrictions (Section 12.1)). o <see-other-host/> -- theSection 12.1). C: <message to='juliet@example.com'> <body><!--just a comment!--></body> </message> S: <stream:error> <restricted-xml xmlns='urn:ietf:params:xml:ns:xmpp-streams'/> </stream:error> </stream:stream> 5.8.3.18. see-other-host The server will not provide service to the initiating entity but is redirecting traffic to another host; the XML character data of the <see-other-host/> element returned by the server SHOULD specify the alternate hostname or IP address at which to connect, which SHOULD be a valid domain identifier but may also include a port number; if no port is specified, the initiating entity SHOULD perform a [DNS-SRV] lookup on the provided domain identifier but MAY assume that it can Saint-Andre Expires January 18, 2008 [Page 36] Internet-Draft XMPP Core July 2007 connect to that domain identifier at the standard XMPP ports (5222 for client-to-server connections and 5269 for server-to-server connections).o <system-shutdown/> -- theC: <?xml version='1.0'?> <stream:stream from='juliet@example.com' to='example.com' version='1.0' xmlns='jabber:client' xmlns:stream='http://etherx.jabber.org/streams'> S: <?xml version='1.0'?> <stream:stream from='example.com' id='++TR84Sm6A3hnt3Q065SnAbbk3Y=' to='juliet@example.com' version='1.0' xml:lang='en' xmlns='jabber:client' xmlns:stream='http://etherx.jabber.org/streams'> <stream:error> <see-other-host xmlns='urn:ietf:params:xml:ns:xmpp-streams'> xmpp.example.com:9090 </see-other-host> </stream:error> </stream:stream> 5.8.3.19. system-shutdown The server is being shut down and all active streams are being closed.o <undefined-condition/> -- theS: <stream:error> <system-shutdown xmlns='urn:ietf:params:xml:ns:xmpp-streams'/> </stream:error> </stream:stream> 5.8.3.20. undefined-condition The error condition is not one of those defined by the other conditions in this list; this error condition SHOULD be used only in conjunction with an application-specific condition.o <unsupported-encoding/> -- theSaint-Andre Expires January 18, 2008 [Page 37] Internet-Draft XMPP Core July 2007 S: <stream:error> <undefined-condition xmlns='urn:ietf:params:xml:ns:xmpp-streams'/> <app-error xmlns='some-application-ns'/> </stream:error> </stream:stream> 5.8.3.21. unsupported-encoding The initiating entity has encoded the stream in an encoding that is not supported by the server (seeCharacter Encoding (Section 12.5)). o <unsupported-stanza-type/> -- theSection 12.5). C: <?xml version='1.0' encoding='UTF-16'?> <stream:stream from='juliet@example.com' to='example.com' version='1.0' xmlns='jabber:client' xmlns:stream='http://etherx.jabber.org/streams'> S: <?xml version='1.0'?> <stream:stream from='example.com' id='++TR84Sm6A3hnt3Q065SnAbbk3Y=' to='juliet@example.com' version='1.0' xml:lang='en' xmlns='jabber:client' xmlns:stream='http://etherx.jabber.org/streams' <stream:error> <unsupported-encoding xmlns='urn:ietf:params:xml:ns:xmpp-streams'/> </stream:error> </stream:stream> 5.8.3.22. unsupported-stanza-type The initiating entity has sent a first-level child of the stream that is not supported by the server.o <unsupported-version/> --Saint-Andre Expires January 18, 2008 [Page 38] Internet-Draft XMPP Core July 2007 C: <pubsub> <publish node='princely_musings'> <item id='ae890ac52d0df67ed7cfdf51b644e901'> <entry xmlns='http://www.w3.org/2005/Atom'> <title>Soliloquy</title> <summary> To be, or not to be: that is the question: Whether 'tis nobler in the mind to suffer The slings and arrows of outrageous fortune, Or to take arms against a sea of troubles, And by opposing end them? </summary> <link rel='alternate' type='text/html' href='http://denmark.lit/2003/12/13/atom03'/> <id>tag:denmark.lit,2003:entry-32397</id> <published>2003-12-13T18:30:02Z</published> <updated>2003-12-13T18:30:02Z</updated> </entry> </item> </publish> </pubsub> S: <stream:error> <unsupported-stanza-type xmlns='urn:ietf:params:xml:ns:xmpp-streams'/> </stream:error> </stream:stream> 5.8.3.23. unsupported-version The value of the 'version' attribute provided by the initiating entity in the stream header specifies a version of XMPP that is not supported by the server; the server MAY specify the version(s) it supports in the <text/> element. Saint-Andre ExpiresOctober 19, 2007January 18, 2008 [Page22]39] Internet-Draft XMPP CoreAprilJuly 2007oC: <?xml version='1.0'?> <stream:stream from='juliet@example.com' to='example.com' version='11.0' xmlns='jabber:client' xmlns:stream='http://etherx.jabber.org/streams'> S: <?xml version='1.0'?> <stream:stream from='example.com' id='++TR84Sm6A3hnt3Q065SnAbbk3Y=' to='juliet@example.com' version='1.0' xml:lang='en' xmlns='jabber:client' xmlns:stream='http://etherx.jabber.org/streams' <stream:error> <unsupported-version xmlns='urn:ietf:params:xml:ns:xmpp-streams'/> </stream:error> </stream:stream> 5.8.3.24. xml-not-well-formed <xml-not-well-formed/> -- the initiating entity has sent XML that is not well-formed as defined by [XML]. C: <message><body></message> S: <stream:error> <xml-not-well-formed xmlns='urn:ietf:params:xml:ns:xmpp-streams'/> </stream:error> </stream:stream> 5.8.4. Application-Specific Conditions As noted, an application MAY provide application-specific stream error information by including a properly-namespaced child in the error element. The application-specific element SHOULD supplement or further qualify a defined element. Thus the <error/> element will contain two or three child elements: Saint-Andre Expires January 18, 2008 [Page 40] Internet-Draft XMPP Core July 2007 C: <message> <body> My keyboard layout is: QWERTYUIOP{}| ASDFGHJKL:" ZXCVBNM<>? </body> </message> S: <stream:error> <xml-not-well-formed xmlns='urn:ietf:params:xml:ns:xmpp-streams'/> <text xml:lang='en' xmlns='urn:ietf:params:xml:ns:xmpp-streams'> Some special application diagnostic information! </text> <escape-your-data xmlns='application-ns'/> </stream:error> </stream:stream> 5.9. Simplified Stream Examples This section contains two simplified examples of a stream-based connection of a client on a server (where the "C" lines are sent from the client to the server, and the "S" lines are sent from the server to the client); these examples are included for the purpose of illustrating the concepts introduced thus far. Saint-Andre ExpiresOctober 19, 2007January 18, 2008 [Page23]41] Internet-Draft XMPP CoreAprilJuly 2007 A basic connection: C: <?xml version='1.0'?> <stream:streamxmlns='jabber:client' xmlns:stream='http://etherx.jabber.org/streams' xml:lang='en'from='juliet@example.com' to='example.com'version='1.0'>version='1.0' xml:lang='en' xmlns='jabber:client' xmlns:stream='http://etherx.jabber.org/streams' S: <?xml version='1.0'?> <stream:streamxmlns='jabber:client' xmlns:stream='http://etherx.jabber.org/streams' xml:lang='en'from='example.com'id='someid'id='++TR84Sm6A3hnt3Q065SnAbbk3Y=' to='juliet@example.com'version='1.0'>version='1.0' xml:lang='en' xmlns='jabber:client' xmlns:stream='http://etherx.jabber.org/streams'> [ ... encryption, authentication, and resource binding ... ] C: <message from='juliet@example.com/balcony' to='romeo@example.net' xml:lang='en'>C:<body>Art thou not Romeo, and a Montague?</body>C:</message> S: <message from='romeo@example.net/orchard' to='juliet@example.com/balcony' xml:lang='en'>S:<body>Neither, fair saint, if either thee dislike.</body>S:</message> C: </stream:stream> S: </stream:stream> Saint-Andre ExpiresOctober 19, 2007January 18, 2008 [Page24]42] Internet-Draft XMPP CoreAprilJuly 2007 A connection gone bad: C: <?xml version='1.0'?> <stream:streamxmlns='jabber:client' xmlns:stream='http://etherx.jabber.org/streams' xml:lang='en'from='juliet@example.com' to='example.com'version='1.0'>version='1.0' xml:lang='en' xmlns='jabber:client' xmlns:stream='http://etherx.jabber.org/streams'> S: <?xml version='1.0'?> <stream:streamxmlns='jabber:client' xmlns:stream='http://etherx.jabber.org/streams' xml:lang='en'from='example.com'id='someid'id='++TR84Sm6A3hnt3Q065SnAbbk3Y=' to='juliet@example.com'version='1.0'>version='1.0' xml:lang='en' xmlns='jabber:client' xmlns:stream='http://etherx.jabber.org/streams'> [ ... encryption, authentication, and resource binding ... ] C: <message from='juliet@example.com/balcony' to='romeo@example.net' xml:lang='en'> <body>Bad XML, no closing body tag! </message> S: <stream:error> <xml-not-well-formed xmlns='urn:ietf:params:xml:ns:xmpp-streams'/> </stream:error>S:</stream:stream> More detailed examples are provided under Section 10. 6.TLSSTARTTLS Negotiation 6.1. Overview XMPP includes a method for securing the stream from tampering and eavesdropping. This channel encryption method makes use of the Transport Layer Security(TLS)protocol[TLS], along with(see [TLS]), specifically a "STARTTLS" extension that is modelled after similar extensions for the [IMAP], [POP3], and [ACAP] protocols as described in [USINGTLS]. Saint-Andre Expires January 18, 2008 [Page 43] Internet-Draft XMPP Core July 2007 The XML namespace name for the STARTTLS extension is 'urn:ietf:params:xml:ns:xmpp-tls'. Support for STARTTLS is REQUIRED in XMPP client and server implementations. An administrator of a givendomain MAYdeployment may require the use of TLS for client-to-servercommunications,communication, server-to-servercommunications,communication, or both.Clients SHOULDA deployed client should use TLS to securethe streamsits stream with a server prior to attempting the completion of SASL negotiation (Section 7), andSaint-Andre Expires October 19, 2007 [Page 25] Internet-Draft XMPP Core April 2007deployed serversSHOULDshould use TLS between two domains for the purpose of securing server-to-servercommunications.communication. 6.2. Rules 6.2.1. Data Formatting Thefollowing rules apply: 1. An initiating entity that complies with this specificationentities MUSTinclude the 'version' attribute set to a valueNOT send any white space characters (matching production [3] content of"1.0" in[XML]) within theinitialroot streamheader. 2. If the TLS negotiation occurselement as separators betweentwo servers, communications MUST NOT proceed until the Domain Name System (DNS) hostnames asserted byelements (any white space characters shown in theservers have been resolved (see Server-to-Server Communications (Section 15.4)). 3. When a receiving entity that complies withSTARTTLS examples provided in thisspecification receives an initial stream header that includesdocument are included for the'version' attribute set to a valuesake ofat least "1.0", after sending a stream header in reply (including the version flag), it MUST include a <starttls/> element (qualified by the 'urn:ietf:params:xml:ns:xmpp-tls' namespace) along with the listreadability only); this prohibition helps to ensure proper security layer byte precision. 6.2.2. Order ofother stream features it supports. 4.Negotiation If the initiating entity chooses to use TLS,TLSSTARTTLS negotiation MUST be completed before proceeding to SASLnegotiation;negotiation (Section 7); this order of negotiation is required to help safeguard authentication information sent during SASL negotiation, as well as to make it possible to base the use of the SASL EXTERNAL mechanism on a certificate (or other credentials) provided during prior TLS negotiation.5. During TLS negotiation, an6.3. Process 6.3.1. Exchange of Stream Headers and Stream Features The initiating entityMUST NOT send any white space characters (matching production [3] contentresolves the hostname of[XML]) withintheroot stream elementreceiving entity asseparators between elements (any white space characters shown inspecified under Section 4, opens a TCP connection to theTLS examples that follow are included foradvertised port at thesake of readability only); this prohibition helpsresolved IP address, and sends an initial stream header toensure proper security layer byte precision. 6. Thethe receiving entity; if the initiating entity is capable of STARTTLS negotiation, it MUSTconsiderinclude theTLS negotiation'version' attribute set tohave begun immediately after sending the closing ">" charactera value of at least "1.0" in the<proceed/> element to the initiating entity.initial stream header. Saint-Andre Expires January 18, 2008 [Page 44] Internet-Draft XMPP Core July 2007 I: <stream:stream from='juliet@example.com' to='example.com' version='1.0' xml:lang='en' xmlns='jabber:client' xmlns:stream='http://etherx.jabber.org/streams'> Theinitiatingreceiving entity MUSTconsidersend a response stream header to theTLS negotiation to have begun immediately after receivinginitiating entity over theclosing ">" character ofTCP connection opened by the<proceed/> element frominitiating entity (for client-to-server streams) or over a new TCP connection (for server-to-server streams); if the receivingentity. 7. The initiatingentity is capable of STARTTLS negotiation, it MUSTvalidateinclude thecertificate presented by'version' attribute set to a value of at least "1.0" in the response stream header. R: <stream:stream from='example.com' id='t7AMCin9zjMNwQKDnplntZPIDEI=' to='juliet@example.com' version='1.0' xml:lang='en' xmlns='jabber:client' xmlns:stream='http://etherx.jabber.org/streams' The receivingentity; see Certificate Validation (Section 15.2) regarding certificate validation procedures. 8. Certificatesentity then MUSTbe checked against the hostname as provided bysend stream features to the initiatingentity (e.g.,entity, which SHOULD include auser), not<starttls/> element (qualified by thehostname as resolved via'urn:ietf:params:xml:ns:xmpp-tls' namespace) to indicate that theDomain Name System; e.g., ifreceiving entity supports STARTTLS negotiation. R: <stream:features> <starttls xmlns='urn:ietf:params:xml:ns:xmpp-tls'/> </stream:features> If theuser specifies a hostname of "example.net" but a [DNS-SRV] lookup returned "im.example.net",receiving entity requires thecertificate MUST be checkeduse of STARTTLS, it SHOULD include an empty <required/> element as"example.net". IfaJID for an XMPP client (e.g., an end user account) is represented inchild of the <starttls/> element. R: <stream:features> <starttls xmlns='urn:ietf:params:xml:ns:xmpp-tls'> <required/> </starttls> </stream:features> 6.3.2. Initiation of STARTTLS Negotiation In order to begin the STARTTLS negotiation, the initiating entity issues the STARTTLS command (i.e., acertificate, it MUST be represented<starttls/> element qualified by the 'urn:ietf:params:xml:ns:xmpp-tls' namespace) to instruct the Saint-Andre ExpiresOctober 19, 2007January 18, 2008 [Page26]45] Internet-Draft XMPP CoreAprilJuly 2007as a UTF8String within an otherNamereceiving entityinside the subjectAltName, using the [ASN.1] Object Identifier "id-on- xmppAddr" specified in Section 6.1.1 of this document. Ifthat it wishes to begin aJID for an XMPP server is represented inSTARTTLS negotiation to secure the stream. I: <starttls xmlns='urn:ietf:params:xml:ns:xmpp-tls'/> The receiving entity MUST reply with either acertificate, it SHOULD be represented as<proceed/> element (proceed case) or aUTF8String within an otherName entity inside<failure/> element (failure case) qualified by thesubjectAltName, using'urn:ietf:params:xml:ns:xmpp-tls' namespace. If the[ASN.1] Object Identifier "id-on- xmppAddr" specified in Section 6.1.1 of this document; however,failure case occurs, theJID for an XMPP server MAY also or instead be represented asreceiving entity MUST return asubjectAltName extension of type dNSName, where the dNSName may contain<failure/> element qualified by thewildcard character '*', which applies only to'urn:ietf:params:xml:ns:xmpp-tls' namespace, terminate theleft-most domain name component or component fragmentXML stream, andis considered to match any single component or component fragment (e.g., *.example.com matches foo.example.comterminate the underlying TCP connection. Causes for the failure case include but are notbar.foo.example.com, and im*.example.net matches im1.example.net and im2.example.net butlimited to: 1. The initiating entity has sent a malformed STARTTLS command. 2. The receiving entity does notchat.example.net). 9.offer STARTTLS negotiation either temporarily or permanently. 3. The receiving entity cannot complete STARTTLS negotiation because of an internal error. R: <failure xmlns='urn:ietf:params:xml:ns:xmpp-tls'/> R: </stream:stream> If theTLS negotiation is successful,proceed case occurs, theinitiatingreceiving entity MUSTsendreturn anew stream header to<proceed/> element qualified by the 'urn:ietf:params:xml:ns:xmpp-tls' namespace. R: <proceed xmlns='urn:ietf:params:xml:ns:xmpp-tls'/> Note: The receivingentity. 10. Ifentity MUST consider the TLS negotiationis successful,to have begun immediately after sending thereceiving entity MUST discard any knowledge obtained in an insecure manner fromclosing '>' character of the <proceed/> element to the initiating entity. The initiating entitybefore TLS takes effect. 11. IfMUST consider the TLS negotiationis successful,to have begun immediately after receiving theinitiating entity MUST discard any knowledge obtained in an insecure mannerclosing '>' character of the <proceed/> element from the receivingentity beforeentity. 6.3.3. TLStakes effect. 12. If theNegotiation The entities MUST now attempt to complete TLS negotiationis successful,over thereceiving entityTCP connection by following the process defined in [TLS]. Note: The entities MUST NOToffersend any further XML data until theSTARTTLS extension toTLS negotiation has either failed or succeeded. If theinitiatingreceiving entityalong withpresents a certificate during TLS negotiation, theother stream features that are offered afterinitiating entity MUST validate thenew stream header is received and responded to. 13. Ifcertificate in Saint-Andre Expires January 18, 2008 [Page 46] Internet-Draft XMPP Core July 2007 order to determine if the TLS negotiationis successful,shall succeed (see Section 15.2 regarding certificate validation procedures). Specifically, the certificate MUST be checked against the hostname as provided by the initiating entity (e.g., a user), not the hostname as resolved via the Domain Name System; e.g., if the user specifies a hostname of "example.net" but a [DNS-SRV] lookup returns "xmpp.example.net", the certificate MUSTcontinue with SASL negotiation. 14.be checked as "example.net". See Section 6.4 for information about the representation of XMPP addresses in certificates. Note: See Section 15.7 regarding ciphers that MUST be supported for TLS; naturally, other ciphers MAY be supported as well. 6.3.4. Failure If the TLS negotiation results in failure, the receiving entity MUST terminateboth the XML stream andtheunderlyingTCP connection.15. See Mandatory-to-Implement Technologies (Section 15.7) regarding mechanisms thatNote: It is not necessary to send a closing </stream> tag before terminating the TCP connection, since the receiving entity and initiating entity MUST consider the original stream to besupported. 6.1.1. ASN.1 Object Identifier for XMPP Address The [ASN.1] Object Identifier "id-on-xmppAddr" described above is defined as follows: id-pkix OBJECT IDENTIFIER ::= { iso(1) identified-organization(3) dod(6) internet(1) security(5) mechanisms(5) pkix(7) } id-on OBJECT IDENTIFIER ::= { id-pkix 8 } -- other name forms id-on-xmppAddr OBJECT IDENTIFIER ::= { id-on 5 } XmppAddr ::= UTF8String Saint-Andre Expires October 19, 2007 [Page 27] Internet-Draft XMPP Core April 2007 This Object Identifier MAY also be represented in dotted display format (i.e., "1.3.6.1.5.5.7.8.5") or inclosed upon failure of theUniform Resource Name notation specified in [URN-OID] (i.e., "urn:oid:1.3.6.1.5.5.7.8.5"). Thus for exampleTLS negotiation. 6.3.5. Success If theJID "example.com"TLS negotiation is successful, then the entities MUST proceed asincludedfollows. The receiving entity MUST discard any knowledge obtained ina certificate might be formatted as "subjectAltName=otherName: 1.3.6.1.5.5.7.8.5;UTF8:example.com". 6.2. Narrative Whenan insecure manner from the initiating entitysecures a stream with a receivingbefore TLS took effect. The initiating entityusing TLS,MUST discard any knowledge obtained in an insecure manner from thesteps involved are as follows: 1.receiving entity before TLS took effect. The initiating entityopensMUST send aTCP connection and initiates the stream by sending the opening XMLnew stream header to the receivingentity, includingentity over the'version' attribute setsecured TCP connection. I: <stream:stream from='juliet@example.com' to='example.com' version='1.0' xml:lang='en' xmlns='jabber:client' xmlns:stream='http://etherx.jabber.org/streams'> Note: It is not necessary to send avalue of at least "1.0". 2. The receiving entity responds by opening a TCP connection andclosing </stream> tag before sendingan XMLthe initial streamheader toheader, since the receiving entity and initiatingentity, includingentity MUST consider the'version' attribute setoriginal stream toa valuebe closed upon Saint-Andre Expires January 18, 2008 [Page 47] Internet-Draft XMPP Core July 2007 success ofat least "1.0". 3.the TLS negotiation. The receiving entityoffers the STARTTLS extension to the initiating entity by including it with the list of other supported stream features (if successful TLS negotiation is required for interactionMUST respond withthe receiving entity, it SHOULD signal that fact by including a <required/> element asachild of the <starttls/> element); theresponse stream header. R: <stream:stream from='example.com' id='vgKi/bkYME8OAj4rlXMkpucAqe4=' to='juliet@example.com' version='1.0' xml:lang='en' xmlns='jabber:client' xmlns:stream='http://etherx.jabber.org/streams' The receiving entitySHOULDalsoinclude a list of supported SASL mechanisms in theMUST send streamfeatures. 4. Thefeatures to the initiatingentity issuesentity, which MUST NOT include the STARTTLScommand (i.e., a <starttls/> element qualified by the 'urn:ietf:params:xml:ns:xmpp-tls' namespace) to instructfeature but which SHOULD include thereceiving entity that it wishes to begin aSASL stream feature as described under Section 7. R: <stream:features> <mechanisms xmlns='urn:ietf:params:xml:ns:xmpp-sasl'> <mechanism>EXTERNAL</mechanism> <mechanism>DIGEST-MD5</mechanism> <mechanism>PLAIN</mechanism> <required/> </mechanisms> </stream:features> 6.4. Representation of JIDs in Certificates TLS negotiationto secure the stream. 5. The receiving entity MUST reply with either a <proceed/> element oris commonly based on a<failure/> element qualifieddigital certificate presented by the'urn:ietf:params:xml:ns:xmpp-tls' namespace. Ifreceiving entity (or in thefailurecaseoccurs,of mutual authentication both the receiving entityMUST terminate both the XML streamand theunderlying TCP connection (failure cases include when theinitiatingentity sendsentity). If amalformed STARTTLS command, when the receiving entity does not offer TLS negotiation either temporarily or permanently, and when the receiving entity cannot complete TLS negotiation because ofJID for aninternal error). If the proceed case occurs, the entitiesXMPP user account is represented in a certificate, it MUSTattempt to complete the TLS negotiation overbe represented as a UTF8String within an otherName entity inside theTCP connection and MUST NOT send any further XML data untilsubjectAltName, using theTLS negotiation is complete. 6. The initiating entity and receiving entity attempt to complete a TLS negotiation[ASN.1] Object Identifier "id-on- xmppAddr" specified inaccordance with [TLS]. Saint-Andre Expires October 19, 2007 [Page 28] Internet-Draft XMPP Core April 2007 7. If the TLS negotiation is unsuccessful, the receiving entity MUST terminate the TCP connection.this section. Ifthe TLS negotiation is successful, the initiating entity MUST initiateanew stream by sendingJID for anopening XML stream header to the receiving entity (itXMPP server isnot necessary to sendrepresented in aclosing </stream> tag first, since the receiving entity and initiating entity MUST consider the original stream tocertificate, it SHOULD beclosed upon successful TLS negotiation). 8. Upon receiving the new stream header from the initiating entity, the receiving entity MUST respond by sendingrepresented as anew XML stream header to the initiatingUTF8String within an otherName entityalong with the available features (but not includinginside theSTARTTLS feature) and SHOULD include an updated list of SASL mechanisms so thatsubjectAltName, using theinitiating entity can detect any changes[ASN.1] Object Identifier "id- on-xmppAddr" specified in this section. However, in addition tothe listor instead ofSASL mechanisms supported bythereceiving entity. Examples of TLS negotiation are provided under Section 10. 7. SASL Negotiation 7.1. Overview XMPP includes a method for authenticating"id-on-xmppAddr" representation, it MAY be represented as astream by means of an XMPP-specific profilesubjectAltName extension of type dNSName; this dNSName MAY contain theSimple Authentication and Security Layer protocol (see [SASL]). SASL provides a generalized method for adding authentication supportwildcard character '*', which applies only toconnection-based protocols,the left- most domain name component or component fragment andXMPP usesis considered to match any single component or component fragment (e.g., *.example.com matches foo.example.com but not bar.foo.example.com, and im*.example.net matches im1.example.net and im2.example.net but not Saint-Andre Expires January 18, 2008 [Page 48] Internet-Draft XMPP Core July 2007 chat.example.net). The [ASN.1] Object Identifier "id-on-xmppAddr" is defined as follows. id-pkix OBJECT IDENTIFIER ::= { iso(1) identified-organization(3) dod(6) internet(1) security(5) mechanisms(5) pkix(7) } id-on OBJECT IDENTIFIER ::= { id-pkix 8 } -- other name forms id-on-xmppAddr OBJECT IDENTIFIER ::= { id-on 5 } XmppAddr ::= UTF8String This Object Identifier MAY be represented in dotted display format (i.e., "1.3.6.1.5.5.7.8.5") or in the Uniform Resource Name notation specified in [URN-OID] (i.e., "urn:oid:1.3.6.1.5.5.7.8.5"). Thus for example the JID "juliet@example.com" as included in a certificate could be formatted in any of the following three ways: o subjectAltName=otherName:id-on-xmppAddr;UTF8:juliet@example.com o subjectAltName=otherName:1.3.6.1.5.5.7.8.5;UTF8:juliet@example.com o subjectAltName=otherName:urn:oid:1.3.6.1.5.5.7.8.5;UTF8:juliet@ example.com 7. SASL Negotiation 7.1. Overview XMPP includes a method for authenticating a stream by means of an XMPP-specific profile of the Simple Authentication and Security Layer protocol (see [SASL]). SASL provides agenericgeneralized method for adding authentication support to connection-based protocols, and XMPP uses an XML namespace profileforof SASL that conforms to the profiling requirements of [SASL]. Support for SASL is REQUIRED in XMPP client and server implementations. 7.2. Rules 7.2.1. Data Formatting The following formatting rulesapply: 1. Ifapply to the data sent during SASLnegotiation occurs between two servers, communicationsnegotiation: Saint-Andre Expires January 18, 2008 [Page 49] Internet-Draft XMPP Core July 2007 1. The entities MUST NOTproceed untilsend any white space characters (matching production [3] content of [XML]) within theDomain Name System (DNS) hostnames asserted by the servers have been resolved (see Server-to-Server Communications (Section 15.4)). 2. If the initiating entity is capable of SASL negotiation, it MUST include the 'version' attribute set to a value of at least "1.0" in the initial stream header. 3. If the receiving entity is capable of SASL negotiation, it MUST advertise one or more authentication mechanisms within a <mechanisms/> element qualified by the 'urn:ietf:params:xml:ns:xmpp-sasl' namespace in reply to the opening stream tag received from the initiating entity (if the opening stream tag included the 'version' attribute set to a value of at least "1.0"). 4. During SASL negotiation, an entity MUST NOT send any white space characters (matching production [3] content of [XML]) within the root stream element as separators between elements (any white Saint-Andre Expires October 19, 2007 [Page 29] Internet-Draft XMPP Core April 2007 space characters shown inroot stream element as separators between elements (any white space characters shown in the SASL examplesthat followprovided in this document are included for the sake of readability only); this prohibition helps to ensure proper security layer byte precision.5.2. Any XML character data contained within the XML elementsused during SASL negotiationMUST be encoded using base64, where the encoding adheres to the definition in Section 4 ofRFC 3548 [BASE64]. 6. If[BASE64] and where thereceiving entity does not includepadding bits are set to zero. 7.2.2. Security Layers Upon successful SASL negotiation that involves negotiation of a'realm' value,security layer, the initiating entitymust default it to the domain identifier portion ofMUST discard any knowledge obtained from the receivingentity's JID. 7. If provision of a "simple username" is supported byentity which was not obtained from theselectedSASLmechanism (e.g., this is supported by the DIGEST-MD5 and CRAM-MD5 mechanisms but not bynegotiation itself. Upon successful SASL negotiation that involves negotiation of a security layer, theEXTERNAL and GSSAPI mechanisms), during authenticationreceiving entity MUST discard any knowledge obtained from the initiating entitySHOULD provide as the simple username itswhich was not obtained from the SASL negotiation itself. The receiving entity SHOULD also include an updated list of SASL mechanisms with the stream features so that the initiating entity is able to detect any changes to the list of mechanisms supported by the receiving entity. 7.2.3. Simple Usernames If provision of a "simple username" is supported by the selected SASL mechanism (e.g., this is supported by the DIGEST-MD5 and CRAM-MD5 mechanisms but not by the EXTERNAL and GSSAPI mechanisms), during authentication the initiating entity SHOULD provide as the simple username its sending domain (IP address or fully qualified domain name as contained inaan XMPP domain identifier) in the case of server-to-servercommunicationscommunication or its registered account name (user or node name as contained in an XMPP node identifier) in the case of client-to-servercommunications.communication. In either case, the initiating entity MUST ensure that the username adheres to the [NAMEPREP] or Nodeprep (Appendix A) profile of [STRINGPREP] (as appropriate) before sending it to the receiving entity.(Note: Account provisioning is out of scope for this specification; possible methods for account provisioning include account creation by a server administrator and in-band account registration using the 'jabber:iq:register' namespace as documented in [XEP-0077].) 8.7.2.4. Authorization Identities If the initiating entity wishes to act on behalf of another entity and the selected SASL mechanism supports transmission of an authorization identity, the initiating entity MUST provide an authorization identity during SASL negotiation. If the initiating entity does not wish to act on behalf of another entity, it MUST NOT Saint-Andre Expires January 18, 2008 [Page 50] Internet-Draft XMPP Core July 2007 provide an authorization identity. As specified in [SASL], the initiating entity MUST NOT provide an authorization identity unless the authorization identity is different from the default authorization identity derived from the authentication identity. If provided, the value of the authorization identity MUST be of the form <domain> (i.e.,aan XMPP domain identifier only) for servers and of the form <node@domain> (i.e., node identifier and domain identifier) for clients.9.7.3. Process The process for SASL negotiation is as follows. 7.3.1. Exchange of Stream Headers and Stream Features If SASL negotiation follows successful STARTTLS negotation (Section 6), then the SASL negotiationis successful,occurs over the existing stream. If not, the initiating entityMUST sendresolves the hostname of the receiving entity as specified under Section 4, opens anewTCP connection to the advertised port at the resolved IP address, and sends an initial stream header to the receivingentity. 10. Upon successful SASL negotiation that involves negotiationentity; if the initiating entity is capable of STARTTLS negotiation, it MUST include the 'version' attribute set to asecurity layer,value of at least "1.0" in the initial stream header. I: <stream:stream from='juliet@example.com' to='example.com' version='1.0' xml:lang='en' xmlns='jabber:client' xmlns:stream='http://etherx.jabber.org/streams'> The receiving entity MUSTdiscard any knowledge obtained from the initiating entity which was not obtained fromsend a response stream header to the initiating entity; if the receiving entity is capable of SASLnegotiation itself;negotiation, it MUST include the 'version' attribute set to a value of at least "1.0" in the response stream header. R: <stream:stream from='example.com' id='vgKi/bkYME8OAj4rlXMkpucAqe4=' to='juliet@example.com' version='1.0' xml:lang='en' xmlns='jabber:client' xmlns:stream='http://etherx.jabber.org/streams' The receiving entitySHOULDalso MUST sendnewstream features(including an updated list of SASLto the initiating Saint-Andre ExpiresOctober 19, 2007January 18, 2008 [Page30]51] Internet-Draft XMPP CoreAprilJuly 2007mechanisms) soentity, which SHOULD include the SASL stream feature, i.e., a <mechanisms/> element (qualified by the 'urn:ietf:params:xml:ns:xmpp-sasl' namespace) that contains one <mechanism/> child element for each authentication mechanism theinitiatingreceiving entitycan detect any changesoffers to thelistinitiating entity. The order of <mechanism/> elements in the XML indicates the preference order of the SASL mechanismssupported byaccording to the receiving entity.11. Upon successful SASL negotiation that involves negotiation of a security layer,R: <stream:features> <mechanisms xmlns='urn:ietf:params:xml:ns:xmpp-sasl'> <mechanism>EXTERNAL</mechanism> <mechanism>DIGEST-MD5</mechanism> <mechanism>PLAIN</mechanism> </mechanisms> </stream:features> Note: If the initiating entityMUST discard any knowledge obtained frompresents a valid certificate during prior TLS negotiation, the receiving entitywhich was not obtained fromSHOULD offer the SASL EXTERNAL mechanism to the initiating entity during SASL negotiationitself. 12. See Mandatory-to-Implement Technologies(refer to [SASL]), although the EXTERNAL mechanism MAY be offered under other circumstances as well. Note: If TLS negotiation (Section15.7)6) needs to be completed before a particular authentication mechanism may be used, the receiving entity MUST NOT provide that mechanism in the list of available SASL authentication mechanisms prior to TLS negotiation. Note: See Section 15.7 regarding mechanisms that MUST be supported; naturally, other SASL mechanisms MAY be supported as well (best practices for the use of several SASL mechanisms in the context of XMPP are described in [XEP-0175] and [XEP-0178]).7.2. Narrative When an initiating entity authenticatesIf successful SASL negotiation is required for interaction witha receiving entity using SASL, the steps involved are as follows: 1. The initiating entity requests SASL authentication by including the 'version' attribute in the opening XML stream header sent tothe receiving entity,with the value set to "1.0". 2. After sending an XML stream header in reply, the receiving entity advertises a list of available SASL authentication mechanisms as stream features; each of these isit SHOULD signal that fact by including a<mechanism/><required/> elementincludedas a childwithin aof the <mechanisms/>containerelement. R: <stream:features> <mechanisms xmlns='urn:ietf:params:xml:ns:xmpp-sasl'> <mechanism>EXTERNAL</mechanism> <mechanism>DIGEST-MD5</mechanism> <mechanism>PLAIN</mechanism> <required/> </mechanisms> </stream:features> Note: The receiving entity MAY include an application-specific child elementqualified byinside the'urn:ietf:params:xml:ns:xmpp-sasl' namespace, which in turn is a child of a <features/><mechanisms/> element inthe streams namespace. If TLS negotiation (Section 6) needsorder tobe completed before a particular authentication mechanism may be used, the receiving entity MUST NOTprovide information thatmechanism in the list of available SASL authentication mechanisms prior to TLS negotiation. Ifmay be needed by the initiatingentity presents a valid certificate during prior TLS negotiation, the receiving entity SHOULD offer the SASL EXTERNAL mechanismin order tothe initiating entity duringcomplete Saint-Andre Expires January 18, 2008 [Page 52] Internet-Draft XMPP Core July 2007 successful SASL negotiation(refer to [SASL]), althoughusing one or more of theEXTERNAL mechanism MAY beofferedunder other circumstances as well. If successful SASL negotiation is required for interaction withmechanisms; however, thereceiving entity, it SHOULD signal that fact by including a <required/>syntax and semantics of any such elementas a childare out of scope for this specification. 7.3.2. Initiation In order to begin the SASL negotiation, the<mechanisms/> element. 3. Theinitiating entityselects a mechanism by sendingsends an <auth/> element qualified by the 'urn:ietf:params:xml:ns:xmpp-sasl' namespaceto the receiving entityandincludingincludes an appropriate value for the 'mechanism' attribute. This element MAY contain XML character data (in SASL terminology, the "initial response") if the mechanism supports or requires it; if the initiating entity needs to send a zero-length initial response, it MUST transmit the response as a single equals sign ("="), which indicates that the response is present but contains no data.Saint-Andre Expires October 19, 2007 [Page 31] Internet-Draft XMPP Core April 2007 4.I: <auth xmlns='urn:ietf:params:xml:ns:xmpp-sasl' mechanism='DIGEST-MD5'>=</auth> 7.3.3. Challenge-Response Sequence If necessary, the receiving entity challenges the initiating entity by sendingto the initiating entitya <challenge/> element qualified by the 'urn:ietf:params:xml:ns:xmpp-sasl' namespace; this element MAY contain XML character data (which MUST becomputedgenerated in accordance with the definition of the SASL mechanism chosen by the initiating entity).5.R: <challenge xmlns='urn:ietf:params:xml:ns:xmpp-sasl'> cmVhbG09ImV4YW1wbGUuY29tIixub25jZT0iT0E2TUc5dEVRR20yaGgiLHFvcD0i YXV0aCIsY2hhcnNldD11dGYtOCxhbGdvcml0aG09bWQ1LXNlc3MK </challenge> The decoded challenge is: realm="example.com",nonce="OA6MG9tEQGm2hh", qop="auth",charset=utf-8,algorithm=md5-sess Note: If the receiving entity does not specify a 'realm' value, the initiating entity MUST default it to the domain identifier portion of the receiving entity's JID. The initiating entity responds to the challenge by sendingto the receiving entitya <response/> element qualified by the 'urn:ietf:params:xml:ns:xmpp-sasl' namespace; this element MAY contain XML character data (which MUST becomputedgenerated in accordance with the definition of the SASL mechanism chosen by the initiating entity).6.Saint-Andre Expires January 18, 2008 [Page 53] Internet-Draft XMPP Core July 2007 I: <response xmlns='urn:ietf:params:xml:ns:xmpp-sasl'> dXNlcm5hbWU9Imp1bGlldCIscmVhbG09ImV4YW1wbGUuY29tIixub25jZT0iT0E2 TUc5dEVRR20yaGgiLGNub25jZT0iT0E2TUhYaDZWcVRyUmsiLG5jPTAwMDAwMDAx LHFvcD1hdXRoLGRpZ2VzdC11cmk9InhtcHAvZXhhbXBsZS5jb20iLHJlc3BvbnNl PWQzODhkYWQ5MGQ0YmJkNzYwYTE1MjMyMWYyMTQzYWY3LGNoYXJzZXQ9dXRmLTgK </response> The decoded response is: username="juliet",realm="example.com", nonce="OA6MG9tEQGm2hh",cnonce="OA6MHXh6VqTrRk", nc=00000001,qop=auth,digest-uri="xmpp/example.com", response=d388dad90d4bbd760a152321f2143af7,charset=utf-8 If necessary, the receiving entity sends more challenges and the initiating entity sends more responses. This series of challenge/response pairs continues until one of three things happens:1.o The initiating entity aborts the handshake. o The receiving entity reports failure of the handshake. o The receiving entity reports success of the handshake. These scenarios are described in the following sections. 7.3.4. Abort The initiating entity aborts the handshake by sending an <abort/> element qualified by the 'urn:ietf:params:xml:ns:xmpp-sasl'namespace to the receiving entity.namespace. I: <abort xmlns='urn:ietf:params:xml:ns:xmpp-sasl'/> Upon receiving an <abort/> element, the receiving entity MUST return an <aborted/> element qualified by the 'urn:ietf:params:xml:ns:xmpp-sasl' namespace. R: <aborted xmlns='urn:ietf:params:xml:ns:xmpp-sasl'/> The receiving entity SHOULD allow a configurable but reasonable number of retries (at least 2 and no more than5), after which it MUST terminate the TCP connection;5); this enables the initiating entity (e.g., an end-user client) to tolerateincorrectly-providedincorrectly- provided credentials (e.g., a mistyped password) without being forced to reconnect.2.If the initiating entity exceeds the number of retries, the receiving entity MUST terminate the TCP connection. Saint-Andre Expires January 18, 2008 [Page 54] Internet-Draft XMPP Core July 2007 7.3.5. Failure The receiving entity reports failure of the handshake by sending a <failure/> element qualified by the 'urn:ietf:params:xml:ns:xmpp-sasl' namespaceto the initiating entity(the particular cause of failure SHOULD be communicated in an appropriate child element of the <failure/> element as defined underSASL Errors (Section 7.4)).Section 7.5). R: <failure xmlns='urn:ietf:params:xml:ns:xmpp-sasl'> <not-authorized/> </failure> If the failure case occurs, the receiving entity SHOULD allow a configurable but reasonable number of retries (at least2), after which it MUST terminate the TCP connection;2 and no more than 5); this enables the initiating entity (e.g., anend- userend-user client) to tolerate incorrectly-provided credentials (e.g., a mistyped password) without being forced to reconnect.3.If the initiating entity exceeds the number of retries, the receiving entity MUST terminate the TCP connection. 7.3.6. Success The receiving entity reports success of the handshake by sending a <success/> element qualified by the 'urn:ietf:params:xml:ns:xmpp-sasl'namespace to the initiating entity;namespace; this element MAY contain XML character data (in SASL terminology, "additional data with success") if required by the chosen SASL mechanism; if the receiving entity needs to send additional data of zero length, it MUST transmit the data as a single equals sign ("="). R: <success xmlns='urn:ietf:params:xml:ns:xmpp-sasl'> cnNwYXV0aD1lYTQwZjYwMzM1YzQyN2I1NTI3Yjg0ZGJhYmNkZmZmZAo= </success> The decoded value for subsequent authentication is: rspauth=ea40f60335c427b5527b84dbabcdfffd Upon receiving the <success/> element, the initiating entity MUST initiate a new stream over the existing TCP connection by sending anopening XMLinitial stream header to the receivingentity (it is notentity. Saint-Andre ExpiresOctober 19, 2007January 18, 2008 [Page32]55] Internet-Draft XMPP CoreAprilJuly 2007 I: <stream:stream from='juliet@example.com' to='example.com' version='1.0' xml:lang='en' xmlns='jabber:client' xmlns:stream='http://etherx.jabber.org/streams' Note: It is not necessary to send a closing </stream> tagfirst,before sending the initial stream header, since the receiving entity and initiating entity MUST consider the original stream to be closed upon sending or receiving the <success/>element).element. Upon receiving thenewinitial stream header from the initiating entity, the receiving entity MUST respond by sending a new XML stream header to the initiatingentity, along withentity. R: <stream:stream from='example.com' id='gPybzaOzBmaADgxKXu9UClbprp0=' to='juliet@example.com' version='1.0' xml:lang='en' xmlns='jabber:client' xmlns:stream='http://etherx.jabber.org/streams'> The receiving entity MUST also send stream features, containing any further available features or containing no features (via an empty <features/>element (to signify that no additional features are available);element); any such additional features not defined herein MUST be defined by the relevant extension to XMPP.As noted, if SASL negotiation involved establishment of a security layer, the receiving entity SHOULD send an updated list of SASL mechanisms so that the initiating entity can detect any changes to the list of mechanisms supported by the receiving entity. 7.3.R: <stream:features> <bind xmlns='urn:ietf:params:xml:ns:xmpp-bind'> <required/> </bind> </stream:features> 7.4. SASL Definition The profiling requirements of [SASL] require that the following information be supplied by a protocol definition: service name: "xmpp" initiation sequence: After the initiating entity provides an opening XML stream header and the receiving entity replies in kind, the receiving entity provides a list of acceptable authentication methods. The initiating entity chooses one method from the list and sends it to the receiving entity as the value of the Saint-Andre Expires January 18, 2008 [Page 56] Internet-Draft XMPP Core July 2007 'mechanism' attribute possessed by an <auth/> element, optionally including an initial response to avoid a round trip. exchange sequence: Challenges and responses are carried through the exchange of <challenge/> elements from receiving entity to initiating entity and <response/> elements from initiating entity to receiving entity. The receiving entity reports failure by sending a <failure/> element and success by sending a <success/> element; the initiating entity aborts the exchange by sending an <abort/> element. Upon successful negotiation, both sides consider the original XML stream to be closed and new stream headers are sent by both entities. security layer negotiation: The security layer takes effect immediately after sending the closing">"'>' character of the <success/> element for the receiving entity, and immediately after receiving the closing">"'>' character of the <success/> element for the initiating entity. The order of layers is first [TCP], then [TLS], then [SASL], then XMPP. use of the authorization identity: The authorization identity may be used byxmppXMPP to denote the non-default <node@domain> of a client or the sending <domain> of a server; an empty string is equivalent to an absent authorization identity.Saint-Andre Expires October 19, 2007 [Page 33] Internet-Draft XMPP Core April 2007 7.4.7.5. SASL Errors The following SASL-related error conditions aredefined: o <aborted/> --defined. 7.5.1. aborted The receiving entity acknowledges an <abort/> element sent by the initiating entity; sent in reply to the <abort/> element.o <incorrect-encoding/> --I: <abort xmlns='urn:ietf:params:xml:ns:xmpp-sasl'/> R: <failure xmlns='urn:ietf:params:xml:ns:xmpp-sasl'> <aborted/> </failure> 7.5.2. incorrect-encoding The data provided by the initiating entity could not be processed because the [BASE64] encoding is incorrect (e.g., because the encoding does not adhere to the definition in Section 4 of [BASE64]); sent in reply to a <response/> element or an <auth/> element with initial response data.o <invalid-authzid/> --Saint-Andre Expires January 18, 2008 [Page 57] Internet-Draft XMPP Core July 2007 I: <auth xmlns='urn:ietf:params:xml:ns:xmpp-sasl' mechanism='DIGEST-MD5'>[ ... ]</auth> R: <failure xmlns='urn:ietf:params:xml:ns:xmpp-sasl'> <incorrect-encoding/> </failure> 7.5.3. invalid-authzid The authzid provided by the initiating entity is invalid, either because it is incorrectly formatted or because the initiating entity does not have permissions to authorize that ID; sent in reply to a <response/> element or an <auth/> element with initial response data.o <invalid-mechanism/> --I: <response xmlns='urn:ietf:params:xml:ns:xmpp-sasl'> [ ... ] </response> R: <failure xmlns='urn:ietf:params:xml:ns:xmpp-sasl'> <invalid-authzid/> </failure> 7.5.4. invalid-mechanism The initiating entity did not provide a mechanism or requested a mechanism that is not supported by the receiving entity; sent in reply to an <auth/> element.o <malformed-request/> --I: <auth xmlns='urn:ietf:params:xml:ns:xmpp-sasl' mechanism='CRAM-MD5'/> R: <failure xmlns='urn:ietf:params:xml:ns:xmpp-sasl'> <invalid-mechanism/> </failure> 7.5.5. malformed-request Thechallenge or responserequest is malformed (e.g., the <auth/> element includes an initial response but the mechanism does not allow that); sent in reply to an <abort/>, <auth/>, <challenge/>, or <response/> element.o <mechanism-too-weak/> --I: <auth xmlns='urn:ietf:params:xml:ns:xmpp-sasl' mechanism='ANONYMOUS'>[ ... ]</auth> R: <failure xmlns='urn:ietf:params:xml:ns:xmpp-sasl'> <malformed-request/> </failure> Saint-Andre Expires January 18, 2008 [Page 58] Internet-Draft XMPP Core July 2007 7.5.6. mechanism-too-weak The mechanism requested by the initiating entity is weaker than server policy permits for that initiating entity; sent in reply toa <response/> element oran <auth/> elementwith(with or without initial responsedata. o <not-authorized/> --data) or a <response/> element. I: <auth xmlns='urn:ietf:params:xml:ns:xmpp-sasl' mechanism='PLAIN'/> R: <failure xmlns='urn:ietf:params:xml:ns:xmpp-sasl'> <mechanism-too-weak/> </failure> 7.5.7. not-authorized The authentication failed because the initiating entity did not provide propercredentials (this includes but is not limited to the case of an unknown username, and no differentiation is made between an unknown username and incorrect credentials);credentials; sent in reply to a <response/> element or an <auth/> element with initial response data.o <temporary-auth-failure/> -- The authentication failed because ofI: <response xmlns='urn:ietf:params:xml:ns:xmpp-sasl'> [ ... ] </response> R: <failure xmlns='urn:ietf:params:xml:ns:xmpp-sasl'> <not-authorized/> </failure> Note: This error condition includes but is not limited to the case of incorrect credentials or an unknown username. In order to discourage directory harvest attacks, no differentiation is made between incorrect credentials and an unknown username. 7.5.8. temporary-auth-failure The authentication failed because of a temporary error condition within the receiving entity, and the initiating entity should try again later; sent in reply to an <auth/> element or <response/> element.Examples of SASL negotiation are provided under Section 10.I: <response xmlns='urn:ietf:params:xml:ns:xmpp-sasl'> [ ... ] </response> R: <failure xmlns='urn:ietf:params:xml:ns:xmpp-sasl'> <temporary-auth-failure/> </failure> Saint-Andre Expires January 18, 2008 [Page 59] Internet-Draft XMPP Core July 2007 8. Resource Binding 8.1. Overview After a client authenticates with a server, it MUST bind a specific resource to the stream so that the server can properly address the client (seeaddresses (Section 3)) and route XML stanzas to and from Saint-Andre Expires October 19, 2007 [Page 34] Internet-Draft XMPP Core April 2007 the client (see stanza delivery rules (Section 11)). That is,Section 3), i.e., there MUST beaan XMPP resource identifier associated with the"bare JID"bare JID (<node@domain>) of theclient; this ensuresclient with the result that the address for use over that stream is a"full JID"full JID of the form <node@domain/resource>. This ensures that the server can deliver XML stanzas to and receive XML stanzas from the client (see Section 11). After binding a resource to the stream, the client is referred to as aCONNECTED RESOURCE.connected resource. If, before completing the resource binding step, the client attempts to send an outbound XML stanza (i.e., a stanza not directed to the server itself or to the client's own account), the server MUST NOT process the stanza and SHOULD return a <not-authorized/> stream error to the client. Support for resource binding is REQUIRED in XMPP client and server implementations. 8.2. Advertising Support Upon receiving a success indication within the SASL negotiation, the client MUST send a new stream header to the server, to which the server MUST respond with a stream header as well as a list of available stream features. Specifically,iffor client-to-server streams the serverrequires the client to bind a resource to the stream after successful SASL negotiation, itMUST include a <bind/> element qualified by the 'urn:ietf:params:xml:ns:xmpp-bind' namespace in the stream featureslistit presents to theclient upon sending the header for the response stream sent after successful SASL negotiation (but not before);client; this <bind/> element SHOULD include an empty <required/> elementas well. Server advertisesto explicitly indicate that resource bindingfeature to client: <stream:stream xmlns='jabber:client' xmlns:stream='http://etherx.jabber.org/streams' xml:lang='en'must be completed at this stage of the stream negotiation process. (Note: The server SHOULD NOT include the <bind/> stream feature until after successful SASL negotiation.) Saint-Andre Expires January 18, 2008 [Page 60] Internet-Draft XMPP Core July 2007 S: <stream:stream from='example.com'id='c2s_345'id='gPybzaOzBmaADgxKXu9UClbprp0=' to='juliet@example.com'version='1.0'>version='1.0' xml:lang='en' xmlns='jabber:client' xmlns:stream='http://etherx.jabber.org/streams'> S: <stream:features> <bind xmlns='urn:ietf:params:xml:ns:xmpp-bind'> <required/> </bind> </stream:features> Upon being so informed that resource binding is required, the client MUST bind a resource to the streamby sending to the server an IQ stanza of type "set" (see IQ Semantics (Section 9.2.3)) containing data qualified by the 'urn:ietf:params:xml:ns:xmpp-bind' namespace. If the client wishes to allow the server to generateas described in theresource identifier on its behalf, it sends an IQ stanza of type "set" that contains an empty <bind/> element. Saint-Andre Expires October 19, 2007 [Page 35] Internet-Draft XMPP Core April 2007 Client asks server to bind a resource: <iq type='set' id='bind_1'> <bind xmlns='urn:ietf:params:xml:ns:xmpp-bind'/> </iq>following sections. 8.3. Server-Generated Resource Identifier A server that supports resource binding MUST be able to generateaan XMPP resource identifier on behalf of a client.AThe resource identifier generated by the server MUST at a minimum becurrentlyunique among the connected resources for that<node@domain>. If<node@domain> and SHOULD be random since the resource identifier may be security-critical. It is RECOMMENDED that the server-generated resource identifier be a Universally Unique Identifier (UUID), for which the format specified in [UUID] is RECOMMENDED. It is RECOMMENDED for the clientwishestospecifyask its server to generate an appropriate resource identifier on its behalf, rather than generating a resource on its own and requesting that the server accept the client-generated resourceidentifier, it MUST sendidentifer. 8.3.1. Success Case A client requests a server-generated resource identifier by sending an IQ stanza of type "set"that contains the desired resource identifier as the non-zero-length XML character data of a <resource/>(see Section 9.2.3) containing an empty <bind/> elementthat is a child ofqualified by the<bind/> element. Client binds a resource:'urn:ietf:params:xml:ns:xmpp-bind' namespace. C: <iqtype='set' id='bind_2'>id='bind_1' type='set'> <bindxmlns='urn:ietf:params:xml:ns:xmpp-bind'> <resource>balcony</resource> </bind>xmlns='urn:ietf:params:xml:ns:xmpp-bind'/> </iq> Once the server has generatedaan XMPP resource identifier for theclient or accepted the resource identifier provided by theclient, it MUST return an IQ stanza of type "result" to the client, Saint-Andre Expires January 18, 2008 [Page 61] Internet-Draft XMPP Core July 2007 which MUST include a <jid/> child element that specifies the full JID for the connected resource as determined by the server.Server informs client of successful resource binding:S: <iqtype='result' id='bind_2'>id='bind_1' type='result'> <bind xmlns='urn:ietf:params:xml:ns:xmpp-bind'><jid>juliet@example.com/balcony</jid><jid> juliet@example.com/4db06f06-1ea4-11dc-aca3-000bcd821bfb </jid> </bind> </iq>A server SHOULD accept the resource identifier provided by the client, but MAY override it with a resource identifier that the server generates; in this case, the server SHOULD NOT return a stanza error (e.g., <forbidden/>) to the client but instead SHOULD communicate the generated resource identifier to the client in the IQ result as shown above. When a client supplies a resource identifier, the following stanza error conditions are8.3.2. Error Case It is possible(see Stanza Errors (Section 9.3)): Saint-Andre Expires October 19, 2007 [Page 36] Internet-Draft XMPP Core April 2007 o The provided resource identifier cannot be processed bythat theserver, e.g. because it is not in accordance with Resourceprep (Appendix B). o Theclient is not allowed to bind a resource to the stream (e.g., because the node or user has reached a limit on the number of connected resources allowed).o The provided resource identifier is already in use butIn this case, the serverdoes not allow binding of multiple connected resources with the same identifier. The protocol for theseMUST return a <not-allowed/> stanza errorconditions is as follows. Resource identifier cannot be processed: <iq type='error' id='bind_2'> <bind xmlns='urn:ietf:params:xml:ns:xmpp-bind'> <resource>someresource</resource> </bind> <error type='modify'> <bad-request xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'/> </error> </iq> Client is not allowedtobind a resource:the client. S: <iqtype='error' id='bind_2'> <bind xmlns='urn:ietf:params:xml:ns:xmpp-bind'> <resource>someresource</resource> </bind>id='bind_1' type='error'> <error type='cancel'> <not-allowed xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'/> </error> </iq>If there is already a connected resource of the same name, the server MUST do one of the following: 1. Not accept8.4. Client-Generated Resource Identifier A client MAY attempt to specify the resource identifierprovided byon its own rather than asking theclient but instead override it withserver to generate a resource identifierthat the server generates. 2. Terminate the current resource and allow the newly-requested resource. 3. Disallow the newly-requestedon its behalf. 8.4.1. Success Case A client asks its server to accept a client-generated resourceand maintain the current resource. Whichidentifier by sending an IQ stanza ofthese thetype "set" containing a <bind/> element with a child <resource/> element containing non-zero-length XML character data. C: <iq id='bind_2' type='set'> <bind xmlns='urn:ietf:params:xml:ns:xmpp-bind'> <resource>balcony</resource> </bind> </iq> The serverdoes is up toMAY accept theimplementation, althoughresource identifier provided by the client, in which case itis RECOMMENDEDreturns an IQ stanza of type "result" toimplement case #1. In case #2,theserver MUST sendclient, including a<conflict/> stream error to<jid/> child element that specifies thecurrent resource, terminatefull JID for the connected resource. Saint-Andre ExpiresOctober 19, 2007January 18, 2008 [Page37]62] Internet-Draft XMPP CoreAprilJuly 2007 S: <iq id='bind_2' type='result'> <bind xmlns='urn:ietf:params:xml:ns:xmpp-bind'> <jid>juliet@example.com/balcony</jid> </bind> </iq> However, theXML stream and underlying TCP connection forserver MAY instead override thecurrent resource,client-generated resource identifier andreturngenerate aIQ stanzaresource identifier on behalf oftype "result" (indicating success) tothenewly-requested resource. In case #3,client, as shown in theserver MUST either (a) returnprevious section. 8.4.2. Error Cases When aserver-generatedclient attempts to set its own XMPP resourcename or (b) send a <conflict/>identifier during resource binding, the following stanza error conditions are possible: o The client is not allowed tothe newly-requestedbind a resourcebut maintainto theXMLstreamfor that connection so that(e.g., because thenewly-requested resourcenode or user hasan opportunity to negotiatereached anon-conflicting resource identifier before sending another request forlimit on the number of connected resources allowed). o The provided resourcebinding. Resourceidentifier cannot be processed by the server, e.g. because it is not inuse: <iq type='error' id='bind_2'> <bind xmlns='urn:ietf:params:xml:ns:xmpp-bind'> <resource>someresource</resource> </bind> <error type='cancel'> <conflict xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'/> </error> </iq> If, before completingaccordance with the Resourceprep (Appendix B) profile of [STRINGPREP]). o The provided resource identifier is already in use but the server does not allow bindingstep,of multiple connected resources with the same identifier. 8.4.2.1. Not Allowed If the clientattempts to send an outbound XML stanza (i.e., a stanzais notdirectedallowed tothe server itself orbind a resource to theclient's own account),stream, the server MUSTNOT processreturn a <not-allowed/> error. S: <iq id='bind_2' type='error'> <error type='cancel'> <not-allowed xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'/> </error> </iq> 8.4.2.2. Bad Request If thestanza andprovided resource identifier cannot be processed by the server, the server SHOULD return a<not-authorized/> stanza<bad-request/> errorto the client. 8.1. Binding Multiple Resources A server(but MAYsupport bindinginstead apply the Resourceprep (Appendix B) profile ofmultiple resources to[STRINGPREP] or otherwise process thesame stream. This functionalityresource identifier so that it isdesirableincertain environments (e.g., for devices that are unable to open more than one TCP connection or when a machine runs anconformance). S: <iq id='bind_2' type='error'> <error type='modify'> <bad-request xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'/> </error> Saint-Andre Expires January 18, 2008 [Page 63] Internet-Draft XMPPclient daemon that is used by multiple applications).Core July 2007 </iq> 8.4.2.3. Conflict If there is already aserver supports bindingconnected resource ofmultiple resources to a stream, itthe same name, the server MUSTenable a client to unbind resources. This shall be completed by sending an IQ-set with a child elementdo one of<unbind/> qualified bythe'urn:ietf:params:xml:ns:xmpp-bind' namespace, which in turn has a child element of <resource/> whose XML character data specifiesfollowing: 1. Not accept the resourceto be unbound: <iq type='set' id='unbind_1'> <unbind xmlns='urn:ietf:params:xml:ns:xmpp-bind'> <resource>someresource</resource> </unbind> </iq> If the server does not understandidentifier provided by the<unbind/> element,client but instead override itMUST returnwith anerror of <bad-request/>. Otherwise, if there is no suchXMPP resourceforidentifier thatstream,the serverMUST return an error of <item- Saint-Andre Expires October 19, 2007 [Page 38] Internet-Draft XMPP Core April 2007 not-found/>. When the client unbindsgenerates. 2. Terminate theonlycurrent resourceassociated with the stream,and allow theserver SHOULD closenewly-requested resource. 3. Disallow thestreamnewly-requested resource andterminatemaintain theTCP connection. A server SHOULD advertise its support forcurrent resource. Which of these the'urn:ietf:params:xml:ns:xmpp-bind' namespace by returning an appropriate stream feature as follows: <stream:features> <bind xmlns='urn:ietf:params:xml:ns:xmpp-bind'/> <unbind xmlns='urn:ietf:params:xml:ns:xmpp-bind'/> </stream:features> When a client binds multiple resourcesserver does is up to thesame stream, proper management of 'from' addressesimplementation, although it isimperative.RECOMMENDED to implement case #1. Inparticular, a clientcase #2, the server MUSTspecify a 'from' address on every stanza it sends oversend a <conflict/> stream error towhich it has bound multiple resources, where the 'from' address isthefull JID (<node@domain.tld/resource>) associated withcurrent resource, terminate therelevant resource. If a client does not specify a 'from' address on a stanza it sends over aXML streamto which it has bound multiple resources (or if it specifies asand underlying TCP connection for the'from' address a full JID other than onecurrent resource, and return an IQ stanza of type "result" (indicating success) to thebound resources),newly-requested resource. In case #3, the server MUSTreturn thesend a <conflict/> stanza error to theclient with an <unknown-sender/> stanza error. Naturally,newly-requested resource but maintain therules regarding validation of asserted 'from' addresses still apply (see Section 11). 9.XMLStanzas After a clientstream for that connection so that the newly-requested resource hasconnectedan opportunity to negotiate a non-conflicting resource identifier before sending another request for resource binding. 8.5. Binding Multiple Resources A serveror two servers have connectedMAY support binding of multiple resources toeach other, either party can send XML stanzas overthenegotiatedsame stream.Three kinds of XML stanza are defined for the 'jabber:client' and 'jabber:server' namespaces: <message/>, <presence/>, and <iq/>. In addition, there are five common attributes for these kinds of stanza. These common attributes, as well as the basic semantics of the three stanza kinds, are defined herein; more detailed information regarding the syntax of XML stanzas for instant messaging and presence applicationsThis functionality isprovideddesirable in[XMPP-IM], andcertain environments (e.g., forother applications in the relevantdevices that are unable to open more than one TCP connection or when a machine runs a local XMPPextension specifications. An XML stanzaclient daemon that isthe basic unitused by multiple applications). 8.5.1. Support If a server supports binding ofmeaning in XMPP.multiple resources to a stream, it MUST enable a client to unbind resources. A server that supports unbinding MUSTNOT process, deliver, or routealso support binding of multiple resources. Thus apartial stanza andclient can discover whether a serverMUST NOT attach meaning to the transmission timingsupports binding ofany child element withinmultiple resources by determining if the server advertises astanza.stream feature of <unbind/>, as follows. Saint-Andre ExpiresOctober 19, 2007January 18, 2008 [Page39]64] Internet-Draft XMPP CoreAprilJuly 20079.1. Common Attributes The following five attributes are common to message, presence, and IQ stanzas: 9.1.1. to The 'to' attribute specifies the JID ofS: <stream:features> <bind xmlns='urn:ietf:params:xml:ns:xmpp-bind'> <required/> </bind> <unbind xmlns='urn:ietf:params:xml:ns:xmpp-bind'/> </stream:features> 8.5.2. Binding an Additional Resource A connected client binds an additional resource by following theintended recipientprotocol for binding of thestanza. In the 'jabber:client' namespace, a stanza with a specific intended recipient MUST possess a 'to' attribute, whereas aoriginal resource, i.e., by sending an IQ stanzasent from a client toof type "set" containing aserver for direct processing<bind/> element qualified bythat server (e.g., presence sent totheserver for broadcasting'urn:ietf:params:xml:ns:xmpp-bind' namespace (either empty toother entities) SHOULD NOT possess a 'to' attribute. In the 'jabber:server' namespace, a stanza MUST possess a 'to' attribute; if arequest serverreceives a stanza that does not meet this restriction, it MUST generate an <improper-addressing/> stream error condition and terminate both the XML stream and the underlying TCP connection with the offending server. If the valuegeneration of the'to' attribute is invalid or cannot be contacted, the entity discovering that fact (usually the sender'sresource identifier orrecipient's server) MUST return an appropriate error to the sender, setting the 'from' attribute of the error stanzacontaining a <resource/> element with XML character data tothe value provided in the 'to' attribute of the offending stanza. 9.1.2. from The 'from' attribute specifies the JIDrequest client generation of thesender. Whenresource identifier). 8.5.3. Unbinding aserver receivesResource 8.5.3.1. Success Case A client unbinds a resource by sending anXMLIQ stanzawithin the contextof type "set" containing anauthenticated stream<unbind/> element qualified by the'jabber:client''urn:ietf:params:xml:ns:xmpp-bind' namespace,it MUST do onewhich in turn contains a child element of <resource/> whose XML character data specifies thefollowing: 1. validate that the value ofresource to be unbound: C: <iq id='unbind_1' type='set'> <unbind xmlns='urn:ietf:params:xml:ns:xmpp-bind'> <resource>someresource</resource> </unbind> </iq> If no error occurs, the'from' attribute provided byserver MUST unbind theclient is that of a connectedresourcefor the associated entity 2. add aand no longer accept stanzas whose 'from' addressto the stanza whose value isspecifies the full JID(<node@domain/resource>) determined by the server for the connected resourceassociated with thatgenerated the stanza (see Determination of Addresses (Section 3.5)), or the bare JID (<node@domain>) in the case of subscription-related presence stanzas (see [XMPP-IM] for details) Ifresource. S: <iq id='unbind_1' type='result'/> When a clientattempts to send an XML stanza for which the value ofunbinds the'from' attribute does not exactly match one ofonly resource associated with theconnected resources for that entity,stream, the server SHOULDreturn an <invalid- from/>close the streamerror toand terminate theclient. If a client attempts to send anTCP connection. S: <iq id='unbind_1' type='result'/> S: <stream:stream> Saint-Andre ExpiresOctober 19, 2007January 18, 2008 [Page40]65] Internet-Draft XMPP CoreAprilJuly 2007XML stanza over8.5.3.2. Error Cases 8.5.3.2.1. Unbind Not Supported If the server does not understand the <unbind/> element, it MUST return astream thatstanza error, which SHOULD be <bad-request/>. S: <iq id='unbind_1' type='error'> <error type='modify'> <bad-request xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'/> </error> </iq> 8.5.3.2.2. No Such Resource If there isnot yet authenticated,no such resource for that stream, the serverSHOULDMUST returna <not-authorized/> streaman error of <item-not-found/>. S: <iq id='unbind_1' type='error'> <error type='cancel'> <item-not-found xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'/> </error> </iq> 8.5.4. From Addresses When a client binds multiple resources to theclient. If generated, bothsame stream, proper management ofthese conditions'from' addresses is imperative. In particular, a client MUSTresult in closure of the stream and termination of the underlying TCP connection; this helps to preventspecify adenial of service attack launched from a rogue client. When a server generates a stanza from the server itself for delivery to a connected client (e.g., in the context of data storage services provided by the server'from' address onbehalf of the client), theevery stanzaMUST either (1) not include a 'from' attribute or (2) includeit sends over a stream to which it has bound multiple resources, where the 'from'attribute whose valueaddress is theaccount's bare JID (<node@domain>) or connected resource'sfull JID(<node@domain/resource>). A server MUST NOT send to the client a stanza without a 'from' attribute if the stanza was not generated by(<node@domain.tld/resource>) associated with theserver itself. Whenrelevant resource. If a clientreceives a stanza thatdoes notincludespecify a 'from'attribute,address on a stanza it sends over a stream to which it has bound multiple resources, the server MUSTassume thatreturn the stanzais from the servertowhichthe clientis connected. In the 'jabber:server' namespace, a stanza MUST possess a 'from' attribute; if a server receives a stanza that does not meet this restriction, it MUST generatewith an<improper-addressing/> stream error condition. Furthermore,<unknown-sender/> stanza error. C: <message to='romeo@example.net'> <body>Wherefore art thou?</body> </message> S: <message from='romeo@example.net' type='error'> <body>Wherefore art thou?</body> <error type='modify'> <unknown-sender xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'/> </error> </message> Saint-Andre Expires January 18, 2008 [Page 66] Internet-Draft XMPP Core July 2007 Naturally, thedomain identifier portionrules regarding validation ofthe JID contained in theasserted 'from'attribute MUST matchaddresses still apply (see Section 11). 9. XML Stanzas After a client has connected to a server or two servers have connected to each other, either party can send XML stanzas over thehostnamenegotiated stream. Three kinds of XML stanza are defined for thesending server (or any validated domain thereof, such'jabber:client' and 'jabber:server' namespaces: <message/>, <presence/>, and <iq/>. In addition, there are five common attributes for these stanza types. These common attributes, asa validated local domain hosted by the sending server)well ascommunicated intheSASL negotiation, dialback negotiation or other means; if a server receives a stanza that does not meet this restriction, it MUST generate an <invalid-from/> stream error condition. Both of these conditions MUST result in closurebasic semantics of thestream and termination ofthree stanza types, are defined herein; more detailed information regarding theunderlying TCP connection; this helps to prevent a denial of service attack launched from a rogue server. 9.1.3. id The optional 'id' attribute MAY be used by a sending entity for internal trackingsyntax of XML stanzasthat it sendsfor instant messaging and presence applications is provided in [XMPP-IM], andreceives (especiallyfortracking the request-response interaction inherentother applications in thesemantics of IQ stanzas). Itrelevant XMPP extension specifications. An XML stanza isOPTIONAL forthevaluebasic unit ofthe 'id' attribute to be unique globally, withinmeaning in XMPP. A server MUST NOT process adomain, orpartial stanza and a server MUST NOT attach meaning to the transmission timing of any child element within astream. Thestanza. Support for the XML stanza syntax and semanticsof IQ stanzas impose additional restrictions; seedefined herein is REQUIRED in XMPP client and server implementations. 9.1. Common Attributes The following five attributes are common to message, presence, and IQSemantics (Section 9.2.3). 9.1.4. typestanzas. 9.1.1. to The'type''to' attribute specifiesdetailed information aboutthepurpose or contextJID of themessage, presence, or IQintended recipient for the stanza. <message to='romeo@example.net'> <body>Art thou not Romeo, and a Montague?</body> </message> For information about server processing of inbound and outbound XML stanzas based on the nature of the 'to' address, refer to Section 11. 9.1.1.1. Client-to-Server Streams Theparticular allowable values forfollowing rules apply to the'type''to' attributevary depending on whetherin thestanza is a message, presence, or IQ;context of XML streams qualified by thevalues for message and'jabber:client' namespace (i.e., client-to- server streams). Saint-Andre ExpiresOctober 19, 2007January 18, 2008 [Page41]67] Internet-Draft XMPP CoreAprilJuly 2007presence stanzas are1. A stanza with a specific intended recipient MUST possess a 'to' attribute. 2. A stanza sent from a client toinstant messaging anda server for direct processing by the server (e.g., presenceapplications and therefore are defined in [XMPP-IM], whereassent to thevaluesserver forIQ stanzas specify the role of an IQ stanza in a structured request-response "conversation" and thus are defined under IQ Semantics (Section 9.2.3) below. The only 'type' value commonbroadcasting toall three stanzas is "error"; see Stanza Errors (Section 9.3). 9.1.5. xml:lang A stanzaother entities) SHOULD NOT possessan 'xml:lang' attribute (as defined in Section 2.12 of [XML]) if the stanza contains XML character data that is intended to be presented toahuman user (as explained in [CHARSET], "internationalization is for humans").'to' attribute. 9.1.1.2. Server-to-Server Streams Thevalue offollowing rules apply to the'xml:lang''to' attributespecifiesin thedefault languagecontext ofany such human-readableXMLcharacter data, which MAY be overriddenstreams qualified by the'xml:lang' attribute of'jabber:server' namespace (i.e., server-to- server streams). 1. A stanza MUST possess aspecific child element. If'to' attribute; if a server receives a stanza that does notpossess an 'xml:lang' attribute, an implementationmeet this restriction, it MUSTassume that the default language is that specified forgenerate an <improper-addressing/> stream error and terminate both the XML streamas defined under Stream Attributes (Section 5.3) above.and the underlying TCP connection with the offending server. 9.1.2. from Thevalue'from' attribute specifies the JID of the'xml: lang' attribute MUST be an NMTOKENsender. <message from='juliet@example.com/balcony' to='romeo@example.net'> <body>Art thou not Romeo, andMUST conforma Montague?</body> </message> 9.1.2.1. Client-to-Server Streams The following rules apply to theformat defined'from' attribute in[LANGTAGS]. 9.2. Basic Semantics 9.2.1. Message Semantics The <message/>the context of XML streams qualified by the 'jabber:client' namespace (i.e., client- to-server streams). 1. When the server receives an XML stanzakind can be seen asfrom a"push" mechanism whereby one entity pushes information to another entity, similar toclient and thecommunications that occur instanza does not include asystem such as email. All message stanzas SHOULD possess'from' attribute, the server MUST add a'to''from' attributethat specifiesto theintended recipientstanza, where the value of themessage; upon receiving such a stanza, a'from' attribute is the full JID (<node@domain/resource>) determined by the serverSHOULD routefor the connected resource that generated the stanza (see Section 3.5), ordeliver it totheintended recipientbare JID (<node@domain>) in the case of subscription-related presence stanzas (seeServer Rules for Handling[XMPP-IM]). 2. When the server receives an XMLStanzas (Section 11) for general routingstanza from a client anddelivery rules related to XML stanzas). 9.2.2. Presence Semantics The <presence/> element can be seen asthe stanza includes aspecialized broadcast or "publish-subscribe" mechanism, whereby multiple entities receive information about an entity to which they have subscribed (in this case, network availability information). In general, a publishing entity SHOULD send a presence stanza with no 'to''from' attribute,in which casethe serverto whichMUST either (a) validate that theentityvalue of the 'from' attribute provided by the client isconnected SHOULD broadcast or multiplexthatstanza to all subscribing entities. However, a publishing entity MAY also send a presence stanza withof a'to' attribute, in which caseconnected resource for theserver SHOULD routeassociated entity ordeliver that stanza to(b) override theintended recipient. See Server Rules for Handling XML Stanzas (Section 11) for general routing and delivery rules relatedprovided 'from' attribute by adding a 'from' attribute as specified under Rule #1. Saint-Andre ExpiresOctober 19, 2007January 18, 2008 [Page42]68] Internet-Draft XMPP CoreAprilJuly 2007to XML stanzas, and [XMPP-IM] for rules specific to presence applications. 9.2.3. IQ Semantics Info/Query, or IQ, is a request-response mechanism, similar in some ways to [HTTP]. The semantics of IQ enable an entity to make a request of, and receive a response from, another entity. The data content of3. When therequest and response is defined byserver generates a stanza from theschema or other structural definition associated withserver for delivery to theXML namespace that qualifiesclient on behalf of thedirect child elementaccount of theIQ element (see extended namespaces (Section 9.4)), andconnected client (e.g., in theinteraction is trackedcontext of data storage services provided by therequesting entity through useserver on behalf of the'id' attribute. Thus, IQ interactions followclient), the stanza MUST either (a) not include acommon pattern of structured data exchange such as get/result'from' attribute orset/result (although an error may be returned in reply to(b) include arequest if appropriate): Requesting Responding Entity Entity ---------- ---------- | | | <iq type='get' id='1'> | | ------------------------> | | | | <iq type='result' id='1'> | | <------------------------ | | | | <iq type='set' id='2'> | | ------------------------> | | | | <iq type='error' id='2'> | | <------------------------ | | | In order to enforce these semantics, the following rules apply: 1. The 'id' attribute is REQUIRED for IQ stanzas. 2. The 'type''from' attributeis REQUIRED for IQ stanzas. Thewhose valueMUST be one of the following: * get -- The stanzais the account's bare JID (<node@domain>). 4. When the server generates arequest for information or requirements. * set -- The stanza provides required data, sets new values, or replaces existing values. * result -- Thestanzais a response to a successful get or set request. * error -- An error has occurred regarding processing orfrom the server itself for deliveryof a previously-sent get or set (see Stanza Errors (Section 9.3)). Saint-Andre Expires October 19, 2007 [Page 43] Internet-Draft XMPP Core April 2007 3. An entity that receives an IQ request of type "get" or "set" MUST reply with an IQ response of type "result" or "error" (the response MUST preserveto the'id' attribute ofclient, therequest). 4. An entity that receives astanza MUST include a 'from' attribute whose value is the mere domain (<domain>) oftype "result" or "error"the server. 5. A server MUST NOTrespondsend to the client a stanzaby sendingwithout afurther IQ response of type "result" or "error"; however, as shown above, the requesting entity MAY send another request (e.g., an IQ of type "set" in order to provide required information discovered through a get/ result pair). 5. An IQ stanza of type "get" or "set" MUST contain one and only one child element that specifies the semantics of'from' attribute if theparticular request or response. 6. An IQ stanza of type "result" MUST include zero or one child elements. 7. An IQstanzaof type "error" SHOULD include the child element contained inwas not generated by theassociated "get"server (e.g., if it was generated by another client or"set" and MUST include an <error/> child; for details, see Stanza Errors (Section 9.3). 9.3. Stanza Errors Stanza-related errors are handled inanother server); therefore, when a client receives amanner similar to stream errors (Section 5.8). However, unlike stream errors,stanzaerrors are recoverable; therefore error stanzasthat does not includehints regarding actionsa 'from' attribute, it MUST assume that theoriginal sender can take in orderstanza is from the server toremedywhich theerror. 9.3.1. Rulesclient is connected. 9.1.2.2. Server-to-Server Streams The following rules apply tostanza-related errors: o The receiving or processing entity that detects an error conditionthe 'from' attribute inrelation to athe context of XML streams qualified by the 'jabber:server' namespace (i.e., server- to-server streams). 1. A stanzaSHOULD return an "error stanza" (andMUSTdo so for IQ stanzas), where such an "error stanza" ispossess astanza of the same kind (message, presence, or IQ) whose 'type' attribute is set to'from' attribute; if avalue of "error". o The entityserver receives a stanza thatgeneratesdoes not meet this restriction, it MUST generate an <improper-addressing/> stream errorstanza SHOULD includeand terminate theoriginal XML sent so thatunderlying TCP connection. 2. The domain identifier portion of thesender can inspect and, if necessary, correctJID contained in theXML before attempting to resend. o An error stanza MUST contain an <error/> child element. o An <error/> child'from' attribute MUSTNOT be included ifmatch the'type' attribute has a value other than "error"hostname of the sending server (or any validated domain thereof, such as a validated local domain hosted by the sending server) as communicated in the SASL negotiation (see Section 7), server dialback (see [XEP-0220], or similar means; ifthere is no 'type' attribute). o An entity thata server receivesan errora stanza that does not meet this restriction, it MUSTNOT respond to the stanza with a furthergenerate an <invalid-from/> stream errorstanza; thisand terminate the underlying TCP connection. Enforcement of these rules helps to preventlooping. 9.3.2. Syntaxa denial of service attack launched from a rogue server. 9.1.3. id Thesyntax'id' attribute MAY be used by a sending entity forstanza-related errorsinternal tracking of stanzas that it sends and receives (especially for tracking the request-response interaction inherent in the semantics of IQ stanzas). It isas follows:OPTIONAL for the value of the 'id' attribute to be unique globally, within a domain, or within a stream. The semantics of IQ stanzas impose additional restrictions; see Section 9.2.3. Saint-Andre ExpiresOctober 19, 2007January 18, 2008 [Page44]69] Internet-Draft XMPP CoreAprilJuly 2007<stanza-kind to='sender' type='error'> [RECOMMENDED to include sender XML here] <error type='error-type'> <defined-condition xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'/> [<text xmlns='urn:ietf:params:xml:ns:xmpp-stanzas' xml:lang='langcode'> OPTIONAL descriptive text </text>] [OPTIONAL application-specific condition element] </error> </stanza-kind>9.1.4. type The"stanza-kind" is one'type' attribute specifies detailed information about the purpose or context of the message, presence, oriq.IQ stanza. Thevalue ofparticular allowable values for the<error/> element's'type' attributeMUST be one ofvary depending on whether thefollowing: o cancel -- do not retry (the errorstanza isunrecoverable) o continue -- proceed (the condition was onlyawarning) o modify -- retry after changing the data sent o auth -- retry after providing credentials o wait -- retry after waiting (the error is temporary)message, presence, or IQ stanza. The<error/> element: o MUST contain a child element corresponding to one of thedefinedstanza error conditionsvalues for message and presence stanzas are specific to instant messaging and presence applications and therefore are specifiedbelow; this element MUST be qualified byin [XMPP-IM], whereas the'urn:ietf:params:xml:ns:xmpp-stanzas' namespace. o MAY contain a <text/> child containing XML character data that describesvalues for IQ stanzas specify theerrorrole of an IQ stanza inmore detail; this element MUST be qualified by the 'urn:ietf:params:xml:ns:xmpp-stanzas' namespacea structured request-response exchange and thus are specified under Section 9.2.3. The only 'type' value common to all three stanzas is "error"; see Section 9.3. 9.1.5. xml:lang A stanza SHOULD possess an 'xml:lang'attribute. o MAY contain a child element for an application-specific error condition; this element MUST be qualified by an application- defined namespace, and its structure isattribute (as definedbyin Section 2.12 of [XML]) if the stanza contains XML character data thatnamespace. The <text/> elementisOPTIONAL. If included, it SHOULDintended to beused onlypresented toprovide descriptive or diagnostic information that supplements the meaning ofadefined condition or application-specific condition. It SHOULD NOT be interpreted programmatically by an application. It SHOULD NOT be used as the error message presented to a user, but MAY be shownhuman user (as explained inaddition to[CHARSET], "internationalization is for humans"). The value of theerror message associated with'xml:lang' attribute specifies theincluded condition element (or elements). Finally, to maintain backward compatibility,default language of any such human-readable XML character data. <presence from='romeo@example.net/orchard' xml:lang='en'> <show>dnd</show> <status>Wooing Juliet</status> </presence> The value of theschema (specified in [XMPP-IM]) allows'xml:lang' attribute MAY be overridden by theoptional inclusion'xml: lang' attribute of a'code' attribute onspecific child element. <presence from='romeo@example.net/orchard' xml:lang='en'> <show>dnd</show> <status>Wooing Juliet</status> <status xml:lang='cs'>Dvořím se Julii</status> </presence If an outbound stanza generated by a client does not possess an 'xml: lang' attribute, the<error/> element;client's server MAY add an 'xml:lang' attribute whose value is that specified fordetails, see [XEP-0086].the stream as defined under Section 5.3. Saint-Andre ExpiresOctober 19, 2007January 18, 2008 [Page45]70] Internet-Draft XMPP CoreAprilJuly 20079.3.3. Defined Conditions The following conditions are defined for use inC: <presence from='romeo@example.net/orchard'> <show>dnd</show> <status>Wooing Juliet</status> </presence> S: <presence from='romeo@example.net/orchard' to='juliet@example.com/chamber' xml:lang='en'> <show>dnd</show> <status>Wooing Juliet</status> </presence> If an inbound stanzaerrors. o <bad-request/> -- the sender has sent XMLreceived does not possess an 'xml:lang' attribute, an implementation MUST assume that the default language ismalformed or that cannot be processed (e.g., an IQ stanzathatincludes an unrecognizedspecified for the stream as defined under Section 5.3. The value of the'type' attribute); the associated error type SHOULD be "modify". o <conflict/> -- access cannot be granted because an existing resource exists with'xml:lang' attribute MUST conform to thesame name or address;NMTOKEN datatype (as defined in Section 2.3 of [XML]) and MUST conform to theassociated error type SHOULD be "cancel". o <feature-not-implemented/> -- the feature requested is not implemented by the recipient orformat defined in [LANGTAGS]. A serverand therefore cannotMUST NOT modify or delete 'xml:lang' attributes on stanzas it receives from other entities. 9.2. Basic Semantics 9.2.1. Message Semantics The <message/> stanza can beprocessed;seen as a "push" mechanism whereby one entity pushes information to another entity, similar to theassociated error typecommunications that occur in a system such as email. All message stanzas SHOULDbe "cancel" or "modify". o <forbidden/> -- the requesting entity does notpossess a 'to' attribute that specifies therequired permissions to perform the action;intended recipient of theassociated error typemessage; upon receiving such a stanza, a server SHOULDbe "auth". o <gone/> --route or deliver it to the intended recipientor server(see Section 11 for general routing and delivery rules related to XML stanzas). 9.2.2. Presence Semantics The <presence/> stanza canno longerbecontacted atseen as a specialized broadcast or "publish-subscribe" mechanism, whereby multiple entities receive information about an entity to which they have subscribed (in thisaddress (the error stanza MAY containcase, network availability information). In general, anew addresspublishing entity (client) SHOULD send a presence stanza with no 'to' attribute, in which case theXML character data of the <gone/> element);server to which theassociated error typeentity is connected SHOULDbe "cancel"broadcast or"modify". o <internal-server-error/> --multiplex that stanza to all subscribing entities. However, a publishing entity MAY also send a presence stanza with a 'to' attribute, in which case the servercould not process theSHOULD route or deliver that stanzabecause of a misconfiguration or an otherwise-undefined internal server error; the associated error type SHOULD be "wait". o <item-not-found/> -- the addressed JID or item requested cannot be found; the associated error type SHOULD be "cancel". o <jid-malformed/> --to thesending entity has provided or communicated anintended recipient. See Section 11 for general routing and delivery rules related to XML stanzas, and [XMPP-IM] for rules Saint-Andre Expires January 18, 2008 [Page 71] Internet-Draft XMPPaddress (e.g., a value of the 'to' attribute)Core July 2007 specific to presence applications. 9.2.3. IQ Semantics Info/Query, oraspect thereof (e.g.,IQ, is aresource identifier) that does not adhererequest-response mechanism, similar in some ways to [HTTP]. The semantics of IQ enable an entity to make a request of, and receive a response from, another entity. The data content of thesyntaxrequest and response is definedunder Addresses (Section 3);by the schema or other structural definition associatederror type SHOULD be "modify". o <not-acceptable/> --with therecipient or server understandsXML namespace that qualifies therequest butdirect child element of the IQ element (see Section 9.4), and the interaction isrefusing to process it because it does not meet criteria definedtracked by therecipient or server (e.g.,requesting entity through use of the 'id' attribute. Thus, IQ interactions follow alocal policy regarding stanza size limitscommon pattern of structured data exchange such as get/result oracceptable words in messages); the associatedset/ result (although an errortype SHOULDmay be"modify". o <not-allowed/> -- the recipient or server does not allow any entity to perform the action (e.g., sendingreturned in reply toentities atablacklisted domain); the associated error type SHOULD be "cancel". o <not-authorized/> -- the sender must provide proper credentials before being allowedrequest if appropriate): Requesting Responding Entity Entity ---------- ---------- | | | <iq id='1' type='get'> | | [ ... payload ... ] | | </iq> | | -------------------------> | | | | <iq id='1' type='result'> | | [ ... payload ... ] | | </iq> | | <------------------------- | | | | <iq id='2' type='set'> | | [ ... payload ... ] | | </iq> | | -------------------------> | | | | <iq id='2' type='error'> | | [ ... condition ... ] | | </iq> | | <------------------------- | | | In order toperform the action, or has provided improper credentials; the associated error type SHOULD be "auth". o <not-modified/> -- the item requested has not changed since it was last requested; the associated error type SHOULD be "continue". o <payment-required/> --enforce these semantics, therequesting entityfollowing rules apply: 1. The 'id' attribute isnot authorized to access the requested service because paymentREQUIRED for IQ stanzas. 2. The 'type' attribute isrequired; the associated error type SHOULDREQUIRED for IQ stanzas. The value MUST be"auth".one of the following: Saint-Andre ExpiresOctober 19, 2007January 18, 2008 [Page46]72] Internet-Draft XMPP CoreAprilJuly 2007o <recipient-unavailable/>* get --the intended recipientThe stanza istemporarily unavailable; the associated error type SHOULD be "wait" (note: an application MUST NOT return this error if doing so would providea request for informationabout the intended recipient's network availability to an entity that is not authorized to know such information). o <redirect/>or requirements. * set --the recipientThe stanza provides required data, sets new values, orserverreplaces existing values. * result -- The stanza isredirecting requests for this informationa response toanother entity, usually temporarily (the error stanza SHOULD contain the alternate address, which MUST beavalid JID, in the XML character data of the <redirect/> element); the associatedsuccessful get or set request. * errortype SHOULD be "modify". o <registration-required/>--the requesting entity is not authorized to access the requested service because prior registration is required; the associatedAn errortype SHOULD be "auth". o <remote-server-not-found/> -- a remote server or service specified as parthas occurred regarding processing orall of the JIDdelivery ofthe intended recipient does not exist; the associated error type SHOULD be "cancel". o <remote-server-timeout/> --aremote serverpreviously-sent get orservice specified as partset (see Section 9.3). 3. An entity that receives an IQ request of type "get" orall"set" MUST reply with an IQ response of type "result" or "error". The response MUST preserve theJID'id' attribute of theintended recipient (or required to fulfill a request) could not be contacted withinrequest. 4. An entity that receives areasonable amountstanza oftime; the associated errortypeSHOULD be "wait". o <resource-constraint/> -- the server"result" orrecipient lacks the system resources necessary"error" MUST NOT respond toservice the request;theassociated errorstanza by sending a further IQ response of typeSHOULD be "wait". o <service-unavailable/> -- the server"result" orrecipient does not currently provide the requested service; the associated error type SHOULD be "cancel". o <subscription-required/> --"error"; however, the requesting entityis not authorizedMAY send another request (e.g., an IQ of type "set" in order toaccess the requested service becauseprovide required information discovered through asubscription is required; the associated error type SHOULD be "auth". o <undefined-condition/> -- the error condition is not oneget/result pair). 5. An IQ stanza ofthose defined by the other conditions in this list; any errortypemay be associated with this condition,"get" or "set" MUST contain one andit SHOULD be usedonlyin conjunction with an application-specific condition. o <unexpected-request/> -- the recipient or server understood the request but was not expecting it at this time (e.g.,one child element that specifies therequest was outsemantics oforder);theassociated errorparticular request. 6. An IQ stanza of typeSHOULD be "wait""result" MUST include zero or"modify". o <unknown-sender/> -- theone child elements. 7. An IQ stanza'from' address specified by a remote server or connected client is not known toof type "error" MAY include thereceiving serverchild element contained in the associated "get" oris not valid"set" and MUST include an <error/> child; for details, see Section 9.3. 9.3. Stanza Errors Stanza-related errors are handled in a manner similar to stream errors (Section 5.8). Unlike stream errors, stanza errors are recoverable; therefore they do not result in termination of thestream;XML stream and underlying TCP connection. Instead, the entity that discovers theassociatederrortype SHOULD be "modify". 9.3.4. Application-Specific Conditions As noted,condition returns anapplication MAY provide application-specificERROR STANZA to the sender, i.e., a stanzaerror information by includingof the same kind (message, presence, or IQ) whose 'type' attribute is set to aproperly-namespacedvalue of "error" and which contains an <error/> childinelement that specifies the errorelement.condition. Theapplication-specific element SHOULD supplement or Saint-Andre Expires October 19, 2007 [Page 47] Internet-Draft XMPP Core April 2007 further qualifyspecified error condition provides adefined element. Thus, the <error/> element will contain two or three child elements: <iq type='error' id='some-id'> <error type='modify'> <bad-request xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'/> <too-many-parameters xmlns='application-ns'/> </error> </iq> <message type='error' id='another-id'> <error type='modify'> <undefined-condition xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'/> <text xml:lang='en' xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'> Some special application diagnostic information... </text> <special-application-condition xmlns='application-ns'/> </error> </message> 9.4. Extended Namespaces Whilehint regarding actions that themessage, presence, and IQ stanza kinds provide basic semantics for messaging, availability, and request-response interactions, XMPP uses XML namespacessender can take toextend the stanzas forremedy thepurpose of providing additional functionality. Thus a message or presenceerror. 9.3.1. Rules The following rules apply to stanzaMAY contain oneerrors: 1. The receiving ormore optional child elements specifying contentprocessing entity thatextends the meaning of the message (e.g.,detects anXHTML-formatted version of the message body as describederror condition in[XEP-0071]), andrelation to a stanza SHOULD return an error stanza (and MUST do so for IQ stanzas). 2. The entity that generates an error stanza MAY include the original XML sent so that the sender can inspect and, if necessary, correct the XML before attempting to resend. Saint-Andre Expires January 18, 2008 [Page 73] Internet-Draft XMPP Core July 2007 3. An error stanza MUST containone suchan <error/> child element.This4. An <error/> childelement MAY have any name andMUSTpossess an 'xmlns' namespace declaration (other than "jabber:client", "jabber:server", or "http://etherx.jabber.org/streams") that defines all data contained withinNOT be included if thechild element. Such'type' attribute has achild element is said to be defined by an EXTENDED NAMESPACE. Support for any given extended namespace is OPTIONAL on the part of any implementation. If an entity does not understand such a namespace, the entity's expected behavior depends on whether the entityvalue other than "error" (or if there is(1) the recipient or (2) anno 'type' attribute). 5. An entity thatis routing thereceives an error stanza MUST NOT respond to therecipient: Saint-Andre Expires October 19, 2007 [Page 48] Internet-Draft XMPP Core April 2007 Recipient: If a recipient receives astanzathat containswith achild element it does not understand, it SHOULD ignore that specific XML data, i.e., it SHOULD not process it or present itfurther error stanza; this helps toa user or associated application (if any). In particular: * If an entity receives a message or presence stanza that containsprevent looping. 9.3.2. Syntax The syntax for stanza-related errors is: <stanza-kind from='intended-recipient' to='sender' type='error'> [OPTIONAL to include sender XMLdata qualified by a namespace it does not understand, the portionhere] <error type='error-type'> <defined-condition xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'/> [<text xmlns='urn:ietf:params:xml:ns:xmpp-stanzas' xml:lang='langcode'> OPTIONAL descriptive text </text>] [OPTIONAL application-specific condition element] </error> </stanza-kind> The "stanza-kind" is one of message, presence, or iq. The value of thestanza that is in<error/> element's 'type' attribute MUST be one of theunknown namespace SHOULDfollowing: o cancel -- do not retry (the error cannot beignored. * If an entity receives a message stanza whoseremedied) o continue -- proceed (the condition was onlychild element is qualified byanamespace it does not understand, it MUST ignorewarning) o modify -- retry after changing theentire stanza. * If an entity receives an IQ stanza of type "get" or "set" containingdata sent o auth -- retry after providing credentials o wait -- retry after waiting (the error is temporary) The <error/> element: o MUST contain a child elementqualified by a namespace it does not understand,corresponding to one of theentity SHOULD return an IQdefined stanzaof type "error" with anerrorcondition of <service-unavailable/>. Router: If a routing entity (usually a server) handles a stanza that containsconditions specified; this element MUST be qualified by the 'urn:ietf:params:xml:ns:xmpp-stanzas' namespace. o MAY contain a <text/> child elementit does not understand, it SHOULD ignore the associatedcontaining XML character databy passing it on untouched tothat describes therecipient. 10. Examples 10.1. Client-to-Server The following examples showerror in more detail; this element MUST be qualified by thedata flow for a client negotiating an XML stream with a server, exchanging XML stanzas,'urn:ietf:params:xml:ns:xmpp-stanzas' namespace andclosing the negotiated stream. The server is "example.com",SHOULD possess an 'xml:lang' attribute specifying theserver requires usenatural language ofTLS, the client authenticates via the SASL DIGEST-MD5 mechanism as "juliet@example.com", and the client binds the resource "balcony" to the stream. (Note: The alternate steps shown below are provided to illustratetheprotocolXML character data. o MAY contain a child element forfailure cases; they are not exhaustive and would not necessarilyan application-specific error condition; this element MUST betriggeredqualified bythe data sent in the examples.) Step 1: Client initiates stream to server: <stream:stream xmlns='jabber:client' xmlns:stream='http://etherx.jabber.org/streams' xml:lang='en' from='juliet@example.com' to='example.com' version='1.0'>an application- defined namespace, and its structure is defined by that namespace. Saint-Andre ExpiresOctober 19, 2007January 18, 2008 [Page49]74] Internet-Draft XMPP CoreAprilJuly 2007Step 2: Server responds by sending a stream header to client: <stream:stream xmlns='jabber:client' xmlns:stream='http://etherx.jabber.org/streams' xml:lang='en' from='example.com' id='c2s_123' to='juliet@example.com' version='1.0'> Step 3: Server sends stream features to client (STARTTLS extension and authentication mechanisms): <stream:features> <starttls xmlns='urn:ietf:params:xml:ns:xmpp-tls'> <required/> </starttls> </stream:features> Step 4: Client sends STARTTLS command to server: <starttls xmlns='urn:ietf:params:xml:ns:xmpp-tls'/> Step 5: Server informs client that itThe <text/> element isallowedOPTIONAL. If included, it SHOULD be used only toproceed: <proceed xmlns='urn:ietf:params:xml:ns:xmpp-tls'/> Step 5 (alt): Server informs clientprovide descriptive or diagnostic information thatTLS negotiation has failed and closes both XML stream and TCP connection: <failure xmlns='urn:ietf:params:xml:ns:xmpp-tls'/> </stream:stream> Step 6: Client and server attempt to complete TLS negotiation oversupplements theexisting TCP connection (see [TLS] for details). Step 7: If TLS negotiation is successful, client initiatesmeaning of anew stream to server: <stream:stream xmlns='jabber:client' xmlns:stream='http://etherx.jabber.org/streams' xml:lang='en' from='juliet@example.com' to='example.com' version='1.0'> Saint-Andre Expires October 19, 2007 [Page 50] Internet-Draft XMPP Core April 2007 Step 7 (alt): If TLS negotiation is unsuccessful, server closes TCP connection. Step 8: Server respondsdefined condition or application-specific condition. It SHOULD NOT be interpreted programmatically bysendingan application. It SHOULD NOT be used as the error message presented to astream headeruser, but MAY be shown in addition toclient alongthe error message associated withany available stream features (notice thattheserver now shows a different set of SASL mechanisms; hereincluded condition element (or elements). Finally, to maintain backward compatibility, theserver acceptsschema for theSASL PLAIN mechanism oncedefault namespace (specified in [XMPP-IM]) allows thestream has been secured via TLS): <stream:stream xmlns='jabber:client' xmlns:stream='http://etherx.jabber.org/streams' xml:lang='en' from='example.com' id='c2s_234' to='juliet@example.com' version='1.0'> <stream:features> <mechanisms xmlns='urn:ietf:params:xml:ns:xmpp-sasl'> <mechanism>DIGEST-MD5</mechanism> <mechanism>PLAIN</mechanism> <required/> </mechanisms> </stream:features> Step 9: Client selects an authentication mechanism, in this case [DIGEST-MD5] with an empty authorization identity ("="): <auth xmlns='urn:ietf:params:xml:ns:xmpp-sasl' mechanism='DIGEST-MD5'>=</auth> Step 10: Server sendsoptional inclusion of a[BASE64] encoded challenge to client: <challenge xmlns='urn:ietf:params:xml:ns:xmpp-sasl'> cmVhbG09ImV4YW1wbGUuY29tIixub25jZT0iT0E2TUc5dEVRR20yaGgiLHFvcD0i YXV0aCIsY2hhcnNldD11dGYtOCxhbGdvcml0aG09bWQ1LXNlc3MK </challenge> The decoded challenge is: realm="example.com",nonce="OA6MG9tEQGm2hh", qop="auth",charset=utf-8,algorithm=md5-sess Note: When'code' attribute on theserver sends<error/> element; for details, see [XEP-0086]. 9.3.3. Defined Conditions The following conditions are defined for use in stanza errors. 9.3.3.1. bad-request The sender has sent aDIGEST-MD5 challengestanza containing XML that does not conform to theclient, the qop list mustappropriate schema or that cannot bequoted since it is a list rather than a single item (even if there is only one item inprocessed (e.g., an IQ stanza that includes an unrecognized value of thelist); however, when'type' attribute); theclient sends its response toassociated error type SHOULD be "modify". C: <iq from='juliet@example.com/balcony' id='some-id' to='example.com' type='subscribe'> <ping xmlns='urn:xmpp:ping'/> </iq> S: <iq from='example.com' id='some-id' to='juliet@example.com/balcony' type='error'> <error type='modify'> <bad-request xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'/> </error> </iq> 9.3.3.2. conflict Access cannot be granted because an existing resource exists with theserver (see below),same name or address; theqop must notassociated error type SHOULD bequoted since it is a single item rather than a list."cancel". Saint-Andre ExpiresOctober 19, 2007January 18, 2008 [Page51]75] Internet-Draft XMPP CoreAprilJuly 2007Step 10 (alt): Server returns error to client: <failure xmlns='urn:ietf:params:xml:ns:xmpp-sasl'> <temporary-auth-failure/> </failure> </stream:stream> Step 11: Client sends a [BASE64] encoded response to the challenge: <response xmlns='urn:ietf:params:xml:ns:xmpp-sasl'> dXNlcm5hbWU9Imp1bGlldCIscmVhbG09ImV4YW1wbGUuY29tIixub25jZT0iT0E2 TUc5dEVRR20yaGgiLGNub25jZT0iT0E2TUhYaDZWcVRyUmsiLG5jPTAwMDAwMDAx LHFvcD1hdXRoLGRpZ2VzdC11cmk9InhtcHAvZXhhbXBsZS5jb20iLHJlc3BvbnNl PWQzODhkYWQ5MGQ0YmJkNzYwYTE1MjMyMWYyMTQzYWY3LGNoYXJzZXQ9dXRmLTgK </response>C: <iq id='bind_2' type='set'> <bind xmlns='urn:ietf:params:xml:ns:xmpp-bind'> <resource>balcony</resource> </bind> </iq> S: <iq id='bind_2' type='error'> <error type='cancel'> <conflict xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'/> </error> </iq> 9.3.3.3. feature-not-implemented Thedecoded response is: username="juliet",realm="example.com", nonce="OA6MG9tEQGm2hh",cnonce="OA6MHXh6VqTrRk", nc=00000001,qop=auth,digest-uri="xmpp/example.com", response=d388dad90d4bbd760a152321f2143af7,charset=utf-8 Step 12: Server informs client of success and includes [BASE64] encoded value for subsequent authentication: <success xmlns='urn:ietf:params:xml:ns:xmpp-sasl'> cnNwYXV0aD1lYTQwZjYwMzM1YzQyN2I1NTI3Yjg0ZGJhYmNkZmZmZAo= </success> The decoded value for subsequent authentication is: rspauth=ea40f60335c427b5527b84dbabcdfffd Step 12 (alt): Server returns error to client: <failure xmlns='urn:ietf:params:xml:ns:xmpp-sasl'> <temporary-auth-failure/> </failure> </stream:stream> Saint-Andre Expires October 19, 2007 [Page 52] Internet-Draft XMPP Core April 2007 Step 13: Client initiates a new stream to server: <stream:stream xmlns='jabber:client' xmlns:stream='http://etherx.jabber.org/streams' xml:lang='en' from='juliet@example.com' to='example.com' version='1.0'> Step 14: Server responds by sending a stream header to client along with supported features (in this case resource binding): <stream:stream xmlns='jabber:client' xmlns:stream='http://etherx.jabber.org/streams' xml:lang='en' from='example.com' id='c2s_345' to='juliet@example.com' version='1.0'> <stream:features> <bind xmlns='urn:ietf:params:xml:ns:xmpp-bind'> <required/> </bind> </stream:features> Upon being so informed that resource bindingfeature represented in the XML stanza isrequired,not implemented by theclient MUST bind a resource torecipient or server and therefore thestream; here we assume thatstanza cannot be processed; theclient binds a resource called "balcony". Step 15: Client binds a resource:associated error type SHOULD be "cancel" or "modify". C: <iqtype='set' id='bind_1'> <bind xmlns='urn:ietf:params:xml:ns:xmpp-bind'> <resource>balcony</resource> </bind>from='juliet@example.com/balcony' id='subscriptions1' to='pubsub.example.com' type='get'> <pubsub xmlns='http://jabber.org/protocol/pubsub'> <subscriptions/> </pubsub> </iq> E: <iq from='pubsub.example.com id='subscriptions1' to='juliet@example.com/balcony' type='error'> <error type='cancel'> <feature-not-implemented xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'/> <unsupported xmlns='http://jabber.org/protocol/pubsub#errors' feature='retrieve-subscriptions'/> </error> </iq> 9.3.3.4. forbidden The requesting entity does not possess the required permissions to perform the action; the associated error type SHOULD be "auth". Saint-Andre ExpiresOctober 19, 2007January 18, 2008 [Page53]76] Internet-Draft XMPP CoreAprilJuly 2007Step 16: Server informs client of successful resource binding: <iq type='result'C: <presence from='juliet@example.com/balcony' to='characters@chat.example.com/JulieC'> <x xmlns='http://jabber.org/protocol/muc'/> </presence> E: <presence from='characters@chat.example.com/JulieC' to='juliet@example.com/balcony'id='bind_1'> <bind xmlns='urn:ietf:params:xml:ns:xmpp-bind'> <jid>juliet@example.com/balcony</jid> </bind> </iq> Nowtype='error'> <error type='auth'> <forbidden xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'/> </error> </presence> 9.3.3.5. gone The recipient or server can no longer be contacted at this address (the error stanza MAY contain a new address in theclient is allowed to sendXMLstanzas overcharacter data of thenegotiated stream. Client sends XML stanza to other entity: <message from='juliet@example.com/balcony' to='romeo@example.net' xml:lang='en'> <body>Art thou not Romeo, and a Montague?</body> </message> If necessary, sender's server negotiates XML streams with intended recipient's server (see Server-to-Server Examples (Section 10.2)). The intended recipient replies and the message is delivered to<gone/> element); theclient. Client receives XML stanza from other entity: <message from='romeo@example.net/orchard'associated error type SHOULD be "cancel" or "modify". C: <presence from='juliet@example.com/balcony' to='characters@chat.example.com/JulieC'> <x xmlns='http://jabber.org/protocol/muc'/> </presence> E: <presence from='characters@chat.example.com/JulieC' to='juliet@example.com/balcony'xml:lang='en'> <body>Neither, fair saint, if either thee dislike.</body> </message> Desiring to send no further messages, the client closes the stream. Client closestype='error'> <error type='modify'> <gone xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'> conference.example.com </gone> </error> </presence> 9.3.3.6. internal-server-error <internal-server-error/> -- thestream: </stream:stream> Consistent withserver could not process therecommended stream closing handshake,stanza because of a misconfiguration or an otherwise-undefined internal servercloses stream as well: Server closeserror; thestream: </stream:stream>associated error type SHOULD be "wait" or "cancel". Saint-Andre ExpiresOctober 19, 2007January 18, 2008 [Page54]77] Internet-Draft XMPP CoreAprilJuly 2007Client now terminates the underlying TCP connection. 10.2. Server-to-Server ExamplesC: <presence from='juliet@example.com/balcony' to='characters@chat.example.com/JulieC'> <x xmlns='http://jabber.org/protocol/muc'/> </presence> E: <presence from='characters@chat.example.com/JulieC' to='juliet@example.com/balcony' type='error'> <error type='wait'> <internal-server-error xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'/> </error> </presence> 9.3.3.7. item-not-found Thefollowing examples show the data flow for a server negotiating an XML stream with another server, exchanging XML stanzas, and closingaddressed JID or item requested cannot be found; thenegotiated stream. The initiating server ("Server1") is "example.com";associated error type SHOULD be "cancel" or "modify". C: <iq id='unbind_1' type='set'> <unbind xmlns='urn:ietf:params:xml:ns:xmpp-bind'> <resource>someresource</resource> </unbind> </iq> S: <iq id='unbind_1' type='error'> <error type='cancel'> <item-not-found xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'/> </error> </iq> An application MUST NOT return this error if doing so would provide information about thereceiving server ("Server2")intended recipient's network availability to an entity that isexample.net andnot authorized to know such information; instead itrequires use of TLS; example.com presentsSHOULD return acertificate and authenticates via the SASL EXTERNAL mechanism. (Note:<service-unavailable/> error. 9.3.3.8. jid-malformed Thealternate steps shown below aresending entity has providedto illustrateor communicated an XMPP address (e.g., a value of theprotocol for failure cases; they are not exhaustive and would'to' attribute) or aspect thereof (e.g., an XMPP resource identifier) that does notnecessarilyadhere to the syntax defined under Section 3; the associated error type SHOULD betriggered"modify". Saint-Andre Expires January 18, 2008 [Page 78] Internet-Draft XMPP Core July 2007 C: <presence from='juliet@example.com/balcony' to='ch@r@cters@chat.example.com/JulieC'> <x xmlns='http://jabber.org/protocol/muc'/> </presence> E: <presence from='ch@r@cters@chat.example.com/JulieC' to='juliet@example.com/balcony' type='error'> <error type='modify'> <jid-malformed xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'/> </error> </presence> 9.3.3.9. not-acceptable The recipient or server understands the request but is refusing to process it because it does not meet criteria defined by thedata sentrecipient or server (e.g., a local policy regarding stanza size limits or acceptable words in messages); theexamples.) Step 1: Server1 initiates streamassociated error type SHOULD be "modify". C: <message to='juliet@example.com' id='foo'> <body>[ ... the-emacs-manual ... ]</body> </message> S: <message from='juliet@example.com' id='foo'> <error type='modify'> <not-acceptable xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'/> </error> </message> 9.3.3.10. not-allowed The recipient or server does not allow any entity toServer2: <stream:stream xmlns='jabber:server' xmlns:stream='http://etherx.jabber.org/streams' from='example.com' to='example.net' version='1.0'> Step 2: Server2 responds byperform the action (e.g., sendinga stream tag to Server1: <stream:stream xmlns='jabber:server' xmlns:stream='http://etherx.jabber.org/streams' from='example.net' id='s2s_123' to='example.com' version='1.0'> Step 3: Server2 sends stream featurestoServer1 (STARTTLS extension and authentication mechanisms): <stream:features> <starttls xmlns='urn:ietf:params:xml:ns:xmpp-tls'> <required/> </starttls> </stream:features> Step 4: Server1 sendsentities at a blacklisted domain); theSTARTTLS command to Server2: <starttls xmlns='urn:ietf:params:xml:ns:xmpp-tls'/>associated error type SHOULD be "cancel". Saint-Andre ExpiresOctober 19, 2007January 18, 2008 [Page55]79] Internet-Draft XMPP CoreAprilJuly 2007Step 5: Server2 informs Server1 that it isC: <presence from='juliet@example.com/balcony' to='characters@chat.example.com/JulieC'> <x xmlns='http://jabber.org/protocol/muc'/> </presence> E: <presence from='characters@chat.example.com/JulieC' to='juliet@example.com/balcony'> <error type='cancel'> <not-allowed xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'/> </error> </presence> 9.3.3.11. not-authorized The sender must provide proper credentials before being allowed toproceed: <proceed xmlns='urn:ietf:params:xml:ns:xmpp-tls'/> Step 5 (alt): Server2 informs Server1 that TLS negotiationperform the action, or hasfailed and closes stream: <failure xmlns='urn:ietf:params:xml:ns:xmpp-tls'/> </stream:stream> Step 6: Server1 and Server2 attempt to complete TLS negotiation via TCP. Step 7: If TLS negotiationprovided improper credentials; the associated error type SHOULD be "auth". C: <presence from='juliet@example.com/balcony' to='characters@chat.example.com/JulieC'> <x xmlns='http://jabber.org/protocol/muc'/> </presence> E: <presence from='characters@chat.example.com/JulieC' to='juliet@example.com/balcony'> <error type='auth'> <not-authorized xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'/> </error> </presence> 9.3.3.12. not-modified The item requested has not changed since it was last requested; the associated error type SHOULD be "continue". Saint-Andre Expires January 18, 2008 [Page 80] Internet-Draft XMPP Core July 2007 C: <iq from='juliet@capulet.com/balcony' id='roster2' type='get'> <query xmlns='jabber:iq:roster'> <headers xmlns='http://jabber.org/protocol/shim'> <header name='If-None-Match'>some-long-opaque-string</header> </headers> </query> </iq> S: <iq type='error' to='juliet@capulet.com/balcony' id='roster2'> <query xmlns='jabber:iq:roster'> <headers xmlns='http://jabber.org/protocol/shim'> <header name='If-None-Match'>some-long-opaque-string</header> </headers> </query> <error type='modify'> <not-modified xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'/> </error> </iq> 9.3.3.13. payment-required The requesting entity issuccessful, Server1 initiates a new streamnot authorized toServer2: <stream:stream xmlns='jabber:server' xmlns:stream='http://etherx.jabber.org/streams' from='example.com' to='example.net' version='1.0'> Step 7 (alt): If TLS negotiationaccess the requested service because payment isunsuccessful, Server2 closes TCP connection. Step 8: Server2 responds by sending a stream header to Server1 along with available stream features (notice that Server2 now prefersrequired; theSASL EXTERNAL mechanism): <stream:stream xmlns='jabber:server' xmlns:stream='http://etherx.jabber.org/streams' from='example.net' id='s2s_234' to='example.com' version='1.0'> <stream:features> <mechanisms xmlns='urn:ietf:params:xml:ns:xmpp-sasl'> <mechanism>EXTERNAL</mechanism> <mechanism>DIGEST-MD5</mechanism> <required/> </mechanisms> </stream:features>associated error type SHOULD be "auth". C: <iq from='romeo@example.net/foo' id='items1' to='pubsub.example.com' type='get'> <pubsub xmlns='http://jabber.org/protocol/pubsub'> <items node='my_musings'/> </pubsub> </iq> E: <iq from='pubsub.example.com' id='items1' to='romeo@example.net/foo' type='error'> <error type='auth'> <payment-required xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'/> </error> </iq> Saint-Andre ExpiresOctober 19, 2007January 18, 2008 [Page56]81] Internet-Draft XMPP CoreAprilJuly 2007Step 9: Server1 selects9.3.3.14. recipient-unavailable The intended recipient is temporarily unavailable; theEXTERNAL mechanism, inassociated error type SHOULD be "wait". C: <presence from='juliet@example.com/balcony' to='characters@chat.example.com/JulieC'> <x xmlns='http://jabber.org/protocol/muc'/> </presence> E: <presence from='characters@chat.example.com/JulieC' to='juliet@example.com/balcony'> <error type='wait'> <recipient-unavailable xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'/> </error> </presence> An application MUST NOT return thiscase witherror if doing so would provide information about the intended recipient's network availability to anauthorization identity encoded accordingentity that is not authorized to[BASE64]: <auth xmlns='urn:ietf:params:xml:ns:xmpp-sasl' mechanism='EXTERNAL'/>ZXhhbXBsZS5jb20K</auth>know such information; instead it SHOULD return a <service-unavailable/> error. 9.3.3.15. redirect Thedecoded authorization identityrecipient or server is"example.com". Step 10: Server2 determines that the authorization identity provided by Server1 matches the valid id-xmppAddr-on or Common Nameredirecting requests for this information to another entity, typically inthe presented certificate and therefore returns success: <success xmlns='urn:ietf:params:xml:ns:xmpp-sasl'/> Step 11 (alt): Server2 informs Server1 of failed authentication: <failure xmlns='urn:ietf:params:xml:ns:xmpp-sasl'> <not-authorized/> </failure> </stream:stream> Step 12: Server1 initiatesanew stream to Server2: <stream:stream xmlns='jabber:server' xmlns:stream='http://etherx.jabber.org/streams' from='example.com' to='example.net' version='1.0'> Step 13: Server2 responds by sendingtemporary fashion (the error stanza SHOULD contain the alternate address, which SHOULD be astream header to Server1 along with any additional features (or,valid JID, inthis case, an empty features element): <stream:stream xmlns='jabber:server' xmlns:stream='http://etherx.jabber.org/streams' from='example.net' id='s2s_345' to='example.com' version='1.0'> <stream:features/> Now Server1 is allowed to sendthe XMLstanzas to Server2 overcharacter data of thenegotiated stream; here we assume that<redirect/> element); thetransferred stanzas are those shown earlier for client-to-server communications.associated error type SHOULD be "modify". C: <presence from='juliet@example.com/balcony' to='characters@chat.example.com/JulieC'> <x xmlns='http://jabber.org/protocol/muc'/> </presence> E: <presence from='characters@chat.example.com/JulieC' to='juliet@example.com/balcony' type='error'> <error type='modify'> <redirect xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'> characters@conference.example.org </redirect> </error> Saint-Andre ExpiresOctober 19, 2007January 18, 2008 [Page57]82] Internet-Draft XMPP CoreAprilJuly 2007Server1 sends XML stanza to Server2: <message from='juliet@example.com/balcony' to='romeo@example.net' xml:lang='en'> <body>Art thou not Romeo, and a Montague?</body> </message></presence> 9.3.3.16. registration-required Theintended recipient replies and the messagerequesting entity isdelivered from Server2 to Server1. Server2 sends XML stanza to Server1: <message from='romeo@example.net/orchard' to='juliet@example.com/balcony' xml:lang='en'> <body>Neither, fair saint, if either thee dislike.</body> </message> Desiringnot authorized tosend no further messages, Server1 closes the stream. (In practice,access thestream would most likely remain open for some time, since Server1 and Server2 do not immediately know ifrequested service because prior registration is required; thestream willassociated error type SHOULD beneeded for further communications.) Server1 closes the stream: </stream:stream> Consistent with the recommended stream closing handshake, Server2 closes stream"auth". C: <presence from='juliet@example.com/balcony' to='characters@chat.example.com/JulieC'> <x xmlns='http://jabber.org/protocol/muc'/> </presence> E: <presence from='characters@chat.example.com/JulieC' to='juliet@example.com/balcony'> <error type='auth'> <registration-required xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'/> </error> </presence> 9.3.3.17. remote-server-not-found A remote server or service specified aswell: Server2 closespart or all of thestream: </stream:stream> Server1 now terminatesJID of theunderlying TCP connection. 11. Server Rules for Handling XML Stanzas Compliantintended recipient does not exist; the associated error type SHOULD be "cancel". C: <presence from='juliet@example.com/balcony' to='characters@chat.example.com/JulieC'> <x xmlns='http://jabber.org/protocol/muc'/> </presence> E: <presence from='characters@chat.example.com/JulieC' to='juliet@example.com/balcony'> <error type='wait'> <remote-server-not-found xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'/> </error> </presence> Saint-Andre Expires January 18, 2008 [Page 83] Internet-Draft XMPP Core July 2007 9.3.3.18. remote-server-timeout A remote serverimplementations MUST ensure in-order processingor service specified as part or all ofXML stanzas between any two entities. This includes stanzas sent by a client to its server for direct processing bytheserver. BeyondJID of therequirement for in-order processing, each server implementation will contain its own "delivery tree" for handling stanzas it receives. Suchintended recipient (or required to fulfill atree determines whetherrequest) could not be contacted within astanza needs toreasonable amount of time; the associated error type SHOULD berouted to another domain, processed direct,"wait". C: <presence from='juliet@example.com/balcony' to='characters@chat.example.com/JulieC'> <x xmlns='http://jabber.org/protocol/muc'/> </presence> E: <presence from='characters@chat.example.com/JulieC' to='juliet@example.com/balcony'> <error type='wait'> <remote-server-timeout xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'/> </error> </presence> 9.3.3.19. resource-constraint The server ordeliveredrecipient lacks the system resources necessary toaservice the request; the associated error type SHOULD be "wait". C: <iq from='romeo@example.net/foo' id='items1' to='pubsub.example.com' type='get'> <pubsub xmlns='http://jabber.org/protocol/pubsub'> <items node='my_musings'/> </pubsub> </iq> E: <iq from='pubsub.example.com' id='items1' to='romeo@example.net/foo' type='error'> <error type='wait'> <resource-constraint xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'/> </error> </iq> Saint-Andre ExpiresOctober 19, 2007January 18, 2008 [Page58]84] Internet-Draft XMPP CoreAprilJuly 2007resource associated with a connected node.9.3.3.20. service-unavailable Thefollowing rules apply. 11.1. No 'to' Address Ifserver or recipient does not currently provide thestanza possesses no 'to' attribute,requested service; theserverassociated error type SHOULDprocess it directly on behalf of the entity that sent it. Because all stanzas received from other servers MUST possessbe "cancel". C: <message from='romeo@example.net/foo' to='juliet@example.com'> <body>Hello?</body> </message> S: <message from='juliet@example.com/foo' to='romeo@example.net'> <error type='cancel'> <service-unavailable xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'/> </error> </message> An application SHOULD return a'to' attribute, this rule applies only<service-unavailable/> error instead of <item-not-found/> or <recipient-unavailable/> if sending one of the latter errors would provide information about the intended recipient's network availability tostanzas received from a registeredan entity(such as a client)that isconnectednot authorized to know such information. 9.3.3.21. subscription-required The requesting entity is not authorized to access theserver. If the server receivesrequested service because apresence stanza with no 'to' attribute,subscription is required; theserverassociated error type SHOULDbroadcast it to the entities that are subscribed to the sending entity's presence, if applicable (the semanticsbe "auth". C: <message from='romeo@example.net/orchard' to='playbot@shakespeare.example.com' <body>help</body> </message> E: <message from='playbot@shakespeare.example.com' to='romeo@example.net/orchard' type='error'> <error type='auth'> <subscription-required xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'/> </error> </message> Saint-Andre Expires January 18, 2008 [Page 85] Internet-Draft XMPP Core July 2007 9.3.3.22. undefined-condition The error condition is not one ofpresence broadcast for presence applications arethose definedin [XMPP-IM]). Ifby theserver receives an IQ stanza ofother conditions in this list; any error type"get" or "set"may be associated withno 'to' attributethis condition, and itunderstands the namespace that qualifies the content ofSHOULD be used only in conjunction with an application-specific condition. C: <message from='northumberland@shakespeare.lit' id='richard2-4.1.247' to='kingrichard@royalty.england.lit'> <body>My lord, dispatch; read o'er these articles.</body> <amp xmlns='http://jabber.org/protocol/amp'> <rule action='notify' condition='deliver' value='stored'/> </amp> S: <message from='example.org' id='amp1' to='northumberland@example.net/field' type='error'> <amp xmlns='http://jabber.org/protocol/amp' from='kingrichard@example.org' status='error' to='northumberland@example.net/field'> <rule action='error' condition='deliver' value='stored'/> </amp> <error type='modify'> <undefined-condition xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'/> <failed-rules xmlns='http://jabber.org/protocol/amp#errors'> <rule action='error' condition='deliver' value='stored'/> </failed-rules> </error> </message> 9.3.3.23. unexpected-request The recipient or server understood thestanza,request but was not expecting itMUST either process the stanza directly on behalf of sending entity (where the meaning of "process" is determined byat this time (e.g., thesemanticsrequest was out of order); thequalifying namespace) or return anassociated errorto the sending entity. 11.2. Foreign Domain If the hostname of the domain identifier portion oftype SHOULD be "wait" or "modify". Saint-Andre Expires January 18, 2008 [Page 86] Internet-Draft XMPP Core July 2007 C: <iq from='romeo@example.net/foo' id='unsub1' to='pubsub.example.com' type='set'> <pubsub xmlns='http://jabber.org/protocol/pubsub'> <unsubscribe node='my_musings' jid='romeo@example.net'/> </pubsub> </iq> E: <iq from='pubsub.example.com' id='unsub1' to='romeo@example.net/foo' type='error'> <error type='cancel'> <unexpected-request xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'/> <not-subscribed xmlns='http://jabber.org/protocol/pubsub#errors'/> </error> </iq> 9.3.3.24. unknown-sender The stanza 'from' address specified by a connected client is not valid for theJID contained instream (e.g., the'to' attributestanza does notmatch one of the configured hostnames of the server itself orinclude aconfigured local domain thereof,'from' address when multiple resources are bound to theserver SHOULD routestream); the associated error type SHOULD be "modify". C: <message to='romeo@example.net'> <body>Wherefore art thou?</body> </message> S: <message from='romeo@example.net' type='error'> <body>Wherefore art thou?</body> <error type='modify'> <unknown-sender xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'/> </error> </message> 9.3.4. Application-Specific Conditions As noted, an application MAY provide application-specific stanzatoerror information by including a properly-namespaced child in theforeign domain (subject to local service provisioning and security policies regarding inter-domain communication, since such communication is OPTIONAL). There are two possible cases: A server-to-server stream already exists betweenerror element. The application-specific element SHOULD supplement or further qualify a defined element. Thus, the <error/> element will Saint-Andre Expires January 18, 2008 [Page 87] Internet-Draft XMPP Core July 2007 contain twodomains: The sender's server routesor three child elements: <iq id='some-id' type='error'> <error type='modify'> <bad-request xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'/> <too-many-parameters xmlns='application-ns'/> </error> </iq> <message type='error' id='another-id'> <error type='modify'> <undefined-condition xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'/> <text xml:lang='en' xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'> [ ... application-specific information ... ] </text> <special-application-condition xmlns='application-ns'/> </error> </message> 9.4. Extended Content While thestanzamessage, presence, and IQ stanzas provide basic semantics for messaging, availability, and request-response interactions, XMPP uses XML namespaces (see [XML-NAMES] to extend theauthoritative serverbasic stanza syntax for theforeign domain over the existing stream There exists no server-to-server stream between the two domains: The sender's server (1) resolvespurpose of providing additional functionality. Thus a message or presence stanza MAY contain one or more optional child elements specifying content that extends thehostnamemeaning of theforeign domain (as defined under Server-to-Server Communications (Section 15.4)), (2) negotiates a server-to-server stream betweenmessage (e.g., an XHTML-formatted version of thetwo domains (as defined under TLS negotiation (Section 6)message body as described in [XEP-0071]), andSASL negotiation (Section 7)),an IQ stanza of type "get" or "set" MUST contain one such child element. This child element MAY have any name and(3) routesMUST possess an 'xmlns' namespace declaration (other than "jabber:client", "jabber:server", or "http://etherx.jabber.org/streams") that defines all data contained within thestanzachild element. Such a child element is said tothe authoritative server for the foreign domain over the newly-established stream If routingbe EXTENDED CONTENT and its namespace name is said tothe recipient's serverbe an EXTENDED NAMESPACE. Support for any given extended namespace isunsuccessful,OPTIONAL on thesender's server MUST returnpart of any implementation. If anerror to the sender; ifentity does not understand such a namespace, therecipient's server can be contacted but delivery byentity's expected behavior depends on whether therecipient's server toentity is (1) the recipient or (2) an entity that isunsuccessful,routing therecipient's server MUST return an errorstanza to thesender by way of the sender's server.recipient: Saint-Andre ExpiresOctober 19, 2007January 18, 2008 [Page59]88] Internet-Draft XMPP CoreAprilJuly 200711.3. Local DomainRecipient: Ifthe hostname of the domain identifier portion of the JID contained in the 'to' attribute matches one of the configured hostnames of the server, or one of the configured local domains hosted by the server, the server MUST either process the stanza itself or route the stanza toaspecialized servicerecipient receives a stanza thatis responsible forcontains a child element it does not understand, it SHOULD silently ignore thatlocal domain,particular XML data, i.e., it SHOULD not process it orreturn an errorpresent it tothe sender (if the service providing the local domain is not available). 11.4. Mere Domaina user orSpecific Resourceassociated application (if any). In particular: * If an entity receives a message or presence stanza that contains XML data qualified by a namespace it does not understand, thehostname of the domain identifierportion of theJID contained instanza that qualified by the'to' attribute matchesunknown namespace SHOULD be ignored. * If an entity receives aconfigured hostname of the server itself and the JID contained in the 'to' attributemessage stanza whose only child element isof the form <domain> or <domain/resource>, the server (orqualified by adefined resource thereof)namespace it does not understand, it MUSTeither process the stanza as appropriate forignore the entire stanza. * If an entity receives an IQ stanzakindof type "get" or "set" containing a child element qualified by a namespace it does not understand, the entity SHOULD return anerrorIQ stanzato the sender. 11.5. Node in Same Domain If the hostnameofthe domain identifier portiontype "error" with an error condition ofthe JID contained in the 'to' attribute matches<service-unavailable/>. Router: If a routing entity (typically a server) handles aconfigured hostname of the server itself and the JID contained in the 'to' attribute is of the form <node@domain> or <node@domain/resource>, the server SHOULD deliver thestanzato the intended recipient ofthat contains a child element it does not understand, it SHOULD ignore thestanza as representedassociated XML data by routing or delivering it untouched to theJID contained in the 'to' attribute.recipient. 10. Examples 10.1. Client-to-Server The followingrules apply: 1. Ifexamples show theJID containsXMPP data flow for aresource identifier (i.e., is of the form <node@domain/resource>) and there existsclient negotiating an XML stream with aconnected resource that exactly matches the full JID,server, exchanging XML stanzas, and closing therecipient'snegotiated stream. The serverSHOULD deliver the stanza tois "example.com", thestream or connection that exactly matchesserver requires use of TLS, theresource identifier. 2. Ifclient authenticates via theJID contains a resource identifierSASL DIGEST-MD5 mechanism as "juliet@example.com", andthere exists no connected resource that exactly matches the full JID,therecipient's server SHOULD returnclient binds a<service-unavailable/> stanza errorserver-generated resource to thesender. 3. If the JIDstream. It isof the form <node@domain> and there exists at least one connected resource for the node,assumed that before sending therecipient's server SHOULD deliverinitial stream header, thestanzaclient has already resolved an SRV record of _xmpp-client._tcp.example.com and has opened a TCP connection to the advertised port atleast one oftheconnected resources, accordingresolved IP address. Note: The alternate steps shown are provided only toapplication-specific rules. Particular XMPP applications MAY specify delivery rules that modify or supplementillustrate theforegoing rules; for example, a set of delivery rulesprotocol forinstant messagingfailure cases; they are not exhaustive andpresence applications is definedwould not necessarily be triggered by the data sent in[XMPP-IM].the examples. Saint-Andre ExpiresOctober 19, 2007January 18, 2008 [Page60]89] Internet-Draft XMPP CoreAprilJuly 200712. XML Usage 12.1. Restrictions XMPP is10.1.1. TLS Step 1: Client initiates stream to server: C: <stream:stream from='juliet@example.com' to='example.com' version='1.0' xml:lang='en' xmlns='jabber:client' xmlns:stream='http://etherx.jabber.org/streams'> Step 2: Server responds by sending asimplified and specialized protocol for streaming XML elements in orderstream header toexchange structured information in closeclient: S: <stream:stream from='example.com' id='t7AMCin9zjMNwQKDnplntZPIDEI=' to='juliet@example.com' version='1.0' xml:lang='en' xmlns='jabber:client' xmlns:stream='http://etherx.jabber.org/streams' Step 3: Server sends stream features toreal time. Because XMPP does not require the parsing of arbitrary and complete XML documents, thereclient (STARTTLS extension only at this point): S: <stream:features> <starttls xmlns='urn:ietf:params:xml:ns:xmpp-tls'> <required/> </starttls> </stream:features> Step 4: Client sends STARTTLS command to server: C: <starttls xmlns='urn:ietf:params:xml:ns:xmpp-tls'/> Step 5: Server informs client that it isno requirementallowed to proceed: S: <proceed xmlns='urn:ietf:params:xml:ns:xmpp-tls'/> Step 5 (alt): Server informs client thatXMPP needsTLS negotiation has failed and closes both XML stream and TCP connection: S: <failure xmlns='urn:ietf:params:xml:ns:xmpp-tls'/> S: </stream:stream> Step 6: Client and server attempt tosupport the full feature set of [XML]. In particular,complete TLS negotiation over Saint-Andre Expires January 18, 2008 [Page 90] Internet-Draft XMPP Core July 2007 thefollowing restrictions apply. With regardexisting TCP connection (see [TLS] for details). Step 7: If TLS negotiation is successful, client initiates a new stream toXML generation, an XMPP implementation MUST NOT inject into an XMLserver: C: <stream:stream from='juliet@example.com' to='example.com' version='1.0' xml:lang='en' xmlns='jabber:client' xmlns:stream='http://etherx.jabber.org/streams'> Step 7 (alt): If TLS negotiation is unsuccessful, server closes TCP connection. 10.1.2. SASL Step 8: Server responds by sending a stream header to client along with anyof the following: o comments (as definedavailable stream features: S: <stream:stream from='example.com' id='vgKi/bkYME8OAj4rlXMkpucAqe4=' to='juliet@example.com' version='1.0' xml:lang='en' xmlns='jabber:client' xmlns:stream='http://etherx.jabber.org/streams' S: <stream:features> <mechanisms xmlns='urn:ietf:params:xml:ns:xmpp-sasl'> <mechanism>DIGEST-MD5</mechanism> <mechanism>PLAIN</mechanism> <required/> </mechanisms> </stream:features> Step 9: Client selects an authentication mechanism, inSection 2.5 of [XML]) o processing instructions (Section 2.6 therein) o internal or external DTD subsets (Section 2.8 therein) o internal or external entity references (Section 4.2 therein)this case [DIGEST-MD5] withthe exception of predefined entities (Section 4.6 therein) o character data or attribute values containing unescaped characters that map to the predefined entities (Section 4.6 therein); such characters MUST be escaped With regard to XML processing, ifan empty authorization identity ("="): C: <auth xmlns='urn:ietf:params:xml:ns:xmpp-sasl' mechanism='DIGEST-MD5'>=</auth> Saint-Andre Expires January 18, 2008 [Page 91] Internet-Draft XMPPimplementation receives such restricted XML data, it MUST returnCore July 2007 Step 10: Server sends a<restricted-xml/> stream error. 12.2. XML Namespace Names and Prefixes XML namespaces (see [XML-NAMES]) are used within all XMPP-compliant XML[BASE64] encoded challenge tocreate strict boundaries of data ownership.client: S: <challenge xmlns='urn:ietf:params:xml:ns:xmpp-sasl'> cmVhbG09ImV4YW1wbGUuY29tIixub25jZT0iT0E2TUc5dEVRR20yaGgiLHFvcD0i YXV0aCIsY2hhcnNldD11dGYtOCxhbGdvcml0aG09bWQ1LXNlc3MK </challenge> Thebasic function of namespaces is to separate different vocabularies of XML elements that are structurally mixed together. Ensuring that XMPP- compliant XML is namespace-aware enables any allowable XMLdecoded challenge is: realm="example.com",nonce="OA6MG9tEQGm2hh", qop="auth",charset=utf-8,algorithm=md5-sess Note: When the server sends a DIGEST-MD5 challenge tobe structurally mixed with any data element within XMPP. Rules for XML namespace names and prefixes are defined inthefollowing subsections. 12.2.1. Streams Namespace A streams namespace declaration is REQUIRED in all XML stream headers. The name ofclient, thestreams namespace MUSTqop list must be'http://etherx.jabber.org/streams'. The element names ofquoted since it is a list rather than a single item (even if there is only one item in the<stream/> element andlist); however, when the client sends its<features/> and <error/> children MUST be qualified byresponse to thestreams namespace prefix in all instances. An implementation SHOULD generate onlyserver, the'stream:' prefix for these elements,qop must not be quoted since it is a single item rather than a list. Step 10 (alt): Server returns error to client: S: <failure xmlns='urn:ietf:params:xml:ns:xmpp-sasl'> <temporary-auth-failure/> </failure> S: </stream:stream> Step 11: Client sends a [BASE64] encoded response to the challenge: C: <response xmlns='urn:ietf:params:xml:ns:xmpp-sasl'> dXNlcm5hbWU9Imp1bGlldCIscmVhbG09ImV4YW1wbGUuY29tIixub25jZT0iT0E2 TUc5dEVRR20yaGgiLGNub25jZT0iT0E2TUhYaDZWcVRyUmsiLG5jPTAwMDAwMDAx LHFvcD1hdXRoLGRpZ2VzdC11cmk9InhtcHAvZXhhbXBsZS5jb20iLHJlc3BvbnNl PWQzODhkYWQ5MGQ0YmJkNzYwYTE1MjMyMWYyMTQzYWY3LGNoYXJzZXQ9dXRmLTgK </response> The decoded response is: username="juliet",realm="example.com", nonce="OA6MG9tEQGm2hh",cnonce="OA6MHXh6VqTrRk", nc=00000001,qop=auth,digest-uri="xmpp/example.com", response=d388dad90d4bbd760a152321f2143af7,charset=utf-8 Step 12: Server informs client of success and includes [BASE64] encoded value forhistorical reasons MAY accept only the 'stream:' prefix.subsequent authentication: S: <success xmlns='urn:ietf:params:xml:ns:xmpp-sasl'> cnNwYXV0aD1lYTQwZjYwMzM1YzQyN2I1NTI3Yjg0ZGJhYmNkZmZmZAo= </success> Saint-Andre ExpiresOctober 19, 2007January 18, 2008 [Page61]92] Internet-Draft XMPP CoreAprilJuly 200712.2.2. Default Namespace A default namespace declaration is REQUIRED and is used in all XML streams in order to define the allowable first-level children of the root stream element. This namespace declaration MUST be the same for the initial stream and the response stream so that both streams are qualified consistently.Thedefault namespace declaration appliesdecoded value for subsequent authentication is: rspauth=ea40f60335c427b5527b84dbabcdfffd Step 12 (alt): Server returns error tothe stream and all stanzas sent withinclient: S: <failure xmlns='urn:ietf:params:xml:ns:xmpp-sasl'> <not-authorized/> </failure> Step 13: Client initiates a new stream(unless explicitly qualified by another namespace, orto server: C: <stream:stream from='juliet@example.com' to='example.com' version='1.0' xml:lang='en' xmlns='jabber:client' xmlns:stream='http://etherx.jabber.org/streams' 10.1.3. Resource Binding Step 14: Server responds bythe prefix of the streams namespace or the dialback namespace). A server implementation MUST support the following two default namespaces (for historical reasons, some implementations MAY support only these two default namespaces): o jabber:client -- this default namespace is declared when the stream is used for communications betweensending a stream header to clientand a server o jabber:server --along with supported features (in thisdefault namespacecase resource binding): S: <stream:stream from='example.com' id='gPybzaOzBmaADgxKXu9UClbprp0=' to='juliet@example.com' version='1.0' xml:lang='en' xmlns='jabber:client' xmlns:stream='http://etherx.jabber.org/streams'> S: <stream:features> <bind xmlns='urn:ietf:params:xml:ns:xmpp-bind'> <required/> </bind> <unbind xmlns='urn:ietf:params:xml:ns:xmpp-bind'/> </stream:features> Upon being so informed that resource binding isdeclared whenrequired, thestream is used for communications between two servers AclientimplementationMUSTsupportbind a resource to the'jabber:client' default namespace, and for historical reasons MAY support onlystream; here we assume thatdefault namespace. An implementation MUST NOT generate namespace prefixes for elements qualified bythedefault namespace ifclient asks thedefault namespace is 'jabber:client' or 'jabber:server'. An implementation SHOULD NOT generate namespace prefixes for elements qualified by content (as opposedserver tostream) namespaces other than 'jabber:client' and 'jabber: server'. Note: The 'jabber:client' and 'jabber:server' namespaces are nearly identical but are used in different contexts (client-to-server communications for 'jabber:client'generate a resource identifier on its behalf. Saint-Andre Expires January 18, 2008 [Page 93] Internet-Draft XMPP Core July 2007 Step 15: Client binds a resource: C: <iq id='bind_1' type='set'> <bind xmlns='urn:ietf:params:xml:ns:xmpp-bind'/> </iq> Step 16: Server generates resource identifier andserver-to-server communications for 'jabber:server'). The only difference betweeninforms client of successful resource binding: S: <iq id='bind_1' type='result'> <bind xmlns='urn:ietf:params:xml:ns:xmpp-bind'> <jid> juliet@example.com/4db06f06-1ea4-11dc-aca3-000bcd821bfb </jid> </bind> </iq> 10.1.4. Stanza Exchange Now thetwoclient isthatallowed to send XML stanzas over the'to' and 'from' attributes are OPTIONAL on stanzas sent within 'jabber:client', whereas they are REQUIRED on stanzas sent within 'jabber:server'. If a compliant implementation accepts a stream that is qualified by the 'jabber:client' or 'jabber:server' namespace, it MUST support the common attributes (Section 9.1)negotiated stream. C: <message from='juliet@example.com/4db06f06-1ea4-11dc-aca3-000bcd821bfb' to='romeo@example.net' xml:lang='en'> <body>Art thou not Romeo, andbasic semantics (Section 9.2) of all three core stanza kinds (message, presence,a Montague?</body> </message> If necessary, sender's server negotiates XML streams with intended recipient's server (see Section 10.2). The intended recipient replies andIQ). 12.2.3. Dialback Namespace A dialback namespace declarationthe message isREQUIRED for all elements used in server dialback (Appendix C).delivered to the client. E: <message from='romeo@example.net/63a6be96-1ea4-11dc-a38b-000bcd821cgc' to='juliet@example.com/4db06f06-1ea4-11dc-aca3-000bcd821bfb' xml:lang='en'> <body>Neither, fair saint, if either thee dislike.</body> </message> Thenameclient may send and receive an unbounded number of subsequent XML stanzas over thedialback namespace MUST be 'jabber:server:dialback'. All elements qualified by thisstream. Saint-Andre ExpiresOctober 19, 2007January 18, 2008 [Page62]94] Internet-Draft XMPP CoreAprilJuly 2007namespace MUST be prefixed. An implementation SHOULD generate only10.1.5. Close Desiring to send no further messages, the'db:' prefix for such elements and MAY accept onlyclient closes the'db:' prefix. 12.3. Validation Astream. C: </stream:stream> Consistent with the recommended stream closing handshake, serveris not responsible for validatingcloses stream as well: S: </stream:stream> Client now terminates the underlying TCP connection. 10.2. Server-to-Server Examples The following examples show theXML elements forwarded to a client or another server; an implementation MAY choose to provide only validateddataelements but this is OPTIONAL (althoughflow for a server negotiating animplementation MUST NOT acceptXMLthat is not well-formed). Clients SHOULD NOT rely onstream with another server, exchanging XML stanzas, and closing theability to send data which does not conform to the schemas, and SHOULD ignore any non-conformant elements or attributes on the incoming XMLnegotiated stream.Validation of XML streams and stanzasThe initiating server ("Server1") isOPTIONAL, and schemas are included herein for descriptive purposes only. 12.4. Inclusion of Text Declaration Implementations SHOULD send a text declaration before sending a stream header. Applications MUST follow the rules in [XML] regardingexample.com; thecircumstances under which a text declarationreceiving server ("Server2") isincluded. 12.5. Character Encoding Implementations MUST support the [UTF-8] transformation of Universal Character Set ([UCS2]) characters, as required by [CHARSET]. Implementations MUST NOT attempt to use any other encoding. 12.6. White Space Except where explicitly disallowed (i.e., during TLS negotiation (Section 6)example.net andSASL negotiation [SASL]), either entity MAY send white space characters (matching production [3] contentit requires use of[XML]) within the root stream element as separators between XML stanzas or between any other first-level elements sent overTLS; example.com presents a certificate and authenticates via thestream; one common use for sending such white space charactersSASL EXTERNAL mechanism. It isto checkassumed that before sending theviabilityinitial stream header, Server1 has already resolved an SRV record ofthe underlying_xmpp-client._tcp.example.net and has opened a TCP connectionafter a period of inactivity. 13. Compliance Requirements This section summarizesto thespecific aspects ofadvertised port at theExtensible Messagingresolved IP address. Note: The alternate steps shown are provided only to illustrate the protocol for failure cases; they are not exhaustive andPresence Protocol that MUSTwould not necessarily besupportedtriggered byservers and clientsthe data sent inorder to be considered compliant implementations, as well as additional protocol aspects that SHOULD be supported. For compliance purposes, we draw a distinction between core protocols (which MUST be supported by any server or client, regardless ofthe examples. 10.2.1. TLS Step 1: Server1 initiates stream to Server2: S1: <stream:stream from='example.com' to='example.net' version='1.0' xmlns='jabber:server' xmlns:stream='http://etherx.jabber.org/streams'> Saint-Andre ExpiresOctober 19, 2007January 18, 2008 [Page63]95] Internet-Draft XMPP CoreAprilJuly 2007specific application) and instant messaging and presence protocols (which MUST be supported onlyStep 2: Server2 responds byinstant messaging and presence applications built on top ofsending a stream tag to Server1: S2: <stream:stream from='example.net' id='hTiXkW+ih9k2SqdGkk/AZi0OJ/Q=' to='example.com' version='1.0' xmlns='jabber:server' xmlns:stream='http://etherx.jabber.org/streams'> Step 3: Server2 sends stream features to Server1: S2: <stream:features> <starttls xmlns='urn:ietf:params:xml:ns:xmpp-tls'> <required/> </starttls> </stream:features> Step 4: Server1 sends thecore protocols). Compliance requirementsSTARTTLS command to Server2: S1: <starttls xmlns='urn:ietf:params:xml:ns:xmpp-tls'/> Step 5: Server2 informs Server1 thatapplyit is allowed toall serversproceed: S2: <proceed xmlns='urn:ietf:params:xml:ns:xmpp-tls'/> Step 5 (alt): Server2 informs Server1 that TLS negotiation has failed andclients are specified in this section; compliance requirements for instant messagingcloses stream: S2: <failure xmlns='urn:ietf:params:xml:ns:xmpp-tls'/> S2: </stream:stream> Step 6: Server1 andpresence applications are specified in the corresponding section of [XMPP-IM]. 13.1. Servers In additionServer2 attempt toall defined requirements with regardcomplete TLS negotiation via TCP. Step 7: If TLS negotiation is successful, Server1 initiates a new stream tosecurity, XML usage, and internationalization,Server2: S1: <stream:stream from='example.com' to='example.net' version='1.0' xmlns='jabber:server' xmlns:stream='http://etherx.jabber.org/streams'> Step 7 (alt): If TLS negotiation is unsuccessful, Server2 closes TCP connection. Saint-Andre Expires January 18, 2008 [Page 96] Internet-Draft XMPP Core July 2007 10.2.2. SASL Step 8: Server2 responds by sending aserver MUST support the following core protocols in orderstream header tobe considered compliant: o ConformanceServer1 along with[IDNA] for domain identifiers, the Nodeprep (Appendix A) profile of [STRINGPREP] for node identifiers, and the Resourceprep (Appendix B) profile of [STRINGPREP] for resource identifiers, and enforcement thereofavailable stream features (including a preference forclients that authenticate withtheserver. o XML streams (Section 5), including TLS negotiation (Section 6),SASLnegotiation (Section 7), and Resource Binding (Section 8) o The basic semantics ofEXTERNAL mechanism): S2: <stream:stream from='example.net' id='RChdjlgj/TIBcbT9Keu31zDihH4=' to='example.com' version='1.0' xmlns='jabber:server' xmlns:stream='http://etherx.jabber.org/streams'> S2: <stream:features> <mechanisms xmlns='urn:ietf:params:xml:ns:xmpp-sasl'> <mechanism>EXTERNAL</mechanism> <mechanism>DIGEST-MD5</mechanism> <required/> </mechanisms> </stream:features> Step 9: Server1 selects thethree defined stanza kinds (i.e., <message/>, <presence/>, and <iq/>) as specifiedEXTERNAL mechanism, instanza semantics (Section 9.2) o Generation (and, where appropriate, handling) of error syntax and semantics relatedthis case with an authorization identity encoded according tostreams, TLS, SASL, and XML stanzas In addition, for historical reasons a server SHOULD support[BASE64]: S1: <auth xmlns='urn:ietf:params:xml:ns:xmpp-sasl' mechanism='EXTERNAL'/>ZXhhbXBsZS5jb20K</auth> The decoded authorization identity is "example.com". Step 10: Server2 determines that thefollowing core protocol: o Server dialback (Appendix C) 13.2. Clients A client MUST supportauthorization identity provided by Server1 matches thefollowing core protocolsinformation inorder to be considered compliant: o XML streams (Section 5), including TLS negotiation (Section 6), SASL negotiation (Section 7), and Resource Binding (Section 8) o The basic semantics ofthethree defined stanza kinds (i.e., <message/>, <presence/>,presented certificate and<iq/>) as specified in stanza semantics (Section 9.2) o Handling (and, where appropriate, generation)therefore returns success: S2: <success xmlns='urn:ietf:params:xml:ns:xmpp-sasl'/> Step 11 (alt): Server2 informs Server1 oferror syntax and semantics related to streams, TLS, SASL, and XML stanzas In addition, a client SHOULD support the following core protocols:failed authentication: S2: <failure xmlns='urn:ietf:params:xml:ns:xmpp-sasl'> <not-authorized/> </failure> S2: </stream:stream> Saint-Andre ExpiresOctober 19, 2007January 18, 2008 [Page64]97] Internet-Draft XMPP CoreAprilJuly 2007o ConformanceStep 12: Server1 initiates a new stream to Server2: S1: <stream:stream from='example.com' to='example.net' version='1.0' xmlns='jabber:server' xmlns:stream='http://etherx.jabber.org/streams'> Step 13: Server2 responds by sending a stream header to Server1 along with[IDNA] for domain identifiers, the Nodeprep (Appendix A) profile of [STRINGPREP] for node identifiers, and the Resourceprep (Appendix B) profile of [STRINGPREP] for resource identifiers. 14. Internationalization Considerations XML streams MUST be encodedany additional features (or, inUTF-8 as specified under Character Encoding (Section 12.5). As specified under Stream Attributes (Section 5.3),this case, an empty features element): S2: <stream:stream from='example.net' id='MbbV2FeojySpUIP6J91qaa+TWHM=' to='example.com' version='1.0' xmlns='jabber:server' xmlns:stream='http://etherx.jabber.org/streams'> S2: <stream:features/> 10.2.3. Stanza Exchange Now Server1 is allowed to send XMLstream SHOULD include an 'xml:lang' attribute specifyingstanzas to Server2 over thedefault languagenegotiated stream; here we assume that the transferred stanzas are those shown earlier foranyclient-to-server communication. Server1 sends XMLcharacter data sent overstanza to Server2: S1: <message from='juliet@example.com/balcony' to='romeo@example.net' xml:lang='en'> <body>Art thou not Romeo, and a Montague?</body> </message> The intended recipient replies and thestream thatmessage isintended to be presenteddelivered from Server2 toa human user. As specified under xml:lang (Section 9.1.5), anServer1. Server2 sends XML stanzaSHOULD include an 'xml:lang' attribute if the stanza contains XML character data that is intendedtobe presentedServer1: S2: <message from='romeo@example.net/orchard' to='juliet@example.com/balcony' xml:lang='en'> <body>Neither, fair saint, if either thee dislike.</body> </message> Saint-Andre Expires January 18, 2008 [Page 98] Internet-Draft XMPP Core July 2007 10.2.4. Close Desiring toa human user. A server SHOULD applysend no further messages, Server1 closes thedefault 'xml:lang' attribute to stanzas it routes or delivers on behalf of connected entities,stream. (In practice, the stream would most likely remain open for some time, since Server1 and Server2 do not immediately know if the stream will be needed for further communication.) S1: </stream:stream> Consistent with the recommended stream closing handshake, Server2 closes stream as well: S2: </stream:stream> Server1 now terminates the underlying TCP connection. 11. Server Rules for Processing XML Stanzas An XMPP server MUSTNOT modify or delete 'xml:lang' attributesensure in-order processing of XML stanzasit receives from otherbetween any two entities.15. Security Considerations 15.1. High Security For the purposes of XMPP communications (client-to-server and server- to-server), the term "high security" refersThis includes stanzas sent by a client to its server for direct processing by theuseserver (e.g., in-order processing ofsecurity technologies that provide both mutual authenticationa roster get andintegrity- checking;initial presence as decribed inparticular, when using certificate-based authentication[XMPP-IM]). Beyond the requirement for in-order processing, each server implementation will contain its own logic for processing stanzas it receives. Such logic determines whether the server needs toprovide high security, a chain-of-trust SHOULD be established out- of-band, although a shared certificate authority signing certificates could allowROUTE apreviously unknown certificategiven stanza toestablish trust in- band. See Section 15.2 below regarding certificate validation procedures. Implementations MUST support high security. Service provisioning SHOULD use high security, subjectanother domain, DELIVER it to a localsecurity policies. 15.2. Certificate Validation When an XMPP peer communicatesentity (typically a connected client associated withanother peer securely,a local account), or HANDLE itMUST validatedirectly within thepeer's certificate. There are three possible cases: Case #1:server itself. Thepeer contains an End Entity certificate which appears to be certified byfollowing rules apply. Note: Particular XMPP applications MAY specify delivery rules that modify or supplement the following rules; for example, achainset ofcertificates terminating in a trust anchor (as describeddelivery rules for instant messaging and presence applications is defined inSection 6.1[XMPP-IM]. 11.1. No 'to' Address 11.1.1. Overview If the stanza possesses no 'to' attribute, the server SHOULD handle it directly on behalf of[X509]).the entity that sent it. Because all stanzas received from other servers MUST possess a 'to' attribute, this rule applies only to stanzas received from a local entity (such as a client) that is connected to the server. Saint-Andre ExpiresOctober 19, 2007January 18, 2008 [Page65]99] Internet-Draft XMPP CoreAprilJuly 2007Case #2: The peer certificate is certified by11.1.2. Message If the server receives aCertificate Authority not knownmessage stanza with no 'to' attribute, it SHOULD handle it directly, which may include returning an error to thevalidating peer. Case #3: The peer certificate is self-signed. In Case #1,sending entity. 11.1.3. Presence If thevalidating peer MUST do one of two things: 1. Verifyserver receives a presence stanza with no 'to' attribute, it SHOULD broadcast it to thepeer certificate accordingentities that are subscribed to therulessending entity's presence, if applicable (the semantics of[X509]. The certificate SHOULD then be checked againstpresence broadcast for presence applications are defined in [XMPP-IM]). 11.1.4. IQ If theexpected identityserver receives an IQ stanza of type "get" or "set" with no 'to' attribute, it MUST do thepeer followingfollowing: 1. If it understands therules described in [HTTP-TLS], exceptnamespace thatif present an [ASN.1] Object Identifierqualifies the content of"id-on- xmppAddr" (represented as a UTF8String in an otherName entity insidethesubjectAltName)stanza, it MUSTbe used aseither handle theidentity. If onestanza directly on behalf ofthese checks fails, user-oriented clients MUST either notifysending entity (where theuser (clients MAY givemeaning of "handle" is determined by theusersemantics of theopportunityqualifying namespace) or return an appropriate error tocontinue withtheconnection in any case) or terminatesending entity. 2. If it does not understand theconnection with a bad certificate error. Automated clients SHOULD terminatenamespace that qualifies theconnection (with a bad certificate error) and logcontent of the stanza, it MUST return an error toan appropriate audit log. Automated clients MAY provide a configuration setting that disables this check, but MUST provide a setting that enables it. 2. The peerthe sending entity, which SHOULDshowbe <service-unavailable/>. 11.2. Local Domain If thecertificate to a user for approval, includinghostname of theentire certificate chain. The peer MUST cachedomain identifier portion of thecertificate (or some non-forgeable representation such as a hash). In future connections,JID contained in thepeer MUST verify that'to' attribute matches one of thesame certificate was presented and MUST notifyconfigured hostnames of theuser if it has changed. In Case #2 and Case #3, implementations SHOULD act as in (2) above. 15.3. Client-to-Server Communications A compliant client implementationserver itself, the server MUSTsupport both TLS and SASL for connectionsdo one of the following: 1. Handle the stanza itself. 2. Route the stanza to aserver. The TLS protocolspecialized service that is responsible forencrypting XML streams (defined under TLS negotiation (Section 6)) provides a reliable mechanism for helping to ensure the confidentiality and data integrity of data exchanged between two entities. The SASL protocol for authenticating XML streams (defined under SASL negotiation (Section 7)) provides a reliable mechanism for validatingthata client connecting to a server is who it claimslocal domain. 3. Return an error tobe. Client-to-server communications MUST NOT proceed untiltheDNS hostname asserted bysender if theserver has been resolved as specified under TCP Binding (Section 4). If thereservice providing the local domain isa mismatch betweennot available. 11.3. Resource at Local Domain If the hostnameto whichof the domain identifier portion of the JID contained in the 'to' attribute matches aclient attempted to connect (e.g., "example.net")configured hostname of the server itself and thehostname to whichJID contained in theclient actually connects (e.g., "im.example.net"),'to' attribute is of theclient MUST warnform <domain/resource>, the server (or ahuman user aboutdefined resource thereof) MUST either handle the stanza as appropriate for the stanza kind or return an error stanza to the sender. Saint-Andre ExpiresOctober 19, 2007January 18, 2008 [Page66]100] Internet-Draft XMPP CoreAprilJuly 2007mismatch and the human user MUST approve the connection before11.4. Node at Local Domain If theclient proceeds; however,hostname of theclient MAY allowdomain identifier portion of theuser to addJID contained in thepresented hostname to'to' attribute matches a configuredset of accepted hostnames in order to expedite future connections. The IP address and method of accesshostname ofclients MUST NOT be made public by a server, nor are any connections other thantheoriginalserverconnection required. This helps to protectitself and theclient's server from direct attackJID contained in the 'to' attribute is a bare JID (<node@domain>) oridentification by third parties. 15.4. Server-to-Server Communications A compliantfull JID (<node@domain/resource>), the serverimplementation MUST support both TLS and SASL for inter-domain communications. For historical reasons, a compliant implementationSHOULDalso support Server Dialback (Appendix C). Because service provisioning is a matter of policy, it is OPTIONAL for any given domaindeliver the stanza tocommunicate with other domains, and server- to-server communications MAY be disabled bytheadministratorintended recipient ofany given deployment.the stanza as represented by the JID contained in the 'to' attribute. The following rules apply: 1. If the JID contains an XMPP resource identifier (i.e., is of the form <node@domain/resource>) and there exists aparticular domain enables inter-domain communications, itconnected resource that exactly matches the full JID, the recipient's server SHOULDenable high security. Administrators may wantdeliver the stanza torequire usethat connection. 2. If the JID contains an XMPP resource identifier and there exists no connected resource that exactly matches the full JID, the recipient's server SHOULD return a <service-unavailable/> stanza error to the sender. 3. If the JID is ofSASLthe form <node@domain> and there exists at least one connected resource forserver-to-server communications in orderthe node, the recipient's server SHOULD deliver the stanza toensure both authenticationat least one of the connected resources if the stanza is a message or presence stanza andconfidentiality (e.g.,SHOULD handle it directly on behalf of the node if the stanza is anorganization's private network). Compliant implementations SHOULD support SASL for this purpose. Server-to-server communications MUST NOT proceed untilIQ stanza. 11.5. Foreign Domain 11.5.1. Overview If theDNShostname of the domain identifier portion of the JID contained in the 'to' attribute does not match one of the configured hostnamesasserted by both servers have been resolved as specified under TCP Binding (Section 4). Server dialback helps protect againstof the server itself, the server SHOULD attempt to route the stanza to the foreign domainspoofing, thus making it more difficult(subject tospoof XML stanzas. Itlocal service provisioning and security policies regarding inter-domain communication, since such communication isnot a mechanismoptional forauthenticating, securing, or encrypting streamsany given deployment). There are two possible cases. 11.5.2. Existing Stream If a server-to-server stream already exists betweenservers as is done via SASL and TLS, and results in weak verification ofthe two domains, the sender's serveridentities only. Furthermore, it is susceptibleshall attempt toDNS poisoning attacks unless [DNSSEC] is used, and even ifroute theDNS information is accurate, dialback cannot protect from attacks wherestanza to theattacker is capable of hijackingauthoritative server for theIP address offoreign domain over theremote domain. Domains requiring robust security SHOULD use TLS and SASL.existing stream. 11.5.3. No Existing Stream IfSASL is used forthere exists no server-to-serverauthentication, dialback SHOULD NOT be used since it is unnecessary. 15.5. Order of Layers The order of layers in which protocols MUST be stacked isstream between the two domains, the sender's server shall proceed as follows: Saint-Andre ExpiresOctober 19, 2007January 18, 2008 [Page67]101] Internet-Draft XMPP CoreAprilJuly 2007 1.TCP 2. TLS 3. SASL 4. XMPP The rationale for this order is that [TCP] isResolve thebase connection layer used by allhostname of theprotocols stacked on top of TCP, [TLS] is often provided at the operating system layer, [SASL] is often provided atforeign domain (as defined under Section 15.4). 2. Negotiate a server-to-server stream between theapplication layer,two domains (as defined under Section 6 andXMPP isSection 7). 3. Route theapplication itself. 15.6. Lack of SASL Channel Binding to TLS The SASL framework does not provide a mechanism to bind SASL authentication to a security layer providing confidentiality and integrity protection that was negotiated at a lower layer. This lack of a "channel binding" prevents SASL from being ablestanza toverify thatthesource and destination end pointsauthoritative server for the foreign domain over the newly-established stream. 11.5.4. Error Handling If routing towhichthelower layer's securityintended recipient's server isbound are equivalentunsuccessful, the sender's server MUST return an error to theend points that SASLsender, which SHOULD be <remote-server-not-found/> if resolution of the foreign domain isauthenticating.unsuccessful and <remote-server-timeout/> if resolution succeeds but streams cannot be negotiated. If stream negotiation with theend points are not identical,intended recipient's server is successful but thelower layer's securityforeign server cannotbe trusteddeliver the stanza toprotect data transmitted betweentheSASL authenticated entities. In such a situation, a SASL security layer should be negotiated that effectively ignoresrecipient, thepresenceforeign server shall return an error to the sender by way of thelower layer security. 15.7. Mandatory-to-Implement Technologies Atsender's server. 12. XML Usage 12.1. Restrictions XMPP is aminimum, all implementations MUST support the following mechanisms: for authentication: the SASL [DIGEST-MD5] mechanism for confidentiality: TLS (using the TLS_RSA_WITH_3DES_EDE_CBC_SHA cipher)simplified and specialized protocol forboth: TLS plus SASL PLAIN for client-to-server connections and TLS plus SASL EXTERNAL for server-to-server connections (using the TLS_RSA_WITH_3DES_EDE_CBC_SHA cipher supporting peer certificates) Naturally, implementations MAY support other ciphers with TLS and MAY support other SASL mechanisms. 15.8. Firewalls Communications usingstreaming XML elements in order to exchange structured information in close to real time. Because XMPPnormally occur over [TCP] connections on port 5222 (client-to-server) or port 5269 (server-to-server), as registered withdoes not require theIANA (see IANA Considerations (Section 16)). Useparsing ofthese well-known ports allows administrators to easily enable or disable XMPP activity through existingarbitrary andcommonly-deployed firewalls. Saint-Andre Expires October 19, 2007 [Page 68] Internet-Draftcomplete XML documents, there is no requirement that XMPPCore April 2007 15.9. Useneeds to support the full feature set ofbase64 in SASL Both[XML]. In particular, theclient andfollowing features of XML are prohibited in XMPP: o comments (as defined in Section 2.5 of [XML]) o processing instructions (Section 2.6 therein) o internal or external DTD subsets (Section 2.8 therein) o internal or external entity references (Section 4.2 therein) with theserver MUST verify any [BASE64] data received during SASL negotiationexception of predefined entities (Section7). An implementation MUST reject (not ignore) any4.6 therein) o character data or attribute values containing unescaped characters thatare not explicitly allowed by the base64 alphabet; this helpsmap toguard against creation of a covert channel that couldthe predefined entities (Section 4.6 therein); such characters MUST beusedescaped An XMPP implementation MUST behave as follow with regard to"leak" information.these features: 1. An XMPP implementation MUST NOTbreak on invalid input and MUST reject any sequence of base64inject characterscontaining the pad ('=') character ifmatching such features into an XML stream. Saint-Andre Expires January 18, 2008 [Page 102] Internet-Draft XMPP Core July 2007 2. If an XMPP implementation receives characters matching such features over an XML stream, it MUST return a stream error, which SHOULD be <restricted-xml/> but MAY be <bad-format/>. 12.2. XML Namespace Names and Prefixes XML namespaces (see [XML-NAMES]) are used within all XMPP-compliant XML to create strict boundaries of data ownership. The basic function of namespaces is to separate different vocabularies of XML elements thatcharacterare structurally mixed together. Ensuring that XMPP- compliant XML isincluded as something other thannamespace-aware enables any allowable XML to be structurally mixed with any data element within XMPP. Rules for XML namespace names and prefixes are defined in thelast characterfollowing subsections. 12.2.1. Streams Namespace A streams namespace declaration is REQUIRED in all XML stream headers and the name of thedata (e.g., "=AAA" or "BBBB=CCC");streams namespace MUST be 'http://etherx.jabber.org/streams'. If thishelpsrule is violated, the entity that receives the offending stream header MUST return a stream error toguard against buffer overflow attacks and other attacks ontheimplementation. Base 64 encoding visually hides otherwise easily recognized information, such as passwords,sending entity, which SHOULD be <invalid-namespace/> butdoes not provide any computational confidentiality. Base 64 encodingMAY be <bad-format/>. The element names of the <stream/> element and its <features/> and <error/> children MUSTfollowbe qualified by thedefinitionstreams namespace prefix inSection 4 of [BASE64]. 15.10. Stringprep Profiles XMPP makes use ofall instances. If this rule is violated, the[NAMEPREP] profile of [STRINGPREP] for processing of domain identifiers; for security considerations related to Nameprep, referentity that receives the offending element MUST return a stream error to theappropriate section of [NAMEPREP]. In addition, XMPP defines two profiles of [STRINGPREP]: Nodeprep (Appendix A)sending entity, which SHOULD be <bad-format/>. An implementation SHOULD generate only the 'stream:' prefix fornode identifiersthese elements, andResourceprep (Appendix B)forresource identifiers. The Unicode and ISO/IEC 10646 repertoires have many characters that look similar. In many cases, users of security protocols might do visual matching, such as when comparinghistorical reasons MAY accept only thenames of trusted third parties. Because it is impossible to map similar-looking characters without'stream:' prefix. If an entity receives agreat deal of context, such as knowing the fonts used, stringprepstream header with a streams namespace prefix it doesnothing to map similar-looking characters together, nornot accept, it MUST return a stream error toprohibit some characters because they look like others. A node identifier canthe sending entity, which SHOULD beemployed as one part of an entity's address in XMPP. One common usage<bad-namespace-prefix/> but MAY be <bad-format/>. 12.2.2. Default Namespace A default namespace declaration isas the username of an instant messaging user; anotherREQUIRED and isasused in all XML streams in order to define thename of a multi-user chat room; many other kinds of entities could use node identifiers as part of their addresses. The securityallowable first-level children ofsuch services couldthe root stream element. This namespace declaration MUST becompromised based on different interpretations oftheinternationalized node identifier;same forexample, a user entering a single internationalized node identifier could access another user's account information, or a user could gain accessthe initial stream and the response stream so that both streams are qualified consistently. The default namespace declaration applies toan otherwise restricted chat roomthe stream and all stanzas sent within a stream (unless explicitly qualified by another namespace orservice. A resource identifier can be employed as one partby the prefix ofan entity's address in XMPP. One common usage is asthename for an instantstreams namespace). Saint-Andre ExpiresOctober 19, 2007January 18, 2008 [Page69]103] Internet-Draft XMPP CoreAprilJuly 2007messaging user's connected resource; another is asA server implementation MUST support thenickname of a user in a multi-user chat room; many other kinds of entities could use resource identifiers as part of their addresses. The security of such services could be compromised based on different interpretations offollowing two default namespaces (for historical reasons, an implementation MAY support only these two default namespaces): o jabber:client -- this default namespace is declared when theinternationalized resource identifier;stream is used forexample, a user could attempt to initiate multiple connections with the same name, orcommunication between auser could sendclient and amessage to someone other thanserver o jabber:server -- this default namespace is declared when theintended recipient in a multi-user chat room. 16. IANA Considerations 16.1. XML Namespace Namestream is used forTLS Datacommunication between two servers AURN sub-namespace for TLS-related data inclient implementation MUST support theExtensible Messaging'jabber:client' default namespace, andPresence Protocol (XMPP) is defined as follows. (This namespace name adheres to the format defined in The IETF XML Registry [XML-REG].) URI: urn:ietf:params:xml:ns:xmpp-tls Specification: RFC 3920 Description: Thisfor historical reasons MAY support only that default namespace. If an implementation accepts a stream that is qualified by theXML'jabber:client' or 'jabber:server' namespace, it MUST support the common attributes (Section 9.1) and basic semantics (Section 9.2) of all three core stanza types (message, presence, and IQ). An implementation MUST NOT generate namespacenameprefixes forTLS-related data inelements qualified by theExtensible Messagingdefault namespace if the default namespace is 'jabber:client' or 'jabber:server'. Note: The 'jabber:client' andPresence Protocol (XMPP) as defined by RFC 3920. Registrant Contact: IETF, XMPP Working Group, <xmppwg@xmpp.org> 16.2. XML Namespace Name'jabber:server' namespaces are nearly identical but are used in different contexts (client-to-server communication forSASL Data A URN sub-namespace'jabber:client' and server-to-server communication forSASL-related data in'jabber:server'). The only difference between theExtensible Messaging and Presence Protocol (XMPP)two isdefined as follows. (This namespace name adheres tothat theformat defined in [XML-REG].) URI: urn:ietf:params:xml:ns:xmpp-sasl Specification: RFC 3920 Description: This is'to' and 'from' attributes are OPTIONAL on stanzas sent over XML streams qualified by the 'jabber:client' namespace, whereas they are REQUIRED on stanzas sent over XML streams qualified by the 'jabber: server' namespace. 12.2.3. Extended Namespaces An EXTENDED NAMESPACE is an XML namespacename for SASL-related data in(other than theExtensible Messaging and Presence Protocol (XMPP) as defined by RFC 3920. Registrant Contact: IETF, XMPP Working Group, <xmppwg@xmpp.org> 16.3.default namespace) that is used to qualify XMLNamespace Name for Stream Errors A URN sub-namespace for stream-related errordata contained within an XML stanza. For example, in theExtensible Messaging and Presence Protocol (XMPP) is defined as follows. (Thisfollowing stanza, the extended namespacename adheres tois 'jabber:iq:roster': <iq from='juliet@capulet.com/balcony' id='roster1' type='get'> <query xmlns='jabber:iq:roster'/> </iq> An XML stanza MAY contain XML data qualified by more than one extended namespace, either at theformat defineddirect child level of the stanza (for presence and message stanzas) or in[XML-REG].)any mix of levels (for all stanzas). Saint-Andre ExpiresOctober 19, 2007January 18, 2008 [Page70]104] Internet-Draft XMPP CoreAprilJuly 2007URI: urn:ietf:params:xml:ns:xmpp-streams Specification: RFC 3920 Description: This is<presence from='juliet@capulet.com/balcony'> <c xmlns='http://jabber.org/protocol/caps' node='http://exodus.jabberstudio.org/caps' ver='0.9'/> <x xmlns='vcard-temp:x:update'> <photo>sha1-hash-of-image</photo> </x> </presence> <message to='juliet@capulet.com'> <body>Hello?</body> <html xmlns='http://jabber.org/protocol/xhtml-im'> <body xmlns='http://www.w3.org/1999/xhtml'> <p style='font-weight:bold'>Hello?</t> </body> </html> </message> <iq from='juliet@capulet.com/balcony' id='roster2' type='get'> <query xmlns='jabber:iq:roster'> <headers xmlns='http://jabber.org/protocol/shim'> <header name='If-None-Match'>some-long-opaque-string</header> </headers> </query> </iq> An implementation SHOULD NOT generate namespace prefixes for elements qualified by content (as opposed to stream) namespaces other than 'jabber:client' and 'jabber:server'. However, if included, theXMLnamespacenamedeclarations forstream-related error data inthose prefixes MUST be included on theExtensible Messagingstanza root or a child thereof, not at the level of the stream element (this helps to ensure that any such namespace declaration is routed andPresence Protocol (XMPP) as defined by RFC 3920. Registrant Contact: IETF, XMPP Working Group, <xmppwg@xmpp.org> 16.4. XML Namespace Name for Resource Bindingdelivered with the stanza, instead of assumed from the stream). 12.3. Validation AURN sub-namespaceserver is not responsible forresource binding in the Extensible Messaging and Presence Protocol (XMPP)ensuring that XML data delivered to a client or routed to another server isdefinedvalid asfollows. (This namespace name adheres totheformatterm "valid" is defined in[XML-REG].) URI: urn:ietf:params:xml:ns:xmpp-bind Specification: RFC 3920 Description: ThisSection 2.8 of [XML]. An implementation MAY choose to provide only validated data, but such behavior is OPTIONAL. A client SHOULD NOT rely on theXML namespace name for resource binding in the Extensible Messaging and Presence Protocol (XMPP) as defined by RFC 3920. Registrant Contact: IETF, XMPP Working Group, <xmppwg@xmpp.org> 16.5. XML Namespace Name for Stanza Errors A URN sub-namespace for stanza-related error data in the Extensible Messaging and Presence Protocol (XMPP) is defined as follows. (This namespace name adheresability tothe format defined in [XML-REG].) URI: urn:ietf:params:xml:ns:xmpp-stanzas Specification: RFC 3920 Description: This is the XML namespace name for stanza-related errorsend datainthat does not conform to theExtensible Messagingschemas, andPresence Protocol (XMPP) as defined by RFC 3920. Registrant Contact: IETF, XMPP Working Group, <xmppwg@xmpp.org> 16.6. Nodeprep Profile of Stringprep The Nodeprep profile of stringprep is defined under Nodeprep (Appendix A). The IANA has registered Nodeprep in the stringprep profile registry. Name of this profile: Nodeprep RFC in whichSHOULD ignore any non-conformant elements or attributes on theprofile is defined:incoming XML stream. Saint-Andre ExpiresOctober 19, 2007January 18, 2008 [Page71]105] Internet-Draft XMPP CoreAprilJuly 2007RFC 3920 Indicator whether or not this is the newest version of the profile: This is the first version of Nodeprep 16.7. Resourceprep Profile of StringprepNote: TheResourceprep profile of stringprepterms "valid" and "well-formed" are distinct in XML. All XMPP data MUST be well-formed as the term "well-formed" is definedunder Resourceprep (Appendix B). The IANA has registered Resourceprepinthe stringprep profile registry. NameSection 2.1 ofthis profile: Resourceprep RFC[XML]. 12.4. Inclusion of Text Declaration Implementations SHOULD send a text declaration before sending a stream header. Applications MUST follow the rules inwhich[XML] regarding theprofile is defined: RFC 3920 Indicator whether or not thiscircumstances under which a text declaration is included. 12.5. Character Encoding Implementations MUST support thenewest version of the profile: This is the first version[UTF-8] transformation ofResourceprep 16.8. GSSAPI Service Name The IANA has registered "xmpp"Universal Character Set ([UCS2]) characters, as required by [CHARSET]. Implementations MUST NOT attempt to use any other encoding. If an implementation detects that an entity has attempted to send XML data with an encoding other than UTF-8, it MUST return aGSSAPI [GSS-API] service name, as defined under SASL Definitionstream error, which SHOULD be <unsupported-encoding/>. 12.6. White Space Except where explicitly disallowed (i.e., during TLS negotiation (Section7.3). 16.9. Port Numbers The IANA has registered "xmpp-client"6) and"xmpp-server"SASL negotiation (Section 7)), either entity MAY send white space characters (matching production [3] content of [XML]) within the root stream element askeywordsseparators between XML stanzas or between any other first-level elements sent over the stream; one common use for[TCP] ports 5222sending such white space characters is to check the viability of the underlying TCP connection after a period of inactivity. 13. Compliance Requirements This section summarizes the specific aspects of the Extensible Messaging and5269 respectively. These portsPresence Protocol that MUST be supported by servers and clients in order to be considered compliant implementations, as well as additional protocol aspects that SHOULD beused for client-to-serversupported. For compliance purposes, we draw a distinction between core protocols (which MUST be supported by any server or client, regardless of the specific application) andserver-to-server communications respectively, but their use is OPTIONAL. 17. References 17.1. Normative References [ABNF] Crocker, D.instant messaging andP. Overell, "Augmented BNF for Syntax Specifications: ABNF", RFC 4234, October 2005. [BASE64] Josefsson, S., "The Base16, Base32,presence protocols (which MUST be supported only by instant messaging andBase64 Data Encodings", RFC 4648, October 2006.presence applications built on top of the core protocols). Compliance requirements that apply to all servers and clients are specified in this section; compliance requirements for instant messaging and presence applications are specified in the corresponding section of [XMPP-IM]. Saint-Andre ExpiresOctober 19, 2007January 18, 2008 [Page72]106] Internet-Draft XMPP CoreAprilJuly 2007[CHARSET] Alvestrand, H., "IETF Policy on Character Sets and Languages", BCP 18, RFC 2277, January 1998. [DIGEST-MD5] Leach, P.13.1. Servers In addition to all defined requirements with regard to security, XML usage, andC. Newman, "Using Digest Authentication asinternationalization, aSASL Mechanism", RFC 2831, May 2000. [DNS-SRV] Gulbrandsen, A., Vixie, P., and L. Esibov, "A DNS RRserver MUST support the following core protocols in order to be considered compliant: o Conformance with [IDNA] forspecifyingdomain identifiers, thelocationNodeprep (Appendix A) profile ofservices (DNS SRV)", RFC 2782, February 2000. [DNS] Mockapetris, P., "Domain names - implementation[STRINGPREP] for node identifiers, andspecification", STD 13, RFC 1035, November 1987. [GSS-API] Linn, J., "Generic Security Service Application Program Interface Version 2, Update 1", RFC 2743, January 2000. [HMAC] National Institutethe Resourceprep (Appendix B) profile ofStandards and Technology, "The Keyed-Hash Message Authentication Code (HMAC)", FIPS PUB 198, March 2002, <http://csrc.nist.gov/publications/fips/ fips198/fips-198a.pdf>. [HTTP-TLS] Rescorla, E., "HTTP Over TLS", RFC 2818, May 2000. [IDNA] Faltstrom, P., Hoffman, P., and A. Costello, "Internationalizing Domain Names in Applications (IDNA)", RFC 3490, March 2003. [IPv6] Hinden, R. and S. Deering, "IP Version 6 Addressing Architecture", RFC 4291, February 2006. [LANGTAGS] Phillips, A. and M. Davis, "Tags[STRINGPREP] forIdentifying Languages", BCP 47, RFC 4646, September 2006. [NAMEPREP] Hoffman, P. and M. Blanchet, "Nameprep: A Stringprep Profile for Internationalized Domain Names (IDN)", RFC 3491, March 2003. [PUNYCODE] Costello, A., "Punycode: A Bootstring encoding of Unicode for Internationalized Domain Names in Applications (IDNA)", RFC 3492, March 2003. [RANDOM] Eastlake, D., Schiller, J., and S. Crocker, "Randomness Requirementsresource identifiers, as well as enforcement thereof forSecurity", BCP 106, RFC 4086, June 2005. Saint-Andre Expires October 19, 2007 [Page 73] Internet-Draft XMPP Core April 2007 [SASL] Melnikov, A.clients that authenticate with the server. o XML streams (Section 5), including TLS negotiation (Section 6), SASL negotiation (Section 7), andK. Zeilenga, "Simple AuthenticationResource Binding (Section 8) o The basic semantics of the three defined stanza types (i.e., <message/>, <presence/>, andSecurity Layer (SASL)", RFC 4422, June 2006. [SHA] National Institute<iq/>) as specified in stanza semantics (Section 9.2) o Generation (and, where appropriate, handling) ofStandardserror syntax andTechnology, "Secure Hash Standard", FIPS PUB 180-2, August 2002, <http:// csrc.nist.gov/publications/fips/fips180-2/ fips180-2withchangenotice.pdf>. [STRINGPREP] Hoffman, P.semantics related to streams, TLS, SASL, andM. Blanchet, "PreparationXML stanzas For backward compatibility with the large deployed base ofInternationalized Strings ("stringprep")", RFC 3454, December 2002. [TCP] Postel, J., "Transmission Control Protocol", STD 7, RFC 793, September 1981. [TERMS] Bradner, S., "Key words for use in RFCsXMPP servers, server developers are advised toIndicate Requirement Levels", BCP 14, RFC 2119, March 1997. [TLS] Dierks, T.implement the server dialback protocol first specified in [RFC3920] andE. Rescorla, "The Transport Layer Security (TLS) Protocol Version 1.1", RFC 4346, April 2006. [UCS2] International Organizationnow documented in [XEP-0220], since that protocol is widely used forStandardization, "Information Technology - Universal Multiple-octet coded Character Set (UCS) - Amendment 2: UCS Transformation Format 8 (UTF-8)", ISO Standard 10646-1 Addendum 2, October 1996. [UTF-8] Yergeau, F., "UTF-8, a transformation formatweak identity verification ofISO 10646", STD 63, RFC 3629, November 2003. [X509] Housley, R., Polk, W., Ford, W.,peer servers in the absence of domain certificates. 13.2. Clients A client MUST support the following core protocols in order to be considered compliant: o XML streams (Section 5), including TLS negotiation (Section 6), SASL negotiation (Section 7), andD. Solo, "Internet X.509 Public Key Infrastructure CertificateResource Binding (Section 8) o The basic semantics of the three defined stanza types (i.e., <message/>, <presence/>, andCertificate Revocation List (CRL) Profile", RFC 3280, April 2002. [XML] Bray, T., Paoli, J., Sperberg-McQueen, C.,<iq/>) as specified in Section 9.2 o Handling (and, where appropriate, generation) of error syntax andE. Maler, "Extensible Markup Language (XML) 1.0 (2nd ed)", W3C REC- xml, October 2000, <http://www.w3.org/TR/REC-xml>. [XML-NAMES] Bray, T., Hollander, D.,semantics related to streams, TLS, SASL, andA. Layman, "NamespacesXML stanzas In addition, a client SHOULD support the following core protocols: o Conformance with [IDNA] for domain identifiers, the Nodeprep (Appendix A) profile of [STRINGPREP] for node identifiers, and the Resourceprep (Appendix B) profile of [STRINGPREP] for resource identifiers. 14. Internationalization Considerations XML streams MUST be encoded inXML", W3C REC-xml-names, January 1999, <http://www.w3.org/TR/REC-xml-names>.UTF-8 as specified under Section 12.5. Saint-Andre ExpiresOctober 19, 2007January 18, 2008 [Page74]107] Internet-Draft XMPP CoreAprilJuly 200717.2. Informative References [ACAP] Newman, C. and J. Myers, "ACAP -- Application Configuration Access Protocol", RFC 2244, November 1997. [ASN.1] CCITT, "Recommendation X.208: Specification of Abstract Syntax Notation One (ASN.1)", 1988. [DNSSEC] Arends, R., Austein, R., Larson, M., Massey, D.,As specified under Section 5.3, an XML stream SHOULD include an 'xml: lang' attribute specifying the default language for any XML character data sent over the stream that is intended to be presented to a human user. As specified under Section 9.1.5, an XML stanza SHOULD include an 'xml:lang' attribute if the stanza contains XML character data that is intended to be presented to a human user. A server SHOULD apply the default 'xml:lang' attribute to stanzas it routes or delivers on behalf of connected entities, andS. Rose, "DNSMUST NOT modify or delete 'xml:lang' attributes on stanzas it receives from other entities. 15. SecurityIntroduction and Requirements", RFC 4033, March 2005. [DNS-TXT] Rosenbaum, R., "UsingConsiderations 15.1. High Security For theDomain Name System To Store Arbitrary String Attributes", RFC 1464, May 1993. [HTTP] Fielding, R., Gettys, J., Mogul, J., Frystyk, H., Masinter, L., Leach, P., and T. Berners-Lee, "Hypertext Transfer Protocol -- HTTP/1.1", RFC 2616, June 1999. [IMAP] Crispin, M., "INTERNET MESSAGE ACCESS PROTOCOL - VERSION 4rev1", RFC 3501, March 2003. [IMP-REQS] Day, M., Aggarwal, S., and J. Vincent, "Instant Messaging / Presence Protocol Requirements", RFC 2779, February 2000. [IRI] Duerst, M. and M. Suignard, "Internationalized Resource Identifiers (IRIs)", RFC 3987, January 2005. [LINKLOCAL] Cheshire, S., Aboba, B., and E. Guttman, "Dynamic Configurationpurposes ofIPv4 Link-Local Addresses", RFC 3927, May 2005. [MAILBOXES] Crocker, D., "MAILBOX NAMES FOR COMMON SERVICES, ROLES AND FUNCTIONS", RFC 2142, May 1997. [POP3] Myers, J.XMPP communication (client-to-server andM. Rose, "Post Office Protocol - Version 3", STD 53, RFC 1939, May 1996. [SMTP] Klensin, J., "Simple Mail Transfer Protocol", RFC 2821, April 2001. [STD13] Mockapetris, P., "Domain names - implementation and specification", STD 13, RFC 1035, November 1987. Saint-Andre Expires October 19, 2007 [Page 75] Internet-Draft XMPP Core April 2007 [URI] Berners-Lee, T., Fielding, R., and L. Masinter, "Uniform Resource Identifier (URI): Generic Syntax", STD 66, RFC 3986, January 2005. [URN-OID] Mealling, M., "A URN Namespaceserver- to-server), the term "high security" refers to the use ofObject Identifiers", RFC 3061, February 2001. [USINGTLS] Newman, C., "Using TLS with IMAP, POP3 and ACAP", RFC 2595, June 1999. [XEP-0045] Saint-Andre, P., "Multi-User Chat", XSF XEP 0045, April 2007. [XEP-0071] Saint-Andre, P., "XHTML-IM", XSF XEP 0071, March 2007. [XEP-0077] Saint-Andre, P., "In-Band Registration", XSF XEP 0077, January 2006. [XEP-0086] Norris, R. and P. Saint-Andre, "Error Condition Mappings", XSF XEP 0086, February 2004. [XEP-0124] Paterson, I., Smith, D., and P. Saint-Andre, "Bidirectional-streams Over Synchronous HTTP (BOSH)", XSF XEP 0124, February 2007. [XEP-0156] Hildebrand, J. and P. Saint-Andre, "Discovering Alternative XMPP Connection Methods", XSF XEP 0156, January 2007. [XEP-0157] Saint-Andre, P.security technologies that provide both mutual authentication andJ. Konieczny, "Contact Addresses forintegrity- checking; in particular, when using certificate-based authentication to provide high security, a chain-of-trust SHOULD be established out- of-band, although a shared certificate authority signing certificates could allow a previously unknown certificate to establish trust in- band. See Section 15.2 regarding certificate validation procedures. Implementations MUST support high security. Service provisioning should use high security, subject to local security policies. 15.2. Certificate Validation When an XMPPServices", XSF XEP 0157, January 2007. [XEP-0174] Saint-Andre, P., "Link-Local Messaging", XSF XEP 0174, March 2007. [XEP-0175] Saint-Andre, P., "Best Practices for Usepeer communicates with another peer securely, it MUST validate the peer's certificate. There are three possible cases: Case #1: The peer contains an End Entity certificate that appears to be certified by a chain ofSASL ANONYMOUS", XSF XEP 0175, September 2006.certificates terminating in a trust anchor (as described in Section 6.1 of [X509]). Case #2: The peer certificate is certified by a Certificate Authority not known to the validating peer. Case #3: The peer certificate is self-signed. In Case #1, the validating peer MUST do one of two things: 1. Verify the peer certificate according to the rules of [X509]. The certificate SHOULD then be checked against the expected identity of the peer following the rules described in [HTTP-TLS], except that if present an [ASN.1] Object Identifier of "id-on- xmppAddr" (represented as a UTF8String in an otherName entity inside the subjectAltName) MUST be used as the identity. If one of these checks fails, user-oriented clients MUST either notify Saint-Andre ExpiresOctober 19, 2007January 18, 2008 [Page76]108] Internet-Draft XMPP CoreAprilJuly 2007[XEP-0178] Saint-Andre, P. and P. Millard, "Best Practices for Use of SASL EXTERNALthe user (clients MAY give the user the opportunity to continue withCertificates", XSF XEP 0178, February 2007. [XEP-0206] Paterson, I., "XMPP Over BOSH", XSF XEP 0206, February 2007. [XML-REG] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, January 2004. [XMPP-IM] Saint-Andre, P., "Extensible Messagingthe connection anyway) or terminate the connection with a bad certificate error. Automated clients SHOULD terminate the connection (with a bad certificate error) and log the error to an appropriate audit log. Automated clients MAY provide a configuration setting that disables this check, but MUST provide a setting that enables it. 2. The peer SHOULD show the certificate to a user for approval, including the entire certificate chain. The peer MUST cache the certificate (or some non-forgeable representation such as a hash). In future connections, the peer MUST verify that the same certificate was presented andPresence Protocol (XMPP): Instant MessagingMUST notify the user if it has changed. In Case #2 andPresence", draft-saintandre-rfc3921bis-02 (workCase #3, implementations SHOULD act as inprogress), April 2007. [XMPP-URI] Saint-Andre, P., "Internationalized Resource Identifiers (IRIs)Rule #2 for Case #1. 15.3. Client-to-Server Communication A compliant client implementation MUST support both TLS andUniform Resource Identifiers (URIs)SASL for connections to a server. The TLS protocol for encrypting XML streams (defined under Section 6) provides a reliable mechanism for helping to ensure theExtensible Messagingconfidentiality andPresence Protocol (XMPP)", draft-saintandre-rfc4622bis-00 (work in progress), April 2007. Appendix A. Nodeprep A.1. Introduction This appendix defines the "Nodeprep" profiledata integrity of[STRINGPREP]. As such, it specifies processing rulesdata exchanged between two entities. The SASL protocol for authenticating XML streams (defined under Section 7) provides a reliable mechanism for validating thatwill enable usersa client connecting to a server is who it claims to be. Client-to-server communication MUST NOT proceed until the DNS hostname asserted by the server has been resolved as specified under Section 4. If there is a mismatch between the hostname to which a client attempted to connect (e.g., "example.net") and the hostname to which the client actually connects (e.g., "xmpp.example.net"), the client MUST warn a human user about the mismatch and the human user MUST approve the connection before the client proceeds; however, the client MAY also allow the user toenter internationalized node identifiers inadd theExtensible Messaging and Presence Protocol (XMPP)presented hostname to a configured set of accepted hostnames in order to expedite future connections. The IP address andhave the highest chancemethod ofgetting the contentaccess of clients MUST NOT be made public by a server, nor are any connections other than thestrings correct. (An XMPP node identifier isoriginal server connection required. This helps to protect theoptional portion of anclient's server from direct attack or identification by third parties. Saint-Andre Expires January 18, 2008 [Page 109] Internet-Draft XMPPaddress that precedesCore July 2007 15.4. Server-to-Server Communication A compliant server implementation MUST support both TLS and SASL for inter-domain communication. Because service provisioning is a matter of policy, it is optional for any given domainidentifierto communicate with other domains, and server- to-server communication may be disabled by the'@' separator;administrator of any given deployment. If a particular domain enables inter-domain communication, itis often but not exclusively associated with an instant messaging username.) These processing rules are intended onlyshould enable high security. Administrators may want to require use of SASL forXMPP node identifiersserver-to-server communication in order to ensure both authentication andare not intendedconfidentiality (e.g., on an organization's private network). Compliant implementations SHOULD support SASL forarbitrary text or any other aspectthis purpose. Server-to-server communication MUST NOT proceed until the DNS hostnames asserted by both servers have been resolved as specified under Section 4. 15.5. Order ofanLayers The order of layers in which protocols MUST be stacked is: 1. TCP 2. TLS 3. SASL 4. XMPPaddress. This profile definesThe rationale for this order is that [TCP] is thefollowing, as requiredbase connection layer used by[STRINGPREP]: o The intended applicabilityall of theprofile: internationalized node identifiers within XMPP o The character repertoire thatprotocols stacked on top of TCP, [TLS] is often provided at the operating system layer, [SASL] is often provided at theinputapplication layer, andoutput to stringprep: Unicode 3.2, specified in Section 2 of this Appendix Saint-Andre Expires October 19, 2007 [Page 77] Internet-DraftXMPPCore April 2007 o The mappings used: specified in Section 3 o The Unicode normalization used: specified in Section 4 ois the application itself. 15.6. Lack of SASL Channel Binding to TLS ThecharactersSASL framework does not provide a mechanism to bind SASL authentication to a security layer providing confidentiality and integrity protection thatare prohibited as output: specified in Section 5 o Bidirectional character handling: specified in Section 6 A.2. Character Repertoirewas negotiated at a lower layer. Thisprofile uses Unicode 3.2 with the listlack ofunassigned code pointsa "channel binding" prevents SASL from beingTable A.1, both defined in Appendix A of [STRINGPREP]. A.3. Mapping This profile specifies mapping usingable to verify that thefollowing tables from [STRINGPREP]: Table B.1 Table B.2 A.4. Normalization This profile specifiessource and destination end points to which theuse of Unicode normalization form KC, as described in [STRINGPREP]. A.5. Prohibited Output This profile specifieslower layer's security is bound are equivalent to theprohibition of usingend points that SASL is authenticating. If the end points are not identical, thefollowing tables from [STRINGPREP]. Table C.1.1 Table C.1.2 Table C.2.1 Table C.2.2 Table C.3 Table C.4 Table C.5 Table C.6 Table C.7 Table C.8 Table C.9lower layer's security cannot be trusted to protect data transmitted between the SASL authenticated entities. Inaddition,such a situation, a SASL security layer SHOULD be negotiated that effectively ignores thefollowing Unicode characters are also prohibited: #x22 (")presence of the lower layer security. Saint-Andre ExpiresOctober 19, 2007January 18, 2008 [Page78]110] Internet-Draft XMPP CoreAprilJuly 2007#x26 (&) #x27 (') #x2F (/) #x3A (:) #x3C (<) #x3E (>) #x40 (@) A.6. Bidirectional Characters This profile specifies checking bidirectional strings, as described in Section 6 of [STRINGPREP]. Appendix B. Resourceprep B.1. Introduction This appendix defines the "Resourceprep" profile of [STRINGPREP]. As such, it specifies processing rules that will enable users to enter internationalized resource identifiers in15.7. Mandatory-to-Implement Technologies At a minimum, all implementations MUST support theExtensible Messaging and Presence Protocol (XMPP) and havefollowing mechanisms: for authentication: thehighest chance of gettingSASL [DIGEST-MD5] mechanism for confidentiality: TLS (using thecontent ofTLS_RSA_WITH_3DES_EDE_CBC_SHA cipher) for both: TLS plus SASL PLAIN for client-to-server connections and TLS plus SASL EXTERNAL for server-to-server connections (using thestrings correct. (AnTLS_RSA_WITH_3DES_EDE_CBC_SHA cipher supporting peer certificates) Naturally, implementations MAY support other ciphers with TLS and MAY support other SASL mechanisms. 15.8. Firewalls Communication using XMPPresource identifier isnormally occurs over [TCP] connections on port 5222 (client-to-server) or port 5269 (server-to-server), as registered with theoptional portionIANA (see Section 16). Use ofanthese well-known ports allows administrators to easily enable or disable XMPPaddress that follows a domain identifieractivity through existing and commonly-deployed firewalls. 15.9. Use of base64 in SASL Both the'/' separator.) These processing rules are intended only for XMPP resource identifiersclient and the server MUST verify any [BASE64] data received during SASL negotiation (Section 7). An implementation MUST reject (not ignore) any characters that are notintended for arbitrary text or any other aspect of an XMPP address. This profile defines the following, as requiredexplicitly allowed by[STRINGPREP]: o The intended applicability oftheprofile: internationalized resource identifiers within XMPP o The character repertoirebase64 alphabet; this helps to guard against creation of a covert channel thatis thecould be used to "leak" information. An implementation MUST NOT break on invalid input andoutput to stringprep: Unicode 3.2, specified in Section 2MUST reject any sequence ofthis Appendix o The mappings used: specified in Section 3 o The Unicode normalization used: specified in Section 4 o Thebase64 characters containing the pad ('=') character if thatare prohibitedcharacter is included asoutput: specified in Section 5 o Bidirectionalsomething other than the last characterhandling: specifiedof the data (e.g., "=AAA" or "BBBB=CCC"); this helps to guard against buffer overflow attacks and other attacks on the implementation. Base 64 encoding visually hides otherwise easily recognized information, such as passwords, but does not provide any computational confidentiality. Base 64 encoding MUST follow the definition in Section6 B.2. Character Repertoire This4 of [BASE64] and padding bits MUST be set to zero. 15.10. Stringprep Profiles XMPP makes use of the [NAMEPREP] profileuses Unicode 3.2 withof [STRINGPREP] for processing of domain identifiers; for security considerations related to Nameprep, refer to thelistappropriate section ofunassigned code points being Table A.1, both defined in Appendix A[NAMEPREP]. In addition, XMPP defines two profiles of[STRINGPREP].[STRINGPREP]: Nodeprep Saint-Andre ExpiresOctober 19, 2007January 18, 2008 [Page79]111] Internet-Draft XMPP CoreAprilJuly 2007B.3. Mapping This profile specifies mapping using the following tables from [STRINGPREP]: Table B.1 B.4. Normalization This profile specifies the use of(Appendix A) for node identifiers and Resourceprep (Appendix B) for resource identifiers. The Unicodenormalization form KC, as described in [STRINGPREP]. B.5. Prohibited Output This profile specifies the prohibitionand ISO/IEC 10646 repertoires have many characters that look similar. In many cases, users ofusing the following tables from [STRINGPREP]. Table C.1.2 Table C.2.1 Table C.2.2 Table C.3 Table C.4 Table C.5 Table C.6 Table C.7 Table C.8 Table C.9 B.6. Bidirectional Characters This profile specifies checking bidirectional strings,security protocols might do visual matching, such asdescribed in Section 6when comparing the names of[STRINGPREP]. Appendix C. Server Dialback C.1. Overview Server dialback is a reverse DNS lookup method whose results are communicated over XML streams, thus makingtrusted third parties. Because itmore difficult to spoof XMPP server domains and XML stanzas sent over XML streams between servers. Server dialbackisnotimpossible to map similar-looking characters without asecurity mechanism, and results only in weak verificationgreat deal ofserver identities (see Server-to-Server Communications (Section 15.4) regarding this method's security characteristics). Domains requiring robust security SHOULD use TLS and SASL; see Server-to-Server Communications (Section 15.4) for details. If SASL is used for server-to-server authentication, dialback SHOULD NOTcontext, such as knowing the fonts used, stringprep does nothing to map similar-looking characters together, nor to prohibit some characters because they look like others. A node identifier can beused since itemployed as one part of an entity's address in XMPP. One common usage isunnecessary. Documentation Saint-Andre Expires October 19, 2007 [Page 80] Internet-Draft XMPP Core April 2007as the username ofdialbackan instant messaging user; another isincluded mainly foras thesakename ofbackward-compatibility with existing implementations and deployments. However, depending on local policies,aservice may wish tomulti-user conference room; many other kinds of entities could usedialback to provide weak identity verification in cases where SASL negotiation would not result in strong authentication (e.g., because the certificate presented by the peer service during TLS negotiation is self-signed and thus provides even weaker identity verification than DNS).node identifiers as part of their addresses. Theserver dialback method is made possible by the existencesecurity ofthe Domain Name System (DNS), since one server can (normally) discover the authoritative server for a given domain. Because dialback dependssuch services could be compromised based onDNS, inter-domain communications MUST NOT proceed until the Domain Name System (DNS) hostnames asserted bydifferent interpretations of theservers have been resolved (see Server-to-Server Communications (Section 15.4)). Server dialback is uni-directional, and results in weak identity verification for one stream in one direction. Because server dialback is not an authentication mechanism, mutual authentication is not possible via dialback. Therefore, server dialback MUST be completed in each direction in order to enable bi-directional communications between two domains. The methodinternationalized node identifier; forgenerating and verifying the keys used in server dialback MUST take into account the hostnames being used, the stream ID generated by the receiving server, andexample, a user entering a single internationalized node identifier could access another user's account information, or asecret known byuser could gain access to a hidden or otherwise restricted chat room or service. A resource identifier can be employed as one part of an entity's address in XMPP. One common usage is as theauthoritative server's network; see Appendix C.5name for an instant messaging user's connected resource; another is as therecommended algorithm. Any error that occurs during dialback negotiation MUST be considerednickname of astream error, resultinguser interminationa multi-user conference room; many other kinds ofthe stream andentities could use resource identifiers as part ofthe underlying TCP connection.their addresses. Thepossible error conditions are specified insecurity of such services could be compromised based on different interpretations of theprotocol description below. The following terminology applies: o ORIGINATING SERVER --internationalized resource identifier; for example, a user could attempt to initiate multiple connections with theserver that is attemptingsame name, or a user could send a message toestablishsomeone other than the intended recipient in aconnection betweenmulti-user conference room. 15.11. Address Spoofing As discussed in [XEP-0165], there are twodomains. o RECEIVING SERVER --forms of address spoofing: forging and mimicking. 15.11.1. Address Forging In theserver thatcontext of XMPP technologies, address forging occurs when an entity istrying to authenticate that the Originating Server represents the domain which it claimsable tobe. o AUTHORITATIVE SERVER -- the server that answersgenerate an XML stanza whose 'from' address does not correspond to theDNS hostname asserted by the Originating Server; for basic environments this will beaccount credentials with which theOriginating Server, but it could be a separate machine inentity authenticated onto theOriginating Server's network.network (or an authorization identity provided during SASL negotiation (Section 7). For example, address forging occurs if an entity that authenticated as "juliet@example.com" is able to send XML stanzas from "nurse@example.com" or "romeo@example.net". Saint-Andre ExpiresOctober 19, 2007January 18, 2008 [Page81]112] Internet-Draft XMPP CoreAprilJuly 2007C.2. Order of Events The followingAddress forging isa brief summary of the order of eventsdifficult indialback: 1. The Originating Server establishes an XML stream withXMPP systems, given theReceiving Server. 2. The Originating Server sendsrequirement for sending servers to stamp 'from' addresses and for receiving servers to verify sending domains via server-to-server authentication. However, address forging is not impossible, since a'key' value overrogue server could forge JIDs at theconnection tosending domain by ignoring theReceiving Server. 3. The Receiving Server establishesstamping requirement. A rogue server could even forge JIDs at other domains by means of a DNS poisoning attack if [DNSSEC] is not used. This specification does not define methods for discovering or counteracting such rogue servers. 15.11.2. Address Mimicking Address mimicking occus when anXML stream with the Authoritative Server. 4. The Receiving Serverentity provides legitimate authentication credentials for and sends XML stanzas from an account whose JID appears to a human user to be the same'key' value toas another JID. For example, in some XMPP clients theAuthoritative Server for verification. 5. The Authoritative Server replies that key is valid or invalid. 6. The Receiving Server informsaddress "paypa1@example.org" (spelled with theOriginating Server whether it is authenticated or not. We can represent this flow of events graphicallynumber one asfollows: Originating Receiving Server Server ----------- --------- | | | establish stream | | ----------------------> | | | Authoritative | send dialback key | Server | ----------------------> | ------------- | | | | establish stream | | ----------------------> | | | | send verify request | | ----------------------> | | | | send verify response | | <---------------------- | | | report dialback result | | <---------------------- | | | C.3. Protocol This section describesthedetailed protocol interaction betweenfinal character of the node identifier) may appear to be the same as "paypal@example.org (spelled with theOriginating Server,lower-case version of theReceiving Server, andletter "L"), especially on casual visual inspection; this phenomenon is sometimes called "typejacking". A more sophisticated example of address mimicking might involve theAuthoritative Server. This section usesuse of characters from outside thefollowing domain names, IP addresses, stream Saint-Andre Expires October 19, 2007 [Page 82] Internet-Draft XMPP Core April 2007 IDs, and shared secret inUS-ASCII range, such as theexamples: o The Originating Server is "example.org" (there is no IPCherokee characters U+13DA U+13A2 U+13B5 U+13AC U+13A2 U+13AC U+13D2 instead of the US-ASCII charac