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

创建表

建议的表结构如下,其中,

  • username 为客户端连接的时候指定的用户名,此处的值如果设置为 $all 表示该规则适用于所有的用户
  • password 为使用 salt 加密后的密文
  • salt 为加密串
  • is_superuser 是否为超级用户,用于控制 ACL,缺省为0;设置成 1 的时候为超级用户,可以跳过 ACL 检查
数据表字段可以不用完全跟下面的一致,可以根据业务需要设置,通过 `emqx_auth_mysql.conf` 配置文件中的 `auth_query` 配置项来指定。

image

认证表:

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 需要满足以下条件:

  1. 查询结果中必须包含 password 字段,EMQ X 使用该字段与客户端密码比对
  2. 如果启用了加盐配置,查询结果中必须包含 salt 字段,EMQ X 使用该字段作为 salt(盐)值
  3. 查询结果只能有一条,多条结果时只取第一条作为有效数据

这里基本不需修改,在 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
image

启用 MySQL 认证后,你可以通过用户名: emqx/babaznkj,密码:public/wulongbo 连接。
image

访问控制(附)

访问控制表

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 需要满足以下条件:

  1. 查询结果中必须包含 is_superuser 字段,is_superuser 应该显式的为 true
  2. 查询结果只能有一条,多条结果时只取第一条作为有效数据
阅读 262

推荐阅读