• 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. 将一次传入数据量设置为20字节，多次调用[Cipher.update](../../reference/apis-crypto-architecture-kit/js-apis-cryptoFramework.md#update-1)，更新数据（明文）。
19
20   - 当前单次update长度没有限制，开发者可以根据数据量判断如何调用update。
21   - 建议开发者对每次update的结果都判断是否为null，并在结果不为null时取出其中的数据进行拼接，形成完整的密文。因为在不同的规格下，update的结果可能会受到不同影响。
22
23      1）比如ECB和CBC模式，始终以分组作为基本单位来加密，并输出本次update产生的加密分组结果。即当本次update操作凑满一个分组就输出密文，没有凑满则此次update输出null，将未加密的数据与下次输入的数据拼接凑分组再输出。等到最后doFinal的时候，将未加密的数据，根据指定的填充模式进行填充，在输出剩余加密结果。解密过程中的update同理。
24
25      2）对于流加密模式（比如CTR和OFB模式），通常密文长度和明文长度相等。
26
275. 调用[Cipher.doFinal](../../reference/apis-crypto-architecture-kit/js-apis-cryptoFramework.md#dofinal-1)，获取加密后的数据。
28
29   - 由于已使用update传入数据，此处data传入null。
30   - doFinal输出结果可能为null，在访问具体数据前，需要先判断结果是否为null，避免产生异常。
31
326. 读取GcmParamsSpec.authTag作为解密的认证信息。
33
34   在GCM模式下，需要从加密后的数据中取出末尾16字节，作为解密时初始化的认证信息。示例中authTag恰好为16字节。
35
36
37**解密**
38
39
401. 调用[Cipher.init](../../reference/apis-crypto-architecture-kit/js-apis-cryptoFramework.md#init-1)，设置模式为解密（CryptoMode.DECRYPT_MODE），指定解密密钥（SymKey）和GCM模式对应的解密参数（GcmParamsSpec），初始化解密Cipher实例。
41
422. 将一次传入数据量设置为20字节，多次调用[Cipher.update](../../reference/apis-crypto-architecture-kit/js-apis-cryptoFramework.md#update-1)，更新数据（密文）。
43
443. 调用[Cipher.doFinal](../../reference/apis-crypto-architecture-kit/js-apis-cryptoFramework.md#dofinal-1)，获取解密后的数据。
45
46
47```ts
48import cryptoFramework from '@ohos.security.cryptoFramework';
49import buffer from '@ohos.buffer';
50function genGcmParamsSpec() {
51  let arr = [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]; // 12 bytes
52  let dataIv = new Uint8Array(arr);
53  let ivBlob: cryptoFramework.DataBlob = { data: dataIv };
54  arr = [0, 0, 0, 0, 0, 0, 0, 0]; // 8 bytes
55  let dataAad = new Uint8Array(arr);
56  let aadBlob: cryptoFramework.DataBlob = { data: dataAad };
57  arr = [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]; // 16 bytes
58  let dataTag = new Uint8Array(arr);
59  let tagBlob: cryptoFramework.DataBlob = {
60    data: dataTag
61  }; // The GCM authTag is obtained by doFinal() in encryption and passed in params of init() in decryption.
62  let gcmParamsSpec: cryptoFramework.GcmParamsSpec = {
63    iv: ivBlob,
64    aad: aadBlob,
65    authTag: tagBlob,
66    algName: "GcmParamsSpec"
67  };
68  return gcmParamsSpec;
69}
70let gcmParams = genGcmParamsSpec();
71// 分段加密消息
72async function encryptMessageUpdateBySegment(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 updateLength = 20; // 假设以20字节为单位进行分段update，实际并无要求
76  let cipherText = new Uint8Array();
77  for (let i = 0; i < plainText.data.length; i += updateLength) {
78    let updateMessage = plainText.data.subarray(i, i + updateLength);
79    let updateMessageBlob: cryptoFramework.DataBlob = { data: updateMessage };
80    // 分段update
81    let updateOutput = await cipher.update(updateMessageBlob);
82    // 把update的结果拼接起来，得到密文（有些情况下还需拼接doFinal的结果，这取决于分组模式
83    // 和填充模式，本例中GCM模式的doFinal结果只包含authTag而不含密文，所以不需要拼接）
84    let mergeText = new Uint8Array(cipherText.length + updateOutput.data.length);
85    mergeText.set(cipherText);
86    mergeText.set(updateOutput.data, cipherText.length);
87    cipherText = mergeText;
88  }
89  gcmParams.authTag = await cipher.doFinal(null);
90  let cipherBlob: cryptoFramework.DataBlob = { data: cipherText };
91  return cipherBlob;
92}
93// 分段解密消息
94async function decryptMessagePromise(symKey: cryptoFramework.SymKey, cipherText: cryptoFramework.DataBlob) {
95  let decoder = cryptoFramework.createCipher('AES128|GCM|PKCS7');
96  await decoder.init(cryptoFramework.CryptoMode.DECRYPT_MODE, symKey, gcmParams);
97  let updateLength = 20; // 假设以20字节为单位进行分段update，实际并无要求
98  let decryptText = new Uint8Array();
99  for (let i = 0; i < cipherText.data.length; i += updateLength) {
100    let updateMessage = cipherText.data.subarray(i, i + updateLength);
101    let updateMessageBlob: cryptoFramework.DataBlob = { data: updateMessage };
102    // 分段update
103    let updateOutput = await decoder.update(updateMessageBlob);
104    // 把update的结果拼接起来，得到明文
105    let mergeText = new Uint8Array(decryptText.length + updateOutput.data.length);
106    mergeText.set(decryptText);
107    mergeText.set(updateOutput.data, decryptText.length);
108    decryptText = mergeText;
109  }
110  let decryptData = await decoder.doFinal(null);
111  if (decryptData == null) {
112    console.info('GCM decrypt success, decryptData is null');
113  }
114  let decryptBlob: cryptoFramework.DataBlob = { data: decryptText };
115  return decryptBlob;
116}
117async function genSymKeyByData(symKeyData: Uint8Array) {
118  let symKeyBlob: cryptoFramework.DataBlob = { data: symKeyData };
119  let aesGenerator = cryptoFramework.createSymKeyGenerator('AES128');
120  let symKey = await aesGenerator.convertKey(symKeyBlob);
121  console.info('convertKey success');
122  return symKey;
123}
124async function aes() {
125  let keyData = new Uint8Array([83, 217, 231, 76, 28, 113, 23, 219, 250, 71, 209, 210, 205, 97, 32, 159]);
126  let symKey = await genSymKeyByData(keyData);
127  let message = "aaaaa.....bbbbb.....ccccc.....ddddd.....eee"; // 假设信息总共43字节，根据utf-8解码后，也是43字节
128  let plainText: cryptoFramework.DataBlob = { data: new Uint8Array(buffer.from(message, 'utf-8').buffer) };
129  let encryptText = await encryptMessageUpdateBySegment(symKey, plainText);
130  let decryptText = await decryptMessagePromise(symKey, encryptText);
131  if (plainText.data.toString() === decryptText.data.toString()) {
132    console.info('decrypt ok');
133    console.info('decrypt plainText: ' + buffer.from(decryptText.data).toString('utf-8'));
134  } else {
135    console.error('decrypt failed');
136  }
137}
138```
139