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 +

+
−---
+
−labels:
+
−- 'Stage-Merged'
+
−summary: 'Invite management module for Prosody'
+
−...
+
−
+
−Introduction
+
−============
+
−
+
−::: {.alert .alert-info}
+
−This module has been merged into Prosody as
+
−[mod_invites][doc:modules:mod_invites]. Users of Prosody **0.12**
+
−and later should not install this version.
+
−:::
+
−
+
−This module is part of the suite of modules that implement invite-based
+
−account registration for Prosody. The other modules are:
+
−
+
−- [mod_invites_adhoc][doc:modules:mod_invites_adhoc]
+
−- [mod_invites_register][doc:modules:mod_invites_register]
+
−- [mod_invites_page]
+
−- [mod_invites_register_web]
+
−- [mod_invites_api]
+
−- [mod_register_apps]
+
−
+
−This module manages the creation and consumption of invite codes for the
+
−host(s) it is loaded onto. It currently does not expose any admin/user-facing
+
−functionality (though in the future it will probably gain a way to view/manage
+
−pending invites).
+
−
+
−Instead, other modules can use the API from this module to create invite tokens
+
−which can be used to e.g. register accounts or create automatic subscription
+
−approvals.
+
−
+
−This module should not be confused with the similarly named mod_invite (note the
+
−missing 's'!). That module was a precursor to this one that helped test and prove
+
−the concept of invite-based registration, and is now deprecated.
+
−
+
−# Configuration
+
−
+
−This module exposes just one option - the length of time that a generated invite
+
−should be valid for by default.
+
−
+
−``` {.lua}
+
−-- Configure the number of seconds a token is valid for (default 7 days)
+
−invite_expiry = 86400 * 7
+
−```
+
−
+
−# Invites setup
+
−
+
−For a fully-featured invite-based setup, the following provides an example
+
−configuration:
+
−
+
−``` {.lua}
+
−-- Specify the external URL format of the invite links
+
−
+
−VirtualHost "example.com"
+
−    invites_page = "https://example.com/invite?{invite.token}"
+
−    http_external_url = "https://example.com/"
+
−    http_paths = {
+
−        invites_page = "/invite";
+
−        invites_register_web = "/register";
+
−    }
+
−    modules_enabled = {
+
−        "invites";
+
−        "invites_adhoc";
+
−        "invites_page";
+
−        "invites_register";
+
−        "invites_register_web";
+
−
+
−        "http_libjs"; -- See 'external dependencies' below
+
−    }
+
−```
+
−
+
−Restart Prosody and create a new invite using an ad-hoc command in an XMPP client connected
+
−to your admin account, or use the command line:
+
−
+
−    prosodyctl mod_invites generate example.com
+
−
+
−## External dependencies
+
−
+
−The default HTML templates for the web-based modules depend on some CSS and Javascript
+
−libraries. They expect these to be available at `https://example.com/share`. An easy
+
−way of doing this if you are on Debian 10 (buster) is to enable mod_http_libjs and install
+
−the following packages:
+
−
+
−    apt install libjs-bootstrap4 libjs-jquery
+
−
+
−On other systems you will need to manually put these libraries somewhere on the filesystem
+
−that Prosody can read, and serve them using mod_http_libjs with a custom `libjs_path`
+
−setting.
+
−
+
−# Compatibility
+
−
+
−0.11 and later.