prosody-modules
f2363e6d9a64
mod_auth_oauthbearer/README.markdown
Software / code / prosody-modules
File
mod_auth_oauthbearer/README.markdown @ 5390:f2363e6d9a64
mod_http_oauth2: Advertise the currently supported id_token signing algorithm
This field is REQUIRED. The algorithm RS256 MUST be included, but isn't
because we don't implement it, as that would require implementing a pile
of additional cryptography and JWT stuff. Instead the id_token is
signed using the client secret, which allows verification by the client,
since it's a shared secret per OpenID Connect Core 1.0 § 10.1 under
Symmetric Signatures.
OpenID Connect Discovery 1.0 has a lot of REQUIRED and MUST clauses that
are not supported here, but that's okay because this is served from the
RFC 8414 OAuth 2.0 Authorization Server Metadata .well-known endpoint!
| author | Kim Alvefur <zash@zash.se> |
|---|---|
| date | Sun, 30 Apr 2023 16:13:40 +0200 |
| parent | 3116:1a1affd22f74 |
line wrap: on
line source
--- labels: - 'Type-Auth' summary: OAuth authentication ... Introduction ============ This is an authentication module for the SASL OAUTHBEARER mechanism, as provided by `mod_sasl_oauthbearer`. You can use this to log in via OAuth, for example if you want your user's to log in with Github, Twitter, Reddit etc. The XMPP client needs get an OAuth token from the provider (e.g. Github) and send that to Prosody. This module will then verify that token by calling the `oauth_url` you've configured. Configuration ============= Per VirtualHost, you'll need to supply your OAuth client Id, secret and the URL which Prosody must call in order to verify the OAuth token it receives from the XMPP client. For example, for Github: oauth_client_id = "13f8e9cc8928b3409822" oauth_client_secret = "983161fd3ah608ea7ef35382668aad1927463978" oauth_url = "https://api.github.com/applications/{{oauth_client_id}}/tokens/{{password}}"; authentication = "oauthbearer"
