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 +

-- mod_storage_multi

local storagemanager = require"core.storagemanager";
local backends = module:get_option_array(module.name); -- TODO better name?

-- TODO migrate data "upwards"

-- one → one successful write is success
-- all → all backends must report success
-- majority → majority of backends must report success
local policy = module:get_option_string(module.name.."_policy", "all");

local keyval_store = {};
keyval_store.__index = keyval_store;

function keyval_store:get(username)
	local backends = self.backends;
	local data, err;
	for i = 1, #backends do
		module:log("debug", "%s:%s:get(%q)", tostring(backends[i].get), backends[i]._store, username);
		data, err = backends[i]:get(username);
		if err then
			module:log("error", tostring(err));
		elseif not data then
			module:log("debug", "No data returned");
		else
			module:log("debug", "Data returned");
			return data, err;
		end
	end
end

-- This is where it gets complicated
function keyval_store:set(username, data)
	local backends = self.backends;
	local ok, err, backend;
	local all, one, oks = true, false, 0;
	for i = 1, #backends do
		backend = backends[i];
		module:log("debug", "%s:%s:set(%q)", tostring(backends[i].get), backends[i].store, username);
		ok, err = backend:set(username, data);
		if not ok then
			module:log("error", "Error in storage driver %s: %s", backend.name, tostring(err));
		else
			oks = oks + 1;
		end
		one = one or ok; -- At least one successful write
		all = all and ok; -- All successful
	end
	if policy == "all" then
		return all, err
	elseif policy == "majority" then
		return oks > (#backends/2), err;
	end
	-- elseif policy == "one" then
	return one, err;
end

local stores = {
	keyval = keyval_store;
}

local driver = {};

function driver:open(store, typ)
	local store_mt = stores[typ or "keyval"];
	if store_mt then
		local my_backends = {};
		local driver, opened
		for i = 1, #backends do
			 driver = storagemanager.load_driver(module.host, backends[i]);
			 opened = driver:open(store, typ);
			 my_backends[i] = assert(driver:open(store, typ));
			 my_backends[i]._store = store;
		end
		return setmetatable({ backends = my_backends }, store_mt);
	end
	return nil, "unsupported-store";
end

module:provides("storage", driver);