MQTT(S)协议-自定义模板鉴权-华为云

设备接入 IOTDA-内部函数:Fn::SubStringAfter

Fn::SubStringAfter 内部函数Fn::SubStringAfter截取字符串指定分隔符后的子字符串。 JSON { "Fn::SubStringAfter" : ["content", "separator"] } 表16 参数说明参数名称类型说明 content String 待截取的字符串。 separator String 分隔符。返回值 String 字符串被指定分隔符分割后的子字符串。示例如下： { "Fn::SubStringAfter": ["content:123456", ":"] ] return: "123456"

设备接入 IOTDA MQTT(S)协议-自定义模板鉴权

设备接入 IOTDA-内部函数:Ref

Ref 内部函数Ref将返回指定引用参数的值，引用参数必须在模板中有声明。 JSON { "Ref" : "paramName" } 表18 参数说明参数名称类型说明 paramName String 引用的参数名称。返回值 String 引用参数对应的值。示例如下： { "Ref": "iotda::mqtt::username" } 当参数iotda::mqtt::username="device_123" return: "device_123"

设备接入 IOTDA MQTT(S)协议-自定义模板鉴权

设备接入 IOTDA-内部函数:Fn::SubStringBefore

Fn::SubStringBefore 内部函数Fn::SubStringBefore截取字符串指定分隔符前的子字符串。 JSON { "Fn::SubStringBefore" : ["content", "separator"] } 表17 参数说明参数名称类型说明 content String 待截取的字符串。 separator String 分隔符。返回值 String 字符串被指定分隔符分割前的子字符串。示例如下： { "Fn::SubStringBefore": ["content:123456", ":"] ] return: "content"

设备接入 IOTDA MQTT(S)协议-自定义模板鉴权

设备接入 IOTDA-内部函数:Fn::Split

Fn::Split 内部函数Fn::Split将一个字符串按指定的分隔符分割成字符串数组。 JSON { "Fn::Split" : ["String", "Separator"] } 表13 参数说明参数名称类型说明 String String 被分割的字符串。 Separator String 分隔符。返回值 String[] 原始参数String被分隔符Separator拆分后的字符串数组。示例如下： { "Fn::Split": ["a|b|c", "|"] } return: ["a", "b", "c"]

设备接入 IOTDA MQTT(S)协议-自定义模板鉴权

设备接入 IOTDA-内部函数:Fn::HmacSHA256

Fn::HmacSHA256 内部函数Fn::HmacSHA256将一个字符串按给定密钥进行HmacSHA256算法加密。 JSON {"Fn::HmacSHA256": ["content", "secret"]} 表5 参数说明参数名称类型说明 content String 待加密的字符串。 secret String 或 byte[] 加密密钥，可以是字符串或者字节数组类型返回值 String 使用HmacSHA256算法加密后的值。示例如下： { "Fn::HmacSHA256": ["testvalue", "123456"] } return: "0f9fb47bd47449b6ffac1be951a5c18a7eff694940b1a075b973ff9054a08be3"

设备接入 IOTDA MQTT(S)协议-自定义模板鉴权

设备接入 IOTDA-内部函数:Fn::MathDiv

Fn::MathDiv 内部函数Fn::MathDiv将两个整数进行数学除法运算。 JSON {"Fn::MathDiv": [X, Y]} 表8 参数说明参数名称类型说明 X long 被除数。 Y long 除数。返回值 long X 除Y后的值。示例如下： { "Fn::MathDiv": [10, 2] } return: 5 { "Fn::MathDiv": [10, 3] } return: 3

设备接入 IOTDA MQTT(S)协议-自定义模板鉴权

设备接入 IOTDA-内部函数:Fn::SplitSelect

Fn::SplitSelect 内部函数Fn::SplitSelect将一个字符串按指定的分隔符分割成字符串数组，然后返回数组指定索引的元素。 JSON { "Fn::SplitSelect" : ["String", "Separator", index] } 表14 参数说明参数名称类型说明 String String 被分割的字符串。 Separator String 分隔符。 index int 返回元素在数组中的索引值，从0开始。返回值 String 字符串按特定分隔符分割后指定索引的子字符串。示例如下： { "Fn::SplitSelect": ["a|b|c", "|", 1] } return: "b"

