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 25**加密** 26 271. 调用[OH_CryptoSymCipher_Create](../../reference/apis-crypto-architecture-kit/capi-crypto-sym-cipher-h.md#oh_cryptosymcipher_create)，指定字符串参数'AES128|GCM|PKCS7'，创建对称密钥算法为AES128、分组模式为GCM、填充模式为PKCS7的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）和GCM模式的加密参数（OH_CryptoSymCipherParams），以初始化加密 Cipher 实例。 32 334. 将一次传入数据量设置为20字节，多次调用[OH_CryptoSymCipher_Update](../../reference/apis-crypto-architecture-kit/capi-crypto-sym-cipher-h.md#oh_cryptosymcipher_update)，更新数据（明文）。 34 35 - 当前单次update没有长度限制，开发者可根据数据量判断如何调用update。 36 - 建议开发者对每次update的结果都判断是否为null，并在结果不为null时取出其中的密文进行拼接，形成完整的密文。因为在不同的规格下，update的结果可能会受到不同影响。 37 38 1）例如ECB和CBC模式，始终以分组为基本单位进行加密，并输出本次更新产生的加密分组结果。即当本次更新操作凑满一个分组时，输出密文；若未凑满，则本次更新输出null，将未加密的数据与下次输入的数据拼接后，再进行分组输出。最后进行doFinal操作时，将未加密的数据根据指定的填充模式进行填充，再输出剩余加密结果。解密过程中的update操作同理。 39 40 2）对于流加密模式（比如CTR和OFB模式），通常密文长度和明文长度相等。 41 426. 调用[OH_CryptoSymCipher_Final](../../reference/apis-crypto-architecture-kit/capi-crypto-sym-cipher-h.md#oh_cryptosymcipher_final)，获取密文。 43 44 - 由于已使用update传入数据，此处传入null。 45 - final输出结果可能为null，在访问具体数据前，需要先判断结果是否为null，以避免产生异常。 46 > **注意：** 47 > 在GCM模式下，final会返回authTag，作为解密操作时初始化的认证信息，需要保存。 48 > 在GCM模式下，算法库当前只支持16字节的authTag，作为解密操作时初始化的认证信息。示例中authTag恰好为16字节。 49 50**解密** 51 521. 调用[OH_CryptoSymCipher_Create](../../reference/apis-crypto-architecture-kit/capi-crypto-sym-cipher-h.md#oh_cryptosymcipher_create)，指定参数'AES128|GCM|PKCS7'，创建对称密钥类型为AES128、分组模式为GCM、填充模式为PKCS7的Cipher实例，完成解密操作。 53 542. 调用[OH_CryptoSymCipherParams_SetParam](../../reference/apis-crypto-architecture-kit/capi-crypto-sym-cipher-h.md#oh_cryptosymcipherparams_setparam)设置authTag作为解密的认证信息。 55 56 在GCM模式下，从加密后的数据中取出末尾16字节，作为解密时初始化的认证信息。示例中authTag恰好为16字节。 57 583. 调用[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实例。 59 604. 将一次传入数据量设置为20字节，多次调用[OH_CryptoSymCipher_Update](../../reference/apis-crypto-architecture-kit/capi-crypto-sym-cipher-h.md#oh_cryptosymcipher_update)，更新数据（密文）。 61 625. 调用[OH_CryptoSymCipher_Final](../../reference/apis-crypto-architecture-kit/capi-crypto-sym-cipher-h.md#oh_cryptosymcipher_final)获取解密数据。 63 64**销毁对象** 65 66调用[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)销毁各对象。 67 68```c++ 69#include <string.h> 70#include "CryptoArchitectureKit/crypto_common.h" 71#include "CryptoArchitectureKit/crypto_sym_cipher.h" 72 73#define OH_CRYPTO_GCM_TAG_LEN 16 74#define OH_CRYPTO_MAX_TEST_DATA_LEN 128 75static OH_Crypto_ErrCode doTestAesGcmSeg() 76{ 77 OH_CryptoSymKeyGenerator *genCtx = nullptr; 78 OH_CryptoSymCipher *encCtx = nullptr; 79 OH_CryptoSymCipher *decCtx = nullptr; 80 OH_CryptoSymKey *keyCtx = nullptr; 81 OH_CryptoSymCipherParams *params = nullptr; 82 83 char *plainText = const_cast<char *>("aaaaa.....bbbbb.....ccccc.....ddddd.....eee"); 84 Crypto_DataBlob msgBlob = {.data = (uint8_t *)(plainText), .len = strlen(plainText)}; 85 86 uint8_t aad[8] = {1, 2, 3, 4, 5, 6, 7, 8}; 87 uint8_t tagArr[16] = {0}; 88 uint8_t iv[12] = {1, 2, 4, 12, 3, 4, 2, 3, 3, 2, 0, 4}; // iv使用安全随机数生成。 89 Crypto_DataBlob tag = {.data = nullptr, .len = 0}; 90 Crypto_DataBlob ivBlob = {.data = iv, .len = sizeof(iv)}; 91 Crypto_DataBlob aadBlob = {.data = aad, .len = sizeof(aad)}; 92 Crypto_DataBlob encData = {.data = nullptr, .len = 0}; 93 Crypto_DataBlob decData = {.data = nullptr, .len = 0}; 94 Crypto_DataBlob tagInit = {.data = tagArr, .len = sizeof(tagArr)}; 95 int32_t cipherLen = 0; 96 int blockSize = 20; 97 int32_t randomLen = strlen(plainText); 98 Crypto_DataBlob cipherBlob; 99 // 加密变量定义。 100 int cnt = randomLen / blockSize; 101 int rem = randomLen % blockSize; 102 uint8_t cipherText[OH_CRYPTO_MAX_TEST_DATA_LEN] = {0}; 103 104 // 解密变量定义。 105 int decCnt = cipherLen / blockSize; 106 int decRem = cipherLen % blockSize; 107 int32_t plantLen = 0; 108 uint8_t plantText[OH_CRYPTO_MAX_TEST_DATA_LEN] = {0}; 109 110 // 生成密钥。 111 OH_Crypto_ErrCode ret; 112 ret = OH_CryptoSymKeyGenerator_Create("AES128", &genCtx); 113 if (ret != CRYPTO_SUCCESS) { 114 goto end; 115 } 116 ret = OH_CryptoSymKeyGenerator_Generate(genCtx, &keyCtx); 117 if (ret != CRYPTO_SUCCESS) { 118 goto end; 119 } 120 121 // 设置参数。 122 ret = OH_CryptoSymCipherParams_Create(¶ms); 123 if (ret != CRYPTO_SUCCESS) { 124 goto end; 125 } 126 ret = OH_CryptoSymCipherParams_SetParam(params, CRYPTO_IV_DATABLOB, &ivBlob); 127 if (ret != CRYPTO_SUCCESS) { 128 goto end; 129 } 130 ret = OH_CryptoSymCipherParams_SetParam(params, CRYPTO_AAD_DATABLOB, &aadBlob); 131 if (ret != CRYPTO_SUCCESS) { 132 goto end; 133 } 134 ret = OH_CryptoSymCipherParams_SetParam(params, CRYPTO_TAG_DATABLOB, &tagInit); 135 if (ret != CRYPTO_SUCCESS) { 136 goto end; 137 } 138 139 // 加密。 140 ret = OH_CryptoSymCipher_Create("AES128|GCM|PKCS7", &encCtx); 141 if (ret != CRYPTO_SUCCESS) { 142 goto end; 143 } 144 ret = OH_CryptoSymCipher_Init(encCtx, CRYPTO_ENCRYPT_MODE, keyCtx, params); 145 if (ret != CRYPTO_SUCCESS) { 146 goto end; 147 } 148 149 for (int i = 0; i < cnt; i++) { 150 msgBlob.len = blockSize; 151 ret = OH_CryptoSymCipher_Update(encCtx, &msgBlob, &encData); 152 if (ret != CRYPTO_SUCCESS) { 153 goto end; 154 } 155 msgBlob.data += blockSize; 156 memcpy(&cipherText[cipherLen], encData.data, encData.len); 157 cipherLen += encData.len; 158 } 159 if (rem > 0) { 160 msgBlob.len = rem; 161 ret = OH_CryptoSymCipher_Update(encCtx, (Crypto_DataBlob *)&msgBlob, &encData); 162 if (ret != CRYPTO_SUCCESS) { 163 goto end; 164 } 165 memcpy(&cipherText[cipherLen], encData.data, encData.len); 166 cipherLen += encData.len; 167 } 168 ret = OH_CryptoSymCipher_Final(encCtx, nullptr, &tag); 169 if (ret != CRYPTO_SUCCESS) { 170 goto end; 171 } 172 173 // 解密。 174 cipherBlob = {.data = reinterpret_cast<uint8_t *>(cipherText), .len = (size_t)cipherLen}; 175 ret = OH_CryptoSymCipher_Create("AES128|GCM|PKCS7", &decCtx); 176 if (ret != CRYPTO_SUCCESS) { 177 goto end; 178 } 179 ret = OH_CryptoSymCipherParams_SetParam(params, CRYPTO_TAG_DATABLOB, &tag); 180 if (ret != CRYPTO_SUCCESS) { 181 goto end; 182 } 183 ret = OH_CryptoSymCipher_Init(decCtx, CRYPTO_DECRYPT_MODE, keyCtx, params); 184 if (ret != CRYPTO_SUCCESS) { 185 goto end; 186 } 187 for (int i = 0; i < decCnt; i++) { 188 cipherBlob.len = blockSize; 189 ret = OH_CryptoSymCipher_Update(decCtx, &cipherBlob, &decData); 190 if (ret != CRYPTO_SUCCESS) { 191 goto end; 192 } 193 cipherBlob.data += blockSize; 194 memcpy(&plantText[plantLen], decData.data, decData.len); 195 plantLen += decData.len; 196 } 197 if (decRem > 0) { 198 cipherBlob.len = decRem; 199 ret = OH_CryptoSymCipher_Update(decCtx, &cipherBlob, &decData); 200 if (ret != CRYPTO_SUCCESS) { 201 goto end; 202 } 203 memcpy(&plantText[plantLen], decData.data, decData.len); 204 plantLen += decData.len; 205 } 206 ret = OH_CryptoSymCipher_Final(decCtx, nullptr, &decData); 207 if (ret != CRYPTO_SUCCESS) { 208 goto end; 209 } 210 211end: 212 OH_CryptoSymCipherParams_Destroy(params); 213 OH_CryptoSymCipher_Destroy(encCtx); 214 OH_CryptoSymCipher_Destroy(decCtx); 215 OH_CryptoSymKeyGenerator_Destroy(genCtx); 216 OH_CryptoSymKey_Destroy(keyCtx); 217 OH_Crypto_FreeDataBlob(&encData); 218 OH_Crypto_FreeDataBlob(&tag); 219 OH_Crypto_FreeDataBlob(&decData); 220 return ret; 221} 222``` 223