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 +

module:set_global();
local stats = module:shared"stats";
local iter = require "util.iterators";
local count, keys = iter.count, iter.keys;

stats.stats = stats.stats or {};
stats.conns = stats.conns or {};

setmetatable(stats, {
	__index = {

		broadcast = function (self, stat)
			local value = self.stats[stat];
			for conn in pairs(self.conns) do
				conn:write(stat..":"..value.."\n");
			end
		end;

		adjust = function (self, stat, delta)
			if delta == 0 then return; end
			self.stats[stat] = (self.stats[stat] or 0) + delta;
			self:broadcast(stat);
		end;

		set = function (self, stat, value)
			if value == self.stats[stat] then return; end
			self.stats[stat] = value;
			self:broadcast(stat);
		end;

		add_conn = function (self, conn)
			self.conns[conn] = true;
			for stat, value in pairs(self.stats) do
				conn:write(stat..":"..value.."\n");
			end
		end;

		remove_conn = function (self, conn)
			self.conns[conn] = nil;
		end;
	};
});

local network = {};

function network.onconnect(conn)
	stats:add_conn(conn);
end

function network.onincoming(conn, data)
end

function network.ondisconnect(conn, reason)
	stats:remove_conn(conn);
end

module:add_timer(1, function ()
	stats:set("s2s-in", count(keys(prosody.incoming_s2s)));
	return math.random(10, 20);
end);
module:add_timer(3, function ()
	local s2sout_count = 0;
	for _, host in pairs(prosody.hosts) do
		s2sout_count = s2sout_count + count(keys(host.s2sout));
	end
	stats:set("s2s-out", s2sout_count);
	return math.random(10, 20);
end);


function module.add_host(module)
	module:hook("resource-bind", function ()
		stats:adjust("c2s", 1);
	end);
	module:hook("resource-unbind", function ()
		stats:adjust("c2s", -1);
	end);

	local c2s_count = 0;
	for username, user in pairs(hosts[module.host].sessions or {}) do
		for resource, session in pairs(user.sessions or {}) do
			c2s_count = c2s_count + 1;
		end
	end
	stats:set("c2s", c2s_count);

	module:hook("s2sin-established", function (event)
		stats:adjust("s2s-in", 1);
	end);
	module:hook("s2sin-destroyed", function (event)
		stats:adjust("s2s-in", -1);
	end);
	module:hook("s2sout-established", function (event)
		stats:adjust("s2s-out", 1);
	end);
	module:hook("s2sout-destroyed", function (event)
		stats:adjust("s2s-out", -1);
	end);
end

module:provides("net", {
	default_port = 5444;
	listener = network;
});