Mercurial > prosody-modules
view mod_restrict_xmpp/README.md @ 6319:04c3273cb81f
mod_auth_cyrus: Add empty 'profile' table to SASL handler objects
This is for compatibility with Prosody's built-in util.sasl objects.
A SASL profile table usually includes methods supported by the backend, which
can be used by SASL mechanism handlers to perform operations (such as testing
the password). It also optionally contains a 'cb' field with channel binding
method handlers.
The Cyrus backend doesn't support channel binding, and doesn't have the same
concept of auth backend methods (it handles all that internally, and Prosody
has no insight or control over it).
Thus, we create an empty profile which informs Prosody that the SASL handler
does not support any of the auth or channel binding methods. Some features
will not work, but they didn't work anyway. This just makes it explicit.
This fixes a traceback in mod_sasl2_fast, which expected SASL handlers to
always contain a 'profile' field.
| author | Matthew Wild <mwild1@gmail.com> |
|---|---|
| date | Thu, 04 Sep 2025 10:14:46 +0100 |
| parents | fe081789f7b5 |
| children |
line wrap: on
line source
--- labels: - Stage-Alpha summary: XMPP-layer access control for Prosody --- Introduction ============ This module enforces access policies using Prosody's new [roles and permissions framework](https://prosody.im/doc/developers/permissions). It can be used to grant restricted access to an XMPP account or services. This module is still in its early stages, and prone to change. Feedback from testers is welcome. At this early stage, it should not be solely relied upon for account security purposes. Configuration ============= There is no configuration, apart from Prosody's normal roles and permissions configuration. Permissions =========== `xmpp:federate` : Communicate with other users and services on other hosts on the XMPP network `xmpp:account:messages:read` : Read incoming messages `xmpp:account:messages:write` : Send outgoing messages `xmpp:account:presence:write` : Update presence for the account `xmpp:account:contacts:read`/`xmpp:account:contacts:write` : Controls access to the contact list (roster) `xmpp:account:bookmarks:read`/`xmpp:account:bookmarks:write` : Controls access to the bookmarks (group chats list) `xmpp:account:profile:read`/`xmpp:account:profile:write` : Controls access to the user's profile (e.g. vCard/avatar) `xmpp:account:omemo:read`/`xmpp:account:omemo:write` : Controls access to the user's OMEMO data `xmpp:account:blocklist:read`/`xmpp:account:blocklist:write` : Controls access to the user's block list `xmpp:account:disco:read` : Controls access to the user's service discovery information Compatibility ============= Requires Prosody trunk 72f431b4dc2c (build 1444) or later.