Stomp 协议网关

简介

Stomp 网关基于 Stomp v1.2Stomp 协议网关 - 图1 (opens new window) 版本实现，并兼容 Stomp v1.0 和 v1.1 的标准。

快速开始

EMQX 5.0 中，可以通过 Dashboard 配置并启用 Stomp 网关。

也可以通过 HTTP API 或 emqx.conf 来启用，例如：

  1. curl -X 'PUT' 'http://127.0.0.1:18083/api/v5/gateway/stomp' \
  2.   -u <your-application-key>:<your-security-key> \
  3.   -H 'Content-Type: application/json' \
  4.   -d '{
  5.   "name": "stomp",
  6.   "enable": true,
  7.   "mountpoint": "stomp/",
  8.   "listeners": [
  9.     {
  10.       "type": "tcp",
  11.       "name": "default",
  12.       "bind": "61613",
  13.       "max_conn_rate": 1000,
  14.       "max_connections": 1024000
  15.     }
  16.   ]
  17. }'
  1. gateway.stomp {
  3.   mountpoint = "stomp/"
  5.   listeners.tcp.default {
  6.     bind = 61613
  7.     acceptors = 16
  8.     max_connections = 1024000
  9.     max_conn_rate = 1000
  10.   }
  11. }

提示

通过配置文件进行配置网关，需要在每个节点中进行配置；通过 Dashboard 或者 HTTP API 管理则会在整个集群中生效。

Stomp 网关支持 TCP、SSL 类型的监听器，其完整可配置的参数列表参考：网关配置 - 监听器

认证

由于 Stomp 协议的连接报文已定义了用户名和密码的概念，所以它支持以下多种认证器类型，例如：

Stomp 网关使用 STOMP 协议的 CONNECT 或 STOMP 报文中的信息来生成客户端的认证信息。默认情况下：

  • Client ID：为随机生成的字符串。
  • Username：为 CONNECT 或 STOMP 报文 Headers 中的 login 字段的值。
  • Password：为 CONNECT 或 STOMP 报文 Headers 中的 passcode 字段的值。

例如，通过 HTTP API 或 emqx.conf 为 Stomp 网关创建一个内置数据库认证：

  1. curl -X 'POST' \
  2.   'http://127.0.0.1:18083/api/v5/gateway/stomp/authentication' \
  3.   -u <your-application-key>:<your-security-key> \
  4.   -H 'accept: application/json' \
  5.   -H 'Content-Type: application/json' \
  6.   -d '{
  7.   "backend": "built_in_database",
  8.   "mechanism": "password_based",
  9.   "password_hash_algorithm": {
  10.     "name": "sha256",
  11.     "salt_position": "suffix"
  12.   },
  13.   "user_id_type": "username"
  14. }'
  1. gateway.stomp {
  3.   authentication {
  4.     backend = built_in_database
  5.     mechanism = password_based
  6.     password_hash_algorithm {
  7.       name = sha256
  8.       salt_position = suffix
  9.     }
  10.     user_id_type = username
  11.   }
  12. }

与 MQTT 协议不同，网关仅支持创建一个认证器，而不是认证器列表（或认证链）。当不启用任何认证器时，表示允许所有的 Stomp 客户端都具有接入的权限。

其他类型的认证器的配置格式参考：安全- 认证器

发布订阅

Stomp 协议完全兼容发布订阅的消息模式，Stomp 网关使用：

  • Stomp 协议的 SEND 报文作为消息发布。其主题为 SEND 报文中的 destination 字段，消息内容为 SEND 报文的消息体内容，QoS 固定为 0。
  • Stomp 协议的 SUBSCRIBE 报文作为订阅请求。其主题为 SUBSCRIBE 报文中的 destination 字段，QoS 固定为 0。且支持 MQTT 协议中定义的通配符。
  • Stomp 协议的 UNSUBSCRIBE 报文作为取消订阅请求。其主题为 UNSUBSCRIBE 报文中的destination 字段。

网关内无独立的发布订阅的权限控制，其对主题的权限控制需要统一在 授权（Authorization） 中管理。

用户层接口

客户端库