File

mod_restrict_xmpp/README.markdown @ 5979:d6a695abb33c

mod_ping_muc: Delay ping a configurable amount of time If a server is restarting, checking immediately before it has a chance to complete its restart and get ready would often fail, preventing the possibility of transparent restarts as supported by Prosody's mod_muc. Reconnecting immediately when a connection is closed for being idle, or because the remote server is trying to reclaim some resources, is also counter-productive as the connection may fail. Also, if there is some Internet routing problem affecting s2s, it may help to wait a bit before checking, in case the problem resolved itself in the mean time.
author Kim Alvefur <zash@zash.se>
date Sun, 11 Aug 2024 16:10:24 +0200
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.