harmony 鸿蒙指定二进制数据转换对称密钥(ArkTS)

2025-06-16
浏览 (4)

指定二进制数据转换对称密钥(ArkTS)

以3DES和HMAC为例，根据指定的对称密钥二进制数据，生成对称密钥对象（SymKey），即将外部或存储的二进制数据转换为算法库的密钥对象，该对象可用于后续的加解密等操作。

指定二进制数据转换3DES密钥

获取3DES二进制密钥数据，封装成DataBlob对象。
调用cryptoFramework.createSymKeyGenerator，指定字符串参数’3DES192’，创建密钥算法为3DES、密钥长度为192位的对称密钥生成器（SymKeyGenerator）。
调用SymKeyGenerator.convertKey，根据指定的对称密钥二进制数据生成对称密钥对象（SymKey）。
调用SymKey.getEncoded，获取密钥对象的二进制数据。
以使用callback方式生成3DES密钥为例：

  import { cryptoFramework } from '@kit.CryptoArchitectureKit';
  import { BusinessError } from '@kit.BasicServicesKit';

  function genKeyMaterialBlob(): cryptoFramework.DataBlob {
    let arr = [
      0xba, 0x3d, 0xc2, 0x71, 0x21, 0x1e, 0x30, 0x56,
      0xad, 0x47, 0xfc, 0x5a, 0x46, 0x39, 0xee, 0x7c,
      0xba, 0x3b, 0xc2, 0x71, 0xab, 0xa0, 0x30, 0x72]; // 密钥长度为192位，即24字节。
    let keyMaterial = new Uint8Array(arr);
    return { data: keyMaterial };
  }

  function testConvertSymKey() {
    // 创建SymKeyGenerator实例。
    let symKeyGenerator = cryptoFramework.createSymKeyGenerator('3DES192');
    // 根据指定的数据生成对称密钥。
    let keyMaterialBlob = genKeyMaterialBlob();
    try {
      symKeyGenerator.convertKey(keyMaterialBlob, (error, key) => {
        if (error) { // 如果业务逻辑执行失败，则callback的第一个参数返回错误信息，即异步抛出异常。
          let e: BusinessError = error as BusinessError;
          console.error(`convertKey error, ${e.code}, ${e.message}`);
          return;
        }
        console.info('key algName:' + key.algName);
        console.info('key format:' + key.format);
        let encodedKey = key.getEncoded(); // 获取对称密钥对象的二进制数据，并以字节数组形式输出。长度为24字节。
        console.info('key getEncoded hex: ' + encodedKey.data);
      })
    } catch (error) { // 参数检查发现错误立即抛出异常。
      let e: BusinessError = error as BusinessError;
      console.error(`convertKey failed, ${e.code}, ${e.message}`);
    }
  }

同步方法（调用方法convertKeySync）： “`ts import { cryptoFramework } from ‘@kit.CryptoArchitectureKit’;

function genKeyMaterialBlob(): cryptoFramework.DataBlob { let arr = [ 0xba, 0x3d, 0xc2, 0x71, 0x21, 0x1e, 0x30, 0x56, 0xad, 0x47, 0xfc, 0x5a, 0x46, 0x39, 0xee, 0x7c, 0xba, 0x3b, 0xc2, 0x71, 0xab, 0xa0, 0x30, 0x72]; // 密钥长度为192位，即24字节。 let keyMaterial = new Uint8Array(arr); return { data: keyMaterial }; }

function testConvertSymKey() { // 创建SymKeyGenerator实例。 let symKeyGenerator = cryptoFramework.createSymKeyGenerator(‘3DES192’); // 根据指定的数据生成对称密钥。 let keyMaterialBlob = genKeyMaterialBlob(); let key = symKeyGenerator.convertKeySync(keyMaterialBlob); let encodedKey = key.getEncoded(); // 获取对称密钥对象的二进制数据，并以字节数组形式输出。长度为24字节。 console.info(‘key getEncoded hex’ + encodedKey.data); }


## 指定二进制数据转换HMAC密钥

请查看[对称密钥生成和转换规格：HMAC](crypto-sym-key-generation-conversion-spec.md#hmac)。

1. 获取HMAC二进制密钥并封装成DataBlob对象。

2. 调用[cryptoFramework.createSymKeyGenerator](https://m.seaxiang.com/blog/mZtFVB)，指定字符串参数'HMAC'，创建密钥算法为HMAC、密钥长度为[1, 32768]位的对称密钥生成器（SymKeyGenerator）。

3. 调用[SymKeyGenerator.convertKey](https://m.seaxiang.com/blog/mZtFVB)，根据指定的对称密钥二进制数据，生成对称密钥对象（SymKey）。

4. 调用[SymKey.getEncoded](https://m.seaxiang.com/blog/mZtFVB)，获取密钥的二进制数据。

- 以生成HMAC密钥为例，使用await方式：

  ```ts
  import { cryptoFramework } from '@kit.CryptoArchitectureKit';
  import { buffer } from '@kit.ArkTS';

  async function testConvertHmacKey() {
    // 对称密钥长度64字节，512比特。
    let keyMessage = '12345678abcdefgh12345678abcdefgh12345678abcdefgh12345678abcdefgh';
    let keyBlob: cryptoFramework.DataBlob = {
      data : new Uint8Array(buffer.from(keyMessage, 'utf-8').buffer)
    }
    let symKeyGenerator = cryptoFramework.createSymKeyGenerator('HMAC');
    let key = await symKeyGenerator.convertKey(keyBlob);
    let encodedKey = key.getEncoded();
    console.info('key encoded data:' + encodedKey.data);
  }

同步方法（调用方法convertKeySync）： “`ts import { cryptoFramework } from ‘@kit.CryptoArchitectureKit’; import { buffer } from ‘@kit.ArkTS’;

function testConvertKeySync() { // 对称密钥长度64字节，512比特。 let keyMessage = ‘12345678abcdefgh12345678abcdefgh12345678abcdefgh12345678abcdefgh’; let keyBlob: cryptoFramework.DataBlob = { data : new Uint8Array(buffer.from(keyMessage, ‘utf-8’).buffer) } let symKeyGenerator = cryptoFramework.createSymKeyGenerator(‘HMAC’); let key = symKeyGenerator.convertKeySync(keyBlob); let encodedKey = key.getEncoded(); console.info(‘key encoded data:’ + encodedKey.data); } “`