diff options
Diffstat (limited to 'src/mod_auth_custom_http_onefang/README.markdown')
-rw-r--r-- | src/mod_auth_custom_http_onefang/README.markdown | 32 |
1 files changed, 32 insertions, 0 deletions
diff --git a/src/mod_auth_custom_http_onefang/README.markdown b/src/mod_auth_custom_http_onefang/README.markdown new file mode 100644 index 0000000..ab79bf5 --- /dev/null +++ b/src/mod_auth_custom_http_onefang/README.markdown | |||
@@ -0,0 +1,32 @@ | |||
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. | ||