prosody-modules
fe081789f7b5
mod_auth_oauthbearer/README.md
Software / code / prosody-modules
Comparison
mod_auth_oauthbearer/README.md @ 6003:fe081789f7b5
All community modules: Unify file extention of Markdown files to .md
| author | Menel <menel@snikket.de> |
|---|---|
| date | Tue, 22 Oct 2024 10:26:01 +0200 |
| parent | 3116:mod_auth_oauthbearer/README.markdown@1a1affd22f74 |
comparison
equal
deleted
inserted
replaced
| 6002:5a65a632d5b9 | 6003:fe081789f7b5 |
|---|---|
| 1 --- | |
| 2 labels: | |
| 3 - 'Type-Auth' | |
| 4 summary: OAuth authentication | |
| 5 ... | |
| 6 | |
| 7 Introduction | |
| 8 ============ | |
| 9 | |
| 10 This is an authentication module for the SASL OAUTHBEARER mechanism, as provided by `mod_sasl_oauthbearer`. | |
| 11 | |
| 12 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. | |
| 13 | |
| 14 The XMPP client needs get an OAuth token from the provider (e.g. Github) and send that to Prosody. | |
| 15 This module will then verify that token by calling the `oauth_url` you've configured. | |
| 16 | |
| 17 Configuration | |
| 18 ============= | |
| 19 | |
| 20 Per VirtualHost, you'll need to supply your OAuth client Id, secret and the URL which | |
| 21 Prosody must call in order to verify the OAuth token it receives from the XMPP client. | |
| 22 | |
| 23 For example, for Github: | |
| 24 | |
| 25 oauth_client_id = "13f8e9cc8928b3409822" | |
| 26 oauth_client_secret = "983161fd3ah608ea7ef35382668aad1927463978" | |
| 27 oauth_url = "https://api.github.com/applications/{{oauth_client_id}}/tokens/{{password}}"; | |
| 28 | |
| 29 authentication = "oauthbearer" |
