changeset 5064:7d33178c79f2

mod_sasl2: Add some brief dev notes about events to the README
author Matthew Wild <mwild1@gmail.com>
date Thu, 13 Oct 2022 22:48:57 +0100
parents 53145c6b6b0b
children 368bf9b06484
files mod_sasl2/README.md
diffstat 1 files changed, 13 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/mod_sasl2/README.md	Thu Oct 13 22:48:28 2022 +0100
+++ b/mod_sasl2/README.md	Thu Oct 13 22:48:57 2022 +0100
@@ -5,3 +5,16 @@
 ---
 
 Experimental implementation of [XEP-0388: Extensible SASL Profile]
+
+## Developers
+
+mod_sasl2 provides some events you can hook to affect aspects of the
+authentication process:
+
+- `advertise-sasl-features`
+- `sasl2/c2s/success`
+  - Priority 1000: Session marked as authenticated, success response created (`event.success`)
+  - Priority -1000: Success response sent to client
+  - Priority -1500: Updated <stream-features/> sent to client
+- `sasl2/c2s/failure`
+- `sasl2/c2s/error`