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