emq插件开发mysql,关于java:EMQ-X-基于-MySQL-的-MQTT-连接认证

创立数据库

你能够应用任何本人喜爱的 客户端，创立好相应的数据库。这里用的是 MySQL 自带的命令行客户端，关上 MySQL 的控制台，如下所示，创立一个名为 emqx 的认证数据库，并切换到 emqx 数据库。

mysql> create database emqx;

Query OK, 1 row affected (0.00 sec)

mysql> use emqx;

Database changed

创立表

倡议的表构造如下，其中，

【腾讯云】云产品限时秒杀，爆款1核2G云服务器，首年99元

username 为客户端连贯的时候指定的用户名，此处的值如果设置为 $all 示意该规定实用于所有的用户

password 为应用 salt 加密后的密文

salt 为加密串

is_superuser 是否为超级用户，用于管制 ACL，缺省为0；设置成 1 的时候为超级用户，能够跳过 ACL 查看

数据表字段能够不必齐全跟上面的统一，能够依据业务须要设置，通过 `emqx_auth_mysql.conf` 配置文件中的 `auth_query` 配置项来指定。

认证表：

CREATE TABLE `mqtt_user` (

`id` int(11) unsigned NOT NULL AUTO_INCREMENT,

`username` varchar(100) DEFAULT NULL,

`password` varchar(100) DEFAULT NULL,

`salt` varchar(35) DEFAULT NULL,

`is_superuser` tinyint(1) DEFAULT 0,

`created` datetime DEFAULT NULL,

PRIMARY KEY (`id`),

UNIQUE KEY `mqtt_username` (`username`)

) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;

进行身份认证时，EMQ X 将应用以后客户端信息填充并执行用户配置的认证 SQL，查问出该客户端在数据库中的认证数据。

select password from mqtt_user where username = '%u' limit 1

字段阐明

%u：用户名

%c：clientid

%P：明文明码

%C：TLS 证书专用名(证书的域名或子域名)，仅当 TLS 连贯时无效

%d：TLS 证书 subject，仅当 TLS 连贯时无效

能够依据业务须要调整认证 SQL，如增加多个查问条件、应用数据库预处理函数，以实现更多业务相干的性能。然而任何状况下认证 SQL 须要满足以下条件：

查问后果中必须蕴含 password 字段，EMQ X 应用该字段与客户端明码比对

如果启用了加盐配置，查问后果中必须蕴含 salt 字段，EMQ X 应用该字段作为 salt(盐)值

查问后果只能有一条，多条后果时只取第一条作为无效数据

这里根本不需批改,在 emqx 门路：/etc/emqx/plugins/下的

emqx_auth_mysql.conf中为默认配置。

筹备认证数据：

本文提供示例数据中明码为 wulongbo，盐值 salt 为 secret。即客户端连贯时应用的明码是 wulongbo 。

在 EMQ X 的配置文件的 auth.mysql.password_hash 中，salt 只是一个标识符，示意 salt 与明码明文的拼接关系。

如果采纳auth.mysql.password_hash = md5,salt ，那么 EMQ X 应用 MD5 算法对 test_passwordsecret 字符串加密

如果采纳auth.mysql.password_hash = sha256 ，那么 EMQ X 应用 sha256 算法对 secrettest_password 字符串加密

本文采纳第二种配置形式(不带盐值得哈)，将失去的 sha256 密文插入表 mqtt_user。读者能够通过在线的 sha256 工具或者本人写程序对明码进行编码。

sha256("wulongbo") -> 586f3f5cddba47135b625d98a809e60da6c46ac9cc5fa61e9f132056530bee72

示例数据如下：

INSERT INTO `mqtt_user` ( `username`, `password`, `salt`)

VALUES

('emqx', 'efa1f375d76194fa51a3556a97e641e61685f914d446979da50a551a4333ffd7', NULL);

INSERT INTO `mqtt_user` ( `username`, `password`, `salt`)

VALUES

('babaznkj', '586f3f5cddba47135b625d98a809e60da6c46ac9cc5fa61e9f132056530bee72', 'secret');

启用认证性能

批改插件配置并启用插件

批改 etc/plugins/emqx_auth_mysql.conf，批改后的无效配置如下所示，其余 ACL 相干的配置项能够正文：

## 批改为理论 mysql 所在的服务器地址

## Examples: 3306, 127.0.0.1:3306, localhost:3306

auth.mysql.server = 127.0.0.1:3306

## MySQL pool size.

##

## Value: Number

auth.mysql.pool = 8

## MySQL username.

##

## Value: String

## auth.mysql.username =

auth.mysql.username = root

## MySQL password.

##

## Value: String

## auth.mysql.password =

auth.mysql.password = babaAdmin

## 批改为下面创立胜利的 emqx 数据库

## MySQL database.

##

## Value: String

auth.mysql.database = mqtt

## MySQL query timeout

##

## Value: Duration

## auth.mysql.query_timeout = 5s

## Variables: %u = username, %c = clientid

## 连贯认证查问语句

## Authentication query.

