Mercurial > prosody-modules
comparison mod_http_auth_check/README.md @ 5975: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 |
| parents | mod_http_auth_check/README.markdown@c4db126a9f04 |
| children |
comparison
equal
deleted
inserted
replaced
| 5974:5a65a632d5b9 | 5975:fe081789f7b5 |
|---|---|
| 1 --- | |
| 2 labels: | |
| 3 summary: 'Test account credentials using HTTP' | |
| 4 ... | |
| 5 | |
| 6 Introduction | |
| 7 ------------ | |
| 8 | |
| 9 This module lets you test whether a set of credentials are valid, | |
| 10 using Prosody's configured authentication mechanism. | |
| 11 | |
| 12 This is useful as an easy way to allow other (e.g. non-XMPP) applications | |
| 13 to authenticate users using their XMPP credentials. | |
| 14 | |
| 15 Syntax | |
| 16 ------ | |
| 17 | |
| 18 To test credentials, issue a simple GET request with HTTP basic auth: | |
| 19 | |
| 20 GET /auth_check HTTP/1.1 | |
| 21 Authorization: Basic <base64(jid:password)> | |
| 22 | |
| 23 Prosody will return a 2xx code on success (user exists and credentials are | |
| 24 correct), or 401 if the credentials are invalid. Any other code may be returned | |
| 25 if there is a problem handling the request. | |
| 26 | |
| 27 ### Example usage | |
| 28 | |
| 29 Here follows some example usage using `curl`. | |
| 30 | |
| 31 curl http://prosody.local:5280/auth_check -u user@example.com:secr1t |