prosody-modules
tip
mod_restrict_xmpp/README.md
Software / code / prosody-modules
Comparison
mod_restrict_xmpp/README.md @ 6211:750d64c47ec6 draft default tip
Merge
| author | Trần H. Trung <xmpp:trần.h.trung@trung.fun> |
|---|---|
| date | Tue, 18 Mar 2025 00:31:36 +0700 |
| parent | 6003:fe081789f7b5 |
comparison
equal
deleted
inserted
replaced
| 6210:24316a399978 | 6211:750d64c47ec6 |
|---|---|
| 1 --- | |
| 2 labels: | |
| 3 - Stage-Alpha | |
| 4 summary: XMPP-layer access control for Prosody | |
| 5 --- | |
| 6 | |
| 7 Introduction | |
| 8 ============ | |
| 9 | |
| 10 This module enforces access policies using Prosody's new [roles and | |
| 11 permissions framework](https://prosody.im/doc/developers/permissions). It can | |
| 12 be used to grant restricted access to an XMPP account or services. | |
| 13 | |
| 14 This module is still in its early stages, and prone to change. Feedback from | |
| 15 testers is welcome. At this early stage, it should not be solely relied upon | |
| 16 for account security purposes. | |
| 17 | |
| 18 Configuration | |
| 19 ============= | |
| 20 | |
| 21 There is no configuration, apart from Prosody's normal roles and permissions | |
| 22 configuration. | |
| 23 | |
| 24 Permissions | |
| 25 =========== | |
| 26 | |
| 27 `xmpp:federate` | |
| 28 : Communicate with other users and services on other hosts on the XMPP | |
| 29 network | |
| 30 | |
| 31 `xmpp:account:messages:read` | |
| 32 : Read incoming messages | |
| 33 | |
| 34 `xmpp:account:messages:write` | |
| 35 : Send outgoing messages | |
| 36 | |
| 37 `xmpp:account:presence:write` | |
| 38 : Update presence for the account | |
| 39 | |
| 40 `xmpp:account:contacts:read`/`xmpp:account:contacts:write` | |
| 41 : Controls access to the contact list (roster) | |
| 42 | |
| 43 `xmpp:account:bookmarks:read`/`xmpp:account:bookmarks:write` | |
| 44 : Controls access to the bookmarks (group chats list) | |
| 45 | |
| 46 `xmpp:account:profile:read`/`xmpp:account:profile:write` | |
| 47 : Controls access to the user's profile (e.g. vCard/avatar) | |
| 48 | |
| 49 `xmpp:account:omemo:read`/`xmpp:account:omemo:write` | |
| 50 : Controls access to the user's OMEMO data | |
| 51 | |
| 52 `xmpp:account:blocklist:read`/`xmpp:account:blocklist:write` | |
| 53 : Controls access to the user's block list | |
| 54 | |
| 55 `xmpp:account:disco:read` | |
| 56 : Controls access to the user's service discovery information | |
| 57 | |
| 58 Compatibility | |
| 59 ============= | |
| 60 | |
| 61 Requires Prosody trunk 72f431b4dc2c (build 1444) or later. |
