mod_auth_http_async/README.markdown
author Matthew Wild <mwild1@gmail.com>
Fri, 23 Sep 2022 22:41:15 +0100
changeset 5058 62480053c87b
parent 2125 4916c1b6517f
permissions -rw-r--r--
mod_cloud_notify_encrypted: Additional debug logging when enabling/skipping
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
1937
afba0821f058 mod_auth_http_async/README: Add compatibility info
Kim Alvefur <zash@zash.se>
parents: 1892
diff changeset
     1
---
afba0821f058 mod_auth_http_async/README: Add compatibility info
Kim Alvefur <zash@zash.se>
parents: 1892
diff changeset
     2
labels:
afba0821f058 mod_auth_http_async/README: Add compatibility info
Kim Alvefur <zash@zash.se>
parents: 1892
diff changeset
     3
- Stage-Alpha
afba0821f058 mod_auth_http_async/README: Add compatibility info
Kim Alvefur <zash@zash.se>
parents: 1892
diff changeset
     4
...
afba0821f058 mod_auth_http_async/README: Add compatibility info
Kim Alvefur <zash@zash.se>
parents: 1892
diff changeset
     5
1892
3483381c5e46 mod_auth_http_async: Add README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
     6
Introduction
3483381c5e46 mod_auth_http_async: Add README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
     7
============
3483381c5e46 mod_auth_http_async: Add README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
     8
3483381c5e46 mod_auth_http_async: Add README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
     9
This is an experimental authentication module that does an asynchronous
3483381c5e46 mod_auth_http_async: Add README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    10
HTTP call to verify username and password.
3483381c5e46 mod_auth_http_async: Add README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    11
3483381c5e46 mod_auth_http_async: Add README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    12
Details
3483381c5e46 mod_auth_http_async: Add README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    13
=======
3483381c5e46 mod_auth_http_async: Add README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    14
3483381c5e46 mod_auth_http_async: Add README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    15
When a user attempts to authenticate to Prosody, this module takes the
3483381c5e46 mod_auth_http_async: Add README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    16
username and password and does a HTTP GET request with [Basic
3483381c5e46 mod_auth_http_async: Add README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    17
authentication][rfc7617] to the configured `http_auth_url`.
3483381c5e46 mod_auth_http_async: Add README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    18
3483381c5e46 mod_auth_http_async: Add README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    19
Configuration
3483381c5e46 mod_auth_http_async: Add README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    20
=============
3483381c5e46 mod_auth_http_async: Add README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    21
1937
afba0821f058 mod_auth_http_async/README: Add compatibility info
Kim Alvefur <zash@zash.se>
parents: 1892
diff changeset
    22
``` lua
1892
3483381c5e46 mod_auth_http_async: Add README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    23
VirtualHost "example.com"
3483381c5e46 mod_auth_http_async: Add README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    24
authentication = "http_async"
3483381c5e46 mod_auth_http_async: Add README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    25
http_auth_url = "http://example.com/auth"
3483381c5e46 mod_auth_http_async: Add README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    26
```
3483381c5e46 mod_auth_http_async: Add README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    27
1937
afba0821f058 mod_auth_http_async/README: Add compatibility info
Kim Alvefur <zash@zash.se>
parents: 1892
diff changeset
    28
Compatibility
afba0821f058 mod_auth_http_async/README: Add compatibility info
Kim Alvefur <zash@zash.se>
parents: 1892
diff changeset
    29
=============
afba0821f058 mod_auth_http_async/README: Add compatibility info
Kim Alvefur <zash@zash.se>
parents: 1892
diff changeset
    30
2125
4916c1b6517f Update READMEs to indicate that async requires trunk (dropped from prosody 0.10)
Kim Alvefur <zash@zash.se>
parents: 1937
diff changeset
    31
Requires Prosody trunk