Software /
code /
prosody
File
spec/scansion/muc_subject_issue_667.scs @ 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 | 9708:6507df6d2c55 |
child | 13414:d54364746a7c |
line wrap: on
line source
# #667 MUC message with subject and body SHALL NOT be interpreted as a subject change [Client] Romeo password: password jid: romeo@localhost ----- Romeo connects # and creates a room Romeo sends: <presence to="issue667@conference.localhost/Romeo"> <x xmlns="http://jabber.org/protocol/muc"/> </presence> Romeo receives: <presence from="issue667@conference.localhost/Romeo"> <x xmlns="http://jabber.org/protocol/muc#user"> <status code="201"/> <item affiliation="owner" role="moderator" jid="${Romeo's full JID}"/> <status code="110"/> </x> </presence> # the default (empty) subject Romeo receives: <message type="groupchat" from="issue667@conference.localhost"> <subject/> </message> # this should be treated as a normal message Romeo sends: <message to="issue667@conference.localhost" type="groupchat"> <subject>Greetings</subject> <body>Hello everyone</body> </message> Romeo receives: <message type="groupchat" from="issue667@conference.localhost/Romeo"> <subject>Greetings</subject> <body>Hello everyone</body> </message> # Resync Romeo sends: <presence to="issue667@conference.localhost/Romeo"> <x xmlns="http://jabber.org/protocol/muc"/> </presence> # Presences Romeo receives: <presence from="issue667@conference.localhost/Romeo"> <x xmlns="http://jabber.org/protocol/muc#user"> <item affiliation="owner" role="moderator" jid="${Romeo's full JID}"/> <status code="110"/> </x> </presence> Romeo receives: <message type="groupchat" from="issue667@conference.localhost/Romeo"> <subject>Greetings</subject> <body>Hello everyone</body> </message> # the still empty subject Romeo receives: <message type="groupchat" from="issue667@conference.localhost"> <subject/> </message> # this is a subject change Romeo sends: <message to="issue667@conference.localhost" type="groupchat"> <subject>Something to talk about</subject> </message> Romeo receives: <message type="groupchat" from="issue667@conference.localhost/Romeo"> <subject>Something to talk about</subject> </message> # a message without <subject> Romeo sends: <message to="issue667@conference.localhost" type="groupchat"> <body>Lorem ipsum dolor sit amet</body> </message> Romeo receives: <message type="groupchat" from="issue667@conference.localhost/Romeo"> <body>Lorem ipsum dolor sit amet</body> </message> # Resync Romeo sends: <presence to="issue667@conference.localhost/Romeo"> <x xmlns="http://jabber.org/protocol/muc"/> </presence> # Presences Romeo receives: <presence from="issue667@conference.localhost/Romeo"> <x xmlns="http://jabber.org/protocol/muc#user"> <item affiliation="owner" role="moderator" jid="${Romeo's full JID}"/> <status code="110"/> </x> </presence> # History # These have delay tags but we ignore those for now Romeo receives: <message type="groupchat" from="issue667@conference.localhost/Romeo"> <subject>Greetings</subject> <body>Hello everyone</body> </message> Romeo receives: <message type="groupchat" from="issue667@conference.localhost/Romeo"> <body>Lorem ipsum dolor sit amet</body> </message> # Finally, the topic Romeo receives: <message type="groupchat" from="issue667@conference.localhost/Romeo"> <subject>Something to talk about</subject> </message> Romeo disconnects