Mercurial > prosody-modules
view mod_host_status_check/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 | 2a16a6c67288 |
| children | 694b62d8a82f |
line wrap: on
line source
--- labels: Stage-Beta summary: Host status check ... Introduction ============ This module allows you to monitor the state of hosts and components in your Prosody server. For example, it will track whether components are connected and (if the component supports it) listen for heartbeats sent by the component to indicate that it is functioning. This module does not expose any interface to access the status information itself. See [mod\_http\_host\_status\_check] for a module that allows you to access host status information over HTTP(S). Configuration ============= There are no configuration options for this module. You should enable it on every host that you want to monitor, by adding it to modules\_enabled. Note that to monitor components, adding to the global modules\_enabled list will not suffice - you will need to add it to the component's own modules\_enabled, like this: ``` {.lua} Component "mycomponent.example.com" modules_enabled = { "host_status_check" } ``` Compatibility ============= Works with Prosody 0.9.x and later.