XEP-xxxx: Problem Reporting

Abstract
This specification defines methods for reporting of network problems between XMPP server deployments.
Authors
  • Artur Hefczyc
  • Florian Jensen
  • Mickaël Rémond
  • Peter Saint-Andre
  • Matthew Wild
Copyright
© 2009 – 2009 XMPP Standards Foundation. SEE LEGAL NOTICES.
Status

ProtoXEP

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 <https://xmpp.org/extensions/> and announced on the <standards@xmpp.org> mailing list.
Type
Standards Track
Version
0.0.1 (2009-04-13)
Document Lifecycle
  1. Experimental
  2. Proposed
  3. Stable
  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.

The basic approach is two-fold:

  1. Each server SHOULD mantain a list of other servers that it trusts for the purpose of problem reporting. We can think of this list as the server-to-server equivalent of a user-oriented XMPP roster.
  2. When a server encounters problems (e.g., suspicious account registrations), it SHOULD send a problem report to the servers on its "roster".

2. Server Rosters

To establish a trust relationship with a peer, a server shall send a presence subscription request to the peer, just as is done between XMPP users.

Example 1. Service sends subscription request to peer
<presence from='montague.lit'
          to='capulet.lit'
          type='subscribe'/>
  

The XMPP server software running at the peer MUST prompt the server administrators to approve the request. Methods for doing so are out of scope for this specification.

3. Problem Reports

A problem report consists of an XMPP <message/> stanza containing a <problem/> child element. The following is an example.

Example 2. A problem report
<message from='jabber.org' to='im.flosoft.biz'>
  <problem xmlns='urn:xmpp:problem:0'
      <contact>stpeter@jabber.org</contact>
      <end>2009-04-13T19:27:22Z</end>
      <incident>cc7b247b-18b4-4301-b6d0-e9e4016d802f</incident>
      <ip>192.0.2.0</ip>
      <jids>
        <jid>abuser@spam.lit</jid>
        <jid>loser@spam.lit</jid>
      </jids>
      <room>operators@conference.jabber.org</room>
      <severity>2</severity>
      <start>2009-04-13T19:05:20Z</start>
      <text xml:lang='en'>lots of MUC spammers from abuse.lit!</text>
      <type>muc</type>
</message>
  

The defined child elements are as follows:

Table 1: Child elements
Element Name Description
<contact/> The JID of a person to contact directly.
<end/> The time when the problem ended. Send empty element if still happening. Must conform to XMPP Date and Time Profiles (XEP-0082) [1]
<incident/> An incident number. MUST be a UUID as described in RFC 4122 [2].
<ip/> The IP address where the problem originates.
<jids/> Each <jid/> child contains the JabberID of an entity that is causing trouble.
<room/> A chatroom where the problem can be discussed.
<severity/> The seriousness of the problem, from 5 (least serious) to 1 (most serious).
<start/> The time when the problem started. Send empty element if unknown.
<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.
<type/> The type of problem. Defined values are "muc" for Multi-User Chat (XEP-0045) [3] abuse, "pubsub" for Publish-Subscribe (XEP-0060) [4] abuse, "reg" for account registrations (e.g., via In-Band Registration (XEP-0077) [5]), "spam" for

4. Security Considerations

To follow.

5. IANA Considerations

To follow.

6. XMPP Registrar Considerations

To follow.

7. XML Schema

To follow.


Appendices

Appendix A: Document Information

Series
XEP
Number
xxxx
Publisher
XMPP Standards Foundation
Status
ProtoXEP
Type
Standards Track
Version
0.0.1
Last Updated
2009-04-13
Approving Body
XMPP Council
Dependencies
XMPP Core
Supersedes
None
Superseded By
None
Short Name
NOT_YET_ASSIGNED

This document in other formats: XML  PDF

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@stpeter.im
JabberID
stpeter@jabber.org
URI
https://stpeter.im/
Matthew Wild
Email
mwild1@gmail.com
JabberID
mwild1@jaim.at

Copyright

This XMPP Extension Protocol is copyright © 1999 – 2024 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).

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 <https://xmpp.org/community/> 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. XEP-0082: XMPP Date and Time Profiles <https://xmpp.org/extensions/xep-0082.html>.

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

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

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

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

Appendix H: Revision History

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

  1. Version 0.0.1 (2009-04-13)

    First draft.

    psa

Appendix I: Bib(La)TeX Entry

@report{hefczyc2009xepxxxx,
  title = {Problem Reporting},
  author = {Hefczyc, Artur and Jensen, Florian and Rémond, Mickaël and Saint-Andre, Peter and Wild, Matthew},
  type = {XEP},
  number = {xxxx},
  version = {0.0.1},
  institution = {XMPP Standards Foundation},
  url = {https://xmpp.org/extensions/xep-xxxx.html},
  date = {2009-04-13/2009-04-13},
}

END