• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# 使用SM4对称密钥（ECB模式）加解密(ArkTS)
2
3对应的算法规格请查看[对称密钥加解密算法规格：SM4](crypto-sym-encrypt-decrypt-spec.md#sm4)。
4
5**加密**
6
71. 调用[cryptoFramework.createSymKeyGenerator](../../reference/apis-crypto-architecture-kit/js-apis-cryptoFramework.md#cryptoframeworkcreatesymkeygenerator)、[SymKeyGenerator.generateSymKey](../../reference/apis-crypto-architecture-kit/js-apis-cryptoFramework.md#generatesymkey-1)，生成密钥算法为SM4、密钥长度为128位的对称密钥（SymKey）。
8
9   如何生成SM4对称密钥，开发者可参考下文示例，并结合[对称密钥生成和转换规格：SM4](crypto-sym-key-generation-conversion-spec.md#sm4)和[随机生成对称密钥](crypto-generate-sym-key-randomly.md)理解，参考文档与当前示例可能存在入参差异，请在阅读时注意区分。
10
112. 调用[cryptoFramework.createCipher](../../reference/apis-crypto-architecture-kit/js-apis-cryptoFramework.md#cryptoframeworkcreatecipher)，指定字符串参数'SM4_128|ECB|PKCS7'，创建对称密钥类型为SM4_128、分组模式为ECB、填充模式为PKCS7的Cipher实例，用于完成加密操作。
12
133. 调用[Cipher.init](../../reference/apis-crypto-architecture-kit/js-apis-cryptoFramework.md#init-1)，设置模式为加密（CryptoMode.ENCRYPT_MODE），指定加密密钥（SymKey），初始化加密Cipher实例。
14
15   ECB模式无加密参数，直接传入null。
16
174. 调用[Cipher.update](../../reference/apis-crypto-architecture-kit/js-apis-cryptoFramework.md#update-1)，更新数据（明文）。
18
19   - 当数据量较小时，可以在init完成后直接调用doFinal。
20   - 当数据量较大时，可以多次调用update，即分段加解密。
21
225. 调用[Cipher.doFinal](../../reference/apis-crypto-architecture-kit/js-apis-cryptoFramework.md#dofinal-1)，获取加密后的数据。
23
24   - 由于已使用update传入数据，此处data传入null。
25   - doFinal输出结果可能为null，在访问具体数据前，需要先判断结果是否为null，避免产生异常。
26
27**解密**
28
291. 调用[cryptoFramework.createCipher](../../reference/apis-crypto-architecture-kit/js-apis-cryptoFramework.md#cryptoframeworkcreatecipher)，指定字符串参数'SM4_128|ECB|PKCS7'，创建对称密钥类型为SM4_128、分组模式为ECB、填充模式为PKCS7的Cipher实例，用于完成解密操作。
30
312. 调用[Cipher.init](../../reference/apis-crypto-architecture-kit/js-apis-cryptoFramework.md#init-1)，设置模式为解密（CryptoMode.DECRYPT_MODE），指定解密密钥（SymKey）初始化解密Cipher实例。ECB模式无加密参数，直接传入null。
32
333. 调用[Cipher.update](../../reference/apis-crypto-architecture-kit/js-apis-cryptoFramework.md#update-1)，更新数据（密文）。
34
354. 调用[Cipher.doFinal](../../reference/apis-crypto-architecture-kit/js-apis-cryptoFramework.md#dofinal-1)，获取解密后的数据。
36
37- 异步方法示例：
38
39  ```ts
40  import { cryptoFramework } from '@kit.CryptoArchitectureKit';
41  import { buffer } from '@kit.ArkTS';
42
43  // 加密消息。
44  async function encryptMessagePromise(symKey: cryptoFramework.SymKey, plainText: cryptoFramework.DataBlob) {
45    let cipher = cryptoFramework.createCipher('SM4_128|ECB|PKCS7');
46    await cipher.init(cryptoFramework.CryptoMode.ENCRYPT_MODE, symKey, null);
47    let encryptData = await cipher.doFinal(plainText);
48    return encryptData;
49  }
50  // 解密消息。
51  async function decryptMessagePromise(symKey: cryptoFramework.SymKey, cipherText: cryptoFramework.DataBlob) {
52    let decoder = cryptoFramework.createCipher('SM4_128|ECB|PKCS7');
53    await decoder.init(cryptoFramework.CryptoMode.DECRYPT_MODE, symKey, null);
54    let decryptData = await decoder.doFinal(cipherText);
55    return decryptData;
56  }
57  async function genSymKeyByData(symKeyData: Uint8Array) {
58    let symKeyBlob: cryptoFramework.DataBlob = { data: symKeyData };
59    let symGenerator = cryptoFramework.createSymKeyGenerator('SM4_128');
60    let symKey = await symGenerator.convertKey(symKeyBlob);
61    console.info('convertKey success');
62    return symKey;
63  }
64  async function main() {
65    let keyData = new Uint8Array([7, 154, 52, 176, 4, 236, 150, 43, 237, 9, 145, 166, 141, 174, 224, 131]);
66    let symKey = await genSymKeyByData(keyData);
67    let message = "This is a test";
68    let plainText: cryptoFramework.DataBlob = { data: new Uint8Array(buffer.from(message, 'utf-8').buffer) };
69    let encryptText = await encryptMessagePromise(symKey, plainText);
70    let decryptText = await decryptMessagePromise(symKey, encryptText);
71    if (plainText.data.toString() === decryptText.data.toString()) {
72      console.info('decrypt ok');
73      console.info('decrypt plainText: ' + buffer.from(decryptText.data).toString('utf-8'));
74    } else {
75      console.error('decrypt failed');
76    }
77  }
78  ```
79
80- 同步方法示例：
81
82  ```ts
83  import { cryptoFramework } from '@kit.CryptoArchitectureKit';
84  import { buffer } from '@kit.ArkTS';
85
86  // 加密消息。
87  function encryptMessage(symKey: cryptoFramework.SymKey, plainText: cryptoFramework.DataBlob) {
88    let cipher = cryptoFramework.createCipher('SM4_128|ECB|PKCS7');
89    cipher.initSync(cryptoFramework.CryptoMode.ENCRYPT_MODE, symKey, null);
90    let encryptData = cipher.doFinalSync(plainText);
91    return encryptData;
92  }
93  // 解密消息。
94  function decryptMessage(symKey: cryptoFramework.SymKey, cipherText: cryptoFramework.DataBlob) {
95    let decoder = cryptoFramework.createCipher('SM4_128|ECB|PKCS7');
96    decoder.initSync(cryptoFramework.CryptoMode.DECRYPT_MODE, symKey, null);
97    let decryptData = decoder.doFinalSync(cipherText);
98    return decryptData;
99  }
100  function genSymKeyByData(symKeyData: Uint8Array) {
101    let symKeyBlob: cryptoFramework.DataBlob = { data: symKeyData };
102    let symGenerator = cryptoFramework.createSymKeyGenerator('SM4_128');
103    let symKey = symGenerator.convertKeySync(symKeyBlob);
104    console.info('convertKeySync success');
105    return symKey;
106  }
107  function main() {
108    let keyData = new Uint8Array([7, 154, 52, 176, 4, 236, 150, 43, 237, 9, 145, 166, 141, 174, 224, 131]);
109    let symKey = genSymKeyByData(keyData);
110    let message = "This is a test";
111    let plainText: cryptoFramework.DataBlob = { data: new Uint8Array(buffer.from(message, 'utf-8').buffer) };
112    let encryptText = encryptMessage(symKey, plainText);
113    let decryptText = decryptMessage(symKey, encryptText);
114    if (plainText.data.toString() === decryptText.data.toString()) {
115      console.info('decrypt ok');
116      console.info('decrypt plainText: ' + buffer.from(decryptText.data).toString('utf-8'));
117    } else {
118      console.error('decrypt failed');
119    }
120  }
121  ```