• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# 使用AES对称密钥（GCM模式）加解密(C/C++)
2
3<!--Kit: Crypto Architecture Kit-->
4<!--Subsystem: Security-->
5<!--Owner: @zxz--3-->
6<!--Designer: @lanming-->
7<!--Tester: @PAFT-->
8<!--Adviser: @zengyawen-->
9
10对应的算法规格请查看[对称密钥加解密算法规格：AES](crypto-sym-encrypt-decrypt-spec.md#aes)。
11
12## 在CMake脚本中链接相关动态库
13```txt
14target_link_libraries(entry PUBLIC libohcrypto.so)
15```
16
17## 开发步骤
18
19**创建对象**
20
21调用[OH_CryptoSymKeyGenerator_Create](../../reference/apis-crypto-architecture-kit/capi-crypto-sym-key-h.md#oh_cryptosymkeygenerator_create)和[OH_CryptoSymKeyGenerator_Generate](../../reference/apis-crypto-architecture-kit/capi-crypto-sym-key-h.md#oh_cryptosymkeygenerator_generate)，生成密钥算法为AES、密钥长度为128位的对称密钥（OH_CryptoSymKey）。
22
23   生成AES对称密钥，参考以下示例，并结合[对称密钥生成和转换规格：AES](crypto-sym-key-generation-conversion-spec.md#aes)和[随机生成对称密钥](crypto-generate-sym-key-randomly-ndk.md)理解。注意，参考文档与示例可能有入参差异
24
251. 调用[OH_CryptoSymCipher_Create](../../reference/apis-crypto-architecture-kit/capi-crypto-sym-cipher-h.md#oh_cryptosymcipher_create)，指定字符串参数'AES128|GCM|PKCS7'，创建对称密钥类型为AES128、分组模式为GCM、填充模式为PKCS7的Cipher实例，用于完成加密操作。
26
272. 调用[OH_CryptoSymCipherParams_Create](../../reference/apis-crypto-architecture-kit/capi-crypto-sym-cipher-h.md#oh_cryptosymcipherparams_create)创建参数对象，调用[OH_CryptoSymCipherParams_SetParam](../../reference/apis-crypto-architecture-kit/capi-crypto-sym-cipher-h.md#oh_cryptosymcipherparams_setparam)设置对应的加密参数。
28
293. 调用[OH_CryptoSymCipher_Init](../../reference/apis-crypto-architecture-kit/capi-crypto-sym-cipher-h.md#oh_cryptosymcipher_init)，设置模式为加密（CRYPTO_ENCRYPT_MODE），指定对称密钥（OH_CryptoSymKey）和GCM模式对应的加密参数（OH_CryptoSymCipherParams），以初始化加密Cipher实例。
30
314. 调用[OH_CryptoSymCipher_Update](../../reference/apis-crypto-architecture-kit/capi-crypto-sym-cipher-h.md#oh_cryptosymcipher_update)，更新数据（明文）。
32
33   当前单次update长度没有限制，开发者可以根据数据量判断如何调用update。
34
35   - 当数据量较小时，可以在init完成后直接调用final。
36   - 当数据量较大时，可以多次调用update，即[分段加解密](crypto-aes-sym-encrypt-decrypt-gcm-by-segment-ndk.md)。
37
385. 调用[OH_CryptoSymCipher_Final](../../reference/apis-crypto-architecture-kit/capi-crypto-sym-cipher-h.md#oh_cryptosymcipher_final)，获取加密后的数据。
39   - 由于已使用update传入数据，此处data传入null。
40   - final输出结果可能为null，在访问具体数据前，需要先判断结果是否为null，避免产生异常。
41
42   > **注意：**
43   > 在GCM模式下，final会返回authTag，作为解密时初始化的认证信息，需要保存。GCM模式下，算法库当前只支持16字节的authTag。示例中authTag为16字节。
44
45
46**解密**
47
481. 调用[OH_CryptoSymCipher_Create](../../reference/apis-crypto-architecture-kit/capi-crypto-sym-cipher-h.md#oh_cryptosymcipher_create)，指定字符串参数'AES128|GCM|PKCS7'，创建对称密钥类型为AES128、分组模式为GCM、填充模式为PKCS7的Cipher实例，用于完成解密操作。
49
502. 使用[OH_CryptoSymCipherParams_SetParam](../../reference/apis-crypto-architecture-kit/capi-crypto-sym-cipher-h.md#oh_cryptosymcipherparams_setparam)设置authTag，作为解密的认证信息。
51
523. 调用[OH_CryptoSymCipher_Init](../../reference/apis-crypto-architecture-kit/capi-crypto-sym-cipher-h.md#oh_cryptosymcipher_init)，设置模式为解密（CRYPTO_DECRYPT_MODE），指定解密密钥（OH_CryptoSymKey）和GCM模式对应的解密参数（OH_CryptoSymCipherParams），初始化解密Cipher实例。
53
544. 调用[OH_CryptoSymCipher_Update](../../reference/apis-crypto-architecture-kit/capi-crypto-sym-cipher-h.md#oh_cryptosymcipher_update)，更新数据（密文）。
55
565. 调用[OH_CryptoSymCipher_Final](../../reference/apis-crypto-architecture-kit/capi-crypto-sym-cipher-h.md#oh_cryptosymcipher_final)，获取解密数据。
57
58**销毁对象**
59
60调用[OH_CryptoSymKeyGenerator_Destroy](../../reference/apis-crypto-architecture-kit/capi-crypto-sym-key-h.md#oh_cryptosymkeygenerator_destroy)、[OH_CryptoSymCipher_Destroy](../../reference/apis-crypto-architecture-kit/capi-crypto-sym-cipher-h.md#oh_cryptosymcipher_destroy)、[OH_CryptoSymCipherParams_Destroy](../../reference/apis-crypto-architecture-kit/capi-crypto-sym-cipher-h.md#oh_cryptosymcipherparams_destroy)销毁对象。
61
62- AES GCM模式加解密示例如下：
63
64```c++
65#include "CryptoArchitectureKit/crypto_common.h"
66#include "CryptoArchitectureKit/crypto_sym_cipher.h"
67#include <string.h>
68
69static OH_Crypto_ErrCode doTestAesGcm()
70{
71    OH_CryptoSymKeyGenerator *genCtx = nullptr;
72    OH_CryptoSymCipher *encCtx = nullptr;
73    OH_CryptoSymCipher *decCtx = nullptr;
74    OH_CryptoSymKey *keyCtx = nullptr;
75    OH_CryptoSymCipherParams *params = nullptr;
76
77    Crypto_DataBlob encData = {.data = nullptr, .len = 0};
78    Crypto_DataBlob decData = {.data = nullptr, .len = 0};
79
80    uint8_t aad[8] = {1, 2, 3, 4, 5, 6, 7, 8};
81    uint8_t tag[16] = {0};
82    uint8_t iv[12] = {1, 2, 4, 12, 3, 4, 2, 3, 3, 2, 0, 4}; // iv使用安全随机数生成。
83    Crypto_DataBlob ivData = {.data = iv, .len = sizeof(iv)};
84    Crypto_DataBlob aadData = {.data = aad, .len = sizeof(aad)};
85    Crypto_DataBlob tagData = {.data = tag, .len = sizeof(tag)};
86    Crypto_DataBlob tagOutPut = {.data = nullptr, .len = 0};
87    char *plainText = const_cast<char *>("this is test!");
88    Crypto_DataBlob msgBlob = {.data = (uint8_t *)(plainText), .len = strlen(plainText)};
89
90    // 生成对称密钥。
91    OH_Crypto_ErrCode ret;
92    ret = OH_CryptoSymKeyGenerator_Create("AES128", &genCtx);
93    if (ret != CRYPTO_SUCCESS) {
94        goto end;
95    }
96    ret = OH_CryptoSymKeyGenerator_Generate(genCtx, &keyCtx);
97    if (ret != CRYPTO_SUCCESS) {
98        goto end;
99    }
100
101    // 设置参数。
102    ret = OH_CryptoSymCipherParams_Create(&params);
103    if (ret != CRYPTO_SUCCESS) {
104        goto end;
105    }
106    ret = OH_CryptoSymCipherParams_SetParam(params, CRYPTO_IV_DATABLOB, &ivData);
107    if (ret != CRYPTO_SUCCESS) {
108        goto end;
109    }
110    ret = OH_CryptoSymCipherParams_SetParam(params, CRYPTO_AAD_DATABLOB, &aadData);
111    if (ret != CRYPTO_SUCCESS) {
112        goto end;
113    }
114    ret = OH_CryptoSymCipherParams_SetParam(params, CRYPTO_TAG_DATABLOB, &tagData);
115    if (ret != CRYPTO_SUCCESS) {
116        goto end;
117    }
118
119    // 加密。
120    ret = OH_CryptoSymCipher_Create("AES128|GCM|PKCS7", &encCtx);
121    if (ret != CRYPTO_SUCCESS) {
122        goto end;
123    }
124    ret = OH_CryptoSymCipher_Init(encCtx, CRYPTO_ENCRYPT_MODE, keyCtx, params);
125    if (ret != CRYPTO_SUCCESS) {
126        goto end;
127    }
128    ret = OH_CryptoSymCipher_Update(encCtx, &msgBlob, &encData);
129    if (ret != CRYPTO_SUCCESS) {
130        goto end;
131    }
132    ret = OH_CryptoSymCipher_Final(encCtx, nullptr, &tagOutPut);
133    if (ret != CRYPTO_SUCCESS) {
134        goto end;
135    }
136
137    // 解密。
138    ret = OH_CryptoSymCipher_Create("AES128|GCM|PKCS7", &decCtx);
139    if (ret != CRYPTO_SUCCESS) {
140        goto end;
141    }
142    ret = OH_CryptoSymCipherParams_SetParam(params, CRYPTO_TAG_DATABLOB, &tagOutPut);
143    if (ret != CRYPTO_SUCCESS) {
144        goto end;
145    }
146    ret = OH_CryptoSymCipher_Init(decCtx, CRYPTO_DECRYPT_MODE, keyCtx, params);
147    if (ret != CRYPTO_SUCCESS) {
148        goto end;
149    }
150    ret = OH_CryptoSymCipher_Update(decCtx, &encData, &decData);
151    if (ret != CRYPTO_SUCCESS) {
152        goto end;
153    }
154    ret = OH_CryptoSymCipher_Final(decCtx, nullptr, &decData);
155    if (ret != CRYPTO_SUCCESS) {
156        goto end;
157    }
158
159end:
160    OH_CryptoSymCipherParams_Destroy(params);
161    OH_CryptoSymCipher_Destroy(encCtx);
162    OH_CryptoSymCipher_Destroy(decCtx);
163    OH_CryptoSymKeyGenerator_Destroy(genCtx);
164    OH_CryptoSymKey_Destroy(keyCtx);
165    OH_Crypto_FreeDataBlob(&encData);
166    OH_Crypto_FreeDataBlob(&decData);
167    OH_Crypto_FreeDataBlob(&tagOutPut);
168    return ret;
169}
170```