• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# 使用AES对称密钥（GCM模式）加解密
2
3
4对应的算法规格请查看[对称密钥加解密算法规格：AES](crypto-sym-encrypt-decrypt-spec.md#aes)。
5
6
7**加密**
8
9
101. 调用[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)，生成密钥算法为AES、密钥长度为128位的对称密钥（SymKey）。
11
12   如何生成AES对称密钥，开发者可参考下文示例，并结合[对称密钥生成和转换规格：AES](crypto-sym-key-generation-conversion-spec.md#aes)和[随机生成对称密钥](crypto-generate-sym-key-randomly.md)理解，参考文档与当前示例可能存在入参差异，请在阅读时注意区分。
13
142. 调用[cryptoFramework.createCipher](../../reference/apis-crypto-architecture-kit/js-apis-cryptoFramework.md#cryptoframeworkcreatecipher)，指定字符串参数'AES128|GCM|PKCS7'，创建对称密钥类型为AES128、分组模式为GCM、填充模式为PKCS7的Cipher实例，用于完成加解密操作。
15
163. 调用[Cipher.init](../../reference/apis-crypto-architecture-kit/js-apis-cryptoFramework.md#init-1)，设置模式为加密（CryptoMode.ENCRYPT_MODE），指定加密密钥（SymKey）和GCM模式对应的加密参数（GcmParamsSpec），初始化加密Cipher实例。
17
184. 调用[Cipher.update](../../reference/apis-crypto-architecture-kit/js-apis-cryptoFramework.md#update-1)，更新数据（明文）。
19
20   当前单次update长度没有限制，开发者可以根据数据量判断如何调用update。
21
22   - 当数据量较小时，可以在init完成后直接调用doFinal。
23   - 当数据量较大时，可以多次调用update，即[分段加解密](crypto-aes-sym-encrypt-decrypt-gcm-by-segment.md)。
24
255. 调用[Cipher.doFinal](../../reference/apis-crypto-architecture-kit/js-apis-cryptoFramework.md#dofinal-1)，获取加密后的数据。
26   - 由于已使用update传入数据，此处data传入null。
27   - doFinal输出结果可能为null，在访问具体数据前，需要先判断结果是否为null，避免产生异常。
28
296. 读取[GcmParamsSpec.authTag](../../reference/apis-crypto-architecture-kit/js-apis-cryptoFramework.md#gcmparamsspec)作为解密的认证信息。
30   在GCM模式下，需要从加密后的数据中取出末尾16字节，作为解密时初始化的认证信息。示例中authTag恰好为16字节。
31
32
33**解密**
34
35
361. 调用[Cipher.init](../../reference/apis-crypto-architecture-kit/js-apis-cryptoFramework.md#init-1)，设置模式为解密（CryptoMode.DECRYPT_MODE），指定解密密钥（SymKey）和GCM模式对应的解密参数（GcmParamsSpec），初始化解密Cipher实例。
37
382. 调用[Cipher.update](../../reference/apis-crypto-architecture-kit/js-apis-cryptoFramework.md#update-1)，更新数据（密文）。
39
403. 调用[Cipher.doFinal](../../reference/apis-crypto-architecture-kit/js-apis-cryptoFramework.md#dofinal-1)，获取解密后的数据。
41
42
43```ts
44import cryptoFramework from '@ohos.security.cryptoFramework';
45import buffer from '@ohos.buffer';
46
47function genGcmParamsSpec() {
48  let arr = [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]; // 12 bytes
49  let dataIv = new Uint8Array(arr);
50  let ivBlob: cryptoFramework.DataBlob = { data: dataIv };
51  arr = [0, 0, 0, 0, 0, 0, 0, 0]; // 8 bytes
52  let dataAad = new Uint8Array(arr);
53  let aadBlob: cryptoFramework.DataBlob = { data: dataAad };
54  arr = [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]; // 16 bytes
55  let dataTag = new Uint8Array(arr);
56  let tagBlob: cryptoFramework.DataBlob = {
57    data: dataTag
58  };
59  // GCM的authTag在加密时从doFinal结果中获取，在解密时填入init函数的params参数中
60  let gcmParamsSpec: cryptoFramework.GcmParamsSpec = {
61    iv: ivBlob,
62    aad: aadBlob,
63    authTag: tagBlob,
64    algName: "GcmParamsSpec"
65  };
66  return gcmParamsSpec;
67}
68
69let gcmParams = genGcmParamsSpec();
70
71// 加密消息
72async function encryptMessagePromise(symKey: cryptoFramework.SymKey, plainText: cryptoFramework.DataBlob) {
73  let cipher = cryptoFramework.createCipher('AES128|GCM|PKCS7');
74  await cipher.init(cryptoFramework.CryptoMode.ENCRYPT_MODE, symKey, gcmParams);
75  let encryptUpdate = await cipher.update(plainText);
76  // gcm模式加密doFinal时传入空，获得tag数据，并更新至gcmParams对象中。
77  gcmParams.authTag = await cipher.doFinal(null);
78  return encryptUpdate;
79}
80// 解密消息
81async function decryptMessagePromise(symKey: cryptoFramework.SymKey, cipherText: cryptoFramework.DataBlob) {
82  let decoder = cryptoFramework.createCipher('AES128|GCM|PKCS7');
83  await decoder.init(cryptoFramework.CryptoMode.DECRYPT_MODE, symKey, gcmParams);
84  let decryptUpdate = await decoder.update(cipherText);
85  // gcm模式解密doFinal时传入空，验证init时传入的tag数据，如果验证失败会抛出异常。
86  let decryptData = await decoder.doFinal(null);
87  if (decryptData == null) {
88    console.info('GCM decrypt success, decryptData is null');
89  }
90  return decryptUpdate;
91}
92async function genSymKeyByData(symKeyData: Uint8Array) {
93  let symKeyBlob: cryptoFramework.DataBlob = { data: symKeyData };
94  let aesGenerator = cryptoFramework.createSymKeyGenerator('AES128');
95  let symKey = await aesGenerator.convertKey(symKeyBlob);
96  console.info('convertKey success');
97  return symKey;
98}
99async function main() {
100  let keyData = new Uint8Array([83, 217, 231, 76, 28, 113, 23, 219, 250, 71, 209, 210, 205, 97, 32, 159]);
101  let symKey = await genSymKeyByData(keyData);
102  let message = "This is a test";
103  let plainText: cryptoFramework.DataBlob = { data: new Uint8Array(buffer.from(message, 'utf-8').buffer) };
104  let encryptText = await encryptMessagePromise(symKey, plainText);
105  let decryptText = await decryptMessagePromise(symKey, encryptText);
106  if (plainText.data.toString() === decryptText.data.toString()) {
107    console.info('decrypt ok');
108    console.info('decrypt plainText: ' + buffer.from(decryptText.data).toString('utf-8'));
109  } else {
110    console.error('decrypt failed');
111  }
112}
113```
114