prosody-modules
d194d1012fd3
mod_restrict_xmpp/README.markdown
Software / code / prosody-modules
File
mod_restrict_xmpp/README.markdown @ 5931:d194d1012fd3
Updating dox for mod_rest. Ideas expressed / clarified:
1) Making clear that mod_rest isn't to be installed under VirtualHosts AND as a component.
2) Understanding some of the implications of this choice:
A) Changes to user authentication
B) How it affects subdomains
3) More consistent use of domain names for clarity.
4) Using different heading sizes to show scope of section.
Essentially, I added all the tidbits I had to clarify in getting this to work in my
own example.
| author | Ben Smith <bens@effortlessis.com> |
|---|---|
| date | Mon, 13 May 2024 13:25:13 -0700 |
| parent | 5791:62654f523c6a |
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.
