Mercurial > prosody-modules
view mod_muc_http_defaults/mod_muc_http_defaults.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 | 6d99ddd99694 |
| children |
line wrap: on
line source
-- Copyright (C) 2021 Kim Alvefur -- -- This file is MIT licensed. Please see the -- COPYING file in the source package for more information. -- local http = require "net.http"; local async = require "util.async"; local uh = require "util.http"; local jid = require "util.jid"; local json = require "util.json"; local st = require "util.stanza"; local funcs = {jid_bare = jid.bare; jid_host = jid.host; jid_node = jid.node}; local render = require"util.interpolation".new("%b{}", uh.urlencode, funcs); module:depends"muc"; local url_template = assert(module:get_option_string("muc_create_api_url", nil), "'muc_create_api_url' is a required option"); local apiauth = module:get_option_string("muc_create_api_auth", nil); local ex = { headers = { accept = "application/json"; authorization = apiauth; } }; local problems = { format = "API server returned invalid data, see logs", config = "A problem occured while creating the room, see logs", }; local function apply_config(room, settings) local affiliations = settings.affiliations; if type(affiliations) == "table" then -- COMPAT the room creator is unconditionally made 'owner' -- clear existing affiliation for existing_affiliation in pairs(room._affiliations) do room:set_affiliation(true, existing_affiliation, "none"); end if affiliations[1] ~= nil then -- array of ( jid, affiliation, nick ) for _, aff in ipairs(affiliations) do if type(aff) == "table" and type(aff.jid) == "string" and (aff.nick == nil or type(aff.nick) == "string") then local prepped_jid = jid.prep(aff.jid); if prepped_jid then local ok, err = room:set_affiliation(true, prepped_jid, aff.affiliation, aff.nick and { nick = aff.nick }); if not ok then module:log("error", "Could not set affiliation in %s: %s", room.jid, err); return nil, "config"; end else module:log("error", "Invalid JID returned from API for %s: %q", room.jid, aff.jid); return nil, "format"; end else module:log("error", "Invalid affiliation item returned from API for %s: %q", room.jid, aff); return nil, "format"; end end else -- map of jid : affiliation for user_jid, aff in pairs(affiliations) do if type(user_jid) == "string" and type(aff) == "string" then local prepped_jid = jid.prep(user_jid); if prepped_jid then local ok, err = room:set_affiliation(true, prepped_jid, aff); if not ok then module:log("error", "Could not set affiliation in %s: %s", room.jid, err); return nil, "config"; end else module:log("error", "Invalid JID returned from API: %q", aff.jid); return nil, "format"; end end end end elseif affiliations ~= nil then module:log("error", "Invalid affiliations returned from API for %s: %q", room.jid, affiliations); return nil, "format", { field = "affiliations" }; end local config = settings.config; if type(config) == "table" then -- TODO reject invalid fields instead of ignoring them if type(config.name) == "string" then room:set_name(config.name); end if type(config.description) == "string" then room:set_description(config.description); end if type(config.language) == "string" then room:set_language(config.language); end if type(config.password) == "string" then room:set_password(config.password); end if type(config.subject) == "string" then room:set_subject(room.jid, config.subject); end if type(config.public) == "boolean" then room:set_public(config.public); end if type(config.members_only) == "boolean" then room:set_members_only(config.members_only); end if type(config.allow_member_invites) == "boolean" then room:set_allow_member_invites(config.allow_member_invites); end if type(config.moderated) == "boolean" then room:set_moderated(config.moderated); end if type(config.persistent) == "boolean" then room:set_persistent(config.persistent); end if type(config.changesubject) == "boolean" then room:set_changesubject(config.changesubject); end if type(config.historylength) == "number" then room:set_historylength(config.historylength); end if type(config.public_jids) == "boolean" then room:set_whois(config.public_jids and "anyone" or "moderators"); end -- Leaving out presence_broadcast for now -- mod_muc_mam if type(config.archiving) == "boolean" then room._config.archiving = config.archiving; end elseif config ~= nil then module:log("error", "Invalid config returned from API for %s: %q", room.jid, config); return nil, "format", { field = "config" }; end return true; end module:hook("muc-room-pre-create", function(event) local url = render(url_template, event); module:log("debug", "Calling API at %q for room %s", url, event.room.jid); local wait, done = async.waiter(); local ret, err; http.request(url, ex, function (body, code) if math.floor(code / 100) == 2 then local parsed, parse_err = json.decode(body); if not parsed then module:log("debug", "Got invalid JSON from %s: %s", url, parse_err); err = problems.format; else ret = parsed; end else module:log("debug", "Rejected by API: ", body); err = "Rejected by API"; end done() end); wait(); if not ret then event.room:destroy(); event.origin.send(st.error_reply(event.stanza, "cancel", "internal-server-error", err, module.host)); return true; end local configured, err = apply_config(event.room, ret); if not configured then event.room:destroy(); event.origin.send(st.error_reply(event.stanza, "cancel", "internal-server-error", err, event.room.jid or module.host)); return true; end end, -2);
