# 基于 PostgreSQL 进行授权

PostgreSQL Authorizer 支持客户端的权限列表存储在 PostgreSQL 数据库中。

提示

前置准备:

# 表结构与查询语句

PostgreSQL Authorizer 可以支持任何表结构,甚至是多个表联合查询、或从视图中查询。用户需要提供一个查询 SQL 模板,且确保查询结果包含以下字段:

  • permission: 用于指定操作权限,可选值有 allowdeny
  • action: 用于指定当前规则适用于哪些操作,可选值有 publishsubscribeall
  • topic: 用于指定当前规则适用的主题,可以使用主题过滤器和主题占位符

示例表结构:

CREATE TABLE mqtt_acl(
  id serial PRIMARY KEY,
  username text NOT NULL,
  permission text NOT NULL,
  action text NOT NULL,
  topic text NOT NULL
);
CREATE INDEX mqtt_acl_username_idx ON mqtt_acl(username);
1
2
3
4
5
6
7
8

提示

上面的示例创建了一个索引,当系统中有大量权限数据时,请确保查询使用的表已优化并使用有效的索引,以提升大量连接时的数据查找速度并降低 EMQX 负载。

添加用户名为 emqx_u、禁止发布到 t/1 主题的规则示例:

postgres=# INSERT INTO mqtt_acl(username, permission, action, topic) VALUES ('emqx_u', 'deny', 'publish', 't/1');
INSERT 0 1
1
2

对应的配置参数为:

query = "SELECT permission, action, topic FROM mqtt_acl WHERE username = ${username}"
1

# 配置项

详细配置请参考 authz:postgresql

PostgreSQL authorizer 由 type=postgresql 标识。

配置示例:

{
  type = postgresql
  enable = true

  database = "mqtt"
  username = "postgres"
  password = "public"
  server = "127.0.0.1:5432"
  query = "SELECT permission, action, topic FROM acl WHERE username = ${username}"
}
1
2
3
4
5
6
7
8
9
10

# query

必选的字符串类型配置,用于查询当前客户端具有的权限列表,支持占位符

出于安全原因占位符值不会直接拼接 SQL,而是通过 PostgreSQL 预处理插入,能够有效预防 SQL 注入。

例如,以下查询语句:

SELECT permission, action, topic FROM acl WHERE username = ${username}
1

将首先被转换为以下 Prepared statement:

SELECT permission, action, topic FROM acl WHERE username = $1
1

然后使用 ${username} 执行查询。

# server

必选的字符串类型配置,用于指定 PostgreSQL 服务器地址,格式为 host:port

# database

必选的字符串类型配置,用于指定 PostgreSQL 数据库名称。

# username

可选的字符串类型配置,用于指定 PostgreSQL 用户名。

# password

可选的字符串类型配置,用于指定 PostgreSQL 用户密码。

# auto_reconnect

可选的布尔类型配置,用于指定 EMQX 是否会在连接断开时自动重新连接到 PostgreSQL,默认值为 true

# pool_size

可选的整型配置,用于指定 EMQX 节点到 PostgreSQL 服务器的并发连接数,默认值为 8。

# ssl

用于 安全连接到 PostgreSQL (opens new window) 的标准 SSL 选项。