EMQX_AUTH_USERNAME 使用指南

在阅读该教程之前,假定你已经了解 MQTTEMQX 的简单知识。

emqx_auth_username 它通过比对每个终端的接入的 usernamepassword 与 EMQX 中存储的是否一致来实现终端接入的控制。其功能逻辑如下:

2671557804540_.pic.jpg

emqx_auth_username 目前版本仅提供了 连接认证 的功能。且提供了 CLIREST API 来进行管理当前集群中的 Username 库

插件配置项说明

在这里给出了其 3.1.0 版本默认的配置文件。其内容非常的简单,主要包括:

1.Password 密文加密类型

终端在连接时,必须采用对用加密类型的密文才可以成功连接

## Password hash.
##
## Value: plain | md5 | sha | sha256
auth.user.password_hash = sha256

Username 管理

CLI 命令

在成功启动 emqx_auth_username 该插件时,会向 EMQX 注册一些 CLI 命令以在运行时管理 username:

$ ./bin/emqx_ctl users

users list                                     
users add <Username> <Password>                
users update <Username> <NewPassword>          
users del <Username>

REST API

在成功启动 emqx_auth_username 该插件时,会开启对应的 REST API 用于在运行时管理 username

获取所有的 username

# Request
GET api/v3/auth_username

# Response
{
   "code": 0,
   "data": ["username1"]
}

添加一个 username:

# Request
POST api/v3/auth_username
{
   "username": "some_name",
   "password": "password"
}

# Response
{
   "code": 0
}

更新某 username 的密码 :

# Request
PUT api/v3/auth_username/$NAME
{
   "password": "password"
}

# Response
{
   "code", 0
}

查看某 username 的密码 (密文):

# Request
GET api/v3/auth_username/$NAME

# Response
{
   "code": 0,
   "data": {
       "username": "some_username",
       "password": "hashed_password"
   }
}

删除某 username:

# Request
DELETE api/v3/auth_username/$NAME

# Response
{
   "code": 0
}

推荐阅读

基于 MySQL 的 EMQX Auth & ACL

emqx-auth-mysql 它通过检查每个终端接入的 username 和 password 是否与用户指定 的 MySQL 数据库中存储的信息一致来实现对终端的访问控制。

EMQX_AUTH_HTTP 插件使用指南

EMQX MQTT broker 它将每个终端的接入认证、访问控制事件抛给用户自己的 WebServer 以实现接入认证和ACL鉴权的功能。

EMQX 认证鉴权(一)——基于 MySQL 的 MQTT 连接认证

EMQX 完整支持 MQTT 各项安全规范,内置的安全功能无需编程开箱即用,可以快速排除项目中的安全隐患。