Mercurial > prosody-modules
annotate mod_auth_custom_http/README.markdown @ 4989:b74d592df9e2
mod_http_muc_log: Remove dead code
This might be something left over since a different variant where the
loop went like `for n = i-1, i-100, -1 do ... end` i.e. it went trough a
fixed number of items instead of all the page until the current message.
Then it would have needed something to stop going over the end, but
since the checks are simple it shouldn't be much of a problem looping
over even a very busy day.
| author | Kim Alvefur <zash@zash.se> |
|---|---|
| date | Tue, 16 Aug 2022 01:27:59 +0200 |
| parents | f90cf59bee8e |
| children |
| rev | line source |
|---|---|
| 1934 | 1 --- |
| 2 summary: HTTP Authentication using custom JSON protocol | |
| 3 ... | |
| 4 | |
| 5 Introduction | |
| 6 ============ | |
| 7 | |
| 8 To authenticate users, this module does a `POST` request to a configured | |
| 9 URL with a JSON payload. It is not async so requests block the server | |
| 10 until answered. | |
| 11 | |
| 12 Configuration | |
| 13 ============= | |
| 14 | |
| 15 ``` lua | |
| 16 VirtualHost "example.com" | |
| 17 authentication = "custom_http" | |
|
2868
f90cf59bee8e
mod_auth_custom_http: fix documentation config example
Senya <senya@kinetiksoft.com>
parents:
1934
diff
changeset
|
18 auth_custom_http = { |
|
f90cf59bee8e
mod_auth_custom_http: fix documentation config example
Senya <senya@kinetiksoft.com>
parents:
1934
diff
changeset
|
19 post_url = "http://api.example.com/auth"; |
|
f90cf59bee8e
mod_auth_custom_http: fix documentation config example
Senya <senya@kinetiksoft.com>
parents:
1934
diff
changeset
|
20 } |
| 1934 | 21 ``` |
| 22 | |
| 23 Protocol | |
| 24 ======== | |
| 25 | |
| 26 The JSON payload consists of an object with `username` and `password` | |
| 27 members: | |
| 28 | |
| 29 {"username":"john","password":"secr1t"} | |
| 30 | |
| 31 The module expects the response body to be exactly `true` if the | |
| 32 username and password are correct. |