XEP-0268: Incident Reporting

Abstract:This specification defines methods for incident reporting among XMPP server deployments.
Authors:Artur Hefczyc, Florian Jensen, Mickaël Rémond, Peter Saint-Andre, Matthew Wild
Copyright:© 1999 - 2009 XMPP Standards Foundation. SEE LEGAL NOTICES.
Type:Standards Track
Last Updated:2009-06-05

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 are advised to carefully consider whether it is appropriate to deploy implementations of this protocol before it advances to a status of Draft.

Table of Contents

1. Introduction
2. Incident Reports
3. Incident Solutions
4. Processing of Incident Reports
5. Security Considerations
6. IANA Considerations
7. XMPP Registrar Considerations
    7.1. Protocol Namespaces
    7.2. Protocol Versioning
8. XML Schema

    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 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" as described in Server Rosters [5].

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 [6] 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 [7] incidents, "pubsub" for Publish-Subscribe [8] incidents, "reg" for account registration (In-Band Registration [9]) 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 IPv4 or IPv6 address (optionally including port) and JabberID where the incident originated (multiple instance of each source type can be included).
<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 [10]

3. Incident Solutions

If the reporting entity determines a solution to the problem or a receiving entity has a suggested solution to the problem, it SHOULD send out a revised incident report containing a <solution/> element (or the reporting entity can include a solution in its initial report). The solution element can include any of the elements defined for the <description/> element, such as the <ip/> element (since the XMPP server of a source JID might know the IP address and port of the connected entity).

Example 2. An incident solution

<message from='jabber.org' to='im.flosoft.biz'>
  <incident xmlns='urn:xmpp:incident:0'
      <text xml:lang='en'>iptables -A INPUT -s -j DROP</text>

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

4. Processing of Incident Reports

Unless explicitly configured to do so, a receiving server SHOULD NOT automatically modify its configuration based on receipt of an incident report, even from a trusted server, but instead SHOULD prompt the human administrator(s) so that they can take appropriate action.

A receiving server MAY accept incident reports from peers that are not on its "trust list", but SHOULD treat such reports with caution and provide them to the human administrator(s) of the server.

A receiving server MAY forward reports that it receives to other servers it trusts.

5. Security Considerations

To follow.

6. IANA Considerations

This document requires no interaction with the Internet Assigned Numbers Authority (IANA) [11].

7. XMPP Registrar Considerations

7.1 Protocol Namespaces

This specification defines the following XML namespace:

Upon advancement of this specification from a status of Experimental to a status of Draft, the XMPP Registrar [12] shall add the foregoing namespace to the registry located at <http://xmpp.org/registrar/namespaces.html>, as described in Section 4 of XMPP Registrar Function [13].

7.2 Protocol Versioning

If the protocol defined in this specification undergoes a revision that is not fully backwards-compatible with an older version, the XMPP Registrar shall increment the protocol version number found at the end of the XML namespaces defined herein, as described in Section 4 of XEP-0053.

8. XML Schema

To follow.


Appendix A: Document Information

Series: XEP
Number: 0268
Publisher: XMPP Standards Foundation
Status: Experimental
Type: Standards Track
Version: 0.2
Last Updated: 2009-06-05
Approving Body: XMPP Council
Dependencies: XMPP Core
Supersedes: None
Superseded By: None
Source Control: HTML  RSS

Appendix B: Author Information

Artur Hefczyc

Email: artur.hefczyc@gmail.com
JabberID: artur.hefczyc@tigase.org

Florian Jensen

Email: admin@flosoft.biz
JabberID: admin@im.flosoft.biz

Mickaël Rémond

Email: mickael.remond@process-one.net
JabberID: mremond@process-one.net

Peter Saint-Andre

Email: stpeter@jabber.org
JabberID: stpeter@jabber.org
URI: https://stpeter.im/

Matthew Wild

Email: mwild1@gmail.com
JabberID: mwild1@jaim.at

Appendix C: Legal Notices


This XMPP Extension Protocol is copyright © 1999 - 2009 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 <http://xmpp.org/extensions/ipr-policy.shtml> or obtained by writing to XMPP Standards Foundation, c/o Peter Saint-Andre, 1899 Wynkoop Street, Suite 600, Denver, CO 80202 USA).

Appendix D: Relation to XMPP

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.

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-0267: Server Rosters <http://xmpp.org/extensions/xep-0267.html>.

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

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

8. XEP-0060: Publish-Subscribe <http://xmpp.org/extensions/xep-0060.html>.

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

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

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

12. 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://xmpp.org/registrar/>.

13. XEP-0053: XMPP Registrar Function <http://xmpp.org/extensions/xep-0053.html>.

Appendix H: Revision History

Version 0.2 (2009-06-05)

Added more detailed information about the solution element; removed the suggestion element since the solution element can be used by both reporting entities and receiving entities; added notes about processing of incident reports by receiving entities.


Version 0.1 (2009-04-30)

Initial published version.


Version 0.0.3 (2009-04-30)

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


Version 0.0.2 (2009-04-27)

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


Version 0.0.1 (2009-04-13)

First draft.