Mercurial > prosody-modules

comparison mod_auth_custom_http/README.md @ 5975:fe081789f7b5

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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_auth_custom_http/README.markdown@f90cf59bee8e
children
comparison
equal deleted inserted replaced
5974:5a65a632d5b9 5975:fe081789f7b5
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"
18 auth_custom_http = {
19 post_url = "http://api.example.com/auth";
20 }
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.