设备接入 IOTDA MQTT(S)协议-自定义模板鉴权

设备接入 IOTDA-内部函数:Fn::Base64Encode

Fn::Base64Encode 内部函数Fn::Base64Encode将一个字符串按BASE64编码。 JSON {"Fn::Base64Encode": "content"} 表3 参数说明参数名称类型说明 content String 待编码的字符串。返回值 String base64编码后的字符串。示例如下： { "Fn::Base64Encode": "testvalue" } return: "dGVzdHZhbHVl"

设备接入 IOTDA MQTT(S)协议-自定义模板鉴权

设备接入 IOTDA-内部函数:Fn::GetBytes

Fn::GetBytes 内部函数Fn::GetBytes返回一个字符串UTF-8编码的字节数组。 JSON {"Fn::GetBytes": "content"} 表4 参数说明参数名称类型说明 content String 待编码的字符串。返回值 byte[] 字符串UTF-8编码后的字节数组。示例如下： { "Fn::GetBytes": "testvalue" } return: "7465737476616c7565" //为了方便展示，此处转化为16进制字符串

设备接入 IOTDA MQTT(S)协议-自定义模板鉴权

设备接入 IOTDA-内部函数:Fn::Join

Fn::Join 内部函数Fn::Join可将多个字符串（数量最大值为10）拼接成一个字符串。 JSON {"Fn::Join": ["element", "element"...]} 表6 参数说明参数名称类型说明 element String 需拼接的字符串。返回值 String 子字符串拼接在一起后的字符串。示例如下： { "Fn::Join": ["123", "456", "789"] } return: "123456789"

设备接入 IOTDA MQTT(S)协议-自定义模板鉴权

设备接入 IOTDA-内部函数:Fn::Sub

Fn::Sub 内部函数Fn::Sub将输入字符串中的变量替换为指定的值。在模板中您可以使用此函数来构造一个动态的字符串。 JSON { "Fn::Sub" : [ "String", { "Var1Name": Var1Value, "Var2Name": Var2Value } ] } 表15 参数说明参数名称类型说明 String String 一个包含变量的字符串，变量使用“${}”占位符定义。 VarName String 变量名称，必须在参数“String”中定义。 VarValue String 变量的取值，支持函数嵌套。返回值 String 返回原始“String”参数字符串变量替换后的值。示例如下： { "Fn::Sub": ["${token};hmacsha256", { "token": { "Fn::HmacSHA256": ["${iotda::mqtt::username}", { "Fn::Base64Decode": "${iotda::mqtt::client_id}" }] } }] } 当变量 ${iotda::mqtt::username}="test_device_username" ${iotda::device::client_id}="OozqTPlCWTTJjEH/5s+T6w==" return："0773c4fd6c92902a1b2f4a45fdcdec416b6fc2bc6585200b496e460e2ef31c3d"

设备接入 IOTDA MQTT(S)协议-自定义模板鉴权

设备接入 IOTDA-内部函数:Fn::Base64Decode

Fn::Base64Decode 内部函数Fn::Base64Decode将一个字符串按BASE64解码成一个字节数组。 JSON { "Fn::Base64Decode" : "content" } 表2 参数说明参数名称类型说明 content String 待解码的字符串。返回值 byte[] base64解码后的字节数组。示例如下： { "Fn::Base64Decode": "123456"] } return: d76df8e7 //为了方便展示，此处转化为16进制字符串

设备接入 IOTDA MQTT(S)协议-自定义模板鉴权

设备接入 IOTDA-内部函数:使用说明

