Software /
code /
prosody-modules
File
mod_dnsupdate/mod_dnsupdate.lua @ 6110: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 |
parent | 5711:429be658c0bb |
child | 6254:b6e390a97c85 |
line wrap: on
line source
module:set_global(); local config = require "core.configmanager"; local argparse = require "util.argparse"; local dns = require"net.adns".resolver(); local async = require "util.async"; local set = require "util.set"; local nameprep = require"util.encodings".stringprep.nameprep; local idna_to_ascii = require"util.encodings".idna.to_ascii; local virtualhost_services = { "xmpp-client"; "xmpps-client"; "xmpp-server"; "xmpps-server" } local component_services = { "xmpp-server"; "xmpps-server" } local function validate_dnsname_option(options, option_name, default) local host = options[option_name]; if host == nil then return default end local normalized = nameprep(host); if not normalized then module:log("error", "--%s %q fails normalization"); return; end local alabel = idna_to_ascii(normalized); if not alabel then module:log("error", "--%s %q fails IDNA"); return; end return alabel; end function module.command(arg) local opts = argparse.parse(arg, { short_params = { d = "domain"; p = "primary"; t = "target"; l = "ttl"; h = "help"; ["?"] = "help" }; value_params = { domain = true; primary = true; target = true; ttl = true }; }); if not arg[1] or arg[2] or not opts or opts.help or not opts.domain then local out = opts.help and io.stdout or io.stderr; out:write("prosodyctl mod_dnsupdate [options] virtualhost\n"); out:write("\t-d --domain\tbase domain name *required*\n"); out:write("\t-p --primary\tprimary DNS name server\n"); out:write("\t-t --target\ttarget hostname for SRV\n"); out:write("\t-l --ttl\tTTL to use\n"); out:write("\t--each\tremove and replace individual SRV records\n"); out:write("\t--reset\tremove and replace all SRV records\n"); out:write("\t--remove\tremove all SRV records\n"); return opts and opts.help and 0 or 1; end local vhost = nameprep(arg[1]); -- TODO loop over arg[]? if not vhost then module:log("error", "Host %q fails normalization", arg[1]); return 1; end local ihost = idna_to_ascii(vhost); if not ihost then module:log("error", "Host %q fails IDNA", vhost); return 1; end local is_component = config.get(vhost, "component_module"); if not is_component and not config.get(vhost, "defined") then module:log("error", "Host %q is not defined in the config", vhost); return 1; end local services = virtualhost_services; if is_component then services = component_services; end local domain = validate_dnsname_option(opts, "domain"); if not domain then module:log("error", "--domain is required"); return 1; end local primary = validate_dnsname_option(opts, "primary") or async.wait_for(dns:lookup_promise(domain, "SOA"):next(function(ret) return ret[1].soa.mname; end)); if not primary then module:log("error", "Could not discover primary name server, specify it with --primary"); return 1; end local target = validate_dnsname_option(opts, "target", module:context(vhost):get_option_string("xmpp_host", ihost)); -- TODO validate that target has A/AAAA local configured_ports = { ["xmpp-client"] = module:get_option_array("c2s_ports", { 5222 }); ["xmpp-server"] = module:get_option_array("s2s_ports", { 5269 }); ["xmpps-client"] = module:get_option_array("c2s_direct_tls_ports", {}); ["xmpps-server"] = module:get_option_array("s2s_direct_tls_ports", {}); }; if opts.multiplex then for opt, ports in pairs(configured_ports) do ports:append(module:get_option_array(opt:sub(1, 5) == "xmpps" and "ssl_ports" or "ports", {})); end end local existing_srv = {}; for _, service in ipairs(services) do existing_srv[service] = dns:lookup_promise(("_%s._tcp.%s"):format(service, ihost), "SRV"); end print("zone", domain); print("server", primary); print("ttl " .. tostring(opts.ttl or 60 * 60)); for _, service in ipairs(services) do local ports = set.new(configured_ports[service]); local records = (async.wait_for(existing_srv[service])); if opts.remove or opts.reset then print(("del _%s._tcp.%s IN SRV"):format(service, ihost)); else for _, rr in ipairs(records) do if ports:contains(rr.srv.port) and target == nameprep(rr.srv.target):gsub("%.$", "") then ports:remove(rr.srv.port) elseif not opts.each then print(("del _%s._tcp.%s IN SRV"):format(service, ihost)); break else print(("del _%s._tcp.%s IN SRV %s"):format(service, ihost, rr)); end end end if not opts.remove then for port in ports do print(("add _%s._tcp.%s IN SRV 1 1 %d %s"):format(service, ihost, port, target)); end end if ports:empty() then print(("add _%s._tcp.%s IN SRV 0 0 0 ."):format(service, ihost)); end end print("show"); print("send"); print("answer"); end