Comparison

core/moduleapi.lua @ 12642:9061f9621330

Switch to a new role-based authorization framework, removing is_admin() We began moving away from simple "is this user an admin?" permission checks before 0.12, with the introduction of mod_authz_internal and the ability to dynamically change the roles of individual users. The approach in 0.12 still had various limitations however, and apart from the introduction of roles other than "admin" and the ability to pull that info from storage, not much actually changed. This new framework shakes things up a lot, though aims to maintain the same functionality and behaviour on the surface for a default Prosody configuration. That is, if you don't take advantage of any of the new features, you shouldn't notice any change. The biggest change visible to developers is that usermanager.is_admin() (and the auth provider is_admin() method) have been removed. Gone. Completely. Permission checks should now be performed using a new module API method: module:may(action_name, context) This method accepts an action name, followed by either a JID (string) or (preferably) a table containing 'origin'/'session' and 'stanza' fields (e.g. the standard object passed to most events). It will return true if the action should be permitted, or false/nil otherwise. Modules should no longer perform permission checks based on the role name. E.g. a lot of code previously checked if the user's role was prosody:admin before permitting some action. Since many roles might now exist with similar permissions, and the permissions of prosody:admin may be redefined dynamically, it is no longer suitable to use this method for permission checks. Use module:may(). If you start an action name with ':' (recommended) then the current module's name will automatically be used as a prefix. To define a new permission, use the new module API: module:default_permission(role_name, action_name) module:default_permissions(role_name, { action_name[, action_name...] }) This grants the specified role permission to execute the named action(s) by default. This may be overridden via other mechanisms external to your module. The built-in roles that developers should use are: - prosody:user (normal user) - prosody:admin (host admin) - prosody:operator (global admin) The new prosody:operator role is intended for server-wide actions (such as shutting down Prosody). Finally, all usage of is_admin() in modules has been fixed by this commit. Some of these changes were trickier than others, but no change is expected to break existing deployments. EXCEPT: mod_auth_ldap no longer supports the ldap_admin_filter option. It's very possible nobody is using this, but if someone is then we can later update it to pull roles from LDAP somehow.
author Matthew Wild <mwild1@gmail.com>
date Wed, 15 Jun 2022 12:15:01 +0100
parent 12590:5eaf77114fdb
child 12644:4262ce516e6c
comparison
equal deleted inserted replaced
12641:e9865b0cfb89 12642:9061f9621330
17 local errors = require "util.error"; 17 local errors = require "util.error";
18 local promise = require "util.promise"; 18 local promise = require "util.promise";
19 local time_now = require "util.time".now; 19 local time_now = require "util.time".now;
20 local format = require "util.format".format; 20 local format = require "util.format".format;
21 local jid_node = require "util.jid".node; 21 local jid_node = require "util.jid".node;
22 local jid_split = require "util.jid".split;
22 local jid_resource = require "util.jid".resource; 23 local jid_resource = require "util.jid".resource;
23 24
24 local t_insert, t_remove, t_concat = table.insert, table.remove, table.concat; 25 local t_insert, t_remove, t_concat = table.insert, table.remove, table.concat;
25 local error, setmetatable, type = error, setmetatable, type; 26 local error, setmetatable, type = error, setmetatable, type;
26 local ipairs, pairs, select = ipairs, pairs, select; 27 local ipairs, pairs, select = ipairs, pairs, select;
599 600
600 function api:get_status() 601 function api:get_status()
601 return self.status_type, self.status_message, self.status_time; 602 return self.status_type, self.status_message, self.status_time;
602 end 603 end
603 604
605 function api:default_permission(role_name, permission)
606 permission = permission:gsub("^:", self.name..":");
607 hosts[self.host].authz.add_default_permission(role_name, permission);
608 end
609
610 function api:default_permissions(role_name, permissions)
611 for _, permission in ipairs(permissions) do
612 permission = permission:gsub("^:", self.name..":");
613 self:default_permission(role_name, permission);
614 end
615 end
616
617 function api:may(action, context)
618 if type(context) == "string" then -- check JID permissions
619 local role;
620 local node, host = jid_split(context);
621 if host == self.host then
622 role = hosts[host].authz.get_user_role(node);
623 else
624 role = hosts[self.host].authz.get_jid_role(context);
625 end
626 if not role then
627 self:log("debug", "Access denied: JID <%s> may not %s (no role found)", context, action);
628 return false;
629 end
630 local permit = role:may(action);
631 if not permit then
632 self:log("debug", "Access denied: JID <%s> may not %s (not permitted by role %s)", context, action, role.name);
633 end
634 return permit;
635 end
636
637 local session = context.origin or context.session;
638 if not session then
639 error("Unable to identify actor session from context");
640 end
641 if action:byte(1) == 58 then -- action begins with ':'
642 action = self.name..action; -- prepend module name
643 end
644 if session.type == "s2sin" or (session.type == "c2s" and session.host ~= self.host) then
645 local actor_jid = context.stanza.attr.from;
646 local role = hosts[self.host].authz.get_jid_role(actor_jid);
647 if not role then
648 self:log("debug", "Access denied: JID <%s> may not %s (no role found)", actor_jid, action);
649 return false;
650 end
651 local permit = role:may(action, context);
652 if not permit then
653 self:log("debug", "Access denied: JID <%s> may not %s (not permitted by role %s)", actor_jid, action, role.name);
654 end
655 return permit;
656 elseif session.role then
657 local permit = session.role:may(action, context);
658 if not permit then
659 self:log("debug", "Access denied: session %s (%s) may not %s (not permitted by role %s)",
660 session.id, session.full_jid, action, session.role.name
661 );
662 end
663 return permit;
664 end
665 end
666
604 return api; 667 return api;