view mod_drop_chatstates/README.md @ 6319:04c3273cb81f

mod_auth_cyrus: Add empty 'profile' table to SASL handler objects This is for compatibility with Prosody's built-in util.sasl objects. A SASL profile table usually includes methods supported by the backend, which can be used by SASL mechanism handlers to perform operations (such as testing the password). It also optionally contains a 'cb' field with channel binding method handlers. The Cyrus backend doesn't support channel binding, and doesn't have the same concept of auth backend methods (it handles all that internally, and Prosody has no insight or control over it). Thus, we create an empty profile which informs Prosody that the SASL handler does not support any of the auth or channel binding methods. Some features will not work, but they didn't work anyway. This just makes it explicit. This fixes a traceback in mod_sasl2_fast, which expected SASL handlers to always contain a 'profile' field.
author Matthew Wild <mwild1@gmail.com>
date Thu, 04 Sep 2025 10:14:46 +0100
parents 92e2dcf039d9
children
line wrap: on
line source

---
labels:
- 'Stage-Alpha'
- 'Type-Web'
summary: Drop chatstates for specific domains.
rockspec:
  build:
    modules:
      mod_drop_chatstates: mod_drop_chatstates.lua
...

Introduction
============

This is a Prosody module to drop chatstates for specific domains.

Clients that request chatstates to virtual JIDs (i.e. those created by
modules like mod\_voipms to send/receive SMS/MMS on domains like
'sms.example.com') will, by design, receive errors indicating the
service is unavailable. While most clients will silently ignore this,
clients like profanity will not. This module allows us to drop responses
for chatstates on selected domains if we know they will never respond.

Configuration
=============

| option                    | type   | default | description
|---------------------------|--------|---------|-------------------------------|
| drop\_chatstates\_domains | table  | {}      | Domains to drop chatstates for

Sample module configuration:

```
modules_enabled = {
    "drop_chatstates";
}
drop_chatstates_domains = { "sms.example.com" }
```