• 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. 调用[OH_CryptoSymCipher_Update](../../reference/apis-crypto-architecture-kit/_crypto_sym_cipher_api.md#oh_cryptosymcipher_update)，更新数据（明文）。
27
28   当前单次update长度没有限制，开发者可以根据数据量判断如何调用update。
29
30   - 当数据量较小时，可以在init完成后直接调用final。
31   - 当数据量较大时，可以多次调用update，即[分段加解密](crypto-aes-sym-encrypt-decrypt-gcm-by-segment-ndk.md)。
32
335. 调用[OH_CryptoSymCipher_Final](../../reference/apis-crypto-architecture-kit/_crypto_sym_cipher_api.md#oh_cryptosymcipher_final)，获取加密后的数据。
34   - 由于已使用update传入数据，此处data传入null。
35   - final输出结果可能为null，在访问具体数据前，需要先判断结果是否为null，避免产生异常。
36
37   > **注意：**
38   > 在GCM模式下，final会返回authTag，作为解密时初始化的认证信息，需要保存。在GCM模式下，算法库当前只支持16字节的authTag，作为解密时初始化的认证信息。示例中authTag恰好为16字节。
39
40
41**解密**
42
431. 调用[OH_CryptoSymCipher_Create](../../reference/apis-crypto-architecture-kit/_crypto_sym_cipher_api.md#oh_cryptosymcipher_create)，指定字符串参数'AES128|GCM|PKCS7'，创建对称密钥类型为AES128、分组模式为GCM、填充模式为PKCS7的Cipher实例，用于完成解密操作。
44
452. 使用[OH_CryptoSymCipherParams_SetParam](../../reference/apis-crypto-architecture-kit/_crypto_sym_cipher_api.md#oh_cryptosymcipherparams_setparam)设置authTag，作为解密的认证信息。
46
473. 调用[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实例。
48
494. 调用[OH_CryptoSymCipher_Update](../../reference/apis-crypto-architecture-kit/_crypto_sym_cipher_api.md#oh_cryptosymcipher_update)，更新数据（密文）。
50
515. 调用[OH_CryptoSymCipher_Final](../../reference/apis-crypto-architecture-kit/_crypto_sym_cipher_api.md#oh_cryptosymcipher_final)，获取解密后的数据。
52
53**销毁对象**
54
55调用[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)销毁各对象。
56
57- AES GCM模式加解密示例如下：
58
59```c++
60#include "CryptoArchitectureKit/crypto_common.h"
61#include "CryptoArchitectureKit/crypto_sym_cipher.h"
62#include <string.h>
63
64static OH_Crypto_ErrCode doTestAesGcm()
65{
66    OH_CryptoSymKeyGenerator *genCtx = nullptr;
67    OH_CryptoSymCipher *encCtx = nullptr;
68    OH_CryptoSymCipher *decCtx = nullptr;
69    OH_CryptoSymKey *keyCtx = nullptr;
70    OH_CryptoSymCipherParams *params = nullptr;
71
72    Crypto_DataBlob encData = {.data = nullptr, .len = 0};
73    Crypto_DataBlob decData = {.data = nullptr, .len = 0};
74
75    uint8_t aad[8] = {1, 2, 3, 4, 5, 6, 7, 8};
76    uint8_t tag[16] = {0};
77    uint8_t iv[12] = {1, 2, 4, 12, 3, 4, 2, 3, 3, 2, 0, 4}; // iv使用安全随机数生成。
78    Crypto_DataBlob ivData = {.data = iv, .len = sizeof(iv)};
79    Crypto_DataBlob aadData = {.data = aad, .len = sizeof(aad)};
80    Crypto_DataBlob tagData = {.data = tag, .len = sizeof(tag)};
81    Crypto_DataBlob tagOutPut = {.data = nullptr, .len = 0};
82    char *plainText = const_cast<char *>("this is test!");
83    Crypto_DataBlob msgBlob = {.data = (uint8_t *)(plainText), .len = strlen(plainText)};
84
85    // 生成对称密钥。
86    OH_Crypto_ErrCode ret;
87    ret = OH_CryptoSymKeyGenerator_Create("AES128", &genCtx);
88    if (ret != CRYPTO_SUCCESS) {
89        goto end;
90    }
91    ret = OH_CryptoSymKeyGenerator_Generate(genCtx, &keyCtx);
92    if (ret != CRYPTO_SUCCESS) {
93        goto end;
94    }
95
96    // 设置参数。
97    ret = OH_CryptoSymCipherParams_Create(&params);
98    if (ret != CRYPTO_SUCCESS) {
99        goto end;
100    }
101    ret = OH_CryptoSymCipherParams_SetParam(params, CRYPTO_IV_DATABLOB, &ivData);
102    if (ret != CRYPTO_SUCCESS) {
103        goto end;
104    }
105    ret = OH_CryptoSymCipherParams_SetParam(params, CRYPTO_AAD_DATABLOB, &aadData);
106    if (ret != CRYPTO_SUCCESS) {
107        goto end;
108    }
109    ret = OH_CryptoSymCipherParams_SetParam(params, CRYPTO_TAG_DATABLOB, &tagData);
110    if (ret != CRYPTO_SUCCESS) {
111        goto end;
112    }
113
114    // 加密。
115    ret = OH_CryptoSymCipher_Create("AES128|GCM|PKCS7", &encCtx);
116    if (ret != CRYPTO_SUCCESS) {
117        goto end;
118    }
119    ret = OH_CryptoSymCipher_Init(encCtx, CRYPTO_ENCRYPT_MODE, keyCtx, params);
120    if (ret != CRYPTO_SUCCESS) {
121        goto end;
122    }
123    ret = OH_CryptoSymCipher_Update(encCtx, &msgBlob, &encData);
124    if (ret != CRYPTO_SUCCESS) {
125        goto end;
126    }
127    ret = OH_CryptoSymCipher_Final(encCtx, nullptr, &tagOutPut);
128    if (ret != CRYPTO_SUCCESS) {
129        goto end;
130    }
131
132    // 解密。
133    ret = OH_CryptoSymCipher_Create("AES128|GCM|PKCS7", &decCtx);
134    if (ret != CRYPTO_SUCCESS) {
135        goto end;
136    }
137    ret = OH_CryptoSymCipherParams_SetParam(params, CRYPTO_TAG_DATABLOB, &tagOutPut);
138    if (ret != CRYPTO_SUCCESS) {
139        goto end;
140    }
141    ret = OH_CryptoSymCipher_Init(decCtx, CRYPTO_DECRYPT_MODE, keyCtx, params);
142    if (ret != CRYPTO_SUCCESS) {
143        goto end;
144    }
145    ret = OH_CryptoSymCipher_Update(decCtx, &encData, &decData);
146    if (ret != CRYPTO_SUCCESS) {
147        goto end;
148    }
149    ret = OH_CryptoSymCipher_Final(decCtx, nullptr, &decData);
150    if (ret != CRYPTO_SUCCESS) {
151        goto end;
152    }
153
154end:
155    OH_CryptoSymCipherParams_Destroy(params);
156    OH_CryptoSymCipher_Destroy(encCtx);
157    OH_CryptoSymCipher_Destroy(decCtx);
158    OH_CryptoSymKeyGenerator_Destroy(genCtx);
159    OH_CryptoSymKey_Destroy(keyCtx);
160    OH_Crypto_FreeDataBlob(&encData);
161    OH_Crypto_FreeDataBlob(&decData);
162    OH_Crypto_FreeDataBlob(&tagOutPut);
163    return ret;
164}
165```