XEP-0199: XMPP Ping

Abstract:This specification defines an XMPP protocol extension for sending application-level pings over XML streams. Such pings can be sent from a client to a server, from one server to another, or end-to-end.
Author:Peter Saint-Andre
Copyright:© 1999 – 2018 XMPP Standards Foundation. SEE LEGAL NOTICES.
Status:Final
Type:Standards Track
Version:2.0.1
Last Updated:2019-03-26

NOTICE: The protocol defined herein is a Final Standard of the XMPP Standards Foundation and can be considered a stable technology for implementation and deployment.

Table of Contents


1. Introduction
2. Requirements
3. Protocol
4. Use Cases
    4.1. Server-To-Client Pings
    4.2. Client-To-Server Pings
    4.3. Server-To-Server Pings
    4.4. Client-to-Client Pings
    4.5. Component-to-Client Pings
5. Determining Support
6. Implementation Notes
7. Security Considerations
8. IANA Considerations
9. XMPP Registrar Considerations
    9.1. Protocol Namespaces
10. XML Schema

Appendices
    A: Document Information
    B: Author Information
    C: Legal Notices
    D: Relation to XMPP
    E: Discussion Venue
    F: Requirements Conformance
    G: Notes
    H: Revision History

1. Introduction

As specified in XMPP Core [1], the XML streams used in XMPP are bound to TCP. Unfortunately, TCP connections can go down without the application (XMPP) layer knowing about it. The traditional approach to solving this issue has been to periodically send so-called "whitespace pings" over the XML stream. This document recommends a more XML-friendly approach, which can be used over more than one hop in the communication path (e.g., from one client to another) and can also be used with other bindings such as the BOSH (XEP-0124) [2] method for which XMPP Over BOSH (XEP-0206) [3] is the XMPP profile.

2. Requirements

This specification addresses the following requirements:

  1. Determining the viability of an XML stream (i.e., its underlying binding) between a client and a server, or between two servers.
  2. Determining end-to-end connectivity between any two XMPP entities (e.g., two clients).

The number of "hops" for which the ping tests connectivity depends on how far the pinged entity is from the pinging entity, as shown in the following use cases. However, this specification does not provide per-hop information similar to that provided by the traceroute protocol (RFC 1393 [4]); a future specification may define such functionality for XMPP.

3. Protocol

The XMPP ping protocol is extremely simple:

  1. The pinging entity sends an IQ-get containing a <ping/> element qualified by the 'urn:xmpp:ping' namespace.
  2. The pinged entity returns either an IQ-result (if it supports the namespace) or an IQ-error (if it does not).

4. Use Cases

4.1 Server-To-Client Pings

One popular usage is for a server to test the viability of the underlying stream connection by pinging a connected client. This is done by sending an <iq/> get over the stream from the server to the client.

Example 1. Ping

<iq from='capulet.lit' to='juliet@capulet.lit/balcony' id='s2c1' type='get'>
  <ping xmlns='urn:xmpp:ping'/>
</iq>

If the client supports the ping namespace, it MUST return an IQ-result, which functions as a "pong":

Example 2. Pong

<iq from='juliet@capulet.lit/balcony' to='capulet.lit' id='s2c1' type='result'/>

If the client does not support the ping namespace, it MUST return a <service-unavailable/> error:

Example 3. Ping Not Supported

<iq from='juliet@capulet.lit/balcony' to='capulet.lit' id='s2c1' type='error'>
  <ping xmlns='urn:xmpp:ping'/>
  <error type='cancel'>
    <service-unavailable xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'/>
  </error>
</iq>

The other error conditions defined in RFC 6120 could also be returned if appropriate.

4.2 Client-To-Server Pings

A client may also ping its server by sending an IQ-get over the stream between the two entities.

Example 4. Ping

<iq from='juliet@capulet.lit/balcony' to='capulet.lit' id='c2s1' type='get'>
  <ping xmlns='urn:xmpp:ping'/>
</iq>

Note: The client MAY include a 'to' address of the client's bare JID <localpart@domain.tld>, in this instance "juliet@capulet.lit" or MAY include no 'to' address (this signifies that the stanza shall be handled by the server on behalf of the connected user's bare JID, which in the case of <iq/> stanzas is equivalent to directing the IQ-get to the server itself).

If the server supports the ping namespace, it MUST return an IQ-result:

Example 5. Pong

<iq from='capulet.lit' to='juliet@capulet.lit/balcony' id='c2s1' type='result'/>

If the server does not support the ping namespace, it MUST return a <service-unavailable/> error:

Example 6. Ping Not Supported

<iq from='capulet.lit' to='juliet@capulet.lit/balcony' id='c2s1' type='error'>
  <ping xmlns='urn:xmpp:ping'/>
  <error type='cancel'>
    <service-unavailable xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'/>
  </error>
