MySQL ACL

    插件：

    提示

    emqx_auth_mysql 插件同时包含认证功能，可通过注释禁用。

    MySQL 基础连接信息，需要保证集群内所有节点均能访问。

    3. ## 服务器地址
    4. auth.mysql.server = 127.0.0.1:3306
    6. ## 连接池大小
    7. auth.mysql.pool = 8
    9. auth.mysql.username = emqx
    11. auth.mysql.password = public
    13. auth.mysql.database = mqtt
    15. auth.mysql.query_timeout = 5s

    MySQL 认证插件默认配置下需要确保数据库中有以下两张数据表，用于存储认证规则信息：

    1. CREATE TABLE `mqtt_user` (
    2.   `id` int(11) unsigned NOT NULL AUTO_INCREMENT,
    3.   `username` varchar(100) DEFAULT NULL,
    4.   `password` varchar(100) DEFAULT NULL,
    5.   `is_superuser` tinyint(1) DEFAULT 0,
    6.   `created` datetime DEFAULT NULL,
    7.   PRIMARY KEY (`id`),
    8.   UNIQUE KEY `mqtt_username` (`username`)
    9. ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;

    示例数据：

    ACL 规则表

    1. CREATE TABLE `mqtt_acl` (
    2.   `id` int(11) unsigned NOT NULL AUTO_INCREMENT,
    3.   `allow` int(1) DEFAULT 1 COMMENT '0: deny, 1: allow',
    4.   `ipaddr` varchar(60) DEFAULT NULL COMMENT 'IpAddress',
    5.   `username` varchar(100) DEFAULT NULL COMMENT 'Username',
    6.   `clientid` varchar(100) DEFAULT NULL COMMENT 'ClientId',
    7.   `access` int(2) NOT NULL COMMENT '1: subscribe, 2: publish, 3: pubsub',
    8.   `topic` varchar(100) NOT NULL DEFAULT '' COMMENT 'Topic Filter',
    9.   PRIMARY KEY (`id`),
    10.   INDEX (ipaddr),
    11.   INDEX (username),
    12.   INDEX (clientid)
    13. ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;
    • allow：禁止（0），允许（1）
    • ipaddr：设置 IP 地址
    • username：连接客户端的用户名，此处的值如果设置为 表示该规则适用于所有的用户
    • clientid：连接客户端的 Client ID
    • access：允许的操作：订阅（1），发布（2），订阅发布都可以（3）
    • topic：控制的主题，可以使用通配符，并且可以在主题中加入占位符来匹配客户端信息，例如 t/%c 则在匹配时主题将会替换为当前客户端的 Client ID
      • %u：用户名
      • %c：Client ID

    默认配置下示例数据：

    1. INSERT INTO mqtt_acl (allow, ipaddr, username, clientid, access, topic) VALUES (0, NULL, '$all', NULL, 1, '$SYS/#');
    3. -- 允许 10.59.1.100 上的客户端订阅系统主题
    4. INSERT INTO mqtt_acl (allow, ipaddr, username, clientid, access, topic) VALUES (1, '10.59.1.100', NULL, NULL, 1, '$SYS/#');
    6. -- 禁止客户端订阅 /smarthome/+/temperature 主题
    7. INSERT INTO mqtt_acl (allow, ipaddr, username, clientid, access, topic) VALUES (0, NULL, '$all', NULL, 1, '/smarthome/+/temperature');
    9. -- 允许客户端订阅包含自身 Client ID 的 /smarthome/${clientid}/temperature 主题
    10. INSERT INTO mqtt_acl (allow, ipaddr, username, clientid, access, topic) VALUES (1, NULL, '$all', NULL, 1, '/smarthome/%c/temperature');

    启用 MySQL ACL 后并以用户名 emqx 成功连接后，客户端应当数据具有相应的主题权限。

    提示

    这是默认配置使用的表结构，熟悉该插件的使用后你可以使用任何满足条件的数据表进行 ACL 规则存储。

    进行 ACL 鉴权时，EMQX 将使用当前客户端信息填充并执行用户配置的超级用户 SQL，查询客户端是否为超级用户。客户端为超级用户时将跳过 ACL SQL。

    你可以在 SQL 中使用以下占位符，执行时 EMQX 将自动填充为客户端信息：

    • %u：用户名
    • %c：Client ID
    • %C：TLS 证书公用名（证书的域名或子域名），仅当 TLS 连接时有效
    • %d：TLS 证书 subject，仅当 TLS 连接时有效
    1. 查询结果中必须包含 is_superuser 字段，is_superuser 应该显式的为 true
    2. 查询结果只能有一条，多条结果时只取第一条作为有效数据

    提示

    如果不需要超级用户功能，注释并禁用该选项能有效提高效率

    进行 ACL 鉴权时，EMQX 将使用当前客户端信息填充并执行用户配置的超级用户 SQL，如果没有启用超级用户 SQL 或客户端不是超级用户，则使用 ACL SQL 查询出该客户端在数据库中的 ACL 规则。

    1. # etc/plugins/emqx_auth_mysql.conf
    3. auth.mysql.acl_query = select allow, ipaddr, username, clientid, access, topic from mqtt_acl where ipaddr = '%a' or username = '%u' or username = '$all' or clientid = '%c'

    你可以在 ACL SQL 中使用以下占位符，执行时 EMQX 将自动填充为客户端信息：

    • %u：用户名
    • %c：Client ID
    • %C：TLS 证书公用名（证书的域名或子域名），仅当 TLS 连接时有效
    • %d：TLS 证书 subject，仅当 TLS 连接时有效

    你可以根据业务需要调整 ACL SQL，如添加多个查询条件、使用数据库预处理函数，以实现更多业务相关的功能。但是任何情况下 ACL SQL 需要满足以下条件：

    1. 查询结果中必须包含 allow、access、topic、clientid、username、ipaddr 字段，如果字段不想参与比对则使用 $all 字符串或者数据库 NULL 值
    2. 查询结果可以有多条，多条结果时按照从上到下的顺序进行匹配

    提示

    MySQL 8.0 及以后版本使用了 caching_sha2_password 作为默认身份验证插件，受限于客户端驱动你必须将其更改为 插件：

    1. ALTER USER 'your_username'@'your_host' IDENTIFIED WITH mysql_native_password BY 'your_password';