mod_sasl2/README.md
author Kim Alvefur <zash@zash.se>
Sat, 23 Mar 2024 15:44:13 +0100
changeset 5878 f8b9095f7862
parent 5093 5b77f4720bfe
permissions -rw-r--r--
mod_compat_roles: Fix attempt to index a nil value #1847 permissions[] is not a map with role names as keys since 817bc9873fc2 but instead a level with host names were added. This was likely an oversight. Refactored towards railroad.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
4802
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:
5093
5b77f4720bfe mod_sasl2: Update and expand README with more (and updated) information
Matthew Wild <mwild1@gmail.com>
parents: 5068
diff changeset
     3
- Stage-Beta
4802
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
5093
5b77f4720bfe mod_sasl2: Update and expand README with more (and updated) information
Matthew Wild <mwild1@gmail.com>
parents: 5068
diff changeset
     7
Implementation of [XEP-0388: Extensible SASL Profile]. **Note: At the time of
5b77f4720bfe mod_sasl2: Update and expand README with more (and updated) information
Matthew Wild <mwild1@gmail.com>
parents: 5068
diff changeset
     8
writing (Nov 2022) the version of the XEP implemented by this module is still
5b77f4720bfe mod_sasl2: Update and expand README with more (and updated) information
Matthew Wild <mwild1@gmail.com>
parents: 5068
diff changeset
     9
working its way through the XSF standards process. See [PR #1214](https://github.com/xsf/xeps/pull/1214)
5b77f4720bfe mod_sasl2: Update and expand README with more (and updated) information
Matthew Wild <mwild1@gmail.com>
parents: 5068
diff changeset
    10
for the current status.**
5b77f4720bfe mod_sasl2: Update and expand README with more (and updated) information
Matthew Wild <mwild1@gmail.com>
parents: 5068
diff changeset
    11
5b77f4720bfe mod_sasl2: Update and expand README with more (and updated) information
Matthew Wild <mwild1@gmail.com>
parents: 5068
diff changeset
    12
## Configuration
5b77f4720bfe mod_sasl2: Update and expand README with more (and updated) information
Matthew Wild <mwild1@gmail.com>
parents: 5068
diff changeset
    13
5b77f4720bfe mod_sasl2: Update and expand README with more (and updated) information
Matthew Wild <mwild1@gmail.com>
parents: 5068
diff changeset
    14
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: 5068
diff changeset
    15
[mod_saslauth](https://prosody.im/doc/modules/mod_saslauth).
5068
7d33178c79f2 mod_sasl2: Add some brief dev notes about events to the README
Matthew Wild <mwild1@gmail.com>
parents: 4802
diff changeset
    16
7d33178c79f2 mod_sasl2: Add some brief dev notes about events to the README
Matthew Wild <mwild1@gmail.com>
parents: 4802
diff changeset
    17
## Developers
7d33178c79f2 mod_sasl2: Add some brief dev notes about events to the README
Matthew Wild <mwild1@gmail.com>
parents: 4802
diff changeset
    18
7d33178c79f2 mod_sasl2: Add some brief dev notes about events to the README
Matthew Wild <mwild1@gmail.com>
parents: 4802
diff changeset
    19
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: 4802
diff changeset
    20
authentication process:
7d33178c79f2 mod_sasl2: Add some brief dev notes about events to the README
Matthew Wild <mwild1@gmail.com>
parents: 4802
diff changeset
    21
7d33178c79f2 mod_sasl2: Add some brief dev notes about events to the README
Matthew Wild <mwild1@gmail.com>
parents: 4802
diff changeset
    22
- `advertise-sasl-features`
7d33178c79f2 mod_sasl2: Add some brief dev notes about events to the README
Matthew Wild <mwild1@gmail.com>
parents: 4802
diff changeset
    23
- `sasl2/c2s/success`
7d33178c79f2 mod_sasl2: Add some brief dev notes about events to the README
Matthew Wild <mwild1@gmail.com>
parents: 4802
diff changeset
    24
  - 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: 4802
diff changeset
    25
  - 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: 4802
diff changeset
    26
  - 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: 4802
diff changeset
    27
- `sasl2/c2s/failure`
7d33178c79f2 mod_sasl2: Add some brief dev notes about events to the README
Matthew Wild <mwild1@gmail.com>
parents: 4802
diff changeset
    28
- `sasl2/c2s/error`