1# 使用AES对称密钥（GCM模式）分段加解密(C/C++)
2
3
4对应的算法规格请查看[对称密钥加解密算法规格：AES](crypto-sym-encrypt-decrypt-spec.md#aes)。
5
6
7## 在CMake脚本中链接相关动态库
8```txt
9   target_link_libraries(entry PUBLIC libohcrypto.so)
10```
11
12## 开发步骤
13
14**加密**
15
16
171. 调用[OH_CryptoSymKeyGenerator_Create](../../reference/apis-crypto-architecture-kit/_crypto_sym_key_api.md#oh_cryptosymkeygenerator_create)、[OH_CryptoSymKeyGenerator_Generate](../../reference/apis-crypto-architecture-kit/_crypto_sym_key_api.md#oh_cryptosymkeygenerator_generate)，生成密钥算法为AES、密钥长度为128位的对称密钥（OH_CryptoSymKey）。
18
19   如何生成AES对称密钥，开发者可参考下文示例，并结合[对称密钥生成和转换规格：AES](crypto-sym-key-generation-conversion-spec.md#aes)和[随机生成对称密钥](crypto-generate-sym-key-randomly-ndk.md)理解，参考文档与当前示例可能存在入参差异，请在阅读时注意区分。
20
212. 调用[OH_CryptoSymCipher_Create](../../reference/apis-crypto-architecture-kit/_crypto_sym_cipher_api.md#oh_cryptosymcipher_create)，指定字符串参数'AES128|GCM|PKCS7'，创建对称密钥类型为AES128、分组模式为GCM、填充模式为PKCS7的Cipher实例，用于完成加解密操作。
22
233. 调用[OH_CryptoSymCipherParams_Create](../../reference/apis-crypto-architecture-kit/_crypto_sym_cipher_api.md#oh_cryptosymcipherparams_create)创建参数对象，调用[OH_CryptoSymCipherParams_SetParam](../../reference/apis-crypto-architecture-kit/_crypto_sym_cipher_api.md#oh_cryptosymcipherparams_setparam)设置对应的加密参数。
24
254. 调用[OH_CryptoSymCipher_Init](../../reference/apis-crypto-architecture-kit/_crypto_sym_cipher_api.md#oh_cryptosymcipher_init)，设置模式为加密（CRYPTO_ENCRYPT_MODE），指定加密密钥（OH_CryptoSymKey）和GCM模式对应的加密参数（OH_CryptoSymCipherParams），初始化加密Cipher实例。
26
275. 将一次传入数据量设置为20字节，多次调用[OH_CryptoSymCipher_Update](../../reference/apis-crypto-architecture-kit/_crypto_sym_cipher_api.md#oh_cryptosymcipher_update)，更新数据（明文）。
28
29   - 当前单次update长度没有限制，开发者可以根据数据量判断如何调用update。
30   - 建议开发者对每次update的结果都判断是否为null，并在结果不为null时取出其中的数据进行拼接，形成完整的密文。因为在不同的规格下，update的结果可能会受到不同影响。
31
32      1）比如ECB和CBC模式，始终以分组作为基本单位来加密，并输出本次update产生的加密分组结果。即当本次update操作凑满一个分组就输出密文，没有凑满则此次update输出null，将未加密的数据与下次输入的数据拼接凑分组再输出。等到最后doFinal的时候，将未加密的数据，根据指定的填充模式进行填充，在输出剩余加密结果。解密过程中的update同理。
33
34      2）对于流加密模式（比如CTR和OFB模式），通常密文长度和明文长度相等。
35
366. 调用[OH_CryptoSymCipher_Final](../../reference/apis-crypto-architecture-kit/_crypto_sym_cipher_api.md#oh_cryptosymcipher_final)，获取加密后的数据。
37
38   - 由于已使用update传入数据，此处data传入null。
39   - final输出结果可能为null，在访问具体数据前，需要先判断结果是否为null，避免产生异常。
40
417. 调用[OH_CryptoSymCipherParams_SetParam](../../reference/apis-crypto-architecture-kit/_crypto_sym_cipher_api.md#oh_cryptosymcipherparams_setparam)设置authTag作为解密的认证信息。
42
43   在GCM模式下，需要从加密后的数据中取出末尾16字节，作为解密时初始化的认证信息。示例中authTag恰好为16字节。
44
458. 调用[OH_CryptoSymKeyGenerator_Destroy](../../reference/apis-crypto-architecture-kit/_crypto_sym_key_api.md#oh_cryptosymkeygenerator_destroy)、[OH_CryptoSymCipher_Destroy](../../reference/apis-crypto-architecture-kit/_crypto_sym_cipher_api.md#oh_cryptosymcipher_destroy)、[OH_CryptoSymCipherParams_Destroy](../../reference/apis-crypto-architecture-kit/_crypto_sym_cipher_api.md#oh_cryptosymcipherparams_destroy)销毁各对象。
46
47**解密**
48
49
501. 调用[OH_CryptoSymCipher_Init](../../reference/apis-crypto-architecture-kit/_crypto_sym_cipher_api.md#oh_cryptosymcipher_init)，设置模式为解密（CRYPTO_DECRYPT_MODE），指定解密密钥（OH_CryptoSymKey）和GCM模式对应的解密参数（OH_CryptoSymCipherParams），初始化解密Cipher实例。
51
522. 将一次传入数据量设置为20字节，多次调用[OH_CryptoSymCipher_Update](../../reference/apis-crypto-architecture-kit/_crypto_sym_cipher_api.md#oh_cryptosymcipher_update)，更新数据（密文）。
53
543. 调用[OH_CryptoSymCipher_Final](../../reference/apis-crypto-architecture-kit/_crypto_sym_cipher_api.md#oh_cryptosymcipher_final)，获取解密后的数据。
55
56
57- 示例：
58
59```c++
60#include <string.h>
61#include "CryptoArchitectureKit/crypto_common.h"
62#include "CryptoArchitectureKit/crypto_sym_cipher.h"
63
64#define OH_CRYPTO_GCM_TAG_LEN 16
65#define OH_CRYPTO_MAX_TEST_DATA_LEN 128
66static OH_Crypto_ErrCode doTestAesGcmSeg()
67{
68    OH_CryptoSymKeyGenerator *genCtx = nullptr;
69    OH_CryptoSymCipher *encCtx = nullptr;
70    OH_CryptoSymCipher *decCtx = nullptr;
71    OH_CryptoSymKey *keyCtx = nullptr;
72    OH_CryptoSymCipherParams *params = nullptr;
73
74    char *plainText = const_cast<char *>("aaaaa.....bbbbb.....ccccc.....ddddd.....eee");
75    Crypto_DataBlob msgBlob = {.data = (uint8_t *)(plainText), .len = strlen(plainText)};
76
77    uint8_t aad[8] = {1, 2, 3, 4, 5, 6, 7, 8};
78    uint8_t tagArr[16] = {0};
79    uint8_t iv[12] = {1, 2, 4, 12, 3, 4, 2, 3, 3, 2, 0, 4}; // iv使用安全随机数生成
80    Crypto_DataBlob tag = {.data = nullptr, .len = 0};
81    Crypto_DataBlob ivBlob = {.data = iv, .len = sizeof(iv)};
82    Crypto_DataBlob aadBlob = {.data = aad, .len = sizeof(aad)};
83    Crypto_DataBlob outUpdate = {.data = nullptr, .len = 0};
84    Crypto_DataBlob decUpdate = {.data = nullptr, .len = 0};
85    Crypto_DataBlob tagInit = {.data = tagArr, .len = sizeof(tagArr)};
86    int32_t cipherLen = 0;
87    int blockSize = 20;
88    int32_t randomLen = strlen(plainText);
89    int cnt = randomLen / blockSize;
90    int rem = randomLen % blockSize;
91    uint8_t cipherText[OH_CRYPTO_MAX_TEST_DATA_LEN] = {0};
92    Crypto_DataBlob cipherBlob;
93
94    // 生成密钥
95    OH_Crypto_ErrCode ret;
96    ret = OH_CryptoSymKeyGenerator_Create("AES128", &genCtx);
97    if (ret != CRYPTO_SUCCESS) {
98        goto end;
99    }
100    ret = OH_CryptoSymKeyGenerator_Generate(genCtx, &keyCtx);
101    if (ret != CRYPTO_SUCCESS) {
102        goto end;
103    }
104
105    // 设置参数
106    ret = OH_CryptoSymCipherParams_Create(&params);
107    if (ret != CRYPTO_SUCCESS) {
108        goto end;
109    }
110    ret = OH_CryptoSymCipherParams_SetParam(params, CRYPTO_IV_DATABLOB, &ivBlob);
111    if (ret != CRYPTO_SUCCESS) {
112        goto end;
113    }
114    ret = OH_CryptoSymCipherParams_SetParam(params, CRYPTO_AAD_DATABLOB, &aadBlob);
115    if (ret != CRYPTO_SUCCESS) {
116        goto end;
117    }
118    ret = OH_CryptoSymCipherParams_SetParam(params, CRYPTO_TAG_DATABLOB, &tagInit);
119    if (ret != CRYPTO_SUCCESS) {
120        goto end;
121    }
122
123    // 加密
124    ret = OH_CryptoSymCipher_Create("AES128|GCM|PKCS7", &encCtx);
125    if (ret != CRYPTO_SUCCESS) {
126        goto end;
127    }
128    ret = OH_CryptoSymCipher_Init(encCtx, CRYPTO_ENCRYPT_MODE, keyCtx, params);
129    if (ret != CRYPTO_SUCCESS) {
130        goto end;
131    }
132
133    for (int i = 0; i < cnt; i++) {
134        msgBlob.len = blockSize;
135        ret = OH_CryptoSymCipher_Update(encCtx, &msgBlob, &outUpdate);
136        if (ret != CRYPTO_SUCCESS) {
137            goto end;
138        }
139        msgBlob.data += blockSize;
140        memcpy(&cipherText[cipherLen], outUpdate.data, outUpdate.len);
141        cipherLen += outUpdate.len;
142    }
143    if (rem > 0) {
144        msgBlob.len = rem;
145        ret = OH_CryptoSymCipher_Update(encCtx, (Crypto_DataBlob *)&msgBlob, &outUpdate);
146        if (ret != CRYPTO_SUCCESS) {
147            goto end;
148        }
149        memcpy(&cipherText[cipherLen], outUpdate.data, outUpdate.len);
150        cipherLen += outUpdate.len;
151    }
152    ret = OH_CryptoSymCipher_Final(encCtx, nullptr, &tag);
153    if (ret != CRYPTO_SUCCESS) {
154        goto end;
155    }
156
157    // 解密
158    cipherBlob = {.data = reinterpret_cast<uint8_t *>(cipherText), .len = (size_t)cipherLen};
159    msgBlob.data -= strlen(plainText) - rem;
160    msgBlob.len = strlen(plainText);
161    ret = OH_CryptoSymCipher_Create("AES128|GCM|PKCS7", &decCtx);
162    if (ret != CRYPTO_SUCCESS) {
163        goto end;
164    }
165    ret = OH_CryptoSymCipherParams_SetParam(params, CRYPTO_TAG_DATABLOB, &tag);
166    if (ret != CRYPTO_SUCCESS) {
167        goto end;
168    }
169    ret = OH_CryptoSymCipher_Init(decCtx, CRYPTO_DECRYPT_MODE, keyCtx, params);
170    if (ret != CRYPTO_SUCCESS) {
171        goto end;
172    }
173    ret = OH_CryptoSymCipher_Final(decCtx, &cipherBlob, &decUpdate);
174    if (ret != CRYPTO_SUCCESS) {
175        goto end;
176    }
177
178end:
179    OH_CryptoSymCipherParams_Destroy(params);
180    OH_CryptoSymCipher_Destroy(encCtx);
181    OH_CryptoSymCipher_Destroy(decCtx);
182    OH_CryptoSymKeyGenerator_Destroy(genCtx);
183    OH_CryptoSymKey_Destroy(keyCtx);
184    OH_Crypto_FreeDataBlob(&outUpdate);
185    OH_Crypto_FreeDataBlob(&tag);
186    OH_Crypto_FreeDataBlob(&decUpdate);
187    return ret;
188}
189```
190