本文以Java代码为示例，介绍基于CoAP协议的设备接入物联网平台。
背景信息
CoAP协议适用于资源受限的低功耗设备，尤其是NB-IoT的设备。配置设备通过CoAP协议与物联网平台连接并通信的说明，请参见CoAP连接通信。
重要 目前仅华东2（上海）、华北2（北京）、华南1（深圳）地域支持设备通过CoAP通道接入物联网平台。
配置设备通过CoAP协议接入物联网平台时，需要填写相应的参数，计算设备端签名，步骤较为复杂。为了便于您理解相关配置，本文提供基于Californium框架的接入示例代码。本示例中，为保证数据安全，使用对称加密。
若需使用C语言开发CoAP协议的设备接入物联网平台，请参见C Link SDK的CoAP接入示例。
准备开发环境
本文使用Java开发环境如下：
- 操作系统：Windows10
- JDK版本：JDK8
- 集成开发环境：IntelliJ IDEA社区版
操作步骤
- 打开IntelliJ IDEA，创建一个Maven工程。例如IotCoap-demo。
- 在工程中的pom.xml文件中，添加以下依赖，然后单击Load Maven Changes图标，完成依赖包下载，引入Californium开源框架、Apache commons工具包和阿里云fastjson包。
<dependency> <groupId>org.eclipse.californium</groupId> <artifactId>californium-core</artifactId> <version>2.0.0-M17</version> </dependency> <dependency> <groupId>org.apache.commons</groupId> <artifactId>commons-lang3</artifactId> <version>3.5</version> </dependency> <dependency> <groupId>commons-codec</groupId> <artifactId>commons-codec</artifactId> <version>1.13</version> </dependency> <dependency> <groupId>com.alibaba</groupId> <artifactId>fastjson</artifactId> <version>1.2.83</version> </dependency> - 在工程IotCoap-demo的路径/src/main/java下，创建Java类，输入代码。例如IotCoapClientWithAes.java，代码内容如下。
/* * Copyright 2019 Alibaba. All rights reserved. */ import java.io.IOException; import java.nio.charset.StandardCharsets; import java.security.MessageDigest; import java.security.NoSuchAlgorithmException; import java.util.Set; import java.util.SortedMap; import java.util.TreeMap; import javax.crypto.Cipher; import javax.crypto.Mac; import javax.crypto.spec.IvParameterSpec; import javax.crypto.spec.SecretKeySpec; import org.apache.commons.codec.DecoderException; import org.apache.commons.codec.binary.Hex; import org.apache.commons.lang3.RandomUtils; import org.eclipse.californium.core.CoapClient; import org.eclipse.californium.core.CoapResponse; import org.eclipse.californium.core.Utils; import org.eclipse.californium.core.coap.CoAP; import org.eclipse.californium.core.coap.CoAP.Code; import org.eclipse.californium.core.coap.CoAP.Type; import org.eclipse.californium.core.coap.MediaTypeRegistry; import org.eclipse.californium.core.coap.Option; import org.eclipse.californium.core.coap.OptionNumberRegistry; import org.eclipse.californium.core.coap.OptionSet; import org.eclipse.californium.core.coap.Request; import org.eclipse.californium.elements.exception.ConnectorException; import com.alibaba.fastjson.JSONObject; /** * CoAP客户端连接阿里云物联网平台，基于eclipse californium开发。 * 自主接入开发流程及参数填写，请参见《CoAP连接通信》的使用对称加密自主接入章节。 */ public class IotCoapClientWithAes { // ===================需要用户填写的参数，开始。=========================== // 地域ID，以华东2（上海）为例。 private static String regionId = "cn-shanghai"; // 产品productKey。 private static String productKey = "您的设备productKey"; // 设备名称deviceName。 private static String deviceName = "您的设备deviceName"; // 设备密钥deviceSecret。 private static String deviceSecret = "您的设备deviceSecret"; // ===================需要用户填写的参数，结束。=========================== // 定义加密方式，MAC算法可选以下算法：HmacMD5、HmacSHA1，需与signmethod一致。 private static final String HMAC_ALGORITHM = "hmacsha1"; // CoAP接入地址，对称加密端口号是5682。 private static String serverURI = "coap://" + productKey + ".coap." + regionId + ".link.aliyuncs.com:5682"; // 发送消息用的Topic。需要在控制台自定义Topic，设备操作权限需选择为“发布”。 private static String updateTopic = "/" + productKey + "/" + deviceName + "/user/update"; // token option private static final int COAP2_OPTION_TOKEN = 2088; // seq option private static final int COAP2_OPTION_SEQ = 2089; // 加密算法sha256。 private static final String SHA_256 = "SHA-256"; private static final int DIGITAL_16 = 16; private static final int DIGITAL_48 = 48; // CoAP客户端。 private CoapClient coapClient = new CoapClient(); // token有效期7天，失效后需要重新获取。 private String token = null; private String random = null; @SuppressWarnings("unused") private long seqOffset = 0; /** * 初始化CoAP客户端。 * * @param productKey，产品key。 * @param deviceName，设备名称。 * @param deviceSecret ，设备密钥。 */ public void connect(String productKey, String deviceName, String deviceSecret) { try { // 认证uri，/auth。 String uri = serverURI + "/auth"; // 只支持POST方法。 Request request = new Request(Code.POST, Type.CON); // 设置option。 OptionSet optionSet = new OptionSet(); optionSet.addOption(new Option(OptionNumberRegistry.CONTENT_FORMAT, MediaTypeRegistry.APPLICATION_JSON)); optionSet.addOption(new Option(OptionNumberRegistry.ACCEPT, MediaTypeRegistry.APPLICATION_JSON)); request.setOptions(optionSet); // 设置认证uri。 request.setURI(uri); // 设置认证请求payload。 request.setPayload(authBody(productKey, deviceName, deviceSecret)); // 发送认证请求。 CoapResponse response = coapClient.advanced(request); System.out.println(Utils.prettyPrint(response)); System.out.println(); // 解析请求响应。 JSONObject json = JSONObject.parseObject(response.getResponseText()); token = json.getString("token"); random = json.getString("random"); seqOffset = json.getLongValue("seqOffset"); } catch (ConnectorException e) { e.printStackTrace(); } catch (IOException e) { e.printStackTrace(); } } /** * 发送消息。 * * @param topic，发送消息的Topic。 * @param payload，消息内容。 */ public void publish(String topic, byte[] payload) { try { // 消息发布uri，/topic/${topic}。 String uri = serverURI + "/topic" + topic; // AES加密seq，seq=RandomUtils.nextInt()。 String shaKey = encod(deviceSecret + "," + random); byte[] keys = Hex.decodeHex(shaKey.substring(DIGITAL_16, DIGITAL_48)); byte[] seqBytes = encrypt(String.valueOf(RandomUtils.nextInt()).getBytes(StandardCharsets.UTF_8), keys); // 只支持POST方法。 Request request = new Request(CoAP.Code.POST, CoAP.Type.CON); // 设置option。 OptionSet optionSet = new OptionSet(); optionSet.addOption(new Option(OptionNumberRegistry.CONTENT_FORMAT, MediaTypeRegistry.APPLICATION_JSON)); optionSet.addOption(new Option(OptionNumberRegistry.ACCEPT, MediaTypeRegistry.APPLICATION_JSON)); optionSet.addOption(new Option(COAP2_OPTION_TOKEN, token)); optionSet.addOption(new Option(COAP2_OPTION_SEQ, seqBytes)); request.setOptions(optionSet); // 设置消息发布uri。 request.setURI(uri); // 设置消息payload。 request.setPayload(encrypt(payload, keys)); // 发送消息。 CoapResponse response = coapClient.advanced(request); System.out.println(Utils.prettyPrint(response)); // 解析消息发送结果。 String result = null; if (response.getPayload() != null) { result = new String(decrypt(response.getPayload(), keys)); } System.out.println("payload: " + result); System.out.println(); } catch (ConnectorException e) { e.printStackTrace(); } catch (IOException e) { e.printStackTrace(); } catch (DecoderException e) { e.printStackTrace(); } } /** * 生成认证请求内容。 * * @param productKey，产品key。 * @param deviceName，设备名字。 * @param deviceSecret，设备密钥。 * @return 认证请求。 */ private String authBody(String productKey, String deviceName, String deviceSecret) { // 构建认证请求。 JSONObject body = new JSONObject(); body.put("productKey", productKey); body.put("deviceName", deviceName); body.put("clientId", productKey + "." + deviceName); body.put("timestamp", String.valueOf(System.currentTimeMillis())); body.put("signmethod", HMAC_ALGORITHM); body.put("seq", DIGITAL_16); body.put("sign", sign(body, deviceSecret)); System.out.println("----- auth body -----"); System.out.println(body.toJSONString()); return body.toJSONString(); } /** * 设备端签名。 * * @param params，签名参数。 * @param deviceSecret，设备密钥。 * @return 签名十六进制字符串。 */ private String sign(JSONObject params, String deviceSecret) { // 请求参数按字典顺序排序。 Set<String> keys = getSortedKeys(params); // sign、signmethod、version、resources除外。 keys.remove("sign"); keys.remove("signmethod"); keys.remove("version"); keys.remove("resources"); // 组装签名明文。 StringBuffer content = new StringBuffer(); for (String key : keys) { content.append(key); content.append(params.getString(key)); } // 计算签名。 String sign = encrypt(content.toString(), deviceSecret); System.out.println("sign content=" + content); System.out.println("sign result=" + sign); return sign; } /** * 获取JSON对象排序后的key集合。 * * @param json，需要排序的JSON对象。 * @return 排序后的key集合。 */ private Set<String> getSortedKeys(JSONObject json) { SortedMap<String, String> map = new TreeMap<String, String>(); for (String key : json.keySet()) { String value = json.getString(key); map.put(key, value); } return map.keySet(); } /** * 使用HMAC_ALGORITHM加密。 * * @param content，明文。 * @param secret，密钥。 * @return 密文。 */ private String encrypt(String content, String secret) { try { byte[] text = content.getBytes(StandardCharsets.UTF_8); byte[] key = secret.getBytes(StandardCharsets.UTF_8); SecretKeySpec secretKey = new SecretKeySpec(key, HMAC_ALGORITHM); Mac mac = Mac.getInstance(secretKey.getAlgorithm()); mac.init(secretKey); return Hex.encodeHexString(mac.doFinal(text)); } catch (Exception e) { e.printStackTrace(); return null; } } /** * SHA-256 * * @param str，待加密的报文。 */ private String encod(String str) { MessageDigest messageDigest; String encdeStr = ""; try { messageDigest = MessageDigest.getInstance(SHA_256); byte[] hash = messageDigest.digest(str.getBytes(StandardCharsets.UTF_8)); encdeStr = Hex.encodeHexString(hash); } catch (NoSuchAlgorithmException e) { System.out.println(String.format("Exception@encod: str=%s;", str)); e.printStackTrace(); return null; } return encdeStr; } // AES加解密算法。 private static final String IV = "543yhjy97ae7fyfg"; private static final String TRANSFORM = "AES/CBC/PKCS5Padding"; private static final String ALGORITHM = "AES"; /** * key length = 16 bits */ private byte[] encrypt(byte[] content, byte[] key) { return encrypt(content, key, IV); } /** * key length = 16 bits */ private byte[] decrypt(byte[] content, byte[] key) { return decrypt(content, key, IV); } /** * aes 128 cbc key length = 16 bits */ private byte[] encrypt(byte[] content, byte[] key, String ivContent) { try { SecretKeySpec keySpec = new SecretKeySpec(key, ALGORITHM); Cipher cipher = Cipher.getInstance(TRANSFORM); IvParameterSpec iv = new IvParameterSpec(ivContent.getBytes(StandardCharsets.UTF_8)); cipher.init(Cipher.ENCRYPT_MODE, keySpec, iv); return cipher.doFinal(content); } catch (Exception ex) { System.out.println( String.format("AES encrypt error, %s, %s, %s", content, Hex.encodeHex(key), ex.getMessage())); return null; } } /** * aes 128 cbc key length = 16 bits */ private byte[] decrypt(byte[] content, byte[] key, String ivContent) { try { SecretKeySpec keySpec = new SecretKeySpec(key, ALGORITHM); Cipher cipher = Cipher.getInstance(TRANSFORM); IvParameterSpec iv = new IvParameterSpec(ivContent.getBytes(StandardCharsets.UTF_8)); cipher.init(Cipher.DECRYPT_MODE, keySpec, iv); return cipher.doFinal(content); } catch (Exception ex) { System.out.println(String.format("AES decrypt error, %s, %s, %s", Hex.encodeHex(content), Hex.encodeHex(key), ex.getMessage())); return null; } } public static void main(String[] args) throws InterruptedException { IotCoapClientWithAes client = new IotCoapClientWithAes(); client.connect(productKey, deviceName, deviceSecret); client.publish(updateTopic, "hello coap".getBytes(StandardCharsets.UTF_8)); client.publish(updateTopic, new byte[] { 0x01, 0x02, 0x03, 0x05 }); } } - 配置相关参数，替换以下参数为实际值。
- 运行IotCoapClientWithAes.java程序。运行结果如下所示，设备认证通过后，即可通信。
sign content=clientIda1****RK0.devicedeviceNamedeviceproductKeya1OX****K0seq16timestamp1658909565141 sign result=7f3b76dc21e7******fec424838d1858 ----- auth body ----- {"clientId":"a1OXp8sXRK0.device","signmethod":"hmacsha1","sign":"7f3b76dc21e7******fec424838d1858","productKey":"a1OX****K0","deviceName":"device","seq":16,"timestamp":"1658909565141"} ==[ CoAP Response ]============================================ MID : 37682 Token : 6E1F******6B91 Type : ACK Status : 2.05 - CONTENT Options: {} RTT : 116 ms Payload: 85 Bytes --------------------------------------------------------------- {"random":"a25******6d44","seqOffset":1,"token":"mnx4OF0b******R000000.5ac7"} =============================================================== ==[ CoAP Response ]============================================ MID : 37683 Token : AC60******106E7 Type : ACK Status : 2.05 - CONTENT Options: {"Unknown (2090)":0x158a******6aa00} RTT : 118 ms Payload: 0 Bytes =============================================================== payload: null ==[ CoAP Response ]============================================ MID : 37684 Token : AA9******EFCC Type : ACK Status : 2.05 - CONTENT Options: {"Unknown (2090)":0x158a******f600} RTT : 103 ms Payload: 0 Bytes =============================================================== payload: null