Mercurial > prosody-modules
changeset 5854:fcfe490de8a4
mod_spam_report_forwarder: Rename to mod_report_forward
This module is not only about spam reports.
| author | Matthew Wild <mwild1@gmail.com> |
|---|---|
| date | Sun, 03 Mar 2024 16:03:27 +0000 |
| parents | 97c9b76867ca |
| children | 05356f2d4425 |
| files | mod_report_forward/README.markdown mod_report_forward/mod_report_forward.lua mod_spam_report_forwarder/README.markdown mod_spam_report_forwarder/mod_spam_report_forwarder.lua |
| diffstat | 4 files changed, 216 insertions(+), 187 deletions(-) [+] |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/mod_report_forward/README.markdown Sun Mar 03 16:03:27 2024 +0000 @@ -0,0 +1,77 @@ +--- +labels: +- 'Stage-Beta' +summary: 'Forward spam/abuse reports to a JID' +--- + +This module forwards spam/abuse reports (e.g. those submitted by users via +XEP-0377 via mod_spam_reporting) to one or more JIDs. + +## Configuration + +Install and enable the module the same as any other: + +```lua +modules_enabled = { + --- + "report_forward"; + --- +} +``` + +There are two main options. You can set `report_forward_to` which accepts a +list of JIDs to send all reports to (default is empty): + +```lua +report_forward_to = { "antispam.example.com" } +``` + +You can also control whether the module sends a report to the server from +which the spam/abuse originated (default is `true`): + +```lua +report_forward_to_origin = false +``` + +The module looks up an abuse report address using XEP-0157 (only XMPP +addresses are accepted). If it fails to find any suitable destination, it will +log a warning and not send the report. + + + +## Protocol + +This section is intended for developers. + +XEP-0377 assumes the report is embedded within another protocol such as +XEP-0191, and doesn't specify a format for communicating "standalone" reports. +This module transmits them inside a `<message>` stanza, and adds a `<jid/>` +element (borrowed from XEP-0268): + +```xml +<message from="prosody.example" to="destination.example"> + <report xmlns="urn:xmpp:reporting:1" reason="urn:xmpp:reporting:spam"> + <jid xmlns="urn:xmpp:jid:0">spammer@bad.example</jid> + <text> + Never came trouble to my house like this. + </text> + </report> +</message> +``` + +It may also include the reported message, if this has been indicated by the +user, wrapped in a XEP-0297 `<forwarded/>` element: + +```xml +<message from="prosody.example" to="destination.example"> + <report reason="urn:xmpp:reporting:spam" xmlns="urn:xmpp:reporting:1"> + <jid xmlns="urn:xmpp:jid:0">spammer@bad.example</jid> + <text>Never came trouble to my house like this.</text> + </report> + <forwarded xmlns="urn:xmpp:forward:0"> + <message from="spammer@bad.example" to="victim@prosody.example" type="chat" xmlns="jabber:client"> + <body>Spam, Spam, Spam, Spam, Spam, Spam, baked beans, Spam, Spam and Spam!</body> + </message> + </forwarded> +</message> +```
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/mod_report_forward/mod_report_forward.lua Sun Mar 03 16:03:27 2024 +0000 @@ -0,0 +1,139 @@ +local dt = require "util.datetime"; +local jid = require "util.jid"; +local st = require "util.stanza"; +local url = require "socket.url"; + +local new_id = require "util.id".short; +local render = require"util.interpolation".new("%b{}", function (s) return s; end); + +local destinations = module:get_option_set("report_forward_to", {}); + +local archive = module:open("archive"); + +local cache_size = module:get_option_number("report_forward_contact_cache_size", 256); +local report_to_origin = module:get_option_boolean("report_forward_to_origin", true); +local contact_lookup_timeout = module:get_option_number("report_forward_contact_lookup_timeout", 180); + +local body_template = module:get_option_string("report_forward_body_template", [[ +SPAM/ABUSE REPORT +----------------- + +Reported JID: {reported_jid} + +A user on our service has reported a message originating from the above JID on +your server. + +{reported_message_time&The reported message was sent at: {reported_message_time}} + +-- +This message contains also machine-readable payloads, including XEP-0377, in case +you want to automate handling of these reports. You can receive these reports +to a different address by setting 'spam-report-addresses' in your server +contact info configuration. For more information, see https://xmppbl.org/reports/ +]]):gsub("^%s+", ""):gsub("(%S)\n(%S)", "%1 %2"); + +local report_addresses = require "util.cache".new(cache_size); + +local function get_address(form, ...) + for i = 1, select("#", ...) do + local field_var = select(i, ...); + local field = form:get_child_with_attr("field", "jabber:x:data", "var", field_var); + if field then + local parsed = url.parse(field:get_child_text("value")); + if parsed.scheme == "xmpp" and parsed.path and not parsed.query then + return parsed.path; + end + end + end +end + +local function get_origin_report_address(reported_jid) + local host = jid.host(reported_jid); + local address = report_addresses:get(host); + if address then return address; end + + local contact_query = st.iq({ to = host, from = module.host, id = new_id() }) + :query("http://jabber.org/protocol/disco#info"); + + return module:send_iq(contact_query, prosody.hosts[module.host], contact_lookup_timeout) + :next(function (response) + if response.attr.type ~= "result" then return; end + + for form in response.tags[1]:childtags("x", "jabber:x:data") do + local form_type = form:get_child_with_attr("field", nil, "var", "FORM_TYPE"); + if form_type == "http://jabber.org/network/serverinfo" then + address = get_address(form, "spam-report-addresses", "abuse-addresses"); + break; + end + end + return address; + end); +end + +local function send_report(to, message) + local m = st.clone(message); + m.attr.to = to; + module:send(m); +end + +function forward_report(event) + local reporter_username = event.origin.username; + local reporter_jid = jid.join(reporter_username, module.host); + local reported_jid = event.jid; + + local report = st.clone(event.report); + report:text_tag("jid", reported_jid, { xmlns = "urn:xmpp:jid:0" }); + + local reported_message_id = report:get_child_with_attr( + "stanza-id", + "urn:xmpp:sid:0", + "by", + reported_jid, + jid.prep + ); + + local reported_message, reported_message_time, reported_message_with; + if reported_message_id then + reported_message, reported_message_time, reported_message_with = archive:get(reporter_username, reported_message_id); + if jid.bare(reported_message_with) ~= event.jid then + reported_message = nil; + end + end + + local body_text = render(body_template, { + reporter_jid = reporter_jid; + reported_jid = event.jid; + reported_message_time = dt.datetime(reported_message_time); + }); + + local message = st.message({ from = module.host }) + :text_tag("body", body_text) + :add_child(report); + + if reported_message then + reported_message.attr.xmlns = "jabber:client"; + local fwd = st.stanza("forwarded", { xmlns = "urn:xmpp:forward:0" }) + :tag("delay", { xmlns = "urn:xmpp:delay", stamp = dt.datetime(reported_message_time) }):up() + :add_child(reported_message); + message:add_child(fwd); + end + + for destination in destinations do + send_report(destination, message); + end + + if report_to_origin then + module:log("debug", "Sending report to origin server..."); + get_origin_report_address(event.jid):next(function (origin_report_address) + if not origin_report_address then + module:log("warn", "Couldn't report to origin: no contact address found for %s", jid.host(event.jid)); + return; + end + send_report(origin_report_address, message); + end); + end +end + +module:hook("spam_reporting/abuse-report", forward_report, -1); +module:hook("spam_reporting/spam-report", forward_report, -1); +module:hook("spam_reporting/unknown-report", forward_report, -1);
--- a/mod_spam_report_forwarder/README.markdown Sun Mar 03 11:23:40 2024 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,48 +0,0 @@ ---- -labels: -- 'Stage-Beta' -summary: 'Forward spam/abuse reports to a JID' ---- - -This module forwards spam/abuse reports (e.g. those submitted by users via -XEP-0377 via mod_spam_reporting) to one or more JIDs. - -## Configuration - -Install and enable the module the same as any other. - -There is a single option, `spam_report_destinations` which accepts a list of -JIDs to send reports to. - -For example: - -```lua -modules_enabled = { - --- - "spam_reporting"; - "spam_report_forwarder"; - --- -} - -spam_report_destinations = { "antispam.example.com" } -``` - -## Protocol - -This section is intended for developers. - -XEP-0377 assumes the report is embedded within another protocol such as -XEP-0191, and doesn't specify a format for communicating "standalone" reports. -This module transmits them inside a `<message>` stanza, and adds a `<jid/>` -element (borrowed from XEP-0268): - -```xml -<message from="prosody.example" to="destination.example"> - <report xmlns="urn:xmpp:reporting:1" reason="urn:xmpp:reporting:spam"> - <jid xmlns="urn:xmpp:jid:0">spammer@bad.example</jid> - <text> - Never came trouble to my house like this. - </text> - </report> -</message> -```
--- a/mod_spam_report_forwarder/mod_spam_report_forwarder.lua Sun Mar 03 11:23:40 2024 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,139 +0,0 @@ -local dt = require "util.datetime"; -local jid = require "util.jid"; -local st = require "util.stanza"; -local url = require "socket.url"; - -local new_id = require "util.id".short; -local render = require"util.interpolation".new("%b{}", function (s) return s; end); - -local destinations = module:get_option_set("spam_report_destinations", {}); - -local archive = module:open("archive"); - -local cache_size = module:get_option_number("spam_report_forwarder_contact_cache_size", 256); -local report_to_origin = module:get_option_boolean("spam_report_forwarder_to_origin", true); -local contact_lookup_timeout = module:get_option_number("spam_report_forwarder_contact_lookup_timeout", 180); - -local body_template = module:get_option_string("spam_report_forwarder_body_template", [[ -SPAM/ABUSE REPORT ------------------ - -Reported JID: {reported_jid} - -A user on our service has reported a message originating from the above JID on -your server. - -{reported_message_time&The reported message was sent at: {reported_message_time}} - --- -This message contains also machine-readable payloads, including XEP-0377, in case -you want to automate handling of these reports. You can receive these reports -to a different address by setting 'spam-report-addresses' in your server -contact info configuration. For more information, see https://xmppbl.org/reports/ -]]):gsub("^%s+", ""):gsub("(%S)\n(%S)", "%1 %2"); - -local report_addresses = require "util.cache".new(cache_size); - -local function get_address(form, ...) - for i = 1, select("#", ...) do - local field_var = select(i, ...); - local field = form:get_child_with_attr("field", "jabber:x:data", "var", field_var); - if field then - local parsed = url.parse(field:get_child_text("value")); - if parsed.scheme == "xmpp" and parsed.path and not parsed.query then - return parsed.path; - end - end - end -end - -local function get_origin_report_address(reported_jid) - local host = jid.host(reported_jid); - local address = report_addresses:get(host); - if address then return address; end - - local contact_query = st.iq({ to = host, from = module.host, id = new_id() }) - :query("http://jabber.org/protocol/disco#info"); - - return module:send_iq(contact_query, prosody.hosts[module.host], contact_lookup_timeout) - :next(function (response) - if response.attr.type ~= "result" then return; end - - for form in response.tags[1]:childtags("x", "jabber:x:data") do - local form_type = form:get_child_with_attr("field", nil, "var", "FORM_TYPE"); - if form_type == "http://jabber.org/network/serverinfo" then - address = get_address(form, "spam-report-addresses", "abuse-addresses"); - break; - end - end - return address; - end); -end - -local function send_report(to, message) - local m = st.clone(message); - m.attr.to = to; - module:send(m); -end - -function forward_report(event) - local reporter_username = event.origin.username; - local reporter_jid = jid.join(reporter_username, module.host); - local reported_jid = event.jid; - - local report = st.clone(event.report); - report:text_tag("jid", reported_jid, { xmlns = "urn:xmpp:jid:0" }); - - local reported_message_id = report:get_child_with_attr( - "stanza-id", - "urn:xmpp:sid:0", - "by", - reported_jid, - jid.prep - ); - - local reported_message, reported_message_time, reported_message_with; - if reported_message_id then - reported_message, reported_message_time, reported_message_with = archive:get(reporter_username, reported_message_id); - if jid.bare(reported_message_with) ~= event.jid then - reported_message = nil; - end - end - - local body_text = render(body_template, { - reporter_jid = reporter_jid; - reported_jid = event.jid; - reported_message_time = dt.datetime(reported_message_time); - }); - - local message = st.message({ from = module.host }) - :text_tag("body", body_text) - :add_child(report); - - if reported_message then - reported_message.attr.xmlns = "jabber:client"; - local fwd = st.stanza("forwarded", { xmlns = "urn:xmpp:forward:0" }) - :tag("delay", { xmlns = "urn:xmpp:delay", stamp = dt.datetime(reported_message_time) }):up() - :add_child(reported_message); - message:add_child(fwd); - end - - for destination in destinations do - send_report(destination, message); - end - - if report_to_origin then - module:log("debug", "Sending report to origin server..."); - get_origin_report_address(event.jid):next(function (origin_report_address) - if not origin_report_address then - module:log("warn", "Couldn't report to origin: no contact address found for %s", jid.host(event.jid)); - return; - end - send_report(origin_report_address, message); - end); - end -end - -module:hook("spam_reporting/abuse-report", forward_report, -1); -module:hook("spam_reporting/spam-report", forward_report, -1); -module:hook("spam_reporting/unknown-report", forward_report, -1);