Mercurial > prosody-modules
view mod_auto_moved/mod_auto_moved.lua @ 6082:1a6cd0bbb7ab
mod_compliance_2023: Add 2023 Version of the compliance module, basis is the 2021 Version.
diff --git a/mod_compliance_2023/README.md b/mod_compliance_2023/README.md
new file mode 100644
--- /dev/null
+++ b/mod_compliance_2023/README.md
@@ -0,0 +1,22 @@
+---
+summary: XMPP Compliance Suites 2023 self-test
+labels:
+- Stage-Beta
+rockspec:
+ dependencies:
+ - mod_cloud_notify
+
+...
+
+Compare the list of enabled modules with
+[XEP-0479: XMPP Compliance Suites 2023] and produce basic report to the
+Prosody log file.
+
+If installed with the Prosody plugin installer then all modules needed for a green checkmark should be included. (With prosody 0.12 only [mod_cloud_notify] is not included with prosody and we need the community module)
+
+# Compatibility
+
+ Prosody-Version Status
+ --------------- ----------------------
+ trunk Works as of 2024-12-21
+ 0.12 Works
diff --git a/mod_compliance_2023/mod_compliance_2023.lua b/mod_compliance_2023/mod_compliance_2023.lua
new file mode 100644
--- /dev/null
+++ b/mod_compliance_2023/mod_compliance_2023.lua
@@ -0,0 +1,79 @@
+-- Copyright (c) 2021 Kim Alvefur
+--
+-- This module is MIT licensed.
+
+local hostmanager = require "core.hostmanager";
+
+local array = require "util.array";
+local set = require "util.set";
+
+local modules_enabled = module:get_option_inherited_set("modules_enabled");
+
+for host in pairs(hostmanager.get_children(module.host)) do
+ local component = module:context(host):get_option_string("component_module");
+ if component then
+ modules_enabled:add(component);
+ modules_enabled:include(module:context(host):get_option_set("modules_enabled", {}));
+ end
+end
+
+local function check(suggested, alternate, ...)
+ if set.intersection(modules_enabled, set.new({suggested; alternate; ...})):empty() then return suggested; end
+ return false;
+end
+
+local compliance = {
+ array {"Server"; check("tls"); check("disco")};
+
+ array {"Advanced Server"; check("pep", "pep_simple")};
+
+ array {"Web"; check("bosh"); check("websocket")};
+
+ -- No Server requirements for Advanced Web
+
+ array {"IM"; check("vcard_legacy", "vcard"); check("carbons"); check("http_file_share", "http_upload")};
+
+ array {
+ "Advanced IM";
+ check("vcard_legacy", "vcard");
+ check("blocklist");
+ check("muc");
+ check("private");
+ check("smacks");
+ check("mam");
+ check("bookmarks");
+ };
+
+ array {"Mobile"; check("smacks"); check("csi_simple", "csi_battery_saver")};
+
+ array {"Advanced Mobile"; check("cloud_notify")};
+
+ array {"A/V Calling"; check("turn_external", "external_services", "turncredentials", "extdisco")};
+
+};
+
+function check_compliance()
+ local compliant = true;
+ for _, suite in ipairs(compliance) do
+ local section = suite:pop(1);
+ if module:get_option_boolean("compliance_" .. section:lower():gsub("%A", "_"), true) then
+ local missing = set.new(suite:filter(function(m) return type(m) == "string" end):map(function(m) return "mod_" .. m end));
+ if suite[1] then
+ if compliant then
+ compliant = false;
+ module:log("warn", "Missing some modules for XMPP Compliance 2023");
+ end
+ module:log("info", "%s Compliance: %s", section, missing);
+ end
+ end
+ end
+
+ if compliant then module:log("info", "XMPP Compliance 2023: Compliant ✔️"); end
+end
+
+if prosody.start_time then
+ check_compliance()
+else
+ module:hook_global("server-started", check_compliance);
+end
+
| author | Menel <menel@snikket.de> |
|---|---|
| date | Sun, 22 Dec 2024 16:06:28 +0100 |
| parents | f95a1e197a07 |
| children | fdf7b82099de |
line wrap: on
line source
local id = require "util.id"; local jid = require "util.jid"; local promise = require "util.promise"; local rm = require "core.rostermanager"; local st = require "util.stanza"; local errors = require "util.error".init(module.name, { ["statement-not-found"] = { type = "cancel", condition = "item-not-found" }; ["statement-mismatch"] = { type = "cancel", condition = "conlict" }; }); module:hook("presence/bare", function (event) local origin, stanza = event.origin, event.stanza; if stanza.attr.type ~= "subscribe" then return; -- We're only interested in subscription requests end local moved = stanza:get_child("moved", "urn:xmpp:moved:1"); if not moved then return; -- We're only interested in stanzas with a moved notification end local verification = stanza:get_child("moved-verification", "https://prosody.im/protocol/moved"); if verification then return; -- We already attempted to verify this stanza end module:log("debug", "Received moved notification from %s", stanza.attr.from); local old_jid = moved:get_child_text("old-jid"); if not old_jid then return; -- Failed to read old JID end local to_user = jid.node(stanza.attr.to); local new_jid_unverified = jid.bare(stanza.attr.from); if not rm.is_contact_subscribed(to_user, module.host, old_jid) then return; -- Old JID was not an existing contact, ignore end if rm.is_contact_pending_in(to_user, module.host, new_jid_unverified) or rm.is_contact_subscribed(to_user, module.host, new_jid_unverified) then return; -- New JID already subscribed or pending, ignore end local moved_statement_query = st.iq({ to = old_jid, type = "get", id = id.short() }) :tag("pubsub", { xmlns = "http://jabber.org/protocol/pubsub" }) :tag("items", { node = "urn:xmpp:moved:1" }) :tag("item", { id = "current" }):up() :up() :up(); -- TODO: Catch and handle <gone/> errors per note in XEP-0283. module:send_iq(moved_statement_query):next(function (reply) module:log("debug", "Statement reply: %s", reply.stanza); local moved_statement = reply.stanza:find("{http://jabber.org/protocol/pubsub}pubsub/items/{http://jabber.org/protocol/pubsub}item/{urn:xmpp:moved:1}moved"); if not moved_statement then return promise.reject(errors.new("statement-not-found")); -- No statement found end local new_jid = jid.prep(moved_statement:get_child_text("new-jid")); if new_jid ~= new_jid_unverified then return promise.reject(errors.new("statement-mismatch")); -- Verification failed; JIDs do not match end -- Verified! module:log("info", "Verified moved notification <%s> -> <%s>", old_jid, new_jid); -- Add incoming subscription and respond rm.set_contact_pending_in(to_user, module.host, new_jid); rm.subscribed(to_user, module.host, new_jid); module:send(st.presence({ to = new_jid, from = to_user.."@"..module.host, type = "subscribed" })); rm.roster_push(to_user, module.host, new_jid); -- Request outgoing subscription if old JID had one if rm.is_user_subscribed(to_user, module.host, old_jid) then module:log("debug", "Requesting subscription to new JID"); rm.set_contact_pending_out(to_user, module.host, new_jid); module:send(st.presence({ to = new_jid, from = to_user.."@"..module.host, type = "subscribe" })); end end):catch(function (err) module:log("debug", "Failed to verify moved statement for <%s> -> <%s>: %s", old_jid, new_jid_unverified, require "util.serialization".serialize(err, "debug")); stanza:reset() :tag("moved-verification", { xmlns = "https://prosody.im/protocol/moved", status = "failed" }) :up(); module:send(stanza, origin); end); -- Halt processing of the stanza, for now return true; end, 1);
