CoAP用戶端對稱式加密接入樣本 - IoT Platform

本文以Java代碼為樣本，介紹基於CoAP協議的裝置接入物聯網平台。

背景資訊

CoAP協議適用於資源受限的低功耗裝置，尤其是NB-IoT的裝置。配置裝置通過CoAP協議與物聯網平台串連並通訊的說明，請參見CoAP串連通訊。

說明目前僅華東2（上海）地區支援裝置通過CoAP通道接入物聯網平台。

配置裝置通過CoAP協議接入物聯網平台時，需要填寫相應的參數，計算裝置端簽名，步驟較為複雜。為了便於您理解相關配置，本文提供基於Californium架構的接入範例程式碼。本樣本中，為保證資料安全，使用對稱式加密。

準備開發環境

本文使用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 });
    }
}

配置相關參數，替換以下參數為實際值。

參數	說明
regionId	您的物聯網平台服務的地區代碼。您可在物聯網平台控制台左上方，查看當前服務所在地區。地區代碼的表達方法，請參見地區列表。
productKey	您在物聯網平台控制台添加裝置後，儲存的裝置認證資訊。您可在物聯網平台控制台的裝置詳情頁面查看。
deviceName
deviceSecret
serverURI	CoAP接入地址。擷取方法，請參見查看和配置執行個體終端節點資訊（Endpoint）。

運行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