annotate mod_csi_simple_compat/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 fe081789f7b5
children 59d42b883f12
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4006
fcea7cf91702 mod_csi_simple_compat: Module for Prosody 0.11 that adds a setting available from Prosody 0.12
Kim Alvefur <zash@zash.se>
parents:
diff changeset
1 # About
fcea7cf91702 mod_csi_simple_compat: Module for Prosody 0.11 that adds a setting available from Prosody 0.12
Kim Alvefur <zash@zash.se>
parents:
diff changeset
2
fcea7cf91702 mod_csi_simple_compat: Module for Prosody 0.11 that adds a setting available from Prosody 0.12
Kim Alvefur <zash@zash.se>
parents:
diff changeset
3 This module allows using the [mod_csi_simple][doc:modules:mod_csi_simple]
fcea7cf91702 mod_csi_simple_compat: Module for Prosody 0.11 that adds a setting available from Prosody 0.12
Kim Alvefur <zash@zash.se>
parents:
diff changeset
4 setting `csi_important_payloads` (added in trunk/0.12) in Prosody 0.11.x.
fcea7cf91702 mod_csi_simple_compat: Module for Prosody 0.11 that adds a setting available from Prosody 0.12
Kim Alvefur <zash@zash.se>
parents:
diff changeset
5
fcea7cf91702 mod_csi_simple_compat: Module for Prosody 0.11 that adds a setting available from Prosody 0.12
Kim Alvefur <zash@zash.se>
parents:
diff changeset
6 # Config
fcea7cf91702 mod_csi_simple_compat: Module for Prosody 0.11 that adds a setting available from Prosody 0.12
Kim Alvefur <zash@zash.se>
parents:
diff changeset
7
fcea7cf91702 mod_csi_simple_compat: Module for Prosody 0.11 that adds a setting available from Prosody 0.12
Kim Alvefur <zash@zash.se>
parents:
diff changeset
8 ```
fcea7cf91702 mod_csi_simple_compat: Module for Prosody 0.11 that adds a setting available from Prosody 0.12
Kim Alvefur <zash@zash.se>
parents:
diff changeset
9 modules_enabled = {
fcea7cf91702 mod_csi_simple_compat: Module for Prosody 0.11 that adds a setting available from Prosody 0.12
Kim Alvefur <zash@zash.se>
parents:
diff changeset
10 -- other modules etc
fcea7cf91702 mod_csi_simple_compat: Module for Prosody 0.11 that adds a setting available from Prosody 0.12
Kim Alvefur <zash@zash.se>
parents:
diff changeset
11 "csi_simple",
fcea7cf91702 mod_csi_simple_compat: Module for Prosody 0.11 that adds a setting available from Prosody 0.12
Kim Alvefur <zash@zash.se>
parents:
diff changeset
12 "csi_simple_compat",
fcea7cf91702 mod_csi_simple_compat: Module for Prosody 0.11 that adds a setting available from Prosody 0.12
Kim Alvefur <zash@zash.se>
parents:
diff changeset
13 }
fcea7cf91702 mod_csi_simple_compat: Module for Prosody 0.11 that adds a setting available from Prosody 0.12
Kim Alvefur <zash@zash.se>
parents:
diff changeset
14
fcea7cf91702 mod_csi_simple_compat: Module for Prosody 0.11 that adds a setting available from Prosody 0.12
Kim Alvefur <zash@zash.se>
parents:
diff changeset
15 csi_important_payloads = {
fcea7cf91702 mod_csi_simple_compat: Module for Prosody 0.11 that adds a setting available from Prosody 0.12
Kim Alvefur <zash@zash.se>
parents:
diff changeset
16 -- Anything in this namespace:
fcea7cf91702 mod_csi_simple_compat: Module for Prosody 0.11 that adds a setting available from Prosody 0.12
Kim Alvefur <zash@zash.se>
parents:
diff changeset
17 "{urn:example:important-namespace}",
fcea7cf91702 mod_csi_simple_compat: Module for Prosody 0.11 that adds a setting available from Prosody 0.12
Kim Alvefur <zash@zash.se>
parents:
diff changeset
18 -- Specific element name and namespace:
fcea7cf91702 mod_csi_simple_compat: Module for Prosody 0.11 that adds a setting available from Prosody 0.12
Kim Alvefur <zash@zash.se>
parents:
diff changeset
19 "{urn:example:xmpp:priority}super-important",
fcea7cf91702 mod_csi_simple_compat: Module for Prosody 0.11 that adds a setting available from Prosody 0.12
Kim Alvefur <zash@zash.se>
parents:
diff changeset
20 }
fcea7cf91702 mod_csi_simple_compat: Module for Prosody 0.11 that adds a setting available from Prosody 0.12
Kim Alvefur <zash@zash.se>
parents:
diff changeset
21 ```
fcea7cf91702 mod_csi_simple_compat: Module for Prosody 0.11 that adds a setting available from Prosody 0.12
Kim Alvefur <zash@zash.se>
parents:
diff changeset
22
fcea7cf91702 mod_csi_simple_compat: Module for Prosody 0.11 that adds a setting available from Prosody 0.12
Kim Alvefur <zash@zash.se>
parents:
diff changeset
23 # Example
fcea7cf91702 mod_csi_simple_compat: Module for Prosody 0.11 that adds a setting available from Prosody 0.12
Kim Alvefur <zash@zash.se>
parents:
diff changeset
24
fcea7cf91702 mod_csi_simple_compat: Module for Prosody 0.11 that adds a setting available from Prosody 0.12
Kim Alvefur <zash@zash.se>
parents:
diff changeset
25 ``` lua
fcea7cf91702 mod_csi_simple_compat: Module for Prosody 0.11 that adds a setting available from Prosody 0.12
Kim Alvefur <zash@zash.se>
parents:
diff changeset
26 csi_important_payloads = {
fcea7cf91702 mod_csi_simple_compat: Module for Prosody 0.11 that adds a setting available from Prosody 0.12
Kim Alvefur <zash@zash.se>
parents:
diff changeset
27 -- XEP-0353: Jingle Message Initiation
fcea7cf91702 mod_csi_simple_compat: Module for Prosody 0.11 that adds a setting available from Prosody 0.12
Kim Alvefur <zash@zash.se>
parents:
diff changeset
28 "{urn:xmpp:jingle-message:0}",
fcea7cf91702 mod_csi_simple_compat: Module for Prosody 0.11 that adds a setting available from Prosody 0.12
Kim Alvefur <zash@zash.se>
parents:
diff changeset
29 }
fcea7cf91702 mod_csi_simple_compat: Module for Prosody 0.11 that adds a setting available from Prosody 0.12
Kim Alvefur <zash@zash.se>
parents:
diff changeset
30 ```
fcea7cf91702 mod_csi_simple_compat: Module for Prosody 0.11 that adds a setting available from Prosody 0.12
Kim Alvefur <zash@zash.se>
parents:
diff changeset
31