</iq>

The other error conditions defined in RFC 6120 could also be returned if appropriate.

4.3 Server-To-Server Pings

Pings can also be used to test a server-to-server connection. This is done by sending an IQ-get over the stream from one server to another.

Example 7. Ping

<iq from='capulet.lit' to='montague.lit' id='s2s1' type='get'>
  <ping xmlns='urn:xmpp:ping'/>
</iq>

If the other party to the stream supports the ping namespace, it MUST return an IQ-result:

Example 8. Pong

<iq from='montague.lit' to='capulet.lit' id='s2s1' type='result'/>

If the other party to the stream does not support the ping namespace, it MUST return a <service-unavailable/> error:

Example 9. Ping Not Supported

<iq from='montague.lit' to='capulet.lit' id='s2s1' type='error'>
  <ping xmlns='urn:xmpp:ping'/>
  <error type='cancel'>
    <service-unavailable xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'/>
  </error>
</iq>

The other error conditions defined in RFC 6120 could also be returned if appropriate.

4.4 Client-to-Client Pings

Pings can also be used for client-to-client (i.e., end-to-end) pings.

Example 10. Ping

<iq from='romeo@montague.lit/home'
    to='juliet@capulet.lit/chamber'
    type='get'
    id='e2e1'>
  <ping xmlns='urn:xmpp:ping'/>
</iq>

Note: The 'to' address should be a full JID <localpart@domain.tld/resource>, since a ping sent to a bare JID <localpart@domain.tld> will be handled by the server on behalf of the client.

If the pinged entity supports the ping namespace, it SHOULD return an IQ-result:

Example 11. Pong

<iq from='juliet@capulet.lit/chamber'
    to='romeo@montague.lit/home'
    id='e2e1'
    type='result'/>

If the pinged entity does not support the ping namespace, it MUST return a <service-unavailable/> error:

Example 12. Ping Not Supported

<iq from='juliet@capulet.lit/chamber'
    to='romeo@montague.lit/home'
    id='e2e1'
    type='error'>
  <ping xmlns='urn:xmpp:ping'/>
  <error type='cancel'>
    <service-unavailable xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'/>
  </error>
</iq>

The other error conditions defined in RFC 6120 could also be returned if appropriate.

4.5 Component-to-Client Pings

Pings can also be used for component-to-client pings, for example from a Multi-User Chat (XEP-0045) [5] component to a client.

Example 13. Ping

<iq from='chat.shakespeare.lit'
    to='juliet@capulet.lit/chamber'
    type='get'
    id='comp1'>
  <ping xmlns='urn:xmpp:ping'/>
</iq>

Note: The 'to' address should be a full JID <localpart@domain.tld/resource>, since a ping sent to a bare JID <localpart@domain.tld> will be handled by the server on behalf of the client.

If the pinged entity supports the ping namespace, it SHOULD return an IQ-result:

Example 14. Pong

<iq from='juliet@capulet.lit/chamber'
    to='chat.shakespeare.lit'
    id='comp1'
    type='result'/>

If the pinged entity does not support the ping namespace, RFC 6120 requires it to return a <service-unavailable/> error:

Example 15. Ping Not Supported

<iq from='juliet@capulet.lit/chamber'
    to='chat.shakespeare.lit'
    id='comp1'
    type='error'>
  <ping xmlns='urn:xmpp:ping'/>
  <error type='cancel'>
    <service-unavailable xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'/>
  </error>
</iq>

The other error conditions defined in RFC 6120 could also be returned if appropriate.

5. Determining Support

If an entity supports the XMPP Ping protocol, it MUST report that fact by including a service discovery feature of "urn:xmpp:ping" in response to a Service Discovery (XEP-0030) [6] information request:

Example 16. Service Discovery information request

<iq type='get'
    from='juliet@capulet.lit/balcony'
    to='capulet.lit'
    id='disco1'>
  <query xmlns='http://jabber.org/protocol/disco#info'/>
</iq>

Example 17. Service Discovery information response

<iq type='result'
    from='capulet.lit'
    to='juliet@capulet.lit/balcony'
    id='disco1'>
  <query xmlns='http://jabber.org/protocol/disco#info'>
    ...
    <feature var='urn:xmpp:ping'/>
    ...
  </query>
</iq>

In order for an application to determine whether an entity supports this protocol, where possible it SHOULD use the dynamic, presence-based profile of service discovery defined in Entity Capabilities (XEP-0115) [7]. However, if an application has not received entity capabilities information from an entity, it SHOULD use explicit service discovery instead.

6. Implementation Notes

Some XMPP clients do not respond to IQ stanzas containing unsupported payloads. Although this is in violation of XMPP Core [1], this behavior can result in disconnection of clients that are in fact actively connected to the server.

7. Security Considerations

