This document specifies a standards-track XMPP protocol extension that enables server components to connect to XMPP servers.
WARNING: This Standards-Track document is Experimental. Publication as an XMPP Extension Protocol does not imply approval of this proposal by the XMPP Standards Foundation. Implementation of the protocol described herein is encouraged in exploratory implementations, but production systems should not deploy implementations of this protocol until it advances to a status of Draft.
Series: XEP
Number: 0225
Publisher: XMPP Standards Foundation
Status:
Experimental
Type:
Standards Track
Version: 0.1
Last Updated: 2007-08-08
Approving Body: XMPP Council
Dependencies: XMPP Core
Supersedes: None
Superseded By: None
Short Name: NOT YET ASSIGNED
Wiki Page: <http://wiki.jabber.org/index.php/Component Connections (XEP-0225)>
JabberID:
stpeter@jabber.org
URI:
https://stpeter.im/
The preferred venue for discussion of this document is the Standards discussion list: <http://mail.jabber.org/mailman/listinfo/standards>.
Errata may be sent to <editor@xmpp.org>.
The Extensible Messaging and Presence Protocol (XMPP) is defined in the XMPP Core (RFC 3920) and XMPP IM (RFC 3921) 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 following 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. Introduction
2. Requirements
3. Stream Establishment
4. Hostname Binding
5. Examples
6. Security Considerations
7. IANA Considerations
8. XMPP Registrar Considerations
8.1. Protocol Namespaces
9. XML Schema
Notes
Revision History
Jabber Component Protocol [1] defines a protocol that enables a server component to connect to an XMPP server. However, there are a number of perceived limitations with that protocol:
This document specifies a standards-track protocol that addresses the basic requirements for component connections. In the future, additional documents may specify more advanced features on top of the protocol defined herein.
This document addresses the following requirements:
XML streams are established between a component and a server exactly as they are between a client and a server as specified in XMPP Core [4], with the following exceptions:
The protocol defined in XEP-0114 depended on use of the 'to' address in the stream header to specify the hostname of the component. By contrast, client-to-server connections use stream establishment is followed by binding of a resource to the stream (in fact multiple resources can be bound to the stream). This protocol emulates client-to-server connections by using a hostname binding process that is similar to the resource binding process specified in XMPP Core.
If a server offers component binding over a stream, it MUST advertise a feature of "urn:xmpp:tmp:component".
S: <stream:stream from='example.com' id='gPybzaOzBmaADgxKXu9UClbprp0=' to='chat.example.com' version='1.0' xml:lang='en' xmlns='jabber:client' xmlns:stream='http://etherx.jabber.org/streams'> S: <stream:features> <bind xmlns='urn:xmpp:tmp:component'> <required/> </bind> </stream:features>
In order to bind a hostname, the component sends a bind request to the server.
C: <iq id='bind_1' type='set'> <bind xmlns='urn:xmpp:tmp:component'> <hostname>chat.example.com</hostname> </bind> </iq>
If the hostname can be bound, the server MUST return an IQ-result.
S: <iq id='bind_1' type='result'/>
A component can send a subsequent bind request to bind another hostname (a server MUST support binding of multiple hostnames).
C: <iq id='bind_2' type='set'> <bind xmlns='urn:xmpp:tmp:component'> <hostname>foo.example.com</hostname> </bind> </iq>
If the server cannot process the bind request (e.g., because the component has already bound the desired hostname), the server MUST return an IQ-error (e.g., <conflict/>).
A component can also unbind a resource that has already been bound (a server MUST support unbinding).
C: <iq id='unbind_1' type='set'> <unbind xmlns='urn:xmpp:tmp:component'> <hostname>foo.example.com</hostname> </unbind> </iq>
If the hostname can be unbound, the server MUST return an IQ-result.
S: <iq id='unbind_1' type='result'/>
Further examples to follow.
This protocol improves upon the earlier component protocol defined in XEP-0114 by specifying the use of Transport Layer Security (TLS) for channel encryption and the Simple Authentication and Security Layer (SASL) for authentication. Because this protocol re-uses the XML stream establishment processes defined in XMPP Core, the security considerations from RFC 3920 and rfc3920bis apply to this protocol as well.
This document requires no interaction with the Internet Assigned Numbers Authority (IANA) [5].
Until this specification advances to a status of Draft, its associated namespace shall be "urn:xmpp:tmp:component"; upon advancement of this specification, the XMPP Registrar [6] shall issue a permanent namespace in accordance with the process defined in Section 4 of XMPP Registrar Function [7].
<?xml version='1.0' encoding='UTF-8'?> <xs:schema xmlns:xs='http://www.w3.org/2001/XMLSchema' targetNamespace='urn:xmpp:tmp:component' xmlns='urn:xmpp:tmp:component' elementFormDefault='qualified'> <xs:element name='bind'> <xs:complexType> <xs:sequence> <xs:choice minOccurs='0' maxOccurs='1'> <xs:element name='hostname' type='xs:string'/> </xs:choice> <xs:element name='required' minOccurs='0' maxOccurs='1' type='empty'/> </xs:sequence> </xs:complexType> </xs:element> <xs:element name='unbind'> <xs:complexType> <xs:sequence minOccurs='0'> <xs:element name='hostname' type='xs:string'/> </xs:sequence> </xs:complexType> </xs:element> </xs:schema>
1. XEP-0114: Jabber Component Protocol <http://www.xmpp.org/extensions/xep-0114.html>.
2. RFC 4346: The Transport Layer Security (TLS) Protocol Version 1.1 <http://tools.ietf.org/html/rfc4346>.
3. RFC 4422: Simple Authentication and Security Layer (SASL) <http://tools.ietf.org/html/rfc4422>.
4. RFC 3920: Extensible Messaging and Presence Protocol (XMPP): Core <http://tools.ietf.org/html/rfc3920>.
5. 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/>.
6. 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 <http://www.xmpp.org/registrar/>.
7. XEP-0053: XMPP Registrar Function <http://www.xmpp.org/extensions/xep-0053.html>.
Initial published version.
(psa)First draft.
(psa)END