%ents; ]>
Discovering Alternative XMPP Connection Methods This document defines an XMPP Extension Protocol for discovering alternative methods of connecting to an XMPP server via Web Host Metadata Link format. &LEGALNOTICE; 0156 Draft Standards Track Standards Council XMPP Core RFC 1464 alt-connections &hildjj; &stpeter; &lance; 1.4.0 2022-02-10 tjb

Remove DNS _xmppconnect method due to security vulnerability.

1.3.1 2020-07-07 adiaholic

Include all described formats in the abstract, instead of just mentioning the TXT record format.

1.3.0 2020-06-23 fs

Fix reference to RFC 6415 and organize requirements more clearly. This raises the JSON requirement from MAY (OPTIONAL) to SHOULD (effectively), to accustom web-based software.

1.2.0 2019-02-20 wk

Add information about CORS header usage and requirements

1.1.5 2018-09-30 jsc

Make JSON example less error-prone.

1.1.4 2018-09-30 jsc

Fix XML header on example.

1.1.3 2018-07-21 egp

Replace references to draft-ietf-xmpp-websocket with RFC7395 (XMPP over WebSocket).

1.1.2 2016-06-07 XSF Editor: ssw
  • Clarify that the XML version of the XRD document is required by the RFC and the JSON version is optional.
  • Update references to draft-ietf-xmpp-websocket to point to RFC 7395.
1.1.1 2016-06-06 XSF Editor: ssw

Fix a small typo in one of the examples (UTF-9 encoding).

1.1 2014-01-08 ls/psa

Defined HTTP lookup methods using well-known URIs as specified in RFC 5785.

1.0 2007-06-12 psa

Per a vote of the XMPP Council, advanced status to Draft; XMPP Registrar assigned alt-connections shortname and created appropriate registry.

0.7 2007-04-18 psa

Updated to reflect renaming of HTTP Binding to XMPP Over BOSH.

0.6 2007-01-30 psa

Finally and definitively removed _xmpp-client-tcp and _xmpp-server-tcp attributes since clients and servers should use either SRV records or standard XMPP ports (5222 or 5269).

0.5 2007-01-30 psa

Removed _xmpp-client-tcpssl attribute since use of the old-style SSL-only port is discouraged.

0.4 2007-01-29 psa

Added _xmpp-client-tcpssl for old-style SSL connections; added discussion of IETF U-NAPTR technology.

0.3 2006-05-16 psa

Clarified order of lookups; restored _xmpp-client-tcp and added _xmpp-server-tcp as optional records if SRV is not supported or accessible.

0.2 2005-12-05 psa

Removed _xmpp-client-tcp from TXT records (belongs in SRV records only).

0.1 2005-09-08 psa

Initial version.

0.0.3 2005-09-07 psa

More fully specified the rationale for using DNS TXT records.

0.0.2 2005-08-27 psa

Added security considerations and registrar considerations.

0.0.1 2005-08-23 psa/jh

First draft.

Although &xmppcore; specifies the use of TCP as the method of connecting to an XMPP server, alternative connection methods exist, including the &xep0124; method (for which &xep0206; is the XMPP profile) and the websocket subprotocol specified in &rfc7395;. For some of these methods, it is necessary to discover further parameters before connecting, such as the HTTP URL of an alternative connection manager. Without ways to auto-discover alternative connection methods, the relevant information would need to be provided manually by a human user (which is cumbersome and error-prone) or hard-coded into XMPP software applications (which is brittle and not interoperable).

This document defines a way to encapsulate information about alternative connection methods for auto-discovery via Link entries in a server's "host-meta" file.

The HTTP lookup method uses Web Host Metadata &rfc6415; to categorize and list the URIs of alternative connection methods. It is primarily intended for use by clients in environments where the ability to perform DNS queries is restricted, such as in web browsers.

Each alternative connection method is specified in the host-meta (XRD) file using a distinctive link relation &rfc5988;. This specification defines several extension relation types:

  • urn:xmpp:alt-connections:websocket
  • urn:xmpp:alt-connections:xbosh

The following business rules apply:

  1. host-meta files MUST be fetched only over HTTPS, and MUST only use connection URLs starting with 'https://' or 'wss://'. This provides secure delegation, meaning you SHOULD send SNI matching the host of the URL from the connection URL and validate that the certificate is valid for that host *or* the XMPP domain.
  2. Services implementing this XEP MUST offer the information in the Extensible Resource Descriptor (XRD) format and SHOULD additionally provide the JRD format (both formats are specified in &rfc6415;).
  3. HTTPS queries for host-meta information MUST be used only as a fallback after the methods specified in RFC 6120 have been exhausted.
  4. A domain SHOULD NOT present information in host-meta link records that is available via the DNS SRV records defined in RFC 6120.
  5. The order of XMPP related link entries in the host-meta file SHOULD NOT be interpreted as significant by the presenting domain or the receiving entity.

The following examples show two host-meta link records: the first indicates support for the XMPP Over BOSH connection method defined in XEP-0124 and XEP-0206 and the second indicates support for the XMPP Over WebSocket connection method defined in &rfc7395;.

... ... ]]>

It is possible to use additionally a JSON-based format for host-meta information. The JSON representation of the host metadata is named JRD and specified in Appendix A of &rfc6415;. The above XRD example would be presented in JRD as:

To make connection discovery work in web clients (including those hosted on a different domain) the host service SHOULD set appropriate CORS headers for Web Host Metadata files. The exact headers and values are out of scope of this document but may include: Access-Control-Allow-Origin, Access-Control-Allow-Methods and Access-Control-Allow-Headers.

Due care has to be exercised in limiting the scope of Access-Control-Allow-Origin response header to Web Host Metadata files only.

Access-Control-Allow-Origin header with a value of * allows JavaScript code running on a different domain to read the content of Web Host Metadata files. Special value * ensures that the request will only succeed if it is invoked without user credentials (e.g. cookies, HTTP authentication).

It is possible that advertisement of alternative connection methods can introduce security vulnerabilities, since a connecting entity (usually a client) might deliberately seek to connect using the method with the weakest security mechanisms (e.g., no channel encryption or relatively weak authentication). Care needs to be taken in determining which alternative connection methods are appropriate to advertise or implement in your lookup.

Entities that use these connection methods MUST only fetch host-meta over Transport Layer Security (TLS), and MUST only use 'https' or 'wss' URLs that are protected using TLS.

A previous version of this XEP defined a DNS method to look up this info using a TXT _xmppconnect record, this was insecure and has been removed.

Because the link relations specified here are extension relation types rather than registered relation types (see Section 4 of RFC 5988), this document requires no interaction with &IANA;.

The ®ISTRAR; shall include 'urn:xmpp:alt-connections' in its registry of protocol namespaces (see &NAMESPACES;).

  • urn:xmpp:alt-connections