XEP-xxxx: Incident Reporting

This specification defines methods for incident reporting among XMPP server deployments.
  • Artur Hefczyc
  • Florian Jensen
  • Mickaël Rémond
  • Peter Saint-Andre
  • Matthew Wild
© 1999 – 2020 XMPP Standards Foundation. SEE LEGAL NOTICES.


WARNING: This document has not yet been accepted for consideration or approved in any official manner by the XMPP Standards Foundation, and this document is not yet an XMPP Extension Protocol (XEP). If this document is accepted as a XEP by the XMPP Council, it will be published at <http://xmpp.org/extensions/> and announced on the <standards@xmpp.org> mailing list.
Standards Track
0.0.3 (2009-04-30)
Document Lifecycle
  1. Experimental
  2. Proposed
  3. Draft
  4. Final

1. Introduction

As XMPP technologies have been deployed more widely, the open XMPP network has become a more significant target for attacks. This specification defines ways for XMPP server deployments to share information with each other and therefore handle such attacks in a more real-time fashion. In particular, it defines a format for sharing incident reports among XMPP server deployments. (For some related considerations, see RFC 2350 [1], RFC 3067 [2], and RFC 5070 [3].)

2. Incident Reports

An incident report consists of an XMPP <message/> stanza containing an <incident/> child element that includes an 'id' attribute whose value is a UUID as described in RFC 4122 [4]. An example is shown below. A server deployment SHOULD send incident reports only to peer servers that it trusts, for example peers that are in its "server roster".

Example 1. An incident report
<message from='jabber.org' to='im.flosoft.biz'>
  <incident xmlns='urn:xmpp:incident:0'
      <text xml:lang='en'>lots of MUC spammers from abuse.lit!</text>

The defined children of the <description/> element are as follows:

Table 1: <description/> children
Element Name Description
<discuss/> This element contains the JID of the server admin who generated the incident report (<admin/>), as well as a Multi-User Chat (XEP-0045) [5] room where the incident can be discussed (<muc/>).
<info/> Structured information about the incident. The defined values of the <category/> and <type/> elements shall be provided via a registry. It is envisioned that the <category/> values shall be "muc" for Multi-User Chat (XEP-0045) [5] incidents, "pubsub" for Publish-Subscribe (XEP-0060) [6] incidents, "reg" for account registration (In-Band Registration (XEP-0077) [7]) incidents, and "stanzas" for general XMPP traffic incidents.
<locs/> The place or places on the XMPP network where the incident has occurred (such as a multi-user chat room, a publish-subscribe service, or a general XMPP server), each contained in a separate <loc/> element.
<rels/> The IDs of one or more incidents to which this incident might be related, each contained in a separate <rel/> element.
<severity/> The seriousness of the problem, from 5 (least serious) to 1 (most serious).
<source/> The IP address(es) and JabberID(s) where the incident originated.
<text/> A natural-language description of the event. This element SHOULD possess an 'xml:lang' attribute. Multiple <text/> elements MAY be included, each with a different 'xml:lang' value.
<time/> The time when the incident began and ended (include an empty <end/> element if the incident is still happening) and, optionally, was reported. The dates MUST conform to the DateTime profile specified in XMPP Date and Time Profiles (XEP-0082) [8]

3. Incident Solutions

If the reporting entity determines a solution to the problem, it MAY send out a revised incident report containing a <solution/> element.

Example 2. An incident solution
<message from='jabber.org' to='im.flosoft.biz'>
  <incident xmlns='urn:xmpp:incident:0'
      <text xml:lang='en'>banned the offenders</text>

Further definition of the <solution/> element will be provided in a future version of this specification.

4. Incident Suggestions

If an entity that receives an incident report has a suggested solution to the problem, it MAY send an incident message containing a <suggestion/> element.

Example 3. An incident solution
<message from='im.flosoft.biz' to='jabber.org'>
  <incident xmlns='urn:xmpp:incident:0'
      <text xml:lang='en'>here is how we solved the problem...</text>

Further definition of the <suggestion/> element will be provided in a future version of this specification.

5. Security Considerations

To follow.

6. IANA Considerations

To follow.

7. XMPP Registrar Considerations

To follow.

8. XML Schema

To follow.


Appendix A: Document Information

XMPP Standards Foundation
Standards Track
Last Updated
Approving Body
XMPP Council
Superseded By
Short Name

This document in other formats: XML  PDF

Appendix B: Author Information

Artur Hefczyc
Florian Jensen
Mickaël Rémond
Peter Saint-Andre
Matthew Wild


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.

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

Visual Presentation

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.

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

There exists a special venue for discussion related to the technology described in this document: the <operators@xmpp.org> mailing list.

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 2350: Expectations for Computer Security Incident Response <http://tools.ietf.org/html/rfc2350>.

2. RFC 3067: TERENA's Incident Object Description and Exchange Format Requirements <http://tools.ietf.org/html/rfc3067>.

3. RFC 5070: The Incident Object Description Exchange Format <http://tools.ietf.org/html/rfc5070>.

4. RFC 4122: A Universally Unique IDentifier (UUID) URN Namespace <http://tools.ietf.org/html/rfc4122>.

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

6. XEP-0060: Publish-Subscribe <https://xmpp.org/extensions/xep-0060.html>.

7. XEP-0077: In-Band Registration <https://xmpp.org/extensions/xep-0077.html>.

8. XEP-0082: XMPP Date and Time Profiles <https://xmpp.org/extensions/xep-0082.html>.

Appendix H: Revision History

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

  1. Version 0.0.3 (2009-04-30)

    Per Council feedback, moved server rosters to a separate specification.

  2. Version 0.0.2 (2009-04-27)

    Refactored XML format; added elements for sub-categories, locations, related incidents, solutions, and suggestions.

  3. Version 0.0.1 (2009-04-13)

    First draft.