跳到主要内容

使用AES对称密钥(GCM模式)加解密(C/C++)

对应的算法规格请查看对称密钥加解密算法规格:AES

在CMake脚本中链接相关动态库

target_link_libraries(entry PUBLIC libohcrypto.so)

开发步骤

创建对象

调用OH_CryptoSymKeyGenerator_CreateOH_CryptoSymKeyGenerator_Generate,生成密钥算法为AES、密钥长度为128位的对称密钥(OH_CryptoSymKey)。

生成AES对称密钥,参考以下示例,并结合对称密钥生成和转换规格:AES随机生成对称密钥理解。注意,参考文档与示例可能有入参差异

  1. 调用OH_CryptoSymCipher_Create,指定字符串参数'AES128|GCM|PKCS7',创建对称密钥类型为AES128、分组模式为GCM、填充模式为PKCS7的Cipher实例,用于完成加密操作。

  2. 调用OH_CryptoSymCipherParams_Create创建参数对象,调用OH_CryptoSymCipherParams_SetParam设置对应的加密参数。

  3. 调用OH_CryptoSymCipher_Init,设置模式为加密(CRYPTO_ENCRYPT_MODE),指定对称密钥(OH_CryptoSymKey)和GCM模式对应的加密参数(OH_CryptoSymCipherParams),以初始化加密Cipher实例。

  4. 调用OH_CryptoSymCipher_Update,更新数据(明文)。

    当前单次update长度没有限制,开发者可以根据数据量判断如何调用update。

    • 当数据量较小时,可以在init完成后直接调用final。
    • 当数据量较大时,可以多次调用update,即分段加解密
  5. 调用OH_CryptoSymCipher_Final,获取加密后的数据。

    • 由于已使用update传入数据,此处data传入null。
    • final输出结果可能为null,在访问具体数据前,需要先判断结果是否为null,避免产生异常。

    在GCM模式下,final会返回authTag,作为解密时初始化的认证信息,需要保存。GCM模式下,算法库当前只支持16字节的authTag。示例中authTag为16字节。

解密

  1. 调用OH_CryptoSymCipher_Create,指定字符串参数'AES128|GCM|PKCS7',创建对称密钥类型为AES128、分组模式为GCM、填充模式为PKCS7的Cipher实例,用于完成解密操作。
  2. 使用OH_CryptoSymCipherParams_SetParam设置authTag,作为解密的认证信息。
  3. 调用OH_CryptoSymCipher_Init,设置模式为解密(CRYPTO_DECRYPT_MODE),指定解密密钥(OH_CryptoSymKey)和GCM模式对应的解密参数(OH_CryptoSymCipherParams),初始化解密Cipher实例。
  4. 调用OH_CryptoSymCipher_Update,更新数据(密文)。
  5. 调用OH_CryptoSymCipher_Final,获取解密数据。

销毁对象

调用OH_CryptoSymKeyGenerator_DestroyOH_CryptoSymCipher_DestroyOH_CryptoSymCipherParams_Destroy销毁对象。

  • AES GCM模式加解密示例如下:
#include "CryptoArchitectureKit/crypto_common.h"
#include "CryptoArchitectureKit/crypto_sym_cipher.h"
#include <cstring>
#include "file.h"

OH_Crypto_ErrCode doTestAesGcm()
{
OH_CryptoSymKeyGenerator *genCtx = nullptr;
OH_CryptoSymCipher *encCtx = nullptr;
OH_CryptoSymCipher *decCtx = nullptr;
OH_CryptoSymKey *keyCtx = nullptr;
OH_CryptoSymCipherParams *params = nullptr;

Crypto_DataBlob outUpdate = {.data = nullptr, .len = 0};
Crypto_DataBlob decUpdate = {.data = nullptr, .len = 0};

uint8_t aad[8] = {1, 2, 3, 4, 5, 6, 7, 8};
uint8_t tag[16] = {0};
uint8_t iv[12] = {1, 2, 4, 12, 3, 4, 2, 3, 3, 2, 0, 4}; // iv使用安全随机数生成
Crypto_DataBlob ivData = {.data = iv, .len = sizeof(iv)};
Crypto_DataBlob aadData = {.data = aad, .len = sizeof(aad)};
Crypto_DataBlob tagData = {.data = tag, .len = sizeof(tag)};
Crypto_DataBlob tagOutPut = {.data = nullptr, .len = 0};
char *plainText = const_cast<char *>("this is test!");
Crypto_DataBlob msgBlob = {.data = (uint8_t *)(plainText), .len = strlen(plainText)};

// 生成对称密钥
OH_Crypto_ErrCode ret = OH_CryptoSymKeyGenerator_Create("AES128", &genCtx);
if (ret != CRYPTO_SUCCESS) {
goto end;
}
ret = OH_CryptoSymKeyGenerator_Generate(genCtx, &keyCtx);
if (ret != CRYPTO_SUCCESS) {
goto end;
}

// 设置参数
ret = OH_CryptoSymCipherParams_Create(&params);
if (ret != CRYPTO_SUCCESS) {
goto end;
}
ret = OH_CryptoSymCipherParams_SetParam(params, CRYPTO_IV_DATABLOB, &ivData);
if (ret != CRYPTO_SUCCESS) {
goto end;
}
ret = OH_CryptoSymCipherParams_SetParam(params, CRYPTO_AAD_DATABLOB, &aadData);
if (ret != CRYPTO_SUCCESS) {
goto end;
}
ret = OH_CryptoSymCipherParams_SetParam(params, CRYPTO_TAG_DATABLOB, &tagData);
if (ret != CRYPTO_SUCCESS) {
goto end;
}

// 加密
ret = OH_CryptoSymCipher_Create("AES128|GCM|PKCS7", &encCtx);
if (ret != CRYPTO_SUCCESS) {
goto end;
}
ret = OH_CryptoSymCipher_Init(encCtx, CRYPTO_ENCRYPT_MODE, keyCtx, params);
if (ret != CRYPTO_SUCCESS) {
goto end;
}
ret = OH_CryptoSymCipher_Update(encCtx, &msgBlob, &outUpdate);
if (ret != CRYPTO_SUCCESS) {
goto end;
}
ret = OH_CryptoSymCipher_Final(encCtx, nullptr, &tagOutPut);
if (ret != CRYPTO_SUCCESS) {
goto end;
}

// 解密
ret = OH_CryptoSymCipher_Create("AES128|GCM|PKCS7", &decCtx);
if (ret != CRYPTO_SUCCESS) {
goto end;
}
ret = OH_CryptoSymCipherParams_SetParam(params, CRYPTO_TAG_DATABLOB, &tagOutPut);
if (ret != CRYPTO_SUCCESS) {
goto end;
}
ret = OH_CryptoSymCipher_Init(decCtx, CRYPTO_DECRYPT_MODE, keyCtx, params);
if (ret != CRYPTO_SUCCESS) {
goto end;
}
ret = OH_CryptoSymCipher_Final(decCtx, &outUpdate, &decUpdate);
if (ret != CRYPTO_SUCCESS) {
goto end;
}

end:
OH_CryptoSymCipherParams_Destroy(params);
OH_CryptoSymCipher_Destroy(encCtx);
OH_CryptoSymCipher_Destroy(decCtx);
OH_CryptoSymKeyGenerator_Destroy(genCtx);
OH_CryptoSymKey_Destroy(keyCtx);
OH_Crypto_FreeDataBlob(&outUpdate);
OH_Crypto_FreeDataBlob(&decUpdate);
OH_Crypto_FreeDataBlob(&tagOutPut);
return ret;
}