mod_auth_http_async/README.markdown
author Kim Alvefur <zash@zash.se>
Thu, 01 Oct 2015 20:43:14 +0200
changeset 1892 3483381c5e46
child 1937 afba0821f058
permissions -rw-r--r--
mod_auth_http_async: Add README
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
1892
3483381c5e46 mod_auth_http_async: Add README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
     1
Introduction
3483381c5e46 mod_auth_http_async: Add README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
     2
============
3483381c5e46 mod_auth_http_async: Add README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
     3
3483381c5e46 mod_auth_http_async: Add README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
     4
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
     5
HTTP call to verify username and password.
3483381c5e46 mod_auth_http_async: Add README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
     6
3483381c5e46 mod_auth_http_async: Add README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
     7
Details
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
3483381c5e46 mod_auth_http_async: Add README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    10
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
    11
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
    12
authentication][rfc7617] to the configured `http_auth_url`.
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
Configuration
3483381c5e46 mod_auth_http_async: Add README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    15
=============
3483381c5e46 mod_auth_http_async: Add README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    16
3483381c5e46 mod_auth_http_async: Add README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    17
``` {.lua}
3483381c5e46 mod_auth_http_async: Add README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    18
VirtualHost "example.com"
3483381c5e46 mod_auth_http_async: Add README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    19
authentication = "http_async"
3483381c5e46 mod_auth_http_async: Add README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    20
http_auth_url = "http://example.com/auth"
3483381c5e46 mod_auth_http_async: Add README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    21
```
3483381c5e46 mod_auth_http_async: Add README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    22