使用说明华为云IoTDA提供了多个内部函数供用户在模板中使用，使用时请认真阅读每个函数的功能定义，包括入参类型，参数长度，返回值类型等。整个函数必须是合法的Json格式。函数中可使用${}变量占位符或者"Ref"函数引用入参定义的参数值。函数所使用的参数必须在模板参数中声明。单一入参的函数后面直接跟参数，比如："Fn::Base64Decode": "${iotda::mqtt::username}"。多个入参的函数后面接数组格式，比如："Fn::HmacSHA256": ["${iotda::mqtt::username}", "${iotda::device::secret}"]。函数可以嵌套使用，即一个函数的参数可以是另一个函数，注意嵌套函数的返回值必须跟当前函数参数类型一致，比如：{"Fn::HmacSHA256": ["${iotda::mqtt::username}", {"Fn::Base64Encode": "${iotda::device::secret}"}]}

设备接入 IOTDA MQTT(S)协议-自定义模板鉴权

设备接入 IOTDA-自定义模板示例:示例1

示例1 证书认证设备，不限制UserName与ClientId参数取值，从设备证书通用名称（Common Name）中取值设备ID。表1 鉴权参数参数说明 Client ID 任意值 User Name 任意值 Password 空值鉴权模板： { "template_name": "template1", "description": "template1", "template_body": { "parameters": { "iotda::certificate::common_name": { "type": "String" } }, "resources": { "device_id": { "Ref": "iotda::certificate::common_name" } } } }

设备接入 IOTDA MQTT(S)协议-自定义模板鉴权

设备接入 IOTDA-自定义模板示例:示例2

示例2 设备ID格式为：${ProductId}_${NodeId}。表2 鉴权参数参数说明 Client ID 固定格式： ${ClientId}|securemode=2,signmethod=hmacsha256|timestamp=${timestamp}| ${ClientId}：固定格式 ${ProductId}.${NodeId}。 ${NodeId}：设备标识码。 ${ProductId}：产品ID。 ${timestamp}：Unix时间戳，毫秒。 User Name 由设备标识码和产品ID组成，固定格式： ${NodeId}&${ProductId} Password 以设备密码为密钥，将设备参数与参数值拼接后的字符串为加密串进行hmacsha256算法加密。加密串格式： clientId${clientId}deviceName${nodeId}productKey${productId}timestamp${timestamp} ${ClientId}：固定格式 ${ProductId}.${NodeId}。 ${NodeId}：设备标识码。 ${ProductId}：产品ID。 ${timestamp}：时间戳。鉴权模板： { "template_name": "template2", "description": "template2", "template_body": { "parameters": { "iotda::mqtt::client_id": { "type": "String" }, "iotda::mqtt::username": { "type": "String" }, "iotda::device::secret": { "type": "String" } }, "resources": { "device_id": { "Fn::Join": [{ "Fn::SplitSelect": [ "${iotda::mqtt::username}", "&", 1 ] }, "_", { "Fn::SplitSelect": [ "${iotda::mqtt::username}", "&", 0 ] }] }, "timestamp": { "type": "UNIX", "value": { "Fn::MathDiv": [{ "Fn::ParseLong": { "Fn::SplitSelect": [{ "Fn::SplitSelect": ["${iotda::mqtt::client_id}", "|", 2] }, "=", 1] } }, 1000] } }, "password": { "Fn::HmacSHA256": [{ "Fn::Sub": [ "clientId${clientId}deviceName${deviceName}productKey${productKey}timestamp${timestamp}", { "clientId": { "Fn::SplitSelect": [ "${iotda::mqtt::client_id}", "|", 0 ] }, "deviceName": { "Fn::SplitSelect": [ "${iotda::mqtt::username}", "&", 0 ] }, "productKey": { "Fn::SplitSelect": [ "${iotda::mqtt::username}", "&", 1 ] }, "timestamp": { "Fn::SplitSelect": [{ "Fn::SplitSelect": ["${iotda::mqtt::client_id}", "|", 2] }, "=", 1] } } ] }, "${iotda::device::secret}" ] } } } }

设备接入 IOTDA MQTT(S)协议-自定义模板鉴权

云服务器内容精选

MQTT(S)协议-自定义模板鉴权

7*24

备案

专业服务

退订

建议反馈

售前咨询热线