If a server receives a ping request directed to a full JID <localpart@domain.tld/resource> associated with a registered account but there is no connected resource matching the 'to' address, RFC 6120 requires it to reply with a <service-unavailable/> error and set the 'from' address of the IQ-error to the full JID provided in the 'to' address of the ping request. If a connected resource receives a ping request but it does not want to reveal its network availability to the sender for any reason (e.g., because the sender is not authorized to know the connected resource's availability), then it too MUST reply with a <service-unavailable/> error. This consistency between the server response and the client response helps to prevent presence leaks.

8. IANA Considerations

No interaction with the Internet Assigned Numbers Authority (IANA) [8] is necessary as a result of this document.

9. XMPP Registrar Considerations

9.1 Protocol Namespaces

The XMPP Registrar [9] includes "urn:xmpp:ping" in its registry of protocol namespaces (see <https://xmpp.org/registrar/namespaces.html>).

10. XML Schema

<?xml version='1.0' encoding='UTF-8'?>

<xs:schema
    xmlns:xs='http://www.w3.org/2001/XMLSchema'
    targetNamespace='urn:xmpp:ping'
    xmlns='urn:xmpp:ping'
    elementFormDefault='qualified'>

  <xs:annotation>
    <xs:documentation>
      The protocol documented by this schema is defined in
      XEP-0199: http://www.xmpp.org/extensions/xep-0199.html
    </xs:documentation>
  </xs:annotation>

  <xs:element name='ping' type='empty'/>

  <xs:simpleType name='empty'>
    <xs:restriction base='xs:string'>
      <xs:enumeration value=''/>
    </xs:restriction>
  </xs:simpleType>

</xs:schema>

Appendices

Appendix A: Document Information

Series: XEP
Number: 0199
Publisher: XMPP Standards Foundation
Status: Final
Type: Standards Track
Version: 2.0.1
Last Updated: 2019-03-26
Approving Body: XMPP Council
Dependencies: XMPP Core, XEP-0030
Supersedes: None
Superseded By: None
Short Name: ping
Schema: <http://www.xmpp.org/schemas/ping.xsd>
Source Control: HTML
This document in other formats: XML  PDF

Appendix B: Author Information

Peter Saint-Andre

Email: xsf@stpeter.im
JabberID: peter@jabber.org
URI: http://stpeter.im/

Appendix C: Legal Notices

Copyright

This XMPP Extension Protocol is copyright © 1999 – 2018 by the XMPP Standards Foundation (XSF).

Permissions

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.

Disclaimer of Warranty

## 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. ##

Limitation of Liability

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.

IPR Conformance

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).

Appendix D: Relation to XMPP

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.

Appendix E: Discussion Venue

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.

Errata can be sent to <editor@xmpp.org>.

Appendix F: Requirements Conformance

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".

Appendix G: Notes

1. RFC 6120: Extensible Messaging and Presence Protocol (XMPP): Core <http://tools.ietf.org/html/rfc6120>.

2. XEP-0124: Bidirectional-streams Over Synchronous HTTP <https://xmpp.org/extensions/xep-0124.html>.

3. XEP-0206: XMPP Over BOSH <https://xmpp.org/extensions/xep-0206.html>.

4. RFC 1393: Traceroute Using an IP Option <http://tools.ietf.org/html/rfc1393>.

5. XEP-0045: Multi-User Chat <https://xmpp.org/extensions/xep-0045.html>.

6. XEP-0030: Service Discovery <https://xmpp.org/extensions/xep-0030.html>.

7. XEP-0115: Entity Capabilities <https://xmpp.org/extensions/xep-0115.html>.

8. 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/>.

9. 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/>.

Appendix H: Revision History

Note: Older versions of this specification might be available at http://xmpp.org/extensions/attic/

Version 2.0.1 (2019-03-26)

Fix incorrect IQ type in example (result => error) (o01eg)

Version 2.0 (2009-06-03)

Per a vote of the XMPP Council, advanced status to Final.

(psa)

Version 1.0 (2007-06-12)

Per a vote of the XMPP Council, advanced status to Draft; XMPP Registrar issued urn:xmpp:ping namespace.

(psa)

Version 0.5 (2007-05-30)

Clarified error handling and recommended against sending to bare JIDs.

(psa)

Version 0.4 (2007-05-21)

Modified security considerations to ensure coherence of error handling between client and server.

(psa)

Version 0.3 (2007-05-07)

Added use case for client pinging server; changed namespace to conform to XMPP Registrar requirements, with namespace to be issued upon advancement to Draft; added section on discovering support.

(psa)

Version 0.2 (2006-11-22)

Changed IQ-set to IQ-get; clarified requirements; specified protocol description; added use cases.

(psa)

Version 0.1 (2006-11-21)

Initial version.

(psa)

END