view mod_auth_http_async/README.md @ 6556:7477e97a9045

mod_firewall: Apply pre-reload state before re-reading config This change makes load/reload a bit more robust. module.load() runs before module.restore() and it reads from the config and updates the state (if needed). However, after this, module.restore() could run and apply the old state again.
author Matthew Wild <mwild1@gmail.com>
date Sun, 24 May 2026 20:03:20 +0100
parents 7b693a5539ad
children
line wrap: on
line source

---
labels:
- Stage-Alpha
...

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

This is an authentication module that does an asynchronous
HTTP call to verify username and password.

Details
=======

When a user attempts to authenticate to Prosody, this module takes the
username and password and does a HTTP GET request with [Basic
authentication][rfc7617] to the configured `http_auth_url`.

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

After installing, enable the module by setting `authentication` to `"http_async"`.

The only setting is `http_auth_url` which should contain the URL endpoint where the authentication query is sent to. It can contain `$host` and
`$user` which are substituted for the current VirtualHost and the authenticating username, respectively.

``` lua
VirtualHost "example.com"
authentication = "http_async"
http_auth_url = "http://example.com/auth"
```

Compatibility
=============

Should work with Prosody 0.10.x and later.