prosody-modules
f77f5e408d6a
mod_restrict_xmpp/README.md

Find changesets by keywords by author, files, the commit message, revision number or hash, or revset expression.

Software / code / prosody-modules

File

mod_restrict_xmpp/README.md @ 6150:f77f5e408d6a

mod_sasl2_fast: Restore non-FAST SASL handler upon reset This fixes an issue where, after failed FAST authentication, the FAST handler was still used (even though the client now wants to try with a password or other non-FAST credentials). A little hacky perhaps, but probably the best we can do without baking FAST support directly into mod_sasl2.
author Matthew Wild <mwild1@gmail.com>
date Thu, 16 Jan 2025 15:46:15 +0000
parent 6003:fe081789f7b5
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.