## 1.默认不加盐配置

auth.mysql.auth_query = select password from mqtt_user where username = '%u' limit 1

## 2.加盐配置

##auth.mysql.auth_query = select password,salt from ##mqtt_user where username = '%u' limit 1

## 加密算法 plain | md5 | sha | sha256 | bcrypt

## 加盐加密算法

##auth.mysql.password_hash = md5,salt

auth.mysql.password_hash = sha256

## 不加盐加密算法，间接写算法名称即可

# auth.mysql.password_hash = md5

批改结束后应用 Dashboard 或命令行重启插件以利用配置，命令行重启发例如下：

emqx_ctl plugins reload emqx_auth_mysql

敞开匿名认证

EMQ X 默认开启了匿名认证，即使启用了认证性能，数据库没有查问到数据时设施也能失常连贯，只有当查问到数据且明码谬误时才会回绝连贯。

关上 etc/emqx.conf 配置文件，禁用匿名认证：

## Value: true | false

allow_anonymous = false

重启 emqx 实现配置利用。

emqx restart

启用 MySQL 认证

关上 EMQ X Dashboard，点击左侧的 “插件” 选项卡，抉择emqx_auth_mysql：

启用 MySQL 认证后，你能够通过用户名： emqx/babaznkj，明码：public/wulongbo 连贯。

访问控制(附)

访问控制表

CREATE TABLE `mqtt_acl` (

`id` int(11) unsigned NOT NULL AUTO_INCREMENT,

`allow` int(1) DEFAULT 1 COMMENT '0: deny, 1: allow',

`ipaddr` varchar(60) DEFAULT NULL COMMENT 'IpAddress',

`username` varchar(100) DEFAULT NULL COMMENT 'Username',

`clientid` varchar(100) DEFAULT NULL COMMENT 'ClientId',

`access` int(2) NOT NULL COMMENT '1: subscribe, 2: publish, 3: pubsub',

`topic` varchar(100) NOT NULL DEFAULT '' COMMENT 'Topic Filter',

PRIMARY KEY (`id`)

) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;

字段阐明：

allow：禁止(0)，容许(1)

ipaddr：设置 IP 地址

username：连贯客户端的用户名，此处的值如果设置为 $all 示意该规定实用于所有的用户

clientid：连贯客户端的clientid

access：容许的操作：订阅(1)，公布(2)，订阅公布都能够(3)

topic：管制的主题，能够应用通配符，并且能够在主题中退出占位符来匹配客户端信息，例如 t/%c在匹配时主题将会替换为以后客户端的 clientid

访问控制的原理是从MySQL中查找跟客户端相干的条目，而后进行鉴权，默认的查问SQL如下：

select allow, ipaddr, username, clientid, access, topic from mqtt_acl where ipaddr = '%a' or username = '%u' or username = '$all' or clientid = '%c'

能够在认证 SQL 中应用以下占位符，执行时 EMQ X 将主动填充为客户端信息：

%u：用户名

%c：clientid

%a：客户端 IP 地址

%P：明文明码

%C：TLS 证书专用名(证书的域名或子域名)，仅当 TLS 连贯时无效

%d：TLS 证书 subject，仅当 TLS 连贯时无效

默认配置下示例数据：

-- 所有用户不能够订阅零碎主题

INSERT INTO mqtt_acl (allow, ipaddr, username, clientid, access, topic) VALUES (0, NULL, '$all', NULL, 1, '$SYS/#');

-- 容许 10.59.1.100 上的客户端订阅零碎主题

INSERT INTO mqtt_acl (allow, ipaddr, username, clientid, access, topic) VALUES (1, '10.59.1.100', NULL, NULL, 1, '$SYS/#');

-- 禁止客户端订阅 /smarthome/+/temperature 主题

INSERT INTO mqtt_acl (allow, ipaddr, username, clientid, access, topic) VALUES (0, NULL, NULL, NULL, 1, '/smarthome/+/temperature');

-- 容许客户端订阅蕴含本身 Client ID 的 /smarthome/${clientid}/temperature 主题

INSERT INTO mqtt_acl (allow, ipaddr, username, clientid, access, topic) VALUES (1, NULL, NULL, NULL, 1, '/smarthome/%c/temperature');

超级用户

超级用户能够订阅和公布任何Topic，默认SQL如下:

select is_superuser from mqtt_user where username = '%u' limit 1

你能够在 SQL 中应用以下占位符，执行时 EMQ X 将主动填充为客户端信息：

%u：用户名

%c：clientid

%C：TLS 证书专用名(证书的域名或子域名)，仅当 TLS 连贯时无效

%d：TLS 证书 subject，仅当 TLS 连贯时无效

你能够依据业务须要调整超级用户 SQL，如增加多个查问条件、应用数据库预处理函数，以实现更多业务相干的性能。然而任何状况下超级用户 SQL 须要满足以下条件：

查问后果中必须蕴含 is_superuser 字段，is_superuser 应该显式的为 true

查问后果只能有一条，多条后果时只取第一条作为无效数据