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