xeps/xep-0377.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>Spam Reporting</title>
  <abstract>
    This document specifies a mechanism by which users can report spam and other
    abuse to a server operator or other spam service.
  </abstract>
  &LEGALNOTICE;
  <number>0377</number>
  <status>Experimental</status>
  <type>Standards Track</type>
  <sig>Standards</sig>
  <approver>Council</approver>
  <dependencies>
    <spec>XMPP Core</spec>
    <spec>XMPP IM</spec>
    <spec>XEP-0191</spec>
  </dependencies>
  <supersedes/>
  <supersededby/>
  <shortname>NOT_YET_ASSIGNED</shortname>
  &sam;
  <revision>
    <version>0.1.0</version>
    <date>2016-05-25</date>
    <initials>ssw</initials>
    <remark><p>Initial version approved by the Council.</p></remark>
  </revision>
  <revision>
    <version>0.0.1</version>
    <date>2016-05-21</date>
    <initials>ssw</initials>
    <remark><p>First draft.</p></remark>
  </revision>
</header>
<section1 topic='Introduction' anchor='intro'>
  <p>
    Many spam and abuse prevention techniques rely on users being able to report
    other users who are sending unwanted messages, or specific instances of
    abuse. &xep0191; allows users to block spammers, but does not provide a
    mechanism for them to report a reason for the block to the server operator.
    This specification extends the blocking command to optionally provide an
    abuse report.
  </p>
</section1>
<section1 topic='Discovering Support' anchor='disco'>
  <p>
    Entities that support &xep0030; and abuse reporting MUST respond to service
    discovery requests with a feature of 'urn:xmpp:reporting:0' and with a
    feature for each reason supported by the responding entity as described in
    the relavant specifications. Eg. a response from a server that supports
    reporting and understands the abuse and spam reasons defined later in this
    specification might look like the following:
  </p>
  <example caption="Service discovery information response"><![CDATA[
<iq from='shakespeare.lit'
    id='ku6e51v3'
    to='kingclaudius@shakespeare.lit/castle'
    type='result'>
  <query xmlns='http://jabber.org/protocol/disco#info'>
    <feature var='urn:xmpp:reporting:0'/>
    <feature var='urn:xmpp:reporting:reason:abuse:0'/>
    <feature var='urn:xmpp:reporting:reason:spam:0'/>
  </query>
</iq>]]></example>
</section1>
<section1 topic='Payload' anchor='payload'>
  <p>
    The payload for reporting abuse to the server takes the form of a
    &lt;report/&gt; qualified by the 'urn:xmpp:reporting:0' namespace &VNOTE;.
    Report payloads are reusable and MUST NOT be sent without first being
    wrapped in a stanza.
  </p>
  <example caption='The most basic report payload'><![CDATA[
<report xmlns="urn:xmpp:reporting:0" />]]></example>
  <p>
    Abuse reports MAY include a reason for the report and servers MUST tolerate
    unknown XML elements in a report without making assumptions about the
    semantic meaning of unknown elements.
  </p>
  <p>
    This document defines the following reasons for a report:
  </p>
  <dl>
    <di>
      <dt>&lt;spam/&gt;</dt>
      <dd>Used for reporting a JID that is sending unwanted messages.</dd>
    </di>
    <di>
      <dt>&lt;abuse/&gt;</dt>
      <dd>Used for reporting general abuse.</dd>
    </di>
  </dl>
  <p>
    Clients MUST include only one reason per report.
  </p>
  <p>
    Reports MAY contain a user provided message explaining or providing context
    about the reason for the report. See also the
    <link url='#i18n'>Internationalization Considerations</link> section of this
    document.
  </p>
  <example caption='Report with optional reason and text'><![CDATA[
<report xmlns="urn:xmpp:reporting:0">
  <text xml:lang="en">
    Never came trouble to my house like this.
  </text>
  <spam/>
</report>]]></example>
</section1>
<section1 topic='Use with the Blocking Command' anchor='blocking'>
  <p>
    To send a report, a report payload MAY be inserted into an &lt;item/&gt;
    node sent as part of a request to block a spammer as defined in &xep0191;.
    For example:
  </p>
  <example caption='Report sent with blocking command'><![CDATA[
<iq from='juliet@capulet.com/chamber' type='set' id='block1'>
  <block xmlns='urn:xmpp:blocking'>
    <item jid='romeo@montague.net'>
      <report xmlns="urn:xmpp:reporting:0">
        <abuse/>
      </report>
    </item>
  </block>
</iq>]]></example>
  <p>
    Servers that receive a blocking command with a report MUST block the JID or
    return an error just as they would if no report were present. Servers then
    MAY take other actions based on the report, however, such actions are
    outside the scope of this document.
  </p>
