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 +

+
−local array = require"util.array";
+
−local st = require"util.stanza";
+
−
+
−local tos_version = assert(module:get_option("tos_version"), "tos_version must be set")
+
−
+
−local status_storage;
+
−if prosody.process_type == "prosody" or prosody.shutdown then
+
−	status_storage = module:open_store("tos_status", "keyval")
+
−end
+
−
+
−local documents = array{};
+
−
+
−local function validate_doc(doc)
+
−	if not doc.title or not doc.sources or #doc.sources < 1 then
+
−		return false, "document needs to have a title and at least one source"
+
−	end
+
−	for _, source in ipairs(doc.sources) do
+
−		if not source.url or not source.type then
+
−			return false, "document " .. doc.title .. " has a source without url or type"
+
−		end
+
−	end
+
−	return true, doc
+
−end
+
−
+
−for _, doc in ipairs(assert(module:get_option("tos_documents"), "tos_documents option is required")) do
+
−	local ok, doc_or_err = validate_doc(doc)
+
−	if not ok then
+
−		error("invalid TOS document: "..doc_or_err)
+
−	end
+
−	documents:push(doc);
+
−end
+
−
+
−local function send_tos_push(session)
+
−	local to = session.username .. "@" .. session.host .. "/" .. session.resource;
+
−	local push = st.message({
+
−		type = "headline",
+
−		to = to,
+
−	}, "In order to continue to use the service, you have to accept the current version of the Terms of Service.");
+
−	local tos = push:tag("tos-push", { xmlns = "urn:xmpp:tos:0" }):tag("tos", { version = tos_version });
+
−	for _, doc in ipairs(documents) do
+
−		local doc_tag = tos:tag("document"):text_tag("title", doc.title);
+
−		for _, source in ipairs(doc.sources) do
+
−			doc_tag:tag("source", { url = source.url,  type = source.type }):up();
+
−		end
+
−		doc_tag:up();
+
−	end
+
−	tos:up():up();
+
−	module:send(push);
+
−end
+
−
+
−local function check_tos(event)
+
−	local user = event.origin.username
+
−	assert(user)
+
−	local tos_status = status_storage:get(user)
+
−	if tos_status and tos_status.version and tos_status.version == tos_version then
+
−		module:log("debug", "user %s has signed the current tos", user);
+
−		return
+
−	end
+
−	module:log("debug", "user %s has not signed the current tos, sending tos push", user);
+
−	send_tos_push(event.origin)
+
−end
+
−
+
−local function handle_accept_tos_iq(event)
+
−	local user = event.origin.username;
+
−	assert(user);
+
−	local accept = event.stanza.tags[1];
+
−	local version = accept.attr["version"];
+
−	module:log("debug", "user %s has accepted ToS version %s", user, version);
+
−	if version ~= tos_version then
+
−		local reply = st.error_reply(event.stanza, "modify", "not-allowed", "Only the most recent version of the ToS can be accepted");
+
−		module:log("debug", "%s is not the most recent version (%s), rejecting", version, tos_version);
+
−		event.origin.send(reply);
+
−		return true;
+
−	end
+
−
+
−	status_storage:set(user, { version = tos_version });
+
−	local reply = st.reply(event.stanza);
+
−	event.origin.send(reply);
+
−	return true;
+
−end
+
−
+
−module:hook("presence/initial", check_tos, -100);
+
−module:hook("iq-set/bare/urn:xmpp:tos:0:accept", handle_accept_tos_iq);