Software /
code /
prosody
Comparison
core/usermanager.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 | 12333:ed8a4f8dfd27 |
child | 12646:3f38f4735c7a |
comparison
equal
deleted
inserted
replaced
12641:e9865b0cfb89 | 12642:9061f9621330 |
---|---|
184 end | 184 end |
185 return ok, err; | 185 return ok, err; |
186 else -- Remote entity | 186 else -- Remote entity |
187 return authz_provider.set_jid_roles(jid, roles) | 187 return authz_provider.set_jid_roles(jid, roles) |
188 end | 188 end |
189 end | |
190 | |
191 local function is_admin(jid, host) | |
192 local roles = get_roles(jid, host); | |
193 return roles and roles["prosody:admin"]; | |
194 end | 189 end |
195 | 190 |
196 local function get_users_with_role(role, host) | 191 local function get_users_with_role(role, host) |
197 if not hosts[host] then return false; end | 192 if not hosts[host] then return false; end |
198 if type(role) ~= "string" then return false; end | 193 if type(role) ~= "string" then return false; end |
222 users = users; | 217 users = users; |
223 get_sasl_handler = get_sasl_handler; | 218 get_sasl_handler = get_sasl_handler; |
224 get_provider = get_provider; | 219 get_provider = get_provider; |
225 get_roles = get_roles; | 220 get_roles = get_roles; |
226 set_roles = set_roles; | 221 set_roles = set_roles; |
227 is_admin = is_admin; | |
228 get_users_with_role = get_users_with_role; | 222 get_users_with_role = get_users_with_role; |
229 get_jids_with_role = get_jids_with_role; | 223 get_jids_with_role = get_jids_with_role; |
230 }; | 224 }; |