Coap協定接入物聯網平台（java實作）

概述

阿裡雲物聯網平台支援CoAP協定連接配接通信。CoAP協定适用在資源受限的低功耗裝置上，尤其是NB-IoT的裝置使用。本文介紹基于開源的CoAP協定進行對稱加密自主接入的流程，并提供java示例代碼。

官方文檔：

CoAP連接配接通信

說明與限制

Topic規範和MQTT Topic一緻，CoAP協定内 coap://host:port/topic/${topic}接口對于所有${topic}和MQTT Topic可以複用。
用戶端緩存認證傳回的token是請求的令牌。
傳輸的資料大小依賴于MTU的大小，建議在1 KB以内。
僅華東2（上海）地域支援CoAP通信。

接入流程

連接配接CoAP伺服器

endpoint位址為：${YourProductKey}.coap.cn-shanghai.link.aliyuncs.com:${port}
${YourProductKey}：産品的ProductKey
${port}：端口。使用對稱加密時端口為5682

裝置認證

認證請求

POST /auth
Host: ${YourProductKey}.coap.cn-shanghai.link.aliyuncs.com
Port: 5682
Accept: application/json or application/cbor
Content-Format: application/json or application/cbor
payload: {"productKey":"a1NUjcV****","deviceName":"ff1a1****","clientId":"a1NUjcV****&ff1a1****","sign":"F9FD53EE0CD010FCA40D14A9FE******", "seq":"10"}

請求參數說明

參數	說明
Method	請求方法。隻支援POST方法
URL	URL位址，取值：/auth
Host	Endpoint位址。取值格式：${YourProductKey}.coap.cn-shanghai.link.aliyuncs.com。其中，變量${YourProductKey}需替換為您的産品Key。
Port	端口，取值：5682
Accept	裝置接收的資料編碼方式。目前，支援兩種方式：application/json和application/cbor。
Content-Format	裝置發送給物聯網平台的上行資料的編碼格式，目前支援兩種方式： application/json和application/cbor。
payload	裝置認證資訊内容，JSON資料格式。具體參數，請參見 payload說明。

上報資料

上報資料請求

POST /topic/${topic}
Host: ${YourProductKey}.coap.cn-shanghai.link.aliyuncs.com
Port: 5682
Accept: application/json or application/cbor
Content-Format: application/json or application/cbor
payload: ${your_data}
CustomOptions: number:2088(辨別token), 2089(seq)

	是否必需
	是	請求方法。支援POST方法。
		傳入格式：/topic/${topic}。其中，變量${topic}需替換為裝置資料上行Topic。
		endpoint位址。傳入格式：${YourProductKey}.coap.cn-shanghai.link.aliyuncs.com。其中，${YourProductKey}需替換為裝置所屬産品的Key。
		端口。取值：5682。

		上行資料的編碼格式，服務端對此不做校驗。目前，支援兩種方式：application/json和application/cbor。
		待上傳的資料經進階加密标準（AES）加密後的資料。加密規則
CustomOptions		option值有2088和2089兩種類型。類型解釋

java示例代碼

pom.xml依賴

<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.61</version>
</dependency>

IotCoapClientWithAes類

/*
 * 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開發。
 * 自主接入開發流程及參數填寫，請參見：
 * https://help.aliyun.com/document_detail/57697.html [使用對稱加密自主接入]
 */
public class IotCoapClientWithAes {

    // ===================需要使用者填寫的參數，開始===========================
    // 地域ID，目前僅支援華東2
    private static String regionId = "cn-shanghai";
    // 産品productKey
    private static String productKey = "****";
    // 裝置名成deviceName
    private static String deviceName = "****";
    // 裝置密鑰deviceSecret
    private static String deviceSecret = "****";
    //發送的消息内容payload
    private static String payload = "hello coap!!";
    // ===================需要使用者填寫的參數，結束===========================

    // 定義加密方式 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 conenct(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("----------------");
            System.out.println(request.getPayload().length);
            System.out.println("----------------");
            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 vlaue = json.getString(key);
            map.put(key, vlaue);
        }
        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.conenct(productKey, deviceName, deviceSecret);
        client.publish(updateTopic, payload.getBytes(StandardCharsets.UTF_8));
    }
}

注意事項

coap協定是短連接配接，和mqtt長連接配接不同，是以在控制台的裝置行為日志裡看不到記錄，需要注意。
coap協定發送的payload有大小限制，不能超過1KB，如果超過的話這個請求會被拒絕，消息發不到平台。代碼中System.out.println(request.getPayload().length);就是用來列印payload長度的。

Coap協定接入物聯網平台（java實作）

概述

說明與限制

接入流程

連接配接CoAP伺服器

裝置認證

上報資料

java示例代碼

注意事項

繼續閱讀

neo4j之cypher使用文檔

Dijkstra--簡易版（最短路徑）

GitHub連夜封殺！這份阿裡 10W 字内部 Java 字面試手冊到底有多強？

spark/scala關于【資源檔案】加載方法概述外部檔案加載方案測試資源檔案打包入jar包中小結

mybatis_入門程式Mybatis入門

vue-cli簡介（中文翻譯）

AOP程式設計_Android優雅權限架構(1)概念基礎，2021金三銀四前言正文大綱正文

Ajax發送和擷取json資料到Spring mvc 1.spring mvc後端2.web前段

Effective Java 8:通用程式設計

OOM三種類型

工廠模式-三種類型

【遞歸】高效率求2的n次幂

win10本地scala和spark安裝安裝scala安裝spark

scala (3) Function 和 Method

JSONObject包導入異常 java.lang.NoClassDefFoundErrorweb項目的導入包的問題

hdu7108哈希