emqx-auth-http (opens new window)
auth.http.auth_req
| Type |
Default |
| string |
<http://127.0.0.1:8991/mqtt/auth> |
说明
指定认证请求的目标 URL。
auth.http.auth_req.method
| Type |
Optional Value |
Default |
| enum |
get, post |
post |
说明
指定认证请求的请求方法。
auth.http.auth_req.params
| Type |
Format |
Default |
| string |
以 , 分隔的 k=v 键值对,v 可以是固定内容,也可以是占位符 |
clientid=%c,username=%u,password=%P |
说明
指定认证请求中携带的数据。使用 GET 方法时 auth.http.auth_req.params 的值将被转换为以 & 分隔的 k=v 键值对以查询字符串参数的形式发送。使用 POST 方法时 auth.http.auth_req.params 的值将被转换为以 & 分隔的 k=v 键值对以 Request Body 的形式发送。所有的占位符都会被运行时数据所替换,可用的占位符如下:
| 占位符 |
替换内容 |
%u |
用户名 |
%c |
MQTT Client ID |
%a |
客户端的网络 IP 地址 |
%r |
客户端使用的协议,可以是:mqtt, mqtt-sn, coap, lwm2m 以及 stomp |
%P |
密码 |
%p |
客户端连接的服务端端口 |
%c |
客户端证书中的 Common Name |
%d |
客户端证书中的 Subject |
auth.http.super_req
| Type |
Default |
| string |
<http://127.0.0.1:8991/mqtt/superuser> |
说明
指定超级用户认证请求的目标 URL。
auth.http.super_req.method
| Type |
Optional Value |
Default |
| enum |
get, post |
post |
说明
指定超级用户认证请求的请求方法。
auth.http.super_req.params
| Type |
Format |
Default |
| string |
以 , 分隔的 k=v 键值对,v 可以是固定内容,也可以是占位符 |
clientid=%c,username=%u |
说明
指定超级用户认证请求中携带的数据。使用 GET 方法时 auth.http.super_req.params 的值将被转换为以 & 分隔的 k=v 键值对以查询字符串参数的形式发送。使用 POST 方法时 auth.http.super_req.params 的值将被转换为以 & 分隔的 k=v 键值对以 Request Body 的形式发送。所有的占位符都会被运行时数据所替换,可用的占位符同 auth.http.auth_req.params。
auth.http.acl_req
| Type |
Default |
| string |
<http://127.0.0.1:8991/mqtt/acl> |
说明
指定 ACL 验证请求的目标 URL。
auth.http.acl_req.method
| Type |
Optional Value |
Default |
| enum |
get, post |
post |
说明
指定 ACL 验证请求的请求方法。
auth.http.acl_req.params
| Type |
Format |
Default |
| string |
以 , 分隔的 k=v 键值对,v 可以是固定内容,也可以是占位符 |
access=%A,username=%u,clientid=%c,ipaddr=%a,topic=%t,mountpoint=%m |
说明
指定 ACL 验证请求中携带的数据。使用 GET 方法时 auth.http.acl_req.params 的值将被转换为以 & 分隔的 k=v 键值对以查询字符串参数的形式发送。使用 POST 方法时 auth.http.acl_req.params 的值将被转换为以 & 分隔的 k=v 键值对以 Request Body 的形式发送。所有的占位符都会被运行时数据所替换,可用的占位符如下:
| 占位符 |
替换内容 |
%A |
需要验证的权限,1 表示订阅,2 表示发布 |
%u |
MQTT Client ID |
%c |
客户端标识符 |
%a |
客户端的网络 IP 地址 |
%r |
客户端使用的协议,可以是:mqtt, mqtt-sn, coap, lwm2m 以及 stomp |
%m |
挂载点 |
%t |
主题 |
auth.http.request.timeout
说明
HTTP 请求超时时间。任何等价于 0s 的设定值都表示永不超时。
auth.http.request.connect_timeout
说明
HTTP 请求的连接超时时间。任何等价于 0s 的设定值都表示永不超时。
auth.http.request.retry_times
说明
HTTP 请求失败时的重试次数。
auth.http.request.retry_interval
说明
HTTP 请求失败时的重试间隔。
auth.http.request.retry_backoff
说明
HTTP 请求失败时的重试间隔使用了指数退避算法,此配置项用于指定指数退避算法的退避系数。
说明
指定 HTTP 请求头部中的数据。<Key> 指定 HTTP 请求头部中的字段名,此配置项的值为相应的字段值。<Key> 可以是标准的 HTTP 请求头部字段,也可以自定义的字段,可以配置多个不同的请求头部字段。
示例
auth.http.header.Accept = */*
auth.http.header.Accept-Encoding = *
auth.http.ssl.cacertfile
| Type |
Default |
| string |
etc/certs/ca.pem |
说明
CA 证书文件路径。
auth.http.ssl.certfile
| Type |
Default |
| string |
etc/certs/client-cert.pem |
说明
客户端证书文件路径。
auth.http.ssl.keyfile
| Type |
Default |
| string |
etc/certs/client.key.pem |
说明
客户端私钥文件路径。