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 +

local setmetatable = setmetatable;
local pcall = pcall;
local type = type;
local t_concat = table.concat;
local print = print;

local socket_url = require "socket.url";
local http = require "socket.http";
local ltn12 = require "ltn12";

--local json = require "json";
local json = module:require("couchdb/json");

--module("couchdb")
local _M = {};

local function urlcat(url, path)
	return url:gsub("/*$", "").."/"..path:gsub("^/*", "");
end

local doc_mt = {};
doc_mt.__index = doc_mt;

function doc_mt:get()
	return self.db:get(socket_url.escape(self.id));
end
function doc_mt:put(val)
	return self.db:put(socket_url.escape(self.id), val);
end
function doc_mt:__tostring()
	return "couchdb.doc("..self.url..")";
end


local db_mt = {};
db_mt.__index = db_mt;

function db_mt:__tostring()
	return "couchdb.db("..self.url..")";
end
function db_mt:doc(id)
	local url = urlcat(self.url, socket_url.escape(id));
	return setmetatable({ url = url, db = self, id = id }, doc_mt);
end
function db_mt:get(id)
	local url = urlcat(self.url, id);
	local a,b = http.request(url);
	local r,x = pcall(json.decode, a);
	if r then a = x; end
	return a,b;
end
function db_mt:put(id, value)
	local url = urlcat(self.url, id);
	if type(value) == "table" then
		value = json.encode(value);
	elseif value ~= nil and type(value) ~= "string" then
		return nil, "Invalid type";
	end
	local t = {};
	local a,b = http.request {
		url = url,
		sink = ltn12.sink.table(t),
		source = ltn12.source.string(value),
		method = "PUT",
		headers = {
			["Content-Length"] = #value,
			["Content-Type"] = "application/json"
		}
	};
	a = t_concat(t);
	local r,x = pcall(json.decode, a);
	if r then a = x; end
	return a,b;
end


local server_mt = {};
server_mt.__index = server_mt;

function server_mt:db(name)
	local url = urlcat(self.url, socket_url.escape(name));
	return setmetatable({ url = url }, db_mt);
end
function server_mt:__tostring()
	return "couchdb.server("..self.url..")";
end


function _M.server(url)
	return setmetatable({ url = url }, server_mt);
end
function _M.db(url)
	return setmetatable({ url = url }, db_mt);
end

return _M;