Kim Alvefur <zash@zash.se> [Wed, 20 Jul 2022 13:05:35 +0200] rev 12654
moduleapi: Distribute permissions set from global modules to all hosts
Roles and permissions will always happen in the context of a host.
Prevents error upon indexing since `hosts["*"] == nil`
Matthew Wild <mwild1@gmail.com> [Wed, 20 Jul 2022 10:52:17 +0100] rev 12653
mod_tokenauth: New API that better fits how modules are using token auth
This also updates the module to the new role API, and improves support for
scope/role selection (currently treated as the same thing, which they almost
are).
Matthew Wild <mwild1@gmail.com> [Tue, 19 Jul 2022 18:02:02 +0100] rev 12652
mod_authz_internal: Use util.roles, some API changes and config support
This commit was too awkward to split (hg record didn't like it), so:
- Switch to the new util.roles lib to provide a consistent representation of
a role object.
- Change API method from get_role_info() to get_role_by_name() (touches
sessionmanager and usermanager)
- Change get_roles() to get_user_roles(), take a username instead of a JID
This is more consistent with all other usermanager API methods.
- Support configuration of custom roles and permissions via the config file
(to be documented).
Matthew Wild <mwild1@gmail.com> [Tue, 19 Jul 2022 17:44:26 +0100] rev 12651
util.roles: Add new utility module to consolidate role objects and methods
Matthew Wild <mwild1@gmail.com> [Tue, 12 Jul 2022 13:14:47 +0100] rev 12650
usermanager, mod_auth_*: Add get_account_info() returning creation/update time
This is useful for a number of things. For example, listing users that need to
rotate their passwords after some event. It also provides a safer way for code
to determine that a user password has changed without needing to set a handler
for the password change event (which is a more fragile approach).
Kim Alvefur <zash@zash.se> [Wed, 15 Jun 2022 23:04:17 +0200] rev 12649
core.moduleapi: Expand permission name ':' prefix earlier
Ensures it applies to the context as string case
Somehow this fixes everything
Kim Alvefur <zash@zash.se> [Wed, 15 Jun 2022 23:03:15 +0200] rev 12648
core.moduleapi: Fixup method name
`get_user_role()` did not exist anywhere else.
MattJ said `get_user_default_role()` was indented
Matthew Wild <mwild1@gmail.com> [Wed, 15 Jun 2022 14:22:26 +0100] rev 12647
teal-src: update module.d.tl with new access control methods
Matthew Wild <mwild1@gmail.com> [Wed, 15 Jun 2022 12:15:01 +0100] rev 12646
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.
Matthew Wild <mwild1@gmail.com> [Wed, 15 Jun 2022 11:47:39 +0100] rev 12645
mod_saslauth: Rename field from 'scope'->'role'
The 'scope' term derives from OAuth, and represents a bundle of permissions.
We're now setting on the term 'role' for a bundle of permissions.
This change does not affect any public modules I'm aware of.