view mod_sasl2/README.md @ 5668:ecfd7aece33b

mod_measure_modules: Report module statuses via OpenMetrics Someone in the chat asked about a health check endpoint, which reminded me of mod_http_status, which provides access to module statuses with full details. After that, this idea came about, which seems natural. As noted in the README, it could be used to monitor that critical modules are in fact loaded correctly. As more modules use the status API, the more useful this module and mod_http_status becomes.
author Kim Alvefur <zash@zash.se>
date Fri, 06 Oct 2023 18:34:39 +0200
parents 5b77f4720bfe
children da942a3f3660
line wrap: on
line source

---
labels:
- Stage-Beta
summary: "XEP-0388: Extensible SASL Profile"
---

Implementation of [XEP-0388: Extensible SASL Profile]. **Note: At the time of
writing (Nov 2022) the version of the XEP implemented by this module is still
working its way through the XSF standards process. See [PR #1214](https://github.com/xsf/xeps/pull/1214)
for the current status.**

## Configuration

This module honours the same configuration options as Prosody's existing
[mod_saslauth](https://prosody.im/doc/modules/mod_saslauth).

## 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`