annotate mod_rtbl/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 77b5dd33a8f3
children e7926245c88d
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6301
77b5dd33a8f3 mod_rtbl: New generic API module for subscribing to RTBLs via XEP-0060
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
1 ---
77b5dd33a8f3 mod_rtbl: New generic API module for subscribing to RTBLs via XEP-0060
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
2 summary:
77b5dd33a8f3 mod_rtbl: New generic API module for subscribing to RTBLs via XEP-0060
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
3 rockspec:
77b5dd33a8f3 mod_rtbl: New generic API module for subscribing to RTBLs via XEP-0060
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
4 dependencies:
77b5dd33a8f3 mod_rtbl: New generic API module for subscribing to RTBLs via XEP-0060
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
5 - mod_pubsub_subscription
77b5dd33a8f3 mod_rtbl: New generic API module for subscribing to RTBLs via XEP-0060
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
6 labels:
77b5dd33a8f3 mod_rtbl: New generic API module for subscribing to RTBLs via XEP-0060
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
7 - Stage-Alpha
77b5dd33a8f3 mod_rtbl: New generic API module for subscribing to RTBLs via XEP-0060
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
8 ...
77b5dd33a8f3 mod_rtbl: New generic API module for subscribing to RTBLs via XEP-0060
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
9
77b5dd33a8f3 mod_rtbl: New generic API module for subscribing to RTBLs via XEP-0060
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
10 This module allows other modules to subscribe to real-time blocklists using
77b5dd33a8f3 mod_rtbl: New generic API module for subscribing to RTBLs via XEP-0060
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
11 pubsub (XEP-0060). As entries are added and removed from the blocklist, it
77b5dd33a8f3 mod_rtbl: New generic API module for subscribing to RTBLs via XEP-0060
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
12 notifies other modules so they can perform appropriate actions.
77b5dd33a8f3 mod_rtbl: New generic API module for subscribing to RTBLs via XEP-0060
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
13
77b5dd33a8f3 mod_rtbl: New generic API module for subscribing to RTBLs via XEP-0060
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
14 # Configuring
77b5dd33a8f3 mod_rtbl: New generic API module for subscribing to RTBLs via XEP-0060
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
15
77b5dd33a8f3 mod_rtbl: New generic API module for subscribing to RTBLs via XEP-0060
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
16 This module does not do anything on its own. It **should not** be
77b5dd33a8f3 mod_rtbl: New generic API module for subscribing to RTBLs via XEP-0060
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
17 added directly to your configuration file.
77b5dd33a8f3 mod_rtbl: New generic API module for subscribing to RTBLs via XEP-0060
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
18
77b5dd33a8f3 mod_rtbl: New generic API module for subscribing to RTBLs via XEP-0060
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
19 Instead, you might want to look at modules which use mod\_rtbl, such as:
77b5dd33a8f3 mod_rtbl: New generic API module for subscribing to RTBLs via XEP-0060
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
20
77b5dd33a8f3 mod_rtbl: New generic API module for subscribing to RTBLs via XEP-0060
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
21 - mod\_anti\_spam
77b5dd33a8f3 mod_rtbl: New generic API module for subscribing to RTBLs via XEP-0060
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
22 - mod\_muc\_rtbl
77b5dd33a8f3 mod_rtbl: New generic API module for subscribing to RTBLs via XEP-0060
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
23
77b5dd33a8f3 mod_rtbl: New generic API module for subscribing to RTBLs via XEP-0060
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
24 # Compatibility
77b5dd33a8f3 mod_rtbl: New generic API module for subscribing to RTBLs via XEP-0060
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
25
77b5dd33a8f3 mod_rtbl: New generic API module for subscribing to RTBLs via XEP-0060
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
26 Should work with Prosody >= 0.12.x