EMQX 文档

简体中文

English

简体中文

English

Appearance

联系我们

使用 MongoDB 进行密码认证 ​

作为密码认证方式的一种，EMQX 支持通过集成 MongoDB 进行密码认证，目前 EMQX 支持单节点、Replica Set、Sharding 三种模式部署的 MongoDB 服务器。

前置准备

熟悉 EMQX 认证基本概念。

数据结构与查询语句 ​

MongoDB 认证器支持将认证数据存储为 MongoDB 文档。用户需要提供一个查询语句模板，且确保查询结果包含以下字段：

  • password_hash: 必需，数据库中的明文或散列密码字段，可以设置为其他字段名
  • salt: 可选，为空或不存在时视为空盐（salt = ""），可以设置为其他字段名
  • is_superuser: 可选，标记当前客户端是否为超级用户，默认为 false，可以设置为其他字段名

添加用户名为 emqx_u、密码为 public、盐值为 salt_foo123、散列方式为 sha256 且超级用户标志为 true 的用户示例：

js
> db.mqtt_user.insertOne(
  {
      "username": "emqx_u",
      "salt": "slat_foo123",
      "is_superuser": true,
      "password_hash": "44edc2d57cde8d79c98145003e105b90a14f1460b79186ea9cfe83942fc5abb5"
  }
);
{
  "acknowledged" : true,
  "insertedId" : ObjectId("631989e20a33e26b05b15abe")
}

TIP

当系统中有大量用户时，请确保查询使用的集合已优化并使用有效的索引，以提升大量连接时的数据查找速度并降低 EMQX 负载。

对应的配置参数为：

  • 密码加密方式：sha256
  • 加盐方式：suffix
  • Collection：mqtt_user
  • 查询 Filter：{ username = "${username}" }
  • Password Hash 字段名：password_hash
  • Salt 字段名：salt
  • is_superuser_field： is_superuser

通过 Dashboard 配置 ​

  1. 在 EMQX Dashboard 页面上点击左侧导航栏的访问控制 -> 客户端认证。
  2. 在客户端认证页面，点击**+ 创建**。
  3. 依次选择认证方式为 Password-Based，数据源为 MongoDB，点击下一步进入配置参数页签：
use mongodb to authenticate

  1. 根据以下说明配置数据源：

    • MongoDB 数据库的连接设置：

      • 部署模式：选择 MongoDB 数据库的部署模式，可选值：单节点、Replica Set、Sharding
      • 服务（列表）：填入 MongoDB 服务器地址 (host:port) ；当部署模式选为 Replica Set 或 Sharding 时，您需在此提供所有相关 MongoDB 服务器的地址，不同地址之间以 , 分隔，格式为 host1:port1,host2:port2,...
      • Replica Set Name：字符串，用于指定 Replica Set 的名称，仅需在部署模式设置为 Replica Set 时设置。
      • 数据库：数据库名称。
      • Collection： MongoDB 集合名称。
      • 用户名：填入用户名。
      • 密码：填入认证密码。
      • 读模式（可选）：读取模式，可选值：master、slave_ok；默认值：master；master 意味着序列中的每个查询都必须从主服务器读取新数据。 如果连接的服务器不是主服务器，则第一次读取将失败，其余操作将中止。slave_ok 表示允许每个查询从从服务器读取陈旧数据（来自主服务器的新数据也可以）；仅需在部署模式设置为 Replica Set 时设置。
      • 写模式（可选）：写入模式， 可选值：unsafe、 safe；默认值：safe。仅需在部署模式设置为 Replica Set 时设置。

    • 认证加密算法相关的配置：

      • Password Hash 字段名：指定密码的字段名称。
      • 密码加密方式：选择应用于明文密码的哈希算法，用于在将结果存储到数据库之前对密码进行加密。可用选项包括 plain、md5、sha、sha256、sha512、bcrypt 和 pbkdf2。具体配置取决于所选择的算法：
        • 选择 md5、sha、sha256 或 sha512 算法，需配置：
          • 加盐方式：用于指定盐和密码的组合方式，可选值：suffix（在密码尾部加盐）、prefix（在密码头部加盐）、disable（不启用）。如果无需从外部存储迁移用户凭据到 EMQX 内置数据库，可以保持默认值。
          • 生成的哈希以十六进制字符串形式表示，并与存储的凭据进行不区分大小写的比对。
        • 选择 plain：
          • 加盐方式：应设置为 disable。
        • 选择 bcrypt 算法，需配置:
          • Salt Rounds：指定散列需要的计算次数（2^Salt Rounds），也称成本因子。默认值：10，可选值：5 到 10；数值越高，加密的安全性越高，因此建议采用较大的值，但相应的用户验证的耗时也会增加，您可根据业务需求进行配置。
        • 选择 pbkdf2 算法，需配置：
          • 伪随机函数：指定生成密钥使用的散列函数，如 sha256 等。
          • 迭代次数：指定散列次数，默认值：4096。
          • 密钥长度（可选）：指定希望得到的密钥长度。如不指定，密钥长度将由伪随机函数确定。
          • 生成的哈希以十六进制字符串形式表示，并与存储的凭据进行不区分大小写的比对。
      • is_superuser 字段名：指定 MongoDB 数据中超级用户标志位字段。
      • salt 字段名：指定 MongoDB 数据中盐的字段。

    • 调用条件：一个 Variform 表达式，用于控制是否将此 MongoDB 认证器应用于客户端连接。该表达式会根据客户端的属性（例如 username、clientid、listener 等）进行评估。如果表达式的结果为字符串 "true"，则会触发认证器。否则，认证器将被跳过。有关调用条件的更多信息，请参见认证器调用条件。

    • 启用TLS：如果要启用TLS，请打开切换按钮。有关启用 TLS 的更多信息，请参见网络和 TLS。

    • 查询 Filter：MongoDB filter，用于过滤数据，支持认证占位符。

    • 连接配置：在此部分设置并发连接以及连接超时等待时间。

      • Pool size（可选）：填入一个整数用于指定从 EMQX 节点到 MongoDB 数据库的并发连接数；默认值：8。
      • 连接超时（可选）：填入连接超时等待时长，可选单位：小时、分钟、秒、毫秒。

  2. 点击创建完成相关配置。

通过配置文件配置 ​

您也可以通过配置文件完成相关配置。

以下为各部署模式下的配置文件示例：