Appearance
设备MQTT-WebSocket连接认证
设备管理平台支持基于WebSocket的MQTT协议。您可以首先使用WebSocket建立连接,然后在WebSocket通道上使用MQTT协议进行通信,即MQTT over WebSocket。
在进行MQTT WebSocket协议连接时,需注意:
WebSocket可以使用ws和wss两种方式,ws是普通的WebSocket连接,wss是增加了TLS加密。如果使用wss方式进行安全连接,需要使用和TLS直连相同的根证书。
为保障通信安全,推荐使用TLS加密的连接方式wss。
连接认证规范
使用WebSocket方式进行连接,连接参数如下。
1、参数:接入域名。根据具体的平台部署情况,选择合适的地址接入:wss://xxx.openvalley.net:xxx/mqtt
2、参数:可变报头(variable header):Keep Alive。 CONNECT指令中需包含Keep Alive(保活时间)。保活心跳时间取值范围为30秒~1200秒,建议取值300秒以上。若网络不稳定,请将心跳时间设置长一些。如果心跳时间不在保活时间内,平台会拒绝连接。
3、参数:MQTT WebSocket的CONNECT报文。
连接参数如下:
Clientid: clientId+"|clienttype=0,signmethod=hmacmd5,timestamp=132323232|"
Username: deviceName+"&"+productKey
Password: sign_hmac(deviceSecret,content)
参数说明如下:
- ClientId:连接的客户端ID。格式中 | 内为扩展参数。
- clientId:必传。表示客户端ID,可自定义,长度不可超过64个字符。强烈建议使用设备的SN码或MAC地址,方便识别区分不同的客户端。
- clienttype:可选。标识客户端类型,clienttype=0:直连设备(默认,可不传);clienttype=1:appuser,app端用户认证(app也可作为一个通用设备接入mqtt组件中); clienttype=2:web模拟器模拟设备连接认证(需要校验时间)。如果不传则默认为:clienttype=0。
- signmethod:可选。表示签名算法类型。支持hmacmd5,hmacsha1和hmacsha256,不传默认为:hmacmd5。
- timestamp:可选。表示当前时间毫秒值的时间戳,会校验时效性。
- Username:连接的用户名。使用 & 分隔扩展。
- deviceName:必传。表示具体的deviceName。
- productKey:必传。表示具体的productKey。
- Password:连接的密码。sign签名需把提交给服务器的参数按字典排序后,根据signmethod加签。签名计算示例下文有说明。 content的值为提交给服务器的参数(productKey、deviceName、clientId、timestamp),按照参数名称首字母字典排序, 然后将参数值依次拼接。
示例: 假设 clientId = 12345,deviceName = device1, productKey = pk, timestamp = 789,signmethod=hmacmd5,deviceSecret=secret123,那么使用TCP方式提交给MQTT WebSocket的参数如下:
clientId=12345|signmethod=hmacmd5,timestamp=789|
Username=device1&pk
Password=hmacmd5("secret123","clientId12345deviceNamedevice1productKeypktimestamp789");
加密后的Password的值示例为:Password=566BCDA5123424CE529006AFD27BBF7B