实现跨平台加解密数据兼容性
=============

#### 概述

为确保数据安全，数据传输过程中需进行加解密操作。实现加密和解密操作在不同环境下的互操作性和跨平台数据的兼容性也极为关键。这一目标受以下两方面影响：

1.  数据编码格式差异：不同平台可能使用不同的数据格式，导致跨平台传输和存储时出现不兼容。
2.  加解密算法使用差异：不同平台支持相同的算法，但算法框架的使用方式会有所不同。

本文从[数据编码格式差异](#数据编码格式差异)以及[加解密算法使用差异](#加解密算法使用差异)两个方面来深入分析加解密失败的可能原因，并提供相应的解决方案，避免跨平台加解密失败，帮助开发者在HarmonyOS平台上高效、准确地完成加解密任务，实现跨平台数据兼容性。

#### 加解密开发步骤

加解密通常遵循以下流程：

1.  选择加解密算法并确定密钥
    
    *   根据具体的安全需求，选择合适的加解密算法。可以是[对称密钥加解密算法](https://developer.huawei.com/consumer/cn/doc/harmonyos-guides/crypto-sym-encrypt-decrypt-spec)（例如AES）、[非对称密钥加解密算法](https://developer.huawei.com/consumer/cn/doc/harmonyos-guides/crypto-asym-encrypt-decrypt-spec)（例如RSA）等。
    *   确定加解密所需密钥。对称密钥为随机生成的二进制数据，非对称密钥需生成公钥和私钥。
2.  准备待加解密的数据
    
    *   明确需要加密的数据，如文本、文件或数据库记录。
    *   对数据进行预处理，如格式化、编码转换，确保符合加密算法的输入要求。
3.  初始化加解密引擎
    
    根据所选加密算法，初始化加密引擎。设置加密模式（如CBC、ECB）和填充方式等参数，以满足特定安全需求。
    
4.  执行加密操作
    
    *   将明文数据输入加密引擎。
    *   加密引擎根据设定的算法和密钥对数据进行加密，通常逐块处理。对于大文件，可能需要分块加密。
5.  输出结果
    
    *   加密后得到密文数据。
    *   可以将密文存储在文件或数据库中，或通过网络传输给接收方。

#### 数据编码格式差异

加解密操作常跨平台进行，例如服务端加密的数据需在移动设备上解密。HarmonyOS平台的加解密API要求密钥和待处理数据为Uint8Array格式。因此，需将Uint8Array字节数据与其他编码格式数据互相转换，确保编码格式一致。

以下列举三种数据格式之间的转换方法：

*   普通编码格式的字符串与Uint8Array类型的转换
    
    普通文本字符串与Uint8Array的转换建议采用UTF-8编码，但加密后的密文数据（Uint8Array）应使用Base64或十六进制编码进行传输，切勿使用UTF-8编码。
    
    // Convert string to uint8Array.
    public static stringToUint8Array(str: string): Uint8Array {
      let textEncoder = util.TextEncoder.create('utf-8');
      return textEncoder.encodeInto(str);
    }
    
    // Convert uint8Array to string.
    public static uint8ArrayToString(input: Uint8Array): string {
      let textDecoder = util.TextDecoder.create('utf-8');
      return textDecoder.decodeToString(input);
    }
    
*   Base64编码格式字符串与Uint8Array类型的转换
    
    在HarmonyOS侧接收数据后，先进行Base64解码，将字符串转换为Uint8Array类型的字节流，再进行解密操作。
    
    反之，如果需要将数据从HarmonyOS侧发送到服务端，需要先将数据加密后的字节流进行Base64编码，转换为字符串后再进行传输。
    
    // Convert base64 to uint8Array.
    public static base64ToUint8Array(str: string): Uint8Array {
      let base64Helper = new util.Base64Helper();
      return base64Helper.decodeSync(str);
    }
    
    // Convert uint8Array to base64.
    public static uint8ArrayToBase64(input: Uint8Array): string {
      let base64Helper = new util.Base64Helper();
      return base64Helper.encodeToStringSync(input);
    }
    
*   16进制编码格式字符串与Uint8Array类型的转换
    
    // Convert hex to uint8Array.
    public static hexStrToUint8Array(data: string): Uint8Array {
      return new Uint8Array(buffer.from(data, 'hex').buffer);
    }
    
    // Convert uint8Array to hex.
    public static uint8ArrayToHexStr(input: Uint8Array): string {
      let hexString = '';
      for (let i = 0; i < input.length; i++) {
        let char = ('00' + input\[i\].toString(16)).slice(-2);
        hexString += char;
      }
      return hexString;
    }
    

#### 加解密算法使用差异

不同平台支持相同的算法，但加解密算法在使用时可能存在差异，这些差异可能导致加解密无法跨平台正常工作。

HarmonyOS平台与其它平台在加解密使用上存在差异。

1.  HarmonyOS平台加解密API要求密钥和待处理的数据为Uint8Array格式，可参考[数据编码格式差异](#数据编码格式差异)实现数据格式的转换。
2.  在HarmonyOS平台上，默认支持SM2算法。需要注意的是，HarmonyOS仅支持ASN.1格式的数据（如密钥和密文）。因此，SM2算法在跨平台加解密时，需要进行原始裸数据与ASN.1格式数据的转换，包括密钥格式转换和密文格式转换，具体可参考[SM2加解密](#sm2加解密)。
3.  HarmonyOS平台在初始化加解密引擎时，需要传入固定的参数，参数格式可参考[加解密算法规格](https://developer.huawei.com/consumer/cn/doc/harmonyos-guides/crypto-encrypt-decrypt-spec)。以AES为例，详细分析密钥长度使用问题和偏移量参数的设置问题，具体可参考[AES加解密](#aes加解密)。

#### \[h2\]SM2加解密

[SM2](https://developer.huawei.com/consumer/cn/doc/harmonyos-guides/crypto-asym-key-generation-conversion-spec#sm2)，是一种基于椭圆曲线的公钥密码算法。

下面介绍并解决在HarmonyOS平台与其他平台交互使用SM2加解密开发时遇到的密钥格式和密文数据格式问题。

*   SM2密钥格式转换
    
    SM2加解密中，HarmonyOS平台支持ASN.1序列化后的密钥数据（公钥91字节，私钥51字节），而其他平台的密钥数据通常为未序列化过的原始裸数据（公钥64字节，私钥32字节）。这些密钥不能直接在HarmonyOS平台使用，需要通过密钥参数构造公钥规格来生成HarmonyOS可用的SM2公钥对象。下面以其他平台生成的十六进制密钥为例，介绍如何转换为HarmonyOS平台可用的SM2密钥。
    
    其他平台生成的公钥格式为04+x+y，私钥为128位字符串。
    
    将对应的16进制参数放入对应的位置，可通过[使用密钥参数生成](https://developer.huawei.com/consumer/cn/doc/harmonyos-guides/crypto-asym-key-generation-conversion-spec#使用密钥参数生成-3)SM2公钥。
    
    public static async convertStrToPubKey(keyStr: string): Promise<cryptoFramework.PubKey | undefined> {
      const puKeyStr = keyStr.startsWith('04') ? keyStr.slice(2) : keyStr;
      const pkPart1 = puKeyStr.slice(0, puKeyStr.length / 2);
      const pkPart2 = puKeyStr.slice(puKeyStr.length / 2);
      const pks: cryptoFramework.Point = {
        x: BigInt('0x' + pkPart1),
        y: BigInt('0x' + pkPart2)
      };
      try {
        const pubKeySpec: cryptoFramework.ECCPubKeySpec = {
          params: cryptoFramework.ECCKeyUtil.genECCCommonParamsSpec('NID\_sm2'),
          pk: pks,
          algName: 'SM2',
          specType: cryptoFramework.AsyKeySpecType.PUBLIC\_KEY\_SPEC
        };
        const keypairGenerator = cryptoFramework.createAsyKeyGeneratorBySpec(pubKeySpec);
        return keypairGenerator.generatePubKeySync();
      } catch (error) {
        let err = error as BusinessError;
        hilog.error(0x0000, TAG, \`convertStrToPubKey failed, error code=${err.code}, message=${err.message}\`);
        return undefined;
      }
    }
    
    同理，可通过[使用密钥参数生成](https://developer.huawei.com/consumer/cn/doc/harmonyos-guides/crypto-asym-key-generation-conversion-spec#使用密钥参数生成-3)SM2私钥。
    
    public static async convertStrToPriKey(keyStr: string): Promise<cryptoFramework.PriKey | undefined> {
      try {
        const sks = BigInt('0x' + keyStr);
        const priKeySpec: cryptoFramework.ECCPriKeySpec = {
          params: cryptoFramework.ECCKeyUtil.genECCCommonParamsSpec('NID\_sm2'),
          sk: sks,
          algName: 'SM2',
          specType: cryptoFramework.AsyKeySpecType.PRIVATE\_KEY\_SPEC
        };
        const priKeypairGenerator = cryptoFramework.createAsyKeyGeneratorBySpec(priKeySpec);
        let sksData = priKeypairGenerator.generatePriKeySync();
        return sksData;
      } catch (error) {
        let err = error as BusinessError;
        hilog.error(0x0000, TAG, \`convertStrToPriKey failed, error code=${err.code}, message=${err.message}\`);
        return undefined;
      }
    }
    
*   SM2密文格式转换
    
    SM2是一种国产非对称加密算法，其密文格式由三部分组成：
    
    C1：椭圆曲线点，长度为65字节，用于解密过程中的计算。
    
    C2：实际加密数据，长度由加密数据决定。
    
    C3：32字节的哈希值，用于验证密文完整性。
    
    目前SM2密文数据的参数组合顺序有老标准C1C2C3和新标准C1C3C2。
    
    HarmonyOS平台支持的SM2密文格式为国密标准的ASN.1格式，参数组合顺序为C1C3C2。具体参数含义请参考[转换SM2密文格式](https://developer.huawei.com/consumer/cn/doc/harmonyos-guides/crypto-asym-encrypt-decrypt-spec#转换sm2密文格式)。
    
    对于其他平台加密的C1C2C3顺序的密文，在HarmonyOS平台解密时，需先提取所需要的参数，并构造[SM2CipherTextSpec](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/js-apis-cryptoframework#sm2ciphertextspec12)对象，接着调用[genCipherTextBySpec()](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/js-apis-cryptoframework#genciphertextbyspec12)方法序列化生成ASN.1格式的SM2密文。具体可参考[使用SM2密文格式转换(ArkTS)](https://developer.huawei.com/consumer/cn/doc/harmonyos-guides/crypto-sm2-ciphertext-conversion)。
    
    bytesToBigInt(bytes: Uint8Array): bigint {
      let result = 0n;
      for (const byte of bytes) {
        result = (result << 8n) | BigInt(byte);
      }
      return result;
    }
    
    i2dSM2CipherText(primal\_data: string): Uint8Array | undefined {
      // Converting a Hex String to byte array.
      const cipherBytes = DataConversion.hexStrToUint8Array(primal\_data);
    
      // Defines that the length of C1 is 65 bytes (uncompressed format: 04 + x(32) + y(32)).
      const c1Length = 65;
      const totalLength = cipherBytes.length;
    
      if (totalLength < c1Length + 32) {
        hilog.error(0, 'id2\_SM2\_Ciphertext', 'Non-SM2 criterion compliant.');
      }
    
      // Extract C1 Part.
      const c1Bytes = cipherBytes.slice(0, c1Length);
    
      // Verify that C1 is in uncompressed format starting with 04.
      if (c1Bytes\[0\] !== 0x04) {
        hilog.error(0, 'id2\_SM2\_Ciphertext', 'C1 is not in uncompressed format.');
      }
    
      // Extract x and y coordinates.
      const xBytes = c1Bytes.slice(1, 33);
      const yBytes = c1Bytes.slice(33, 65);
    
      // Convert to BigInt.
      const xBigInt = this.bytesToBigInt(xBytes);
      const yBigInt = this.bytesToBigInt(yBytes);
    
      // Extract the C3 part (last 32 bytes).
      const c3Start = totalLength - 32;
      const c3Bytes = cipherBytes.slice(c3Start);
    
      // Extract C2 part (middle part).
      const c2Bytes = cipherBytes.slice(c1Length, c3Start);
    
      let spec: cryptoFramework.SM2CipherTextSpec = {
        xCoordinate: xBigInt,
        yCoordinate: yBigInt,
        cipherTextData: c2Bytes,
        hashData: c3Bytes
      }
    
      try {
        let data = cryptoFramework.SM2CryptoUtil.genCipherTextBySpec(spec, 'C1C3C2');
        return data.data;
      } catch (error) {
        let err = error as BusinessError;
        hilog.error(0x0000, 'xxx', \` failed, error code=${err.code}, message=${err.message}\`);
        return undefined;
      }
    }
    
    同理，HarmonyOS平台生成的采用C1C3C2顺序定义的ASN.1格式密文在其他平台使用时，需要先解码为C1C3C2的裸密文。
    
    d2i\_SM2\_Ciphertext(standard\_data: string): string {
      let message: string = standard\_data;
      if (!message.startsWith('30')) {
        hilog.error(0, 'd2i\_SM2\_Ciphertext', 'Incorrect ciphertext format');
      }
      message = message.slice('30'.length, message.length);
    
      // The length of the SM2 sequence content.
      let sequence\_lexHex: string = this.getLenHex(message);
      message = message.slice(sequence\_lexHex.length, message.length);
      let sequence\_len: number = this.lenHex2number(sequence\_lexHex);
    
      if (sequence\_len !== message.length / 2) {
        hilog.error(0x0000, 'd2i\_SM2\_Ciphertext', 'Incorrect ciphertext format');
      }
    
      let sm2\_sequence = new SM2Sequence();
      message = this.readC1(sm2\_sequence, message);
      message = this.readC3(sm2\_sequence, message);
      message = this.readC2(sm2\_sequence, message);
      hilog.info(0x0000, 'sm2\_sequence', sm2\_sequence.toString());
    
      let primal\_data: string = sm2\_sequence.C1x + sm2\_sequence.C1y + sm2\_sequence.C3 + sm2\_sequence.C2;
      return primal\_data;
    }
    

#### \[h2\]AES加解密

[AES](https://developer.huawei.com/consumer/cn/doc/harmonyos-guides/crypto-sym-key-generation-conversion-spec#aes)（Advanced Encryption Standard），最常见的对称加密算法。

下面介绍并解决在HarmonyOS平台与其他平台交互使用AES加解密开发中遇到的问题：密钥长度和指定分组模式后的偏移量参数设置。

*   AES密钥长度使用问题
    
    在[AES](https://developer.huawei.com/consumer/cn/doc/harmonyos-guides/crypto-sym-key-generation-conversion-spec#aes)加解密算法中，密钥长度是固定的。
    
    初始化HarmonyOS平台的加解密引擎时，需指定算法规格及密钥长度。密钥长度可为128位（对应字符串参数AES128）、192位（对应字符串参数AES192）或256位（对应字符串参数AES256）。AES密钥的字节长度与位数对应关系为：16字节对应128位，24字节对应192位，32字节对应256位。通过密钥位数可推断其字节长度。
    
    以指南[使用AES对称密钥（GCM模式）加解密(ArkTS)](https://developer.huawei.com/consumer/cn/doc/harmonyos-guides/crypto-aes-sym-encrypt-decrypt-gcm)为例，使用'AES128|GCM|PKCS7'初始化加解密算法实例。加解密时对应的密钥应为128位，即16个字符。因此，在生成密钥时，传入的字符为newUint8Array(\[83,217,231,76,28,113,23,219,250,71,209,210,205,97,32,159\])。
    
    **通过字符串获取密钥位数**
    
    使用HarmonyOS的加解密API时，需明确指定算法规格和密钥长度，且该参数必须与传入的密钥匹配。密钥字符串通常以字节序列或十六进制字符串形式表示，无法直接获取其位数信息。
    
    因此，当给定一个表示AES密钥的字符串，需要确定其密钥长度（以位数表示）时，可以按照以下步骤进行：
    
    1.  确定密钥字符串的编码：确定密钥字符串的编码方式，常见的编码方式包括Base64、UTF-8、16进制等。
    2.  计算密钥的字节长度：根据密钥字符串的编码，将其转换为Uint8Array格式，计算其对应的字节长度。转换方式可参考[数据格式转换](#数据编码格式差异)。
    3.  推断密钥位数：根据AES密钥的字节长度与位数之间的对应关系，推断密钥的位数。16字节对应128位，24字节对应192位，32字节对应256位。
*   AES指定分组模式后偏移量参数设置问题
    
    由于AES为分组加密算法，分组长度为128位。在实际应用中，最后一组明文可能不足128位（16字节），此时可以通过不同的[填充模式](https://developer.huawei.com/consumer/cn/doc/harmonyos-guides/crypto-sym-encrypt-decrypt-spec#填充模式)进行数据填充。
    
    以[GCM模式](https://developer.huawei.com/consumer/cn/doc/harmonyos-guides/crypto-aes-sym-encrypt-decrypt-gcm)和[CBC模式](https://developer.huawei.com/consumer/cn/doc/harmonyos-guides/crypto-aes-sym-encrypt-decrypt-cbc)为例，指定字符串参数分别为'AES128|GCM|PKCS7'和'AES128|CBC|PKCS7'，偏移量分别为16字节和12字节。
    
    | 分组模式 | 所需参数 | 备注 |
    | :-- | :-- | :-- |
    | ECB | 没有偏移量等参数。 | \- |
    | CBC、CTR、OFB、CFB | iv长度为16字节。 | \- |
    | GCM | 
    加解密参数iv，长度为1~16字节，常用为12字节。
    
    加解密参数add，长度为0~INT\_MAX字节，常用为16字节。
    
    加解密参数authTag，长度为16字节。
    
     | 在GCM模式下，需要从加密后的数据中取出末尾16字节，作为解密时初始化的认证信息。 |
    

#### 示例代码

*   [基于cryptoFramework实现加解密功能](https://gitcode.com/harmonyos_samples/crypto-collection)