comparison core/sessionmanager.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
parents 3f1a865e9419
children f299e570a0fe
comparison
equal deleted inserted replaced
12641:e9865b0cfb89 12642:9061f9621330
121 end 121 end
122 122
123 retire_session(session); 123 retire_session(session);
124 end 124 end
125 125
126 local function make_authenticated(session, username, scope) 126 local function make_authenticated(session, username, role_name)
127 username = nodeprep(username); 127 username = nodeprep(username);
128 if not username or #username == 0 then return nil, "Invalid username"; end 128 if not username or #username == 0 then return nil, "Invalid username"; end
129 session.username = username; 129 session.username = username;
130 if session.type == "c2s_unauthed" then 130 if session.type == "c2s_unauthed" then
131 session.type = "c2s_unbound"; 131 session.type = "c2s_unbound";
132 end 132 end
133 session.auth_scope = scope; 133
134 session.log("info", "Authenticated as %s@%s", username, session.host or "(unknown)"); 134 local role;
135 if role_name then
136 role = hosts[session.host].authz.get_role_info(role_name);
137 else
138 role = hosts[session.host].authz.get_user_default_role(username);
139 end
140 if role then
141 sessionlib.set_role(session, role);
142 end
143 session.log("info", "Authenticated as %s@%s [%s]", username, session.host or "(unknown)", role and role.name or "no role");
135 return true; 144 return true;
136 end 145 end
137 146
138 -- returns true, nil on success 147 -- returns true, nil on success
139 -- returns nil, err_type, err, err_message on failure 148 -- returns nil, err_type, err, err_message on failure