mirror of
https://github.com/moparisthebest/xeps
synced 2024-10-31 15:35:07 -04:00
249 lines
10 KiB
XML
249 lines
10 KiB
XML
<?xml version='1.0' encoding='UTF-8'?>
|
|
<!DOCTYPE xep SYSTEM 'xep.dtd' [
|
|
<!ENTITY % ents SYSTEM 'xep.ent'>
|
|
%ents;
|
|
]>
|
|
<?xml-stylesheet type='text/xsl' href='xep.xsl'?>
|
|
<xep>
|
|
<header>
|
|
<title>Incident Reporting</title>
|
|
<abstract>This specification defines methods for incident reporting among XMPP server deployments.</abstract>
|
|
&LEGALNOTICE;
|
|
<number>0268</number>
|
|
<status>Deferred</status>
|
|
<type>Standards Track</type>
|
|
<sig>Standards</sig>
|
|
<approver>Council</approver>
|
|
<dependencies>
|
|
<spec>XMPP Core</spec>
|
|
</dependencies>
|
|
<supersedes/>
|
|
<supersededby/>
|
|
<shortname>NOT_YET_ASSIGNED</shortname>
|
|
<discuss>operators</discuss>
|
|
<author>
|
|
<firstname>Artur</firstname>
|
|
<surname>Hefczyc</surname>
|
|
<email>artur.hefczyc@gmail.com</email>
|
|
<jid>artur.hefczyc@tigase.org</jid>
|
|
</author>
|
|
<author>
|
|
<firstname>Florian</firstname>
|
|
<surname>Jensen</surname>
|
|
<email>admin@flosoft.biz</email>
|
|
<jid>admin@im.flosoft.biz</jid>
|
|
</author>
|
|
<author>
|
|
<firstname>Mickaël</firstname>
|
|
<surname>Rémond</surname>
|
|
<email>mickael.remond@process-one.net</email>
|
|
<jid>mremond@process-one.net</jid>
|
|
</author>
|
|
&stpeter;
|
|
<author>
|
|
<firstname>Matthew</firstname>
|
|
<surname>Wild</surname>
|
|
<email>mwild1@gmail.com</email>
|
|
<jid>mwild1@jaim.at</jid>
|
|
</author>
|
|
<revision>
|
|
<version>0.3</version>
|
|
<date>2009-11-17</date>
|
|
<initials>psa</initials>
|
|
<remark><p>Added security considerations; defined schema.</p></remark>
|
|
</revision>
|
|
<revision>
|
|
<version>0.2</version>
|
|
<date>2009-06-05</date>
|
|
<initials>mw/psa</initials>
|
|
<remark><p>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.</p></remark>
|
|
</revision>
|
|
<revision>
|
|
<version>0.1</version>
|
|
<date>2009-04-30</date>
|
|
<initials>psa</initials>
|
|
<remark><p>Initial published version.</p></remark>
|
|
</revision>
|
|
<revision>
|
|
<version>0.0.3</version>
|
|
<date>2009-04-30</date>
|
|
<initials>psa</initials>
|
|
<remark><p>Per Council feedback, moved server rosters to a separate specification.</p></remark>
|
|
</revision>
|
|
<revision>
|
|
<version>0.0.2</version>
|
|
<date>2009-04-27</date>
|
|
<initials>psa/fj</initials>
|
|
<remark><p>Refactored XML format; added elements for sub-categories, locations, related incidents, solutions, and suggestions.</p></remark>
|
|
</revision>
|
|
<revision>
|
|
<version>0.0.1</version>
|
|
<date>2009-04-13</date>
|
|
<initials>ah/fj/psa/mr/mw</initials>
|
|
<remark><p>First draft.</p></remark>
|
|
</revision>
|
|
</header>
|
|
|
|
<section1 topic='Introduction' anchor='intro'>
|
|
<p>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 to 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 &rfc2350;, &rfc3067;, and &rfc5070;.)</p>
|
|
</section1>
|
|
|
|
<section1 topic='Incident Reports' anchor='reports'>
|
|
<p>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 &rfc4122;. 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 &xep0267;.</p>
|
|
<example caption="An incident report"><![CDATA[
|
|
<message from='jabber.org' to='im.flosoft.biz'>
|
|
<incident xmlns='urn:xmpp:incident:0'
|
|
id='BA51A035-7710-4558-9BBF-34838A4C5B24'>
|
|
<description>
|
|
<discuss>
|
|
<admin>stpeter@jabber.org</admin>
|
|
<muc>operators@conference.jabber.org</muc>
|
|
</discuss>
|
|
<info>
|
|
<category>muc</category>
|
|
<type>presence</type>
|
|
<type>long-messages</type>
|
|
</info>
|
|
<locs>
|
|
<loc>jdev@conference.jabber.org</loc>
|
|
<loc>jabber@conference.jabber.org</loc>
|
|
</locs>
|
|
<rels>
|
|
<rel>133BCE2E-E669-4ECE-B0F8-766B9E65630D</rel>
|
|
</rels>
|
|
<severity>2</severity>
|
|
<source>
|
|
<jids>
|
|
<jid>abuser@abuse.lit</jid>
|
|
<jid>loser@abuse.lit</jid>
|
|
</jids>
|
|
</source>
|
|
<text xml:lang='en'>lots of MUC spammers from abuse.lit!</text>
|
|
<time>
|
|
<begin>2009-04-13T19:05:20Z</begin>
|
|
<end>2009-04-13T19:27:22Z</end>
|
|
<report>2009-04-13T19:31:07Z</report>
|
|
</time>
|
|
</description>
|
|
</incident>
|
|
</message>
|
|
]]></example>
|
|
<p>The defined children of the <description/> element are as follows:</p>
|
|
<table caption='<description/> children'>
|
|
<tr>
|
|
<th>Element Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
<tr>
|
|
<td><discuss/></td>
|
|
<td>The JID of the server admin who generated the incident report (<admin/>), as well as a &xep0045; room where the incident can be discussed (<muc/>).</td>
|
|
</tr>
|
|
<tr>
|
|
<td><info/></td>
|
|
<td>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 &xep0045; incidents, "pubsub" for &xep0060; incidents, "reg" for account registration (&xep0077;) incidents, and "stanzas" for general XMPP incidents.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><locs/></td>
|
|
<td>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.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><rels/></td>
|
|
<td>The IDs of one or more incidents to which this incident might be related, each contained in a separate <rel/> element.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><severity/></td>
|
|
<td>The seriousness of the problem, from 5 (least serious) to 1 (most serious).</td>
|
|
</tr>
|
|
<tr>
|
|
<td><source/></td>
|
|
<td>The IPv4 or IPv6 address (optionally including port) and JabberID where the incident originated (multiple instance of each source type can be included).</td>
|
|
</tr>
|
|
<tr>
|
|
<td><text/></td>
|
|
<td>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.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><time/></td>
|
|
<td>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 &xep0082;</td>
|
|
</tr>
|
|
</table>
|
|
</section1>
|
|
|
|
<section1 topic='Incident Solutions' anchor='solutions'>
|
|
<p>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 (alternatively, 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).</p>
|
|
<example caption="An incident solution"><![CDATA[
|
|
<message from='jabber.org' to='im.flosoft.biz'>
|
|
<incident xmlns='urn:xmpp:incident:0'
|
|
id='BA51A035-7710-4558-9BBF-34838A4C5B24'>
|
|
<description>
|
|
...
|
|
</description>
|
|
<solution>
|
|
<source>
|
|
<ips>
|
|
<ip>192.0.2.1:53667</ip>
|
|
</ips>
|
|
</source>
|
|
<text xml:lang='en'>iptables -A INPUT -s 192.0.2.1 -j DROP</text>
|
|
</solution>
|
|
</incident>
|
|
</message>
|
|
]]></example>
|
|
</section1>
|
|
|
|
<section1 topic='Processing of Incident Reports' anchor='processing'>
|
|
<p>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 administrators so that they can take appropriate action.</p>
|
|
<p>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.</p>
|
|
<p>A receiving server MAY forward reports that it receives to other servers it trusts.</p>
|
|
</section1>
|
|
|
|
<section1 topic='Security Considerations' anchor='security'>
|
|
<p>This technology is designed to help mitigate attacks on the XMPP network. However, incident reporting is itself vulnerable to the following attacks:</p>
|
|
<ul>
|
|
<li>False reports could lead a server to deny service to legitimate users or peer servers (see also &xep0205;). To help mitigate such attacks, a server SHOULD treat with caution any incident reports that it might receive from untrusted entities.</li>
|
|
<li>If traffic between two servers is not protected using Transport Layer Security (TLS), a passive eavesdropper could gain access to incident reports and therefore adjust its behavior in response. To prevent such attacks, servers SHOULD use TLS.</li>
|
|
</ul>
|
|
</section1>
|
|
|
|
<section1 topic='IANA Considerations' anchor='iana'>
|
|
<p>This document requires no interaction with &IANA;.</p>
|
|
</section1>
|
|
|
|
<section1 topic='XMPP Registrar Considerations' anchor='reg'>
|
|
<section2 topic='Protocol Namespaces' anchor='registrar-ns'>
|
|
<p>This specification defines the following XML namespace:</p>
|
|
<ul>
|
|
<li>urn:xmpp:incident:0</li>
|
|
</ul>
|
|
<p>Upon advancement of this specification from a status of Experimental to a status of Draft, the ®ISTRAR; shall add the foregoing namespace to the registry located at &NAMESPACES;, as described in Section 4 of &xep0053;.</p>
|
|
</section2>
|
|
<section2 topic='Protocol Versioning' anchor='registrar-versioning'>
|
|
&NSVER;
|
|
</section2>
|
|
</section1>
|
|
|
|
<section1 topic='XML Schema' anchor='schema'>
|
|
<code><![CDATA[
|
|
<?xml version='1.0' encoding='UTF-8'?>
|
|
|
|
<xs:schema
|
|
xmlns:xs='http://www.w3.org/2001/XMLSchema'
|
|
targetNamespace='urn:xmpp:incident:0'
|
|
xmlns='urn:xmpp:incident:0'
|
|
elementFormDefault='qualified'>
|
|
|
|
<xs:element name='incident'>
|
|
</xs:element>
|
|
|
|
<xs:simpleType name='empty'>
|
|
<xs:restriction base='xs:string'>
|
|
<xs:enumeration value=''/>
|
|
</xs:restriction>
|
|
</xs:simpleType>
|
|
|
|
</xs:schema>
|
|
]]></code>
|
|
</section1>
|
|
|
|
</xep>
|