https://github.com/emqx/emqx-auth-http
EMQX HTTP Authentication/ACL Plugin
https://github.com/emqx/emqx-auth-http
acl authentication emqx emqx-plugin http http-authentication
Last synced: 3 months ago
JSON representation
EMQX HTTP Authentication/ACL Plugin
- Host: GitHub
- URL: https://github.com/emqx/emqx-auth-http
- Owner: emqx
- License: apache-2.0
- Created: 2016-05-16T07:33:23.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2023-12-27T07:39:00.000Z (about 2 years ago)
- Last Synced: 2025-09-29T22:58:33.289Z (3 months ago)
- Topics: acl, authentication, emqx, emqx-plugin, http, http-authentication
- Language: Erlang
- Homepage: https://emqx.io/
- Size: 369 KB
- Stars: 46
- Watchers: 25
- Forks: 48
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
emqx_auth_http
==============
EMQX HTTP Auth/ACL Plugin
Build
-----
```
make && make tests
```
Configure the Plugin
--------------------
File: etc/emqx_auth_http.conf
```
##--------------------------------------------------------------------
## Authentication request.
##
## Variables:
## - %u: username
## - %c: clientid
## - %a: ipaddress
## - %r: protocol
## - %P: password
## - %C: common name of client TLS cert
## - %d: subject of client TLS cert
##
## Value: URL
auth.http.auth_req = http://127.0.0.1:8080/mqtt/auth
## Value: post | get | put
auth.http.auth_req.method = post
## Value: Params
auth.http.auth_req.params = clientid=%c,username=%u,password=%P
##--------------------------------------------------------------------
## Superuser request.
##
## Variables:
## - %u: username
## - %c: clientid
## - %a: ipaddress
## - %r: protocol
## - %P: password
## - %C: common name of client TLS cert
## - %d: subject of client TLS cert
##
## Value: URL
auth.http.super_req = http://127.0.0.1:8080/mqtt/superuser
## Value: post | get | put
auth.http.super_req.method = post
## Value: Params
auth.http.super_req.params = clientid=%c,username=%u
##--------------------------------------------------------------------
## ACL request.
##
## Variables:
## - %A: 1 | 2, 1 = sub, 2 = pub
## - %u: username
## - %c: clientid
## - %a: ipaddress
## - %r: protocol
## - %m: mountpoint
## - %t: topic
##
## Value: URL
auth.http.acl_req = http://127.0.0.1:8080/mqtt/acl
## Value: post | get | put
auth.http.acl_req.method = get
## Value: Params
auth.http.acl_req.params = access=%A,username=%u,clientid=%c,ipaddr=%a,topic=%t
```
Load the Plugin
---------------
```
./bin/emqx_ctl plugins load emqx_auth_http
```
HTTP API
--------
200 if ok
4xx if unauthorized
License
-------
Apache License Version 2.0
Author
------
EMQX Team.