Software `/` code `/` prosody

Comparison

plugins/mod_authz_internal.lua @ 12648:f299e570a0fe

mod_authz_internal: Use util.roles, some API changes and config support This commit was too awkward to split (hg record didn't like it), so: - Switch to the new util.roles lib to provide a consistent representation of a role object. - Change API method from get_role_info() to get_role_by_name() (touches sessionmanager and usermanager) - Change get_roles() to get_user_roles(), take a username instead of a JID This is more consistent with all other usermanager API methods. - Support configuration of custom roles and permissions via the config file (to be documented).

author	Matthew Wild <mwild1@gmail.com>
date	Tue, 19 Jul 2022 18:02:02 +0100
parent	12642:9061f9621330
child	12662:07424992d7fc

comparison

equal deleted inserted replaced

-:a661292d074a
+:f299e570a0fe
 local array = require "util.array";
 local it = require "util.iterators";
 local set = require "util.set";
 local jid_split, jid_bare = require "util.jid".split, require "util.jid".bare;
 local normalize = require "util.jid".prep;
+local roles = require "util.roles";
 local config_global_admin_jids = module:context("*"):get_option_set("admins", {}) / normalize;
 local config_admin_jids = module:get_option_inherited_set("admins", {}) / normalize;
 local host = module.host;
 local role_store = module:open_store("roles");
 local role_map_store = module:open_store("roles", "map");
-local role_methods = {};
+local role_registry = {};
-local role_mt = { __index = role_methods };
+function register_role(role)
-local role_registry = {
+	if role_registry[role.name] ~= nil then
-	["prosody:operator"] = {
+		return error("A role '"..role.name.."' is already registered");
-		default = true;
+	end
-		priority = 75;
+	if not roles.is_role(role) then
-		includes = { "prosody:admin" };
+		-- Convert table syntax to real role object
-	};
+		for i, inherited_role in ipairs(role.inherits or {}) do
-	["prosody:admin"] = {
+			if type(inherited_role) == "string" then
-		default = true;
+				role.inherits[i] = assert(role_registry[inherited_role], "The named role '"..inherited_role.."' is not registered");
-		priority = 50;
+			end
-		includes = { "prosody:user" };
+		end
-	};
+		if not role.permissions then role.permissions = {}; end
-	["prosody:user"] = {
+		for _, allow_permission in ipairs(role.allow or {}) do
-		default = true;
+			role.permissions[allow_permission] = true;
-		priority = 25;
+		end
-		includes = { "prosody:restricted" };
+		for _, deny_permission in ipairs(role.deny or {}) do
-	};
+			role.permissions[deny_permission] = false;
-	["prosody:restricted"] = {
+		end
-		default = true;
+		role = roles.new(role);
-		priority = 15;
+	end
-	};
+	role_registry[role.name] = role;
-};
+end
--- Some processing on the role registry
+-- Default roles
-for role_name, role_info in pairs(role_registry) do
+register_role {
-	role_info.name = role_name;
+	name = "prosody:restricted";
-	role_info.includes = set.new(role_info.includes) / function (included_role_name)
+	priority = 15;
-		return role_registry[included_role_name];
+};
-	end;
-	if not role_info.permissions then
+register_role {
-		role_info.permissions = {};
+	name = "prosody:user";
-	end
+	priority = 25;
-	setmetatable(role_info, role_mt);
+	inherits = { "prosody:restricted" };
-end
+};
-function role_methods:may(action, context)
+register_role {
-	local policy = self.permissions[action];
+	name = "prosody:admin";
-	if policy ~= nil then
+	priority = 50;
-		return policy;
+	inherits = { "prosody:user" };
-	end
+};
-	for inherited_role in self.includes do
-		module:log("debug", "Checking included role '%s' for %s", inherited_role.name, action);
+register_role {
-		policy = inherited_role:may(action, context);
+	name = "prosody:operator";
-		if policy ~= nil then
+	priority = 75;
-			return policy;
+	inherits = { "prosody:admin" };
-		end
+};
-	end
-	return false;
+-- Process custom roles from config
+local custom_roles = module:get_option("custom_roles", {});
+for n, role_config in ipairs(custom_roles) do
+	local ok, err = pcall(register_role, role_config);
+	if not ok then
+		module:log("error", "Error registering custom role %s: %s", role_config.name or tostring(n), err);
+	end
+end
+-- Process custom permissions from config
+local config_add_perms = module:get_option("add_permissions", {});
+local config_remove_perms = module:get_option("remove_permissions", {});
+for role_name, added_permissions in pairs(config_add_perms) do
+	if not role_registry[role_name] then
+		module:log("error", "Cannot add permissions to unknown role '%s'", role_name);
+	else
+		for _, permission in ipairs(added_permissions) do
+			role_registry[role_name]:set_permission(permission, true, true);
+		end
+	end
+end
+for role_name, removed_permissions in pairs(config_remove_perms) do
+	if not role_registry[role_name] then
+		module:log("error", "Cannot remove permissions from unknown role '%s'", role_name);
+	else
+		for _, permission in ipairs(removed_permissions) do
+			role_registry[role_name]:set_permission(permission, false, true);
+		end
+	end
 end
 -- Public API
 local config_operator_role_set = {
 	["prosody:operator"] = role_registry["prosody:operator"];
 };
 local config_admin_role_set = {
 	["prosody:admin"] = role_registry["prosody:admin"];
+};
+local default_role_set = {
+	["prosody:user"] = role_registry["prosody:user"];
 };
 function get_user_roles(user)
 	local bare_jid = user.."@"..host;
 	if config_global_admin_jids:contains(bare_jid) then
 		return config_operator_role_set;
 	elseif config_admin_jids:contains(bare_jid) then
 		return config_admin_role_set;
 	end
 	local role_names = role_store:get(user);
-	if not role_names then return {}; end
+	if not role_names then return default_role_set; end
-	local roles = {};
+	local user_roles = {};
 	for role_name in pairs(role_names) do
-		roles[role_name] = role_registry[role_name];
+		user_roles[role_name] = role_registry[role_name];
 	end
-	return roles;
+	return user_roles;
 end
-function set_user_roles(user, roles)
+function set_user_roles(user, user_roles)
-	role_store:set(user, roles)
+	role_store:set(user, user_roles)
 	return true;
 end
 function get_user_default_role(user)
-	local roles = get_user_roles(user);
+	local user_roles = get_user_roles(user);
-	if not roles then return nil; end
+	if not user_roles then return nil; end
 	local default_role;
-	for role_name, role_info in pairs(roles) do --luacheck: ignore 213/role_name
+	for role_name, role_info in pairs(user_roles) do --luacheck: ignore 213/role_name
-		if role_info.default and (not default_role or role_info.priority > default_role.priority) then
+		if role_info.default ~= false and (not default_role or role_info.priority > default_role.priority) then
 			default_role = role_info;
 		end
 	end
 	if not default_role then return nil; end
 	return default_role;
 		return role_registry["prosody:admin"];
 	end
 	return nil;
 end
-function set_jid_role(jid) -- luacheck: ignore 212
+function set_jid_role(jid, role_name) -- luacheck: ignore 212
 	return false;
 end
 function get_jids_with_role(role_name)
 	-- Fetch role users from storage
 	local role = role_registry[role_name];
 	if not role then
 		module:log("warn", "Attempt to add default permission for unknown role: %s", role_name);
 		return nil, "no-such-role";
 	end
-	if role.permissions[action] == nil then
+	if policy == nil then policy = true; end
-		if policy == nil then
+	module:log("debug", "Adding policy %s for permission %s on role %s", policy, action, role_name);
-			policy = true;
+	return role:set_permission(action, policy);
-		end
+end
-		module:log("debug", "Adding permission, role '%s' may '%s': %s", role_name, action, policy and "allow" or "deny");
-		role.permissions[action] = policy;
+function get_role_by_name(role_name)
-	end
+	return assert(role_registry[role_name], role_name);
-	return true;
+end
-end
-function get_role_info(role_name)
-	return role_registry[role_name];
-end

prosody

f299e570a0fe

plugins/mod_authz_internal.lua

Software / code / prosody

Comparison

plugins/mod_authz_internal.lua @ 12648:f299e570a0fe

Software `/` code `/` prosody