moparisthebest/xeps
1
0
Fork 0
mirror of https://github.com/moparisthebest/xeps synced 2024-12-22 15:48:52 -05:00
Code Issues Releases Wiki Activity

0.4

Browse Source
This commit is contained in:
stpeter 2012-04-17 09:51:43 -06:00
parent e03fabb9bb
commit b972053333
1 changed files with 97 additions and 119 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

216
xep-0268.xml
View File

@ -6,11 +6,11 @@
<?xml-stylesheet type='text/xsl' href='xep.xsl'?> <?xml-stylesheet type='text/xsl' href='xep.xsl'?>
<xep> <xep>
<header> <header>
<title>Incident Reporting</title> <title>Incident Handling</title>
<abstract>This specification defines methods for incident reporting among XMPP server deployments.</abstract> <abstract>This specification defines methods for incident reporting among XMPP server deployments using the IODEF format produced by the IETF's INCH Working Group.</abstract>
&LEGALNOTICE; &LEGALNOTICE;
<number>0268</number> <number>0268</number>
<status>Deferred</status> <status>Experimental</status>
<type>Standards Track</type> <type>Standards Track</type>
<sig>Standards</sig> <sig>Standards</sig>
<approver>Council</approver> <approver>Council</approver>
@ -40,12 +40,13 @@
<jid>mremond@process-one.net</jid> <jid>mremond@process-one.net</jid>
</author> </author>
&stpeter; &stpeter;
<author> &mwild;
<firstname>Matthew</firstname> <revision>
<surname>Wild</surname> <version>0.4</version>
<email>mwild1@gmail.com</email> <date>2012-04-17</date>
<jid>mwild1@jaim.at</jid> <initials>psa</initials>
</author> <remark><p>Changed the XML format from a custom schema to IODEF (RFC 5070); incremented namespace version from 1 to 2.</p></remark>
</revision>
<revision> <revision>
<version>0.3</version> <version>0.3</version>
<date>2009-11-17</date> <date>2009-11-17</date>
@ -85,135 +86,119 @@
</header> </header>
<section1 topic='Introduction' anchor='intro'> <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> <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 way to use the IODEF format (defined in &rfc5070; and produced by the IETF's INCH Working Group) as the basis for sharing incident reports among XMPP server deployments. (For some related considerations, see &rfc2350; and &rfc3067;.)</p>
</section1> </section1>
<section1 topic='Incident Reports' anchor='reports'> <section1 topic='Interactions' anchor='interactions'>
<p>An incident report consists of an XMPP &MESSAGE; stanza containing an &lt;incident/&gt; 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> <p>This document defines several interactions (similar to those in &rfc6045;) between XMPP server deployments with respect to incident handling. These interactions are transported using the XMPP &IQ; stanza as described below.</p>
<ol>
<li><p>The &lt;report/&gt; element (contained in an &IQ; stanza of type "set" or, in response to an &lt;inquiry/&gt; element, of type "result") describes the nature of an incident and also flags the 'status' of the incident as "new", "updated", or "resolved"; it is sent from one server to another for informative purposes (sometimes in reply to the &lt;inquiry/&gt; element) but without requesting assistance (for which see the &lt;request/&gt; element).</p></li>
<li><p>The &lt;inquiry/&gt; element (contained in an &IQ; stanza of type "get") asks for information about an incident; it is expected that the reply will contain a &lt;report/&gt; element.</p></li>
<li><p>The &lt;request/&gt; element (contained in an &IQ; stanza of type "get") asks for assistance in resolving an incident.</p></li>
<li><p>The &lt;response/&gt; element (contained in an &IQ; stanza of type "result") provides assistance in resolving an incident.</p></li>
</ol>
</section1>
<section1 topic='Report Format and Processing' anchor='report'>
<p>An incident report consists of an XMPP &IQ; stanza of type "set" or "result" containing an IODEF document. An example is shown below.</p>
<example caption="An incident report"><![CDATA[ <example caption="An incident report"><![CDATA[
<message from='jabber.org' to='im.flosoft.biz'> <iq from='jabber.org' id='vk2x91g47 to='im.flosoft.biz' type='set'>
<incident xmlns='urn:xmpp:incident:0' <Incident xmlns='urn:ietf:params:xml:ns:iodef-1.0'
id='BA51A035-7710-4558-9BBF-34838A4C5B24'> purpose='reporting'>
<description> <IncidentID name='jabber.org'>4BF5D2CE-7C90-4860-BEF2-43A7D777D5FF</IncidentID>
<discuss> <StartTime>2009-04-13T19:05:20Z</StartTime>
<admin>stpeter@jabber.org</admin> <EndTime>2009-04-13T19:27:22Z</EndTime>
<muc>operators@conference.jabber.org</muc> <ReportTime>2009-04-13T19:31:07Z</ReportTime>
</discuss> <Description xml:lang='en'>lots of MUC spammers from abuse.lit!</Description>
<Contact role='admin' type='person'>
<AdditionalData>
<jid xmlns='urn:xmpp:incident:2'>stpeter@jabber.org</jid>
</AdditionalData>
</Contact>
<Contact role='admin' type='person'>
<AdditionalData>
<jid xmlns='urn:xmpp:incident:2'>stpeter@jabber.org</jid>
</AdditionalData>
</Contact>
<Contact role='ext-type' ext-type='chatroom'>
<AdditionalData>
<jid xmlns='urn:xmpp:incident:2'>operators@muc.xmpp.org</jid>
</AdditionalData>
</Contact>
<RelatedActivity>
<IncidentID name='im.example.com'>133BCE2E-E669-4ECE-B0F8-766B9E65630D</IncidentID>
</RelatedActivity>
<Assessment>
<Impact lang='en' severity='medium' completion='succeeded' type='dos'/>
</Assessment>
<EventData>
<Flow>
<System category='source'>
<Node>
<Address category='ext-category' ext-category='xmpp'>abuser@abuse.lit</Address>
<Counter type='ext-type' ext-type='xmpp-presence'>123</Counter>
</Node>
<Node>
<Address category='ext-category' ext-category='xmpp'>luser27@abuse.lit</Address>
<Counter type='ext-type' ext-type='xmpp-presence'>47</Counter>
</Node>
</System>
<System category='target'>
<Node>
<Address category='ext-category' ext-category='xmpp'>jdev@conference.jabber.org</Address>
<Address category='ext-category' ext-category='xmpp'>jabber@conference.jabber.org</Address>
<NodeRole category='ext-category' ext-category='xmpp-muc'/>
</Node>
</System>
</Flow>
<info> <info>
<category>muc</category> <category>muc</category>
<type>presence</type> <type>presence</type>
<type>long-messages</type> <type>long-messages</type>
</info> </Incident>
<locs> </iq>
<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> ]]></example>
<p>The defined children of the &lt;description/&gt; element are as follows:</p> <p>If the report is contained in an &IQ; stanza of type "set" and the recipient of the report is able to process it, it MUST return an &IQ; stanza of type "result". Error handling will be defined in a future version of this specification.</p>
<table caption='&lt;description/&gt; children'>
<tr>
<th>Element Name</th>
<th>Description</th>
</tr>
<tr>
<td>&lt;discuss/&gt;</td>
<td>The JID of the server admin who generated the incident report (&lt;admin/&gt;), as well as a &xep0045; room where the incident can be discussed (&lt;muc/&gt;).</td>
</tr>
<tr>
<td>&lt;info/&gt;</td>
<td>Structured information about the incident. The defined values of the &lt;category/&gt; and &lt;type/&gt; elements shall be provided via a registry. It is envisioned that the &lt;category/&gt; 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>&lt;locs/&gt;</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 &lt;loc/&gt; element.</td>
</tr>
<tr>
<td>&lt;rels/&gt;</td>
<td>The IDs of one or more incidents to which this incident might be related, each contained in a separate &lt;rel/&gt; element.</td>
</tr>
<tr>
<td>&lt;severity/&gt;</td>
<td>The seriousness of the problem, from 5 (least serious) to 1 (most serious).</td>
</tr>
<tr>
<td>&lt;source/&gt;</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>&lt;text/&gt;</td>
<td>A natural-language description of the event. This element SHOULD possess an 'xml:lang' attribute. Multiple &lt;text/&gt; elements MAY be included, each with a different 'xml:lang' value.</td>
</tr>
<tr>
<td>&lt;time/&gt;</td>
<td>The time when the incident began and ended (include an empty &lt;end/&gt; 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>
<section1 topic='Incident Solutions' anchor='solutions'> <section1 topic='Inquiry Format and Processing' anchor='inquiry'>
<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 &lt;solution/&gt; 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 &lt;description/&gt; element, such as the &lt;ip/&gt; element (since the XMPP server of a source JID might know the IP address and port of the connected entity).</p> <p>To follow.</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>
<section1 topic='Processing of Incident Reports' anchor='processing'> <section1 topic='Request Format and Processing' anchor='request'>
<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>To follow.</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> </section1>
<p>A receiving server MAY forward reports that it receives to other servers it trusts.</p>
<section1 topic='Response Format and Processing' anchor='response'>
<p>To follow.</p>
</section1>
<section1 topic='Internationalization Considerations' anchor='i18n'>
<p>The &lt;jid/&gt; element qualified by the 'urn:xmpp:incident:2' namespace is a "JID slot" as described in &rfc6122bis;.</p>
</section1> </section1>
<section1 topic='Security Considerations' anchor='security'> <section1 topic='Security Considerations' anchor='security'>
<p>It is RECOMMENDED for a server deployment to exchange incident reports only with peer servers that it trusts, for example peers that are in its "server roster" as described in &xep0267;.</p>
<p>This technology is designed to help mitigate attacks on the XMPP network. However, incident reporting is itself vulnerable to the following attacks:</p> <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> <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>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> <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> </ul>
<p>Use of the XMPP channel is convenient for communication among XMPP servers; however, if a denial of service attack is severe enough then that channel itself might be unusable.</p>
<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>
<section1 topic='IANA Considerations' anchor='iana'> <section1 topic='IANA Considerations' anchor='iana'>
<p>This document requires no interaction with &IANA;.</p> <p>This document might require interaction with &IANA; to register various IODEF extension attributes.</p>
</section1> </section1>
<section1 topic='XMPP Registrar Considerations' anchor='reg'> <section1 topic='XMPP Registrar Considerations' anchor='reg'>
<section2 topic='Protocol Namespaces' anchor='registrar-ns'> <section2 topic='Protocol Namespaces' anchor='registrar-ns'>
<p>This specification defines the following XML namespace:</p> <p>This specification defines the following XML namespace:</p>
<ul> <ul>
<li>urn:xmpp:incident:0</li> <li>urn:xmpp:incident:2</li>
</ul> </ul>
<p>Upon advancement of this specification from a status of Experimental to a status of Draft, the &REGISTRAR; shall add the foregoing namespace to the registry located at &NAMESPACES;, as described in Section 4 of &xep0053;.</p> <p>Upon advancement of this specification from a status of Experimental to a status of Draft, the &REGISTRAR; shall add the foregoing namespace to the registry located at &NAMESPACES;, as described in Section 4 of &xep0053;.</p>
</section2> </section2>
@ -228,18 +213,11 @@
<xs:schema <xs:schema
xmlns:xs='http://www.w3.org/2001/XMLSchema' xmlns:xs='http://www.w3.org/2001/XMLSchema'
targetNamespace='urn:xmpp:incident:0' targetNamespace='urn:xmpp:incident:2'
xmlns='urn:xmpp:incident:0' xmlns='urn:xmpp:incident:2'
elementFormDefault='qualified'> elementFormDefault='qualified'>
<xs:element name='incident'> <xs:element name='jid' type='xs:string'/>
</xs:element>
<xs:simpleType name='empty'>
<xs:restriction base='xs:string'>
<xs:enumeration value=''/>
</xs:restriction>
</xs:simpleType>
</xs:schema> </xs:schema>
]]></code> ]]></code>