Mercurial > prosody-modules
annotate mod_http_authentication/README.markdown @ 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 | b19d64dd4c66 |
children |
rev | line source |
---|---|
2337
c6e86b74f62e
Add mod_http_authentication.lua
JC Brand <jcbrand@minddistrict.com>
parents:
diff
changeset
|
1 --- |
c6e86b74f62e
Add mod_http_authentication.lua
JC Brand <jcbrand@minddistrict.com>
parents:
diff
changeset
|
2 labels: |
c6e86b74f62e
Add mod_http_authentication.lua
JC Brand <jcbrand@minddistrict.com>
parents:
diff
changeset
|
3 - 'Stage-Beta' |
c6e86b74f62e
Add mod_http_authentication.lua
JC Brand <jcbrand@minddistrict.com>
parents:
diff
changeset
|
4 summary: Enforces HTTP Basic authentication across all HTTP endpoints served by Prosody |
c6e86b74f62e
Add mod_http_authentication.lua
JC Brand <jcbrand@minddistrict.com>
parents:
diff
changeset
|
5 ... |
c6e86b74f62e
Add mod_http_authentication.lua
JC Brand <jcbrand@minddistrict.com>
parents:
diff
changeset
|
6 |
c6e86b74f62e
Add mod_http_authentication.lua
JC Brand <jcbrand@minddistrict.com>
parents:
diff
changeset
|
7 # mod_http_authentication |
c6e86b74f62e
Add mod_http_authentication.lua
JC Brand <jcbrand@minddistrict.com>
parents:
diff
changeset
|
8 |
c6e86b74f62e
Add mod_http_authentication.lua
JC Brand <jcbrand@minddistrict.com>
parents:
diff
changeset
|
9 This module enforces HTTP Basic authentication across all HTTP endpoints served by Prosody. |
c6e86b74f62e
Add mod_http_authentication.lua
JC Brand <jcbrand@minddistrict.com>
parents:
diff
changeset
|
10 |
c6e86b74f62e
Add mod_http_authentication.lua
JC Brand <jcbrand@minddistrict.com>
parents:
diff
changeset
|
11 ## Configuration |
c6e86b74f62e
Add mod_http_authentication.lua
JC Brand <jcbrand@minddistrict.com>
parents:
diff
changeset
|
12 |
3019
b19d64dd4c66
mod_http_authentication/README: Change name of config option to match the code
Kim Alvefur <zash@zash.se>
parents:
3012
diff
changeset
|
13 Name Default Description |
b19d64dd4c66
mod_http_authentication/README: Change name of config option to match the code
Kim Alvefur <zash@zash.se>
parents:
3012
diff
changeset
|
14 ---------------------------------- --------------------------------- -------------------------------------------------------------------------------------------------------------------------------------- |
b19d64dd4c66
mod_http_authentication/README: Change name of config option to match the code
Kim Alvefur <zash@zash.se>
parents:
3012
diff
changeset
|
15 http\_credentials "minddistrict:secretpassword" The credentials that HTTP clients must provide to access the HTTP interface. Should be a string with the syntax "username:password". |
b19d64dd4c66
mod_http_authentication/README: Change name of config option to match the code
Kim Alvefur <zash@zash.se>
parents:
3012
diff
changeset
|
16 unauthenticated\_http\_endpoints { "/http-bind", "/http-bind/" } A list of paths that should be excluded from authentication. |
2337
c6e86b74f62e
Add mod_http_authentication.lua
JC Brand <jcbrand@minddistrict.com>
parents:
diff
changeset
|
17 |
c6e86b74f62e
Add mod_http_authentication.lua
JC Brand <jcbrand@minddistrict.com>
parents:
diff
changeset
|
18 ## Usage |
c6e86b74f62e
Add mod_http_authentication.lua
JC Brand <jcbrand@minddistrict.com>
parents:
diff
changeset
|
19 |
c6e86b74f62e
Add mod_http_authentication.lua
JC Brand <jcbrand@minddistrict.com>
parents:
diff
changeset
|
20 This is a global module, so should be added to the global `modules_enabled` option in your config file. It applies to all HTTP virtual hosts. |
c6e86b74f62e
Add mod_http_authentication.lua
JC Brand <jcbrand@minddistrict.com>
parents:
diff
changeset
|
21 |
3012
1380ae0e003f
mod_http_authentication: Replace 'Known issues' section with Compatibility since the issue referenced has been resolved
Kim Alvefur <zash@zash.se>
parents:
2337
diff
changeset
|
22 ## Compatibility |
2337
c6e86b74f62e
Add mod_http_authentication.lua
JC Brand <jcbrand@minddistrict.com>
parents:
diff
changeset
|
23 |
3012
1380ae0e003f
mod_http_authentication: Replace 'Known issues' section with Compatibility since the issue referenced has been resolved
Kim Alvefur <zash@zash.se>
parents:
2337
diff
changeset
|
24 The module use a new API in Prosody 0.10 and will not work with older |
1380ae0e003f
mod_http_authentication: Replace 'Known issues' section with Compatibility since the issue referenced has been resolved
Kim Alvefur <zash@zash.se>
parents:
2337
diff
changeset
|
25 versions. |
2337
c6e86b74f62e
Add mod_http_authentication.lua
JC Brand <jcbrand@minddistrict.com>
parents:
diff
changeset
|
26 |
c6e86b74f62e
Add mod_http_authentication.lua
JC Brand <jcbrand@minddistrict.com>
parents:
diff
changeset
|
27 ## Details |
c6e86b74f62e
Add mod_http_authentication.lua
JC Brand <jcbrand@minddistrict.com>
parents:
diff
changeset
|
28 |
c6e86b74f62e
Add mod_http_authentication.lua
JC Brand <jcbrand@minddistrict.com>
parents:
diff
changeset
|
29 By Kim Alvefur \<zash@zash.se\> |