There is a growing number of XMPP Extension Protocols (XEPs) that provide different building blocks for XMPP-based applications. XMPP software developers are confronted with the challenge of finding the right combination of XEPs for a given application profile. Users need a way to compare applications without resorting to comparing for individual XEP numbers.
This document defines XMPP application Categories based on typical use cases (Core, Web, IM, Mobile) and Levels (Core, Advanced) based on functionality in the respective category. For each combination of those, the required XEPs are referenced. As the protocol landscape changes over time, this document is updated roughly once a year.
For developers, this document provides guidance on which specifications they need to consider when implementing an application of a certain kind. By completing a compliance test or performing a self-assessment, they can advertise their implementation as compliant with a given Category and Level.
For users, this provides an easy way to compare implementations based on their respective advertised compliance levels and year.
Unless explicitly noted, support for the listed specifications is REQUIRED for compliance purposes. A feature is considered supported if all comma separated feature providers listed in the "Providers" column are implemented (unless otherwise noted).
The following changes were made to the Compliance Suites since XMPP Compliance Suites 2019 (XEP-0412) [15]:
| Feature | Core Server | Core Client | Advanced Server | Advanced Client | Providers |
|---|---|---|---|---|---|
| Core features | ✓ | ✓ | ✓ | ✓ | RFC 6120 [16] [17] |
| TLS | ✓ | ✓ | ✓ | ✓ | RFC 7590 [19] |
| Direct TLS | ✕ | ✕ | ✓ [20] | ✓ | SRV records for XMPP over TLS (XEP-0368) [21] |
| Feature discovery | ✓ | ✓ | ✓ | ✓ | Service Discovery (XEP-0030) [22] |
| Feature broadcasts | ✕ | ✓ | ✓ | ✓ | Entity Capabilities (XEP-0115) [23] |
| Server Extensibility | ✓ | N/A | ✓ | N/A | Jabber Component Protocol (XEP-0114) [24] |
| Event publishing | ✕ | ✕ | ✓ [25] | ✓ | Personal Eventing Protocol (XEP-0163) [26] |
To be considered XMPP web compliant, all features from the core compliance category must be met, as well as all features in this suite.
| Feature | Core Server | Core Client | Advanced Server | Advanced Client | Providers |
|---|---|---|---|---|---|
| Web Connection Mechanisms | ✓ [27] | ✓ [28] | ✓ [27] | ✓ [28] | RFC 7395 [29], XMPP Over BOSH (XEP-0206) [30] (See also: BOSH (XEP-0124) [31]) |
| Connection Mechanism Discovery | ✕ | ✕ | N/A | ✓ | Discovering Alternative XMPP Connection Methods (XEP-0156) [7] |
To be considered XMPP IM compliant, all features from the core compliance category must be met, as well as all features in this suite.
Further specifications of note, which are not required for compliance:
To be considered XMPP mobile compliant, all features from the core compliance category must be met, as well as all features in this suite.
| Feature | Core Server | Core Client | Advanced Server | Advanced Client | Providers |
|---|---|---|---|---|---|
| Stream Management | ✓ | ✓ | ✓ | ✓ | Stream Management (XEP-0198) [51] |
| Client State Indication | ✓ | ✓ | ✓ | ✓ | Client State Indication (XEP-0352) [55] |
| Third Party Push Notifications | ✕ | ✕ | ✓ [27] | ✓ [56] | Push Notifications (XEP-0357) [57] |
Further specifications of note, which are not required for compliance:
This section outlines the protocol specifications that are relevant for developers, but are not ready yet to be required for Compliance. Developers are encouraged to implement those and to share their experience and feedback.
Some of the protocol specifications referenced herein have their own dependencies; developers need to consult the relevant specifications for further information.
This document introduces no additional security considerations above and beyond those defined in the documents on which it depends.
This document requires no interaction with the Internet Assigned Numbers Authority (IANA) [68].
This document requires no interaction with the XMPP Registrar [69].
The author would like to thank Guus der Kinderen, Dele Olajide, Marc Laporte, Dave Cridland, Daniel Gultsch, Florian Schmaus, Tobias Markmann, and Jonas Schäfer for their suggestions.
This document in other formats: XML PDF
This XMPP Extension Protocol is copyright © 1999 – 2020 by the XMPP Standards Foundation (XSF).
Permission is hereby granted, free of charge, to any person obtaining a copy of this specification (the "Specification"), to make use of the Specification without restriction, including without limitation the rights to implement the Specification in a software program, deploy the Specification in a network service, and copy, modify, merge, publish, translate, distribute, sublicense, or sell copies of the Specification, and to permit persons to whom the Specification is furnished to do so, subject to the condition that the foregoing copyright notice and this permission notice shall be included in all copies or substantial portions of the Specification. Unless separate permission is granted, modified works that are redistributed shall not contain misleading information regarding the authors, title, number, or publisher of the Specification, and shall not claim endorsement of the modified works by the authors, any organization or project to which the authors belong, or the XMPP Standards Foundation.
## NOTE WELL: This Specification is provided on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. ##
In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall the XMPP Standards Foundation or any author of this Specification be liable for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising from, out of, or in connection with the Specification or the implementation, deployment, or other use of the Specification (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if the XMPP Standards Foundation or such author has been advised of the possibility of such damages.
This XMPP Extension Protocol has been contributed in full conformance with the XSF's Intellectual Property Rights Policy (a copy of which can be found at <https://xmpp.org/about/xsf/ipr-policy> or obtained by writing to XMPP Standards Foundation, P.O. Box 787, Parker, CO 80134 USA).
The HTML representation (you are looking at) is maintained by the XSF. It is based on the YAML CSS Framework, which is licensed under the terms of the CC-BY-SA 2.0 license.
The Extensible Messaging and Presence Protocol (XMPP) is defined in the XMPP Core (RFC 6120) and XMPP IM (RFC 6121) specifications contributed by the XMPP Standards Foundation to the Internet Standards Process, which is managed by the Internet Engineering Task Force in accordance with RFC 2026. Any protocol defined in this document has been developed outside the Internet Standards Process and is to be understood as an extension to XMPP rather than as an evolution, development, or modification of XMPP itself.
The primary venue for discussion of XMPP Extension Protocols is the <standards@xmpp.org> discussion list.
Discussion on other xmpp.org discussion lists might also be appropriate; see <http://xmpp.org/about/discuss.shtml> for a complete list.
Given that this XMPP Extension Protocol normatively references IETF technologies, discussion on the <xsf-ietf@xmpp.org> list might also be appropriate.
Errata can be sent to <editor@xmpp.org>.
The following requirements keywords as used in this document are to be interpreted as described in RFC 2119: "MUST", "SHALL", "REQUIRED"; "MUST NOT", "SHALL NOT"; "SHOULD", "RECOMMENDED"; "SHOULD NOT", "NOT RECOMMENDED"; "MAY", "OPTIONAL".
1. XEP-0066: Out of Band Data <https://xmpp.org/extensions/xep-0066.html>.
2. XEP-0385: Stateless Inline Media Sharing (SIMS) <https://xmpp.org/extensions/xep-0385.html>.
3. XEP-0392: Consistent Color Generation <https://xmpp.org/extensions/xep-0392.html>.
4. XEP-0077: In-Band Registration <https://xmpp.org/extensions/xep-0077.html>.
5. XEP-0157: Contact Addresses for XMPP Services <https://xmpp.org/extensions/xep-0157.html>.
6. XEP-0286: Mobile Considerations on LTE Networks <https://xmpp.org/extensions/xep-0286.html>.
7. XEP-0156: Discovering Alternative XMPP Connection Methods <https://xmpp.org/extensions/xep-0156.html>.
8. XEP-0333: Chat Markers <https://xmpp.org/extensions/xep-0333.html>.
9. XEP-0420: Stanza Content Encryption <https://xmpp.org/extensions/xep-0420.html>.
10. XEP-0245: The /me Command <https://xmpp.org/extensions/xep-0245.html>.
11. XEP-0363: HTTP File Upload <https://xmpp.org/extensions/xep-0363.html>.
12. XEP-0234: Jingle File Transfer <https://xmpp.org/extensions/xep-0234.html>.
13. XEP-0261: Jingle In-Band Bytestreams Transport Method <https://xmpp.org/extensions/xep-0261.html>.
14. XEP-0411: Bookmarks Conversion <https://xmpp.org/extensions/xep-0411.html>.
15. XEP-0412: XMPP Compliance Suites 2019 <https://xmpp.org/extensions/xep-0412.html>.
16. RFC 6120: Extensible Messaging and Presence Protocol (XMPP): Core <http://tools.ietf.org/html/rfc6120>.
17. RFC 7622 [18] is not listed due to the unclear interoperability impact of using PRECIS and Stringprep in the same ecosystem.
18. RFC 7622: Extensible Messaging and Presence Protocol (XMPP): Address Format <http://tools.ietf.org/html/rfc7622>.
19. RFC 7590: Use of Transport Layer Security (TLS) in the Extensible Messaging and Presence Protocol (XMPP) <http://tools.ietf.org/html/rfc7590>.
20. Server support of XEP-0368 means having the ability to accept direct TLS connections.
21. XEP-0368: SRV records for XMPP over TLS <https://xmpp.org/extensions/xep-0368.html>.
22. XEP-0030: Service Discovery <https://xmpp.org/extensions/xep-0030.html>.
23. XEP-0115: Entity Capabilities <https://xmpp.org/extensions/xep-0115.html>.
24. XEP-0114: Jabber Component Protocol <https://xmpp.org/extensions/xep-0114.html>.
25. While 'Personal Eventing Protocol' does not require all the features of 'Publish-Subscribe' to be available on the users' JIDs, and nor does this suite, it is desirable for this to be the case and it is expected that this will a requirement of future Compliance Suites.
26. XEP-0163: Personal Eventing Protocol <https://xmpp.org/extensions/xep-0163.html>.
27. Support can be enabled via an external component or an internal server module/plugin. If claiming compliance using such an addition, the necessary components/modules/plugins MUST be detailed.
28. Only one of the recommended providers must be implemented for compliance.
29. RFC 7395: An Extensible Messaging and Presence Protocol (XMPP) Subprotocol for WebSocket <http://tools.ietf.org/html/rfc7395>.
30. XEP-0206: XMPP Over BOSH <https://xmpp.org/extensions/xep-0206.html>.
31. XEP-0124: Bidirectional-streams Over Synchronous HTTP <https://xmpp.org/extensions/xep-0124.html>.
32. RFC 6121: Extensible Messaging and Presence Protocol (XMPP): Instant Messaging and Presence <http://tools.ietf.org/html/rfc6121>.
33. Not required for command line or terminal based interfaces.
34. XEP-0084: User Avatar <https://xmpp.org/extensions/xep-0084.html>.
35. XEP-0398: User Avatar to vCard-Based Avatars Conversion <https://xmpp.org/extensions/xep-0398.html>.
36. XEP-0153: vCard-Based Avatars <https://xmpp.org/extensions/xep-0153.html>.
37. XEP-0054: vcard-temp <https://xmpp.org/extensions/xep-0054.html>.
38. XEP-0280: Message Carbons <https://xmpp.org/extensions/xep-0280.html>.
39. XEP-0191: Blocking Command <https://xmpp.org/extensions/xep-0191.html>.
40. Support for the Entity Use Cases and Occupant Use Cases is REQUIRED; support for the remaining use cases is RECOMMENDED.
41. XEP-0045: Multi-User Chat <https://xmpp.org/extensions/xep-0045.html>.
42. Implementations should take note that future versions of these compliance suites may rely on Mediated Information eXchange (MIX) (XEP-0369) [43] instead.
43. XEP-0369: Mediated Information eXchange (MIX) <https://xmpp.org/extensions/xep-0369.html>.
44. XEP-0249: Direct MUC Invitations <https://xmpp.org/extensions/xep-0249.html>.
45. XEP-0048: Bookmark Storage <https://xmpp.org/extensions/xep-0048.html>.
46. XEP-0313: Message Archive Management <https://xmpp.org/extensions/xep-0313.html>.
47. Support for requesting history from a MUC archive as opposed to from the user's account.
48. XEP-0410: MUC Self-Ping (Schrödinger's Chat) <https://xmpp.org/extensions/xep-0410.html>.
49. XEP-0223: Best Practices for Persistent Storage of Private Data via Publish-Subscribe <https://xmpp.org/extensions/xep-0223.html>.
50. XEP-0049: Private XML Storage <https://xmpp.org/extensions/xep-0049.html>.
51. XEP-0198: Stream Management <https://xmpp.org/extensions/xep-0198.html>.
52. XEP-0184: Message Delivery Receipts <https://xmpp.org/extensions/xep-0184.html>.
53. XEP-0085: Chat State Notifications <https://xmpp.org/extensions/xep-0085.html>.
54. XEP-0308: Last Message Correction <https://xmpp.org/extensions/xep-0308.html>.
55. XEP-0352: Client State Indication <https://xmpp.org/extensions/xep-0352.html>.
56. Only on platforms that disallow long-lasting background connections.
57. XEP-0357: Push Notifications <https://xmpp.org/extensions/xep-0357.html>.
58. XEP-0386: Bind 2.0 <https://xmpp.org/extensions/xep-0386.html>.
59. XEP-0409: IM Routing-NG <https://xmpp.org/extensions/xep-0409.html>.
60. XEP-0397: Instant Stream Resumption <https://xmpp.org/extensions/xep-0397.html>.
61. XEP-0380: Explicit Message Encryption <https://xmpp.org/extensions/xep-0380.html>.
62. XEP-0384: OMEMO Encryption <https://xmpp.org/extensions/xep-0384.html>.
63. XEP-0396: Jingle Encrypted Transports - OMEMO <https://xmpp.org/extensions/xep-0396.html>.
64. XEP-0374: OpenPGP for XMPP Instant Messaging <https://xmpp.org/extensions/xep-0374.html>.
65. XEP-0402: PEP Native Bookmarks <https://xmpp.org/extensions/xep-0402.html>.
66. XEP-0225: Component Connections <https://xmpp.org/extensions/xep-0225.html>.
67. XEP-0390: Entity Capabilities 2.0 <https://xmpp.org/extensions/xep-0390.html>.
68. The Internet Assigned Numbers Authority (IANA) is the central coordinator for the assignment of unique parameter values for Internet protocols, such as port numbers and URI schemes. For further information, see <http://www.iana.org/>.
69. The XMPP Registrar maintains a list of reserved protocol namespaces as well as registries of parameters used in the context of XMPP extension protocols approved by the XMPP Standards Foundation. For further information, see <https://xmpp.org/registrar/>.
Note: Older versions of this specification might be available at http://xmpp.org/extensions/attic/
Update to Draft as per council vote on 2019/11/07.
Update with LC feedback
Update before LC:
First draft based on XEP-0412. Non-editorial Changes:
END