Changeset

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 +

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_compliance_2023/README.md	Sun Dec 22 16:06:28 2024 +0100
@@ -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

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_compliance_2023/mod_compliance_2023.lua	Sun Dec 22 16:06:28 2024 +0100
@@ -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
+