f379ab42创建于 2025年3月13日历史提交

使用SM4对称密钥(CBC模式)加解密(ArkTS)

对应的算法规格请查看对称密钥加解密算法规格:SM4

加密

  1. 调用cryptoFramework.createSymKeyGeneratorSymKeyGenerator.generateSymKey,生成密钥算法为SM4、密钥长度为128位的对称密钥(SymKey)。

    如何生成SM4对称密钥,开发者可参考下文示例,并结合对称密钥生成和转换规格:SM4随机生成对称密钥理解,参考文档与当前示例可能存在入参差异,请在阅读时注意区分。

  2. 调用cryptoFramework.createCipher,指定字符串参数'SM4_128|CBC|PKCS7',创建对称密钥类型为SM4_128、分组模式为CBC、填充模式为PKCS7的Cipher实例,用于完成加密操作。

  3. 调用Cipher.init,设置模式为加密(CryptoMode.ENCRYPT_MODE),指定加密密钥(SymKey)和CBC模式对应的加密参数(IvParamsSpec),初始化加密Cipher实例。

  4. 调用Cipher.update,更新数据(明文)。

    • 当数据量较小时,可以在init完成后直接调用doFinal。
    • 当数据量较大时,可以多次调用update,即分段加解密。
  5. 调用Cipher.doFinal,获取加密后的数据。

    • 由于已使用update传入数据,此处data传入null。
    • doFinal输出结果可能为null,在访问具体数据前,需要先判断结果是否为null,避免产生异常。

解密

  1. 调用cryptoFramework.createCipher,指定字符串参数'SM4_128|CBC|PKCS7',创建对称密钥类型为SM4_128、分组模式为CBC、填充模式为PKCS7的Cipher实例,用于完成解密操作。

  2. 调用Cipher.init,设置模式为解密(CryptoMode.DECRYPT_MODE),指定解密密钥(SymKey)和CBC模式对应的解密参数(IvParamsSpec),初始化解密Cipher实例。

  3. 调用Cipher.update,更新数据(密文)。

  4. 调用Cipher.doFinal,获取解密后的数据。

  • 异步方法示例:

    import { cryptoFramework } from '@kit.CryptoArchitectureKit';
    import { buffer } from '@kit.ArkTS';
    
    function generateRandom(len: number) {
      let rand = cryptoFramework.createRandom();
      let generateRandSync = rand.generateRandomSync(len);
      return generateRandSync;
    }
    
    function genIvParamsSpec() {
      let ivBlob = generateRandom(16); // 16 bytes
      let ivParamsSpec: cryptoFramework.IvParamsSpec = {
        algName: "IvParamsSpec",
        iv: ivBlob
      };
      return ivParamsSpec;
    }
    let iv = genIvParamsSpec();
    // 加密消息。
    async function encryptMessagePromise(symKey: cryptoFramework.SymKey, plainText: cryptoFramework.DataBlob) {
      let cipher = cryptoFramework.createCipher('SM4_128|CBC|PKCS7');
      await cipher.init(cryptoFramework.CryptoMode.ENCRYPT_MODE, symKey, iv);
      let encryptData = await cipher.doFinal(plainText);
      return encryptData;
    }
    // 解密消息。
    async function decryptMessagePromise(symKey: cryptoFramework.SymKey, cipherText: cryptoFramework.DataBlob) {
      let decoder = cryptoFramework.createCipher('SM4_128|CBC|PKCS7');
      await decoder.init(cryptoFramework.CryptoMode.DECRYPT_MODE, symKey, iv);
      let decryptData = await decoder.doFinal(cipherText);
      return decryptData;
    }
    async function genSymKeyByData(symKeyData: Uint8Array) {
      let symKeyBlob: cryptoFramework.DataBlob = { data: symKeyData };
      let symGenerator = cryptoFramework.createSymKeyGenerator('SM4_128');
      let symKey = await symGenerator.convertKey(symKeyBlob);
      console.info('convertKey success');
      return symKey;
    }
    async function main() {
      try {
        let keyData = new Uint8Array([7, 154, 52, 176, 4, 236, 150, 43, 237, 9, 145, 166, 141, 174, 224, 131]);
        let symKey = await genSymKeyByData(keyData);
        let message = "This is a test";
        let plainText: cryptoFramework.DataBlob = { data: new Uint8Array(buffer.from(message, 'utf-8').buffer) };
        let encryptText = await encryptMessagePromise(symKey, plainText);
        let decryptText = await decryptMessagePromise(symKey, encryptText);
        if (plainText.data.toString() === decryptText.data.toString()) {
          console.info('decrypt ok');
          console.info('decrypt plainText: ' + buffer.from(decryptText.data).toString('utf-8'));
        } else {
          console.error('decrypt failed');
        }
      } catch (error) {
        console.error(`SM4 “${error}“, error code: ${error.code}`);
      }
    }
    
  • 同步方法示例:

    import { cryptoFramework } from '@kit.CryptoArchitectureKit';
    import { buffer } from '@kit.ArkTS';
    
    function generateRandom(len: number) {
      let rand = cryptoFramework.createRandom();
      let generateRandSync = rand.generateRandomSync(len);
      return generateRandSync;
    }
    
    function genIvParamsSpec() {
      let ivBlob = generateRandom(16); // 16 bytes
      let ivParamsSpec: cryptoFramework.IvParamsSpec = {
        algName: "IvParamsSpec",
        iv: ivBlob
      };
      return ivParamsSpec;
    }
    let iv = genIvParamsSpec();
    // 加密消息。
    function encryptMessage(symKey: cryptoFramework.SymKey, plainText: cryptoFramework.DataBlob) {
      let cipher = cryptoFramework.createCipher('SM4_128|CBC|PKCS7');
      cipher.initSync(cryptoFramework.CryptoMode.ENCRYPT_MODE, symKey, iv);
      let encryptData = cipher.doFinalSync(plainText);
      return encryptData;
    }
    // 解密消息。
    function decryptMessage(symKey: cryptoFramework.SymKey, cipherText: cryptoFramework.DataBlob) {
      let decoder = cryptoFramework.createCipher('SM4_128|CBC|PKCS7');
      decoder.initSync(cryptoFramework.CryptoMode.DECRYPT_MODE, symKey, iv);
      let decryptData = decoder.doFinalSync(cipherText);
      return decryptData;
    }
    function genSymKeyByData(symKeyData: Uint8Array) {
      let symKeyBlob: cryptoFramework.DataBlob = { data: symKeyData };
      let symGenerator = cryptoFramework.createSymKeyGenerator('SM4_128');
      let symKey = symGenerator.convertKeySync(symKeyBlob);
      console.info('convertKeySync success');
      return symKey;
    }
    function main() {
      try {
        let keyData = new Uint8Array([7, 154, 52, 176, 4, 236, 150, 43, 237, 9, 145, 166, 141, 174, 224, 131]);
        let symKey = genSymKeyByData(keyData);
        let message = "This is a test";
        let plainText: cryptoFramework.DataBlob = { data: new Uint8Array(buffer.from(message, 'utf-8').buffer) };
        let encryptText = encryptMessage(symKey, plainText);
        let decryptText = decryptMessage(symKey, encryptText);
        if (plainText.data.toString() === decryptText.data.toString()) {
          console.info('decrypt ok');
          console.info('decrypt plainText: ' + buffer.from(decryptText.data).toString('utf-8'));
        } else {
          console.error('decrypt failed');
        }
      } catch (error) {
        console.error(`SM4 “${error}“, error code: ${error.code}`);
      }
    }