annotate mod_sasl2/README.md @ 5193:2bb29ece216b

mod_http_oauth2: Implement stateless dynamic client registration Replaces previous explicit registration that required either the additional module mod_adhoc_oauth2_client or manually editing the database. That method was enough to have something to test with, but would not probably not scale easily. Dynamic client registration allows creating clients on the fly, which may be even easier in theory. In order to not allow basically unauthenticated writes to the database, we implement a stateless model here. per_host_key := HMAC(config -> oauth2_registration_key, hostname) client_id := JWT { client metadata } signed with per_host_key client_secret := HMAC(per_host_key, client_id) This should ensure everything we need to know is part of the client_id, allowing redirects etc to be validated, and the client_secret can be validated with only the client_id and the per_host_key. A nonce injected into the client_id JWT should ensure nobody can submit the same client metadata and retrieve the same client_secret
author Kim Alvefur <zash@zash.se>
date Fri, 03 Mar 2023 21:14:19 +0100
parents 5b77f4720bfe
children da942a3f3660
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
5089
5b77f4720bfe mod_sasl2: Update and expand README with more (and updated) information
Matthew Wild <mwild1@gmail.com>
parents: 5064
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: 5064
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: 5064
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: 5064
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: 5064
diff changeset
11
5b77f4720bfe mod_sasl2: Update and expand README with more (and updated) information
Matthew Wild <mwild1@gmail.com>
parents: 5064
diff changeset
12 ## Configuration
5b77f4720bfe mod_sasl2: Update and expand README with more (and updated) information
Matthew Wild <mwild1@gmail.com>
parents: 5064
diff changeset
13
5b77f4720bfe mod_sasl2: Update and expand README with more (and updated) information
Matthew Wild <mwild1@gmail.com>
parents: 5064
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: 5064
diff changeset
15 [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
16
7d33178c79f2 mod_sasl2: Add some brief dev notes about events to the README
Matthew Wild <mwild1@gmail.com>
parents: 4798
diff changeset
17 ## Developers
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 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
20 authentication process:
7d33178c79f2 mod_sasl2: Add some brief dev notes about events to the README
Matthew Wild <mwild1@gmail.com>
parents: 4798
diff changeset
21
7d33178c79f2 mod_sasl2: Add some brief dev notes about events to the README
Matthew Wild <mwild1@gmail.com>
parents: 4798
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: 4798
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: 4798
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: 4798
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: 4798
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: 4798
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: 4798
diff changeset
28 - `sasl2/c2s/error`