1# 使用AES对称密钥(CCM模式)加解密(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|CCM',创建对称密钥类型为AES128、分组模式为CCM的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)和CCM模式对应的加密参数(OH_CryptoSymCipherParams),初始化加密Cipher实例。
26
275. 调用[OH_CryptoSymCipher_Update](../../reference/apis-crypto-architecture-kit/_crypto_sym_cipher_api.md#oh_cryptosymcipher_update),更新数据(明文)。
28
29   当前单次update长度没有限制,开发者可以根据数据量判断如何调用update。
30   > **说明:**
31   > CCM模式不支持分段加解密。
32
336. 调用[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
377. 使用[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,作为解密的认证信息。
38
39   在CCM模式下,需要从加密后的数据中取出末尾12字节,作为解密时初始化的认证信息。示例中authTag恰好为12字节。
40
418. 调用[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)销毁各对象。
42
43
44**解密**
45
46
471. 调用[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实例。
48
492. 调用[OH_CryptoSymCipher_Final](../../reference/apis-crypto-architecture-kit/_crypto_sym_cipher_api.md#oh_cryptosymcipher_final),获取解密后的数据。
50
51
52- AES CCM模式加解密示例如下:
53
54```c++
55#include "CryptoArchitectureKit/crypto_common.h"
56#include "CryptoArchitectureKit/crypto_sym_cipher.h"
57#include <string.h>
58
59static OH_Crypto_ErrCode doTestAesCcm()
60{
61    OH_CryptoSymKeyGenerator *genCtx = nullptr;
62    OH_CryptoSymCipher *encCtx = nullptr;
63    OH_CryptoSymCipher *decCtx = nullptr;
64    OH_CryptoSymKey *keyCtx = nullptr;
65    OH_CryptoSymCipherParams *params = nullptr;
66
67    Crypto_DataBlob outUpdate = {.data = nullptr, .len = 0};
68    Crypto_DataBlob decUpdate = {.data = nullptr, .len = 0};
69
70    uint8_t aad[8] = {1, 2, 3, 4, 5, 6, 7, 8};
71    uint8_t tag[12] = {0};
72    uint8_t iv[7] = {1, 2, 4, 12, 3, 4, 2}; // iv使用安全随机数生成
73    Crypto_DataBlob ivData = {.data = iv, .len = sizeof(iv)};
74    Crypto_DataBlob aadData = {.data = aad, .len = sizeof(aad)};
75    Crypto_DataBlob tagData = {.data = tag, .len = sizeof(tag)};
76    Crypto_DataBlob tagOutPut = {.data = nullptr, .len = 0};
77    char *plainText = const_cast<char *>("this is test!");
78    Crypto_DataBlob msgBlob = {.data = (uint8_t *)(plainText), .len = strlen(plainText)};
79    // 生成对称密钥
80    OH_Crypto_ErrCode ret;
81    ret = OH_CryptoSymKeyGenerator_Create("AES128", &genCtx);
82    if (ret != CRYPTO_SUCCESS) {
83        goto end;
84    }
85    ret = OH_CryptoSymKeyGenerator_Generate(genCtx, &keyCtx);
86    if (ret != CRYPTO_SUCCESS) {
87        goto end;
88    }
89
90    // 设置参数
91    ret = OH_CryptoSymCipherParams_Create(&params);
92    if (ret != CRYPTO_SUCCESS) {
93        goto end;
94    }
95    ret = OH_CryptoSymCipherParams_SetParam(params, CRYPTO_IV_DATABLOB, &ivData);
96    if (ret != CRYPTO_SUCCESS) {
97        goto end;
98    }
99    ret = OH_CryptoSymCipherParams_SetParam(params, CRYPTO_AAD_DATABLOB, &aadData);
100    if (ret != CRYPTO_SUCCESS) {
101        goto end;
102    }
103    ret = OH_CryptoSymCipherParams_SetParam(params, CRYPTO_TAG_DATABLOB, &tagData);
104    if (ret != CRYPTO_SUCCESS) {
105        goto end;
106    }
107
108    // 加密
109    ret = OH_CryptoSymCipher_Create("AES128|CCM", &encCtx);
110    if (ret != CRYPTO_SUCCESS) {
111        goto end;
112    }
113    ret = OH_CryptoSymCipher_Init(encCtx, CRYPTO_ENCRYPT_MODE, keyCtx, params);
114    if (ret != CRYPTO_SUCCESS) {
115        goto end;
116    }
117    ret = OH_CryptoSymCipher_Update(encCtx, &msgBlob, &outUpdate);
118    if (ret != CRYPTO_SUCCESS) {
119        goto end;
120    }
121    ret = OH_CryptoSymCipher_Final(encCtx, nullptr, &tagOutPut);
122    if (ret != CRYPTO_SUCCESS) {
123        goto end;
124    }
125
126    // 解密
127    ret = OH_CryptoSymCipher_Create("AES128|CCM", &decCtx);
128    if (ret != CRYPTO_SUCCESS) {
129        goto end;
130    }
131    ret = OH_CryptoSymCipherParams_SetParam(params, CRYPTO_TAG_DATABLOB, &tagOutPut);
132    if (ret != CRYPTO_SUCCESS) {
133        goto end;
134    }
135    ret = OH_CryptoSymCipher_Init(decCtx, CRYPTO_DECRYPT_MODE, keyCtx, params);
136    if (ret != CRYPTO_SUCCESS) {
137        goto end;
138    }
139    ret = OH_CryptoSymCipher_Final(decCtx, &outUpdate, &decUpdate);
140    if (ret != CRYPTO_SUCCESS) {
141        goto end;
142    }
143
144end:
145    OH_CryptoSymCipherParams_Destroy(params);
146    OH_CryptoSymCipher_Destroy(encCtx);
147    OH_CryptoSymCipher_Destroy(decCtx);
148    OH_CryptoSymKeyGenerator_Destroy(genCtx);
149    OH_CryptoSymKey_Destroy(keyCtx);
150    OH_Crypto_FreeDataBlob(&outUpdate);
151    OH_Crypto_FreeDataBlob(&decUpdate);
152    OH_Crypto_FreeDataBlob(&tagOutPut);
153    return ret;
154}
155```