prosody-modules
f25df3af02c1
mod_restrict_xmpp/README.markdown

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.markdown @ 5516:f25df3af02c1

mod_client_management: Include client software version number in listing Should you ever wish to revoke a client by version number, e.g. for security reasons affecting certain versions, then it would be good to at the very least see which version is used. Also includes the OAuth2 software ID, an optional unique identifier that should be the same for all installations of a particular software.
author Kim Alvefur <zash@zash.se>
date Sat, 03 Jun 2023 19:21:39 +0200
parent 5009:459a4001c1d9
child 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.