Software /
code /
prosody
File
plugins/muc/request.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 | 9703:0cfb7b3593eb |
child | 12977:74b9e05af71e |
line wrap: on
line source
-- Prosody IM -- Copyright (C) 2008-2010 Matthew Wild -- Copyright (C) 2008-2010 Waqas Hussain -- Copyright (C) 2014 Daurnimator -- -- This project is MIT/X11 licensed. Please see the -- COPYING file in the source package for more information. -- local st = require "util.stanza"; local jid_resource = require "util.jid".resource; module:hook("muc-disco#info", function(event) event.reply:tag("feature", {var = "http://jabber.org/protocol/muc#request"}):up(); end); local voice_request_form = require "util.dataforms".new({ title = "Voice Request"; { name = "FORM_TYPE"; type = "hidden"; value = "http://jabber.org/protocol/muc#request"; }, { name = "muc#jid"; type = "jid-single"; label = "User ID"; desc = "The user's JID (address)"; }, { name = "muc#roomnick"; type = "text-single"; label = "Room nickname"; desc = "The user's nickname within the room"; }, { name = "muc#role"; type = "list-single"; label = "Requested role"; value = "participant"; options = { "none", "visitor", "participant", "moderator", }; }, { name = "muc#request_allow"; type = "boolean"; label = "Grant voice to this person?"; desc = "Specify whether this person is able to speak in a moderated room"; value = false; } }); local function handle_request(room, origin, stanza, form) local occupant = room:get_occupant_by_real_jid(stanza.attr.from); local fields = voice_request_form:data(form); local event = { room = room; origin = origin; stanza = stanza; fields = fields; occupant = occupant; }; if occupant.role == "moderator" then module:log("debug", "%s responded to a voice request in %s", jid_resource(occupant.nick), room.jid); module:fire_event("muc-voice-response", event); else module:log("debug", "%s requested voice in %s", jid_resource(occupant.nick), room.jid); module:fire_event("muc-voice-request", event); end end module:hook("muc-voice-request", function(event) if event.occupant.role == "visitor" then local nick = jid_resource(event.occupant.nick); local formdata = { ["muc#jid"] = event.stanza.attr.from; ["muc#roomnick"] = nick; }; local message = st.message({ type = "normal"; from = event.room.jid }) :add_child(voice_request_form:form(formdata)); event.room:broadcast(message, function (_, occupant) return occupant.role == "moderator"; end); end end); module:hook("muc-voice-response", function(event) local actor = event.stanza.attr.from; local affected_occupant = event.room:get_occupant_by_real_jid(event.fields["muc#jid"]); local occupant = event.occupant; if occupant.role ~= "moderator" then module:log("debug", "%s tried to grant voice but wasn't a moderator", jid_resource(occupant.nick)); return; end if not event.fields["muc#request_allow"] then module:log("debug", "%s did not grant voice", jid_resource(occupant.nick)); return; end if not affected_occupant then module:log("debug", "%s tried to grant voice to unknown occupant %s", jid_resource(occupant.nick), event.fields["muc#jid"]); return; end if affected_occupant.role ~= "visitor" then module:log("debug", "%s tried to grant voice to %s but they already have it", jid_resource(occupant.nick), jid_resource(occupant.jid)); return; end module:log("debug", "%s granted voice to %s", jid_resource(event.occupant.nick), jid_resource(occupant.jid)); local ok, errtype, err = event.room:set_role(actor, affected_occupant.nick, "participant", "Voice granted"); if not ok then module:log("debug", "Error granting voice: %s", err or errtype); event.origin.send(st.error_reply(event.stanza, errtype, err)); end end); return { handle_request = handle_request; };