</section1>
<section1 topic='Implementation Notes' anchor='impl'>
  <p>
    Clients that support sending reports as part of the blocking command SHOULD
    expose interfaces to both block a JID without reporting it as abusive, and
    to block and report a JID.
  </p>
</section1>
<section1 topic='Internationalization Considerations' anchor='i18n'>
  <p>
    If one or more &lt;text/&gt; elements are present they SHOULD include
    'xml:lang' attributes specifying the natural language of the XML character
    data.
  </p>
</section1>
  <section1 topic='Security Considerations' anchor='security'>
    <p>
      This document introduces no additional security considerations above and
      beyond those defined in the documents on which it depends.
    </p>
  </section1>
  <section1 topic='IANA Considerations' anchor='iana'>
    <p>This document requires no interaction with &IANA;.</p>
  </section1>
  <section1 topic='XMPP Registrar Considerations' anchor='registrar'>
    <section2 topic='Protocol Namespaces' anchor='registrar-ns'>
      <p>This specification defines the following XML namespace:</p>
      <ul>
        <li>urn:xmpp:reporting:0</li>
      </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 &DISCOFEATURES;, as described in Section 4 of
        &xep0053;.
      </p>
    </section2>
    <section2 topic='Namespace Versioning' anchor='registrar-versioning'>
      &NSVER;
    </section2>
    <section2 topic='Abuse Reporting Registry' anchor='registrar-reporting'>
      <p>
        The XMPP Registrar shall maintain a registry of abuse report reasons.
        All abuse report reason registrations shall be defined in separate
        specifications (not in this document). Application types defined within
        the XEP series MUST be registered with the XMPP Registrar, resulting in
        protocol URNs of the form "urn:xmpp:reporting:reason:name:X" (where
        "name" is the registered name of the reason and "X" is a non-negative
        integer).
      </p>
      &REGPROCESS;
      <code>
<![CDATA[<reason>
  <name>The name of the abuse report reason.</name>
  <urn>urn:xmpp:reporting:reason:{name}:{ver}</urn>
  <desc>A natural-language summary of the reason.</desc>
  <doc>
    The document in which the report reason is specified.
  </doc>
</reason>]]></code>
    </section2>
    <section2 topic='Abuse Reporting Reasons' anchor='registrar-reasons'>
      <p>This specification defines the following abuse reporting reasons:</p>
      <ul>
        <li>urn:xmpp:reporting:reason:spam:0</li>
        <li>urn:xmpp:reporting:reason:abuse:0</li>
      </ul>
      <p>
        Upon advancement of this specification from a status of Experimental to
        a status of Draft, the &REGISTRAR; shall add the following definition to
        the abuse reporting reasons registry, as described in this document:
      </p>
      <code><![CDATA[
<reason>
  <name>Spam</name>
  <urn>urn:xmpp:reporting:reason:spam:0</urn>
  <desc>Used to report a JID that was sending spam messages.</desc>
  <doc>XEP-0377</doc>
</reason>]]></code>
      <code><![CDATA[
<reason>
  <name>Abuse</name>
  <urn>urn:xmpp:reporting:reason:abuse:0</urn>
  <desc>Used to report general abuse that is not covered by a more specific reason.</desc>
  <doc>XEP-0377</doc>
</reason>]]></code>
    </section2>
  </section1>
  <section1 topic='XML Schema' anchor='schema'>
    <p>
      An XML schema will be added before this specification moves to draft
      status.
    </p>
  </section1>
  <section1 topic='Acknowledgements' anchor='acknowledgements'>
    <p>
      Thanks to the participants of the XMPP Summit 20 in Austin, TX who
      discussed this XEP: specifically to Waqas Hussain, Kevin Smith, Lance
      Stout, and Matthew Wild. A special thanks to Daniel Wisnewski for giving
      the presentation that kicked off the anti-abuse work.
    </p>
  </section1>
</xep>