view mod_auth_custom_http/README.markdown @ 4311:a6c253bc63a5

End value is index+1 as per the newest revision https://xmpp.org/extensions/xep-0372.html#revision-history-v0.4.0
author Seve Ferrer <seve@delape.net>
date Tue, 22 Dec 2020 11:18:46 +0100
parents f90cf59bee8e
children
line wrap: on
line source

---
summary: HTTP Authentication using custom JSON protocol
...

Introduction
============

To authenticate users, this module does a `POST` request to a configured
URL with a JSON payload. It is not async so requests block the server
until answered.

Configuration
=============

``` lua
VirtualHost "example.com"
authentication = "custom_http"
auth_custom_http = {
  post_url = "http://api.example.com/auth";
}
```

Protocol
========

The JSON payload consists of an object with `username` and `password`
members:

    {"username":"john","password":"secr1t"}

The module expects the response body to be exactly `true` if the
username and password are correct.