annotate mod_sasl2/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 86989059de5b
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4798
957ac41bc70a mod_sasl2: Add initial README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
1 ---
957ac41bc70a mod_sasl2: Add initial README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
2 labels:
5089
5b77f4720bfe mod_sasl2: Update and expand README with more (and updated) information
Matthew Wild <mwild1@gmail.com>
parents: 5064
diff changeset
3 - Stage-Beta
4798
957ac41bc70a mod_sasl2: Add initial README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
4 summary: "XEP-0388: Extensible SASL Profile"
957ac41bc70a mod_sasl2: Add initial README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
5 ---
957ac41bc70a mod_sasl2: Add initial README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
6
6033
26bfcb442138 mod_sasl2: update README.md, the mentioned xep is stable now and not in the inbox anymore.
Menel <menel@snikket.de>
parents: 5937
diff changeset
7 Implementation of [XEP-0388: Extensible SASL Profile].
5089
5b77f4720bfe mod_sasl2: Update and expand README with more (and updated) information
Matthew Wild <mwild1@gmail.com>
parents: 5064
diff changeset
8
5b77f4720bfe mod_sasl2: Update and expand README with more (and updated) information
Matthew Wild <mwild1@gmail.com>
parents: 5064
diff changeset
9 ## Configuration
5b77f4720bfe mod_sasl2: Update and expand README with more (and updated) information
Matthew Wild <mwild1@gmail.com>
parents: 5064
diff changeset
10
5b77f4720bfe mod_sasl2: Update and expand README with more (and updated) information
Matthew Wild <mwild1@gmail.com>
parents: 5064
diff changeset
11 This module honours the same configuration options as Prosody's existing
5b77f4720bfe mod_sasl2: Update and expand README with more (and updated) information
Matthew Wild <mwild1@gmail.com>
parents: 5064
diff changeset
12 [mod_saslauth](https://prosody.im/doc/modules/mod_saslauth).
5064
7d33178c79f2 mod_sasl2: Add some brief dev notes about events to the README
Matthew Wild <mwild1@gmail.com>
parents: 4798
diff changeset
13
7d33178c79f2 mod_sasl2: Add some brief dev notes about events to the README
Matthew Wild <mwild1@gmail.com>
parents: 4798
diff changeset
14 ## Developers
7d33178c79f2 mod_sasl2: Add some brief dev notes about events to the README
Matthew Wild <mwild1@gmail.com>
parents: 4798
diff changeset
15
7d33178c79f2 mod_sasl2: Add some brief dev notes about events to the README
Matthew Wild <mwild1@gmail.com>
parents: 4798
diff changeset
16 mod_sasl2 provides some events you can hook to affect aspects of the
7d33178c79f2 mod_sasl2: Add some brief dev notes about events to the README
Matthew Wild <mwild1@gmail.com>
parents: 4798
diff changeset
17 authentication process:
7d33178c79f2 mod_sasl2: Add some brief dev notes about events to the README
Matthew Wild <mwild1@gmail.com>
parents: 4798
diff changeset
18
7d33178c79f2 mod_sasl2: Add some brief dev notes about events to the README
Matthew Wild <mwild1@gmail.com>
parents: 4798
diff changeset
19 - `advertise-sasl-features`
7d33178c79f2 mod_sasl2: Add some brief dev notes about events to the README
Matthew Wild <mwild1@gmail.com>
parents: 4798
diff changeset
20 - `sasl2/c2s/success`
7d33178c79f2 mod_sasl2: Add some brief dev notes about events to the README
Matthew Wild <mwild1@gmail.com>
parents: 4798
diff changeset
21 - Priority 1000: Session marked as authenticated, success response created (`event.success`)
7d33178c79f2 mod_sasl2: Add some brief dev notes about events to the README
Matthew Wild <mwild1@gmail.com>
parents: 4798
diff changeset
22 - Priority -1000: Success response sent to client
7d33178c79f2 mod_sasl2: Add some brief dev notes about events to the README
Matthew Wild <mwild1@gmail.com>
parents: 4798
diff changeset
23 - Priority -1500: Updated <stream-features/> sent to client
7d33178c79f2 mod_sasl2: Add some brief dev notes about events to the README
Matthew Wild <mwild1@gmail.com>
parents: 4798
diff changeset
24 - `sasl2/c2s/failure`
7d33178c79f2 mod_sasl2: Add some brief dev notes about events to the README
Matthew Wild <mwild1@gmail.com>
parents: 4798
diff changeset
25 - `sasl2/c2s/error`
5937
da942a3f3660 mod_sasl2: Clarify that this module requires Prosody trunk
Kim Alvefur <zash@zash.se>
parents: 5089
diff changeset
26
da942a3f3660 mod_sasl2: Clarify that this module requires Prosody trunk
Kim Alvefur <zash@zash.se>
parents: 5089
diff changeset
27 # Compatibility
da942a3f3660 mod_sasl2: Clarify that this module requires Prosody trunk
Kim Alvefur <zash@zash.se>
parents: 5089
diff changeset
28
da942a3f3660 mod_sasl2: Clarify that this module requires Prosody trunk
Kim Alvefur <zash@zash.se>
parents: 5089
diff changeset
29 This module requires Prosody **trunk** and is not compatible with 0.12 or older versions.
da942a3f3660 mod_sasl2: Clarify that this module requires Prosody trunk
Kim Alvefur <zash@zash.se>
parents: 5089
diff changeset
30
6033
26bfcb442138 mod_sasl2: update README.md, the mentioned xep is stable now and not in the inbox anymore.
Menel <menel@snikket.de>
parents: 5937
diff changeset
31
26bfcb442138 mod_sasl2: update README.md, the mentioned xep is stable now and not in the inbox anymore.
Menel <menel@snikket.de>
parents: 5937
diff changeset
32 Prosody Version Status
26bfcb442138 mod_sasl2: update README.md, the mentioned xep is stable now and not in the inbox anymore.
Menel <menel@snikket.de>
parents: 5937
diff changeset
33 ----------------------- ----------------
6217
694f8fab07d4 : mod_sasl2*** : Update Compability for all of them
Menel <menel@snikket.de>
parents: 6033
diff changeset
34 trunk as of 2025-05-25 Works
6224
86989059de5b :multibe Readme.md: correct prosody 0.13 to 13
Menel <menel@snikket.de>
parents: 6217
diff changeset
35 13 Works
6033
26bfcb442138 mod_sasl2: update README.md, the mentioned xep is stable now and not in the inbox anymore.
Menel <menel@snikket.de>
parents: 5937
diff changeset
36 0.12 Does not work
26bfcb442138 mod_sasl2: update README.md, the mentioned xep is stable now and not in the inbox anymore.
Menel <menel@snikket.de>
parents: 5937
diff changeset
37 ----------------------- ----------------