• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# 使用AES对称密钥（CCM模式）加解密(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|CCM'，创建对称密钥类型为AES128、分组模式为CCM的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）和CCM模式对应的加密参数（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   > CCM模式不支持分段加解密。
31
325. 调用[OH_CryptoSymCipher_Final](../../reference/apis-crypto-architecture-kit/_crypto_sym_cipher_api.md#oh_cryptosymcipher_final)，获取加密后的数据。
33   - 由于已使用update传入数据，此处data传入null。
34   - final输出结果可能为null，在访问具体数据前，需要先判断结果是否为null，避免产生异常。
35   > **注意：**
36   > 在CCM模式下，final会设置authTag，作为解密时初始化的认证信息，需要保存。
37
386. 使用[OH_CryptoSymCipherParams_Create](../../reference/apis-crypto-architecture-kit/_crypto_sym_cipher_api.md#oh_cryptosymcipherparams_create)创建Params，使用[OH_CryptoSymCipherParams_SetParam](../../reference/apis-crypto-architecture-kit/_crypto_sym_cipher_api.md#oh_cryptosymcipherparams_setparam)设置authTag，作为解密的认证信息。
39
40   在CCM模式下，算法库当前只支持12字节的authTag，作为解密时初始化的认证信息。示例中authTag恰好为12字节。
41
42**解密**
43
441. 调用[OH_CryptoSymCipher_Create](../../reference/apis-crypto-architecture-kit/_crypto_sym_cipher_api.md#oh_cryptosymcipher_create)，指定字符串参数'AES128|CCM'，创建对称密钥类型为AES128、分组模式为CCM的Cipher实例，用于完成解密操作。
45
462. 解密需要使用[OH_CryptoSymCipherParams_SetParam](../../reference/apis-crypto-architecture-kit/_crypto_sym_cipher_api.md#oh_cryptosymcipherparams_setparam)设置authTag，作为解密时初始化的认证信息。
47
483. 调用[OH_CryptoSymCipher_Init](../../reference/apis-crypto-architecture-kit/_crypto_sym_cipher_api.md#oh_cryptosymcipher_init)，设置模式为解密（CRYPTO_DECRYPT_MODE），指定解密密钥（OH_CryptoSymKey）和CCM模式对应的解密参数（OH_CryptoSymCipherParams），初始化解密Cipher实例。
49
504. 调用[OH_CryptoSymCipher_Update](../../reference/apis-crypto-architecture-kit/_crypto_sym_cipher_api.md#oh_cryptosymcipher_update)，更新数据（密文）。
51
52   当前单次update长度没有限制，开发者可以根据明文长度判断单次调用update输入的数据长度。
53   > **说明：**
54   > CCM模式不支持分段加解密。
55
564. 调用[OH_CryptoSymCipher_Final](../../reference/apis-crypto-architecture-kit/_crypto_sym_cipher_api.md#oh_cryptosymcipher_final)，获取解密后的数据。
57   - 由于已使用update传入数据，此处data传入null。
58   - final输出结果可能为null，在访问具体数据前，需要先判断结果是否为null，避免产生异常。
59
60**销毁对象**
61
62调用[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_CryptoSymKey_Destroy](../../reference/apis-crypto-architecture-kit/_crypto_sym_key_api.md#oh_cryptosymkey_destroy)、[OH_Crypto_FreeDataBlob](../../reference/apis-crypto-architecture-kit/_crypto_common_api.md#oh_crypto_freedatablob)释放申请的内存，销毁对称密钥、Cipher实例和Params。
63
64- AES CCM模式加解密示例如下：
65
66```c++
67#include "CryptoArchitectureKit/crypto_common.h"
68#include "CryptoArchitectureKit/crypto_sym_cipher.h"
69#include <string.h>
70
71static OH_Crypto_ErrCode doTestAesCcm()
72{
73    OH_CryptoSymKeyGenerator *genCtx = nullptr;
74    OH_CryptoSymCipher *encCtx = nullptr;
75    OH_CryptoSymCipher *decCtx = nullptr;
76    OH_CryptoSymKey *keyCtx = nullptr;
77    OH_CryptoSymCipherParams *params = nullptr;
78
79    Crypto_DataBlob encData = {.data = nullptr, .len = 0};
80    Crypto_DataBlob decData = {.data = nullptr, .len = 0};
81
82    uint8_t aad[8] = {1, 2, 3, 4, 5, 6, 7, 8}; // 示例代码随机aad值仅供参考。
83    uint8_t tag[12] = {0};
84    uint8_t iv[7] = {1, 2, 4, 12, 3, 4, 2}; // 示例代码随机iv值仅供参考。
85    Crypto_DataBlob ivData = {.data = iv, .len = sizeof(iv)};
86    Crypto_DataBlob aadData = {.data = aad, .len = sizeof(aad)};
87    Crypto_DataBlob tagData = {.data = tag, .len = sizeof(tag)};
88    Crypto_DataBlob tagOutPut = {.data = nullptr, .len = 0};
89    char *plainText = const_cast<char *>("this is test!");
90    Crypto_DataBlob msgBlob = {.data = (uint8_t *)(plainText), .len = strlen(plainText)};
91    // 生成对称密钥。
92    OH_Crypto_ErrCode ret;
93    ret = OH_CryptoSymKeyGenerator_Create("AES128", &genCtx);
94    if (ret != CRYPTO_SUCCESS) {
95        goto end;
96    }
97    ret = OH_CryptoSymKeyGenerator_Generate(genCtx, &keyCtx);
98    if (ret != CRYPTO_SUCCESS) {
99        goto end;
100    }
101
102    // 设置参数。
103    ret = OH_CryptoSymCipherParams_Create(&params);
104    if (ret != CRYPTO_SUCCESS) {
105        goto end;
106    }
107    ret = OH_CryptoSymCipherParams_SetParam(params, CRYPTO_IV_DATABLOB, &ivData);
108    if (ret != CRYPTO_SUCCESS) {
109        goto end;
110    }
111    ret = OH_CryptoSymCipherParams_SetParam(params, CRYPTO_AAD_DATABLOB, &aadData);
112    if (ret != CRYPTO_SUCCESS) {
113        goto end;
114    }
115    ret = OH_CryptoSymCipherParams_SetParam(params, CRYPTO_TAG_DATABLOB, &tagData);
116    if (ret != CRYPTO_SUCCESS) {
117        goto end;
118    }
119
120    // 加密。
121    ret = OH_CryptoSymCipher_Create("AES128|CCM", &encCtx);
122    if (ret != CRYPTO_SUCCESS) {
123        goto end;
124    }
125    ret = OH_CryptoSymCipher_Init(encCtx, CRYPTO_ENCRYPT_MODE, keyCtx, params);
126    if (ret != CRYPTO_SUCCESS) {
127        goto end;
128    }
129    ret = OH_CryptoSymCipher_Update(encCtx, &msgBlob, &encData);
130    if (ret != CRYPTO_SUCCESS) {
131        goto end;
132    }
133    ret = OH_CryptoSymCipher_Final(encCtx, nullptr, &tagOutPut);
134    if (ret != CRYPTO_SUCCESS) {
135        goto end;
136    }
137
138    // 解密。
139    ret = OH_CryptoSymCipher_Create("AES128|CCM", &decCtx);
140    if (ret != CRYPTO_SUCCESS) {
141        goto end;
142    }
143    ret = OH_CryptoSymCipherParams_SetParam(params, CRYPTO_TAG_DATABLOB, &tagOutPut);
144    if (ret != CRYPTO_SUCCESS) {
145        goto end;
146    }
147    ret = OH_CryptoSymCipher_Init(decCtx, CRYPTO_DECRYPT_MODE, keyCtx, params);
148    if (ret != CRYPTO_SUCCESS) {
149        goto end;
150    }
151    ret = OH_CryptoSymCipher_Update(decCtx, &encData, &decData);
152    if (ret != CRYPTO_SUCCESS) {
153        goto end;
154    }
155    ret = OH_CryptoSymCipher_Final(decCtx, nullptr, &decData);
156    if (ret != CRYPTO_SUCCESS) {
157        goto end;
158    }
159
160end:
161    OH_CryptoSymCipherParams_Destroy(params);
162    OH_CryptoSymCipher_Destroy(encCtx);
163    OH_CryptoSymCipher_Destroy(decCtx);
164    OH_CryptoSymKeyGenerator_Destroy(genCtx);
165    OH_CryptoSymKey_Destroy(keyCtx);
166    OH_Crypto_FreeDataBlob(&encData);
167    OH_Crypto_FreeDataBlob(&decData);
168    OH_Crypto_FreeDataBlob(&tagOutPut);
169    return ret;
170}
171```