Comparison

plugins/muc/persistent.lib.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 9053:ea9e1f8f3013
child 12729:73a45ba6e3f1
comparison
equal deleted inserted replaced
12641:e9865b0cfb89 12642:9061f9621330
6 -- This project is MIT/X11 licensed. Please see the 6 -- This project is MIT/X11 licensed. Please see the
7 -- COPYING file in the source package for more information. 7 -- COPYING file in the source package for more information.
8 -- 8 --
9 9
10 local restrict_persistent = not module:get_option_boolean("muc_room_allow_persistent", true); 10 local restrict_persistent = not module:get_option_boolean("muc_room_allow_persistent", true);
11 local um_is_admin = require "core.usermanager".is_admin; 11 module:default_permission(
12 restrict_persistent and "prosody:admin" or "prosody:user",
13 ":create-persistent-room"
14 );
12 15
13 local function get_persistent(room) 16 local function get_persistent(room)
14 return room._data.persistent; 17 return room._data.persistent;
15 end 18 end
16 19
20 room._data.persistent = persistent; 23 room._data.persistent = persistent;
21 return true; 24 return true;
22 end 25 end
23 26
24 module:hook("muc-config-form", function(event) 27 module:hook("muc-config-form", function(event)
25 if restrict_persistent and not um_is_admin(event.actor, module.host) then 28 if not module:may(":create-persistent-room", event.actor) then
26 -- Don't show option if hidden rooms are restricted and user is not admin of this host 29 -- Hide config option if this user is not allowed to create persistent rooms
27 return; 30 return;
28 end 31 end
29 table.insert(event.form, { 32 table.insert(event.form, {
30 name = "muc#roomconfig_persistentroom"; 33 name = "muc#roomconfig_persistentroom";
31 type = "boolean"; 34 type = "boolean";
34 value = get_persistent(event.room); 37 value = get_persistent(event.room);
35 }); 38 });
36 end, 100-5); 39 end, 100-5);
37 40
38 module:hook("muc-config-submitted/muc#roomconfig_persistentroom", function(event) 41 module:hook("muc-config-submitted/muc#roomconfig_persistentroom", function(event)
39 if restrict_persistent and not um_is_admin(event.actor, module.host) then 42 if not module:may(":create-persistent-room", event.actor) then
40 return; -- Not allowed 43 return; -- Not allowed
41 end 44 end
42 if set_persistent(event.room, event.value) then 45 if set_persistent(event.room, event.value) then
43 event.status_codes["104"] = true; 46 event.status_codes["104"] = true;
44 end 47 end