File

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 +

+
−-- Send carbons v0 style copies of incoming messages to clients which
+
−-- are not (yet) capable of Message Carbons (XEP-0280).
+
−--
+
−-- This extension integrates with the mod_carbons plugin in such a way
+
−-- that a client capable of Message Carbons will not get a v0 copy.
+
−--
+
−-- This extension can be enabled for all users by default by setting
+
−-- carbons_copies_default = true.
+
−--
+
−-- Alternatively or additionally setting carbons_copies_adhoc = true
+
−-- will allow the user to enable or disable copies through Adhoc
+
−-- commands.
+
−--
+
−-- Copyright (C) 2012 Michael Holzt
+
−--
+
−-- This file is MIT/X11 licensed.
+
−
+
−local jid_split = require "util.jid".split;
+
−local dm_load = require "util.datamanager".load;
+
−local dm_store = require "util.datamanager".store;
+
−local adhoc_new = module:require "adhoc".new;
+
−local xmlns_carbons_v0 = "urn:xmpp:carbons:0";
+
−local storename = "mod_carbons_copies";
+
−
+
−local function toggle_copies(data, on)
+
−	local username, hostname, resource = jid_split(data.from);
+
−	dm_store(username, hostname, storename, { enabled = on });
+
−end
+
−
+
−local function adhoc_enable_copies(self, data, state)
+
−	toggle_copies(data, true);
+
−	return { info = "Copies are enabled for you now.\nPlease restart/reconnect clients.", status = "completed" };
+
−end
+
−
+
−local function adhoc_disable_copies(self, data, state)
+
−	toggle_copies(data, false);
+
−	return { info = "Copies are disabled for you now.\nPlease restart/reconnect clients.", status = "completed" };
+
−end
+
−
+
−module:hook("resource-bind", function(event)
+
−	local session = event.session;
+
−	local username, hostname, resource = jid_split(session.full_jid);
+
−
+
−	local store = dm_load(username, hostname, storename) or
+
−		{ enabled =
+
−		module:get_option_boolean("carbons_copies_default") };
+
−
+
−	if store.enabled then
+
−		session.want_carbons = xmlns_carbons_v0;
+
−		module:log("debug", "%s enabling copies", session.full_jid);
+
−	end
+
−end);
+
−
+
−-- Adhoc-Support
+
−if module:get_option_boolean("carbons_copies_adhoc") then
+
−	local enable_desc = adhoc_new("Carbons: Enable Copies",
+
−		"mod_carbons_copies#enable", adhoc_enable_copies);
+
−	local disable_desc = adhoc_new("Carbons: Disable Copies",
+
−		"mod_carbons_copies#disable", adhoc_disable_copies);
+
−
+
−	module:add_item("adhoc", enable_desc);
+
−	module:add_item("adhoc", disable_desc);
+
−end