Comparison

plugins/mod_disco.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 12388:50fcd3879482
child 12977:74b9e05af71e
comparison
equal deleted inserted replaced
12641:e9865b0cfb89 12642:9061f9621330
6 -- COPYING file in the source package for more information. 6 -- COPYING file in the source package for more information.
7 -- 7 --
8 8
9 local get_children = require "core.hostmanager".get_children; 9 local get_children = require "core.hostmanager".get_children;
10 local is_contact_subscribed = require "core.rostermanager".is_contact_subscribed; 10 local is_contact_subscribed = require "core.rostermanager".is_contact_subscribed;
11 local um_is_admin = require "core.usermanager".is_admin;
12 local jid_split = require "util.jid".split; 11 local jid_split = require "util.jid".split;
13 local jid_bare = require "util.jid".bare; 12 local jid_bare = require "util.jid".bare;
14 local st = require "util.stanza" 13 local st = require "util.stanza"
15 local calculate_hash = require "util.caps".calculate_hash; 14 local calculate_hash = require "util.caps".calculate_hash;
16 15
160 if event.origin.type == "s2sin" then 159 if event.origin.type == "s2sin" then
161 event.features:add_child(get_server_caps_feature()); 160 event.features:add_child(get_server_caps_feature());
162 end 161 end
163 end); 162 end);
164 163
164 module:default_permission("prosody:admin", ":be-discovered-admin");
165
165 -- Handle disco requests to user accounts 166 -- Handle disco requests to user accounts
166 if module:get_host_type() ~= "local" then return end -- skip for components 167 if module:get_host_type() ~= "local" then return end -- skip for components
167 module:hook("iq-get/bare/http://jabber.org/protocol/disco#info:query", function(event) 168 module:hook("iq-get/bare/http://jabber.org/protocol/disco#info:query", function(event)
168 local origin, stanza = event.origin, event.stanza; 169 local origin, stanza = event.origin, event.stanza;
169 local node = stanza.tags[1].attr.node; 170 local node = stanza.tags[1].attr.node;
170 local username = jid_split(stanza.attr.to) or origin.username; 171 local username = jid_split(stanza.attr.to) or origin.username;
171 local is_admin = um_is_admin(stanza.attr.to or origin.full_jid, module.host) 172 local target_is_admin = module:may(":be-discovered-admin", stanza.attr.to or origin.full_jid);
172 if not stanza.attr.to or (expose_admins and is_admin) or is_contact_subscribed(username, module.host, jid_bare(stanza.attr.from)) then 173 if not stanza.attr.to or (expose_admins and target_is_admin) or is_contact_subscribed(username, module.host, jid_bare(stanza.attr.from)) then
173 if node and node ~= "" then 174 if node and node ~= "" then
174 local reply = st.reply(stanza):tag('query', {xmlns='http://jabber.org/protocol/disco#info', node=node}); 175 local reply = st.reply(stanza):tag('query', {xmlns='http://jabber.org/protocol/disco#info', node=node});
175 if not reply.attr.from then reply.attr.from = origin.username.."@"..origin.host; end -- COMPAT To satisfy Psi when querying own account 176 if not reply.attr.from then reply.attr.from = origin.username.."@"..origin.host; end -- COMPAT To satisfy Psi when querying own account
176 local node_event = { origin = origin, stanza = stanza, reply = reply, node = node, exists = false}; 177 local node_event = { origin = origin, stanza = stanza, reply = reply, node = node, exists = false};
177 local ret = module:fire_event("account-disco-info-node", node_event); 178 local ret = module:fire_event("account-disco-info-node", node_event);
183 end 184 end
184 return true; 185 return true;
185 end 186 end
186 local reply = st.reply(stanza):tag('query', {xmlns='http://jabber.org/protocol/disco#info'}); 187 local reply = st.reply(stanza):tag('query', {xmlns='http://jabber.org/protocol/disco#info'});
187 if not reply.attr.from then reply.attr.from = origin.username.."@"..origin.host; end -- COMPAT To satisfy Psi when querying own account 188 if not reply.attr.from then reply.attr.from = origin.username.."@"..origin.host; end -- COMPAT To satisfy Psi when querying own account
188 if is_admin then 189 if target_is_admin then
189 reply:tag('identity', {category='account', type='admin'}):up(); 190 reply:tag('identity', {category='account', type='admin'}):up();
190 elseif prosody.hosts[module.host].users.name == "anonymous" then 191 elseif prosody.hosts[module.host].users.name == "anonymous" then
191 reply:tag('identity', {category='account', type='anonymous'}):up(); 192 reply:tag('identity', {category='account', type='anonymous'}):up();
192 else 193 else
193 reply:tag('identity', {category='account', type='registered'}):up(); 194 reply:tag('identity', {category='account', type='registered'}):up();