Mercurial > prosody-modules
view mod_storage_ldap/mod_storage_ldap.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 | e099586f9de5 |
| children | 0371619d3851 |
line wrap: on
line source
-- vim:sts=4 sw=4 -- Prosody IM -- Copyright (C) 2008-2010 Matthew Wild -- Copyright (C) 2008-2010 Waqas Hussain -- Copyright (C) 2012 Rob Hoelz -- -- This project is MIT/X11 licensed. Please see the -- COPYING file in the source package for more information. -- ---------------------------------------- -- Constants and such -- ---------------------------------------- local setmetatable = setmetatable; local ldap = module:require 'ldap'; local vcardlib = module:require 'ldap/vcard'; local st = require 'util.stanza'; local gettime = require 'socket'.gettime; if not ldap then return; end local CACHE_EXPIRY = 300; local params = module:get_option('ldap'); ---------------------------------------- -- Utility Functions -- ---------------------------------------- local function ldap_record_to_vcard(record) return vcardlib.create { record = record, format = params.vcard_format, } end local get_alias_for_user; do local user_cache; local last_fetch_time; local function populate_user_cache() local ld = ldap.getconnection(); local usernamefield = params.user.usernamefield; local namefield = params.user.namefield; user_cache = {}; for _, attrs in ld:search { base = params.user.basedn, scope = 'onelevel', filter = params.user.filter } do user_cache[attrs[usernamefield]] = attrs[namefield]; end last_fetch_time = gettime(); end function get_alias_for_user(user) if last_fetch_time and last_fetch_time + CACHE_EXPIRY < gettime() then user_cache = nil; end if not user_cache then populate_user_cache(); end return user_cache[user]; end end ---------------------------------------- -- General Setup -- ---------------------------------------- local ldap_store = {}; ldap_store.__index = ldap_store; local adapters = { roster = {}, vcard = {}, } for k, v in pairs(adapters) do setmetatable(v, ldap_store); v.__index = v; v.name = k; end function ldap_store:get(username) return nil, "get method unimplemented on store '" .. tostring(self.name) .. "'" end function ldap_store:set(username, data) return nil, "LDAP storage is currently read-only"; end ---------------------------------------- -- Roster Storage Implementation -- ---------------------------------------- function adapters.roster:get(username) local ld = ldap.getconnection(); local contacts = {}; local memberfield = params.groups.memberfield; local namefield = params.groups.namefield; local filter = memberfield .. '=' .. tostring(username); local groups = {}; for _, config in ipairs(params.groups) do groups[ config[namefield] ] = config.name; end -- XXX this kind of relies on the way we do groups at INOC for _, attrs in ld:search { base = params.groups.basedn, scope = 'onelevel', filter = filter } do if groups[ attrs[namefield] ] then local members = attrs[memberfield]; for _, user in ipairs(members) do if user ~= username then local jid = user .. '@' .. module.host; local record = contacts[jid]; if not record then record = { subscription = 'both', groups = {}, name = get_alias_for_user(user), }; contacts[jid] = record; end record.groups[ groups[ attrs[namefield] ] ] = true; end end end end return contacts; end ---------------------------------------- -- vCard Storage Implementation -- ---------------------------------------- function adapters.vcard:get(username) if not params.vcard_format then return nil, ''; end local ld = ldap.getconnection(); local filter = params.user.usernamefield .. '=' .. tostring(username); local match = ldap.singlematch { base = params.user.basedn, filter = filter, }; if match then match.jid = username .. '@' .. module.host return st.preserialize(ldap_record_to_vcard(match)); else return nil, 'not found'; end end ---------------------------------------- -- Driver Definition -- ---------------------------------------- local driver = {}; function driver:open(store, typ) local adapter = adapters[store]; if adapter and typ == nil or typ == "keyval" then return adapter; end return nil, "unsupported-store"; end module:provides("storage", driver);
