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