view mod_json_streams/mod_json_streams.lua @ 6082:1a6cd0bbb7ab

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 +
author Menel <menel@snikket.de>
date Sun, 22 Dec 2024 16:06:28 +0100
parents 98569ec25ac2
children
line wrap: on
line source

--
-- XEP-0295: JSON Encodings for XMPP
--

module.host = "*"

local httpserver = require "net.httpserver";
local filters = require "util.filters"
local json = require "util.json"

local json_escapes = {
	["\""] = "\\\"", ["\\"] = "\\\\", ["\b"] = "\\b", ["\f"] = "\\f",
	["\n"] = "\\n", ["\r"] = "\\r", ["\t"] = "\\t"};

local s_char = string.char;
for i=0,31 do
	local ch = s_char(i);
	if not json_escapes[ch] then json_escapes[ch] = ("\\u%.4X"):format(i); end
end

local state_out = 0;
local state_key_before = 1;
local state_key_in = 2;
local state_key_escape = 3;
local state_key_after = 4;
local state_val_before = 5;
local state_val_in = 6;
local state_val_escape = 7;
local state_val_after = 8;

local whitespace = { [" "] = true, ["\n"] = true, ["\r"] = true, ["\t"] = true };
function json_decoder()
	local state = state_out;
	local quote;
	local output = "";
	local buffer = "";
	return function(input)
		for ch in input:gmatch(".") do
			module:log("debug", "%s | %d", ch, state)
			local final = false;
			if state == state_out then
				if whitespace[ch] then
				elseif ch ~= "{" then return nil, "{ expected";
				else state = state_key_before end
			elseif state == state_key_before then
				if whitespace[ch] then
				elseif ch ~= "'" and ch ~= "\"" then return nil, "\" expected";
				else quote = ch; state = state_key_in; end
			elseif state == state_key_in then
				if ch == quote then state = state_key_after;
				elseif ch ~= "s" then return nil, "invalid key, 's' expected"; -- only s as key allowed
				else end -- ignore key
			elseif state == state_key_after then
				if whitespace[ch] then
				elseif ch ~= ":" then return nil, ": expected";
				else state = state_val_before; end
			elseif state == state_val_before then
				if whitespace[ch] then
				elseif ch ~= "'" and ch ~= "\"" then return nil, "\" expected";
				else quote = ch; state = state_val_in; end
			elseif state == state_val_in then
				if ch == quote then state = state_val_after;
				elseif ch == "\\" then state = state_val_escape;
				else end
			elseif state == state_val_after then
				if whitespace[ch] then
				elseif ch ~= "}" then return nil, "} expected";
				else state = state_out;
					final = true;
				end
			elseif state == state_val_escape then
				state = state_val_in;
			else
				module:log("error", "Unhandled state: "..state);
				return nil, "Unhandled state in parser"
			end
			buffer = buffer..ch;
			if final then
				module:log("debug", "%s", buffer)
				local tmp;
				pcall(function() tmp = json.decode(buffer); end);
				if not tmp then return nil, "Invalid JSON"; end
				output, buffer = output..tmp.s, "";
			end
		end
		local _ = output; output = "";
		return _;
	end;
end

function filter_hook(session)
	local determined = false;
	local is_json = false;
	local function in_filter(t)
		if not determined then
			is_json = (t:sub(1,1) == "{") and json_decoder();
			determined = true;
		end
		if is_json then
			local s, err = is_json(t);
			if not err then return s; end
			session:close("not-well-formed");
			return;
		end
		return t;
	end
	local function out_filter(t)
		if is_json then
			return '{"s":"' .. t:gsub(".", json_escapes) .. '"}'; -- encode
		end
		return t;
	end
	filters.add_filter(session, "bytes/in", in_filter,   100);
	filters.add_filter(session, "bytes/out", out_filter, 100);
end

function module.load()
	filters.add_filter_hook(filter_hook);
end
function module.unload()
	filters.remove_filter_hook(filter_hook);
end

function encode(data)
	if type(data) == "string" then
		data = json.encode({ s = data });
	elseif type(data) == "table" and data.body then
		data.body = json.encode({ s = data.body });
		data.headers["Content-Type"] = "application/json";
	end
	return data;
end
function handle_request(method, body, request)
	local mod_bosh = modulemanager.get_module("*", "bosh")
	if mod_bosh then
		if body and method == "POST" then
			pcall(function() body = json.decode(body).s; end);
		end
		local _send = request.send;
		function request:send(data) return _send(self, encode(data)); end
		return encode(mod_bosh.handle_request(method, body, request));
	end
	return "<html><body>mod_bosh not loaded</body></html>";
end

local function setup()
	local ports = module:get_option("jsonstreams_ports") or { 5280 };
	httpserver.new_from_config(ports, handle_request, { base = "jsonstreams" });
end
if prosody.start_time then -- already started
	setup();
else
	prosody.events.add_handler("server-started", setup);
end