prosody-modules
d194d1012fd3
mod_auth_oauthbearer/README.markdown
Software / code / prosody-modules
File
mod_auth_oauthbearer/README.markdown @ 5931:d194d1012fd3
Updating dox for mod_rest. Ideas expressed / clarified:
1) Making clear that mod_rest isn't to be installed under VirtualHosts AND as a component.
2) Understanding some of the implications of this choice:
A) Changes to user authentication
B) How it affects subdomains
3) More consistent use of domain names for clarity.
4) Using different heading sizes to show scope of section.
Essentially, I added all the tidbits I had to clarify in getting this to work in my
own example.
| author | Ben Smith <bens@effortlessis.com> |
|---|---|
| date | Mon, 13 May 2024 13:25:13 -0700 |
| 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"
