openharmony 鸿蒙 capi-crypto-asym-cipher-h

2025-06-12 浏览 (1)

crypto_asym_cipher.h

概述

定义非对称密钥加密API。

库： libohcrypto.so

引用文件： <CryptoArchitectureKit/crypto_asym_cipher.h>

系统能力： SystemCapability.Security.CryptoFramework

起始版本： 20

相关模块： CryptoAsymCipherApi

汇总

结构体

名称typedef关键字描述
OH_CryptoAsymCipherOH_CryptoAsymCipher定义非对称加密结构。
OH_CryptoSm2CiphertextSpecOH_CryptoSm2CiphertextSpec定义SM2密文规范结构。

枚举

名称typedef关键字描述
CryptoSm2CiphertextSpec_itemCryptoSm2CiphertextSpec_item定义SM2密文规范项类型。

函数

名称描述
OH_Crypto_ErrCode OH_CryptoAsymCipher_Create(const char *algoName, OH_CryptoAsymCipher **ctx)根据给定的算法名称创建非对称加密。
OH_Crypto_ErrCode OH_CryptoAsymCipher_Init(OH_CryptoAsymCipher *ctx, Crypto_CipherMode mode, OH_CryptoKeyPair *key)初始化非对称加密。
OH_Crypto_ErrCode OH_CryptoAsymCipher_Final(OH_CryptoAsymCipher *ctx, const Crypto_DataBlob *in,Crypto_DataBlob *out)完成非对称加密。
void OH_CryptoAsymCipher_Destroy(OH_CryptoAsymCipher *ctx)销毁非对称加密上下文。
OH_Crypto_ErrCode OH_CryptoSm2CiphertextSpec_Create(Crypto_DataBlob *sm2Ciphertext, OH_CryptoSm2CiphertextSpec **spec)创建SM2密文规范。
OH_Crypto_ErrCode OH_CryptoSm2CiphertextSpec_GetItem(OH_CryptoSm2CiphertextSpec *spec,CryptoSm2CiphertextSpec_item item, Crypto_DataBlob *out)获取SM2密文规范中的指定项。
OH_Crypto_ErrCode OH_CryptoSm2CiphertextSpec_SetItem(OH_CryptoSm2CiphertextSpec *spec,CryptoSm2CiphertextSpec_item item, Crypto_DataBlob *in)设置SM2密文规范中的指定项。
OH_Crypto_ErrCode OH_CryptoSm2CiphertextSpec_Encode(OH_CryptoSm2CiphertextSpec *spec, Crypto_DataBlob *out)将SM2密文规范编码为DER格式密文。
void OH_CryptoSm2CiphertextSpec_Destroy(OH_CryptoSm2CiphertextSpec *spec)销毁SM2密文规范。

枚举类型说明

CryptoSm2CiphertextSpec_item

enum CryptoSm2CiphertextSpec_item

描述

定义SM2密文规范项类型。

起始版本： 20

枚举项描述
CRYPTO_SM2_CIPHERTEXT_C1_X = 0公钥x，也称为C1x。
CRYPTO_SM2_CIPHERTEXT_C1_Y = 1公钥y，也称为C1y。
CRYPTO_SM2_CIPHERTEXT_C2 = 2哈希值，也称为C2。
CRYPTO_SM2_CIPHERTEXT_C3 = 3密文数据，也称为C3。

函数说明

OH_CryptoAsymCipher_Create()

OH_Crypto_ErrCode OH_CryptoAsymCipher_Create(const char *algoName, OH_CryptoAsymCipher **ctx)

描述

根据给定的算法名称创建非对称加密。

起始版本： 20

参数：

参数项描述
const char *algoName用于生成加密的算法名称。
例如"RSA|PKCS1_OAEP|SHA384|MGF1_SHA384", "SM2|SM3"。
OH_CryptoAsymCipher **ctx指向非对称加密上下文的指针。

返回：

类型说明
OH_Crypto_ErrCodeCRYPTO_SUCCESS = 0 : 操作成功。
CRYPTO_INVALID_PARAMS = 401 : 参数无效。
CRYPTO_NOT_SUPPORTED = 801 : 操作不支持。
CRYPTO_MEMORY_ERROR = 17620001 : 内存错误。
CRYPTO_OPERTION_ERROR = 17630001 : 调用三方算法库API出错。

OH_CryptoAsymCipher_Init()

OH_Crypto_ErrCode OH_CryptoAsymCipher_Init(OH_CryptoAsymCipher *ctx, Crypto_CipherMode mode, OH_CryptoKeyPair *key)

描述

初始化非对称加密。

起始版本： 20

参数：

参数项描述
OH_CryptoAsymCipher *ctx非对称加密上下文。
Crypto_CipherMode mode加密模式是加密还是解密。
OH_CryptoKeyPair *key非对称密钥。

返回：

类型说明
OH_Crypto_ErrCodeCRYPTO_SUCCESS = 0 : 操作成功。
CRYPTO_INVALID_PARAMS = 401 : 参数无效。
CRYPTO_NOT_SUPPORTED = 801 : 操作不支持。
CRYPTO_MEMORY_ERROR = 17620001 : 内存错误。
CRYPTO_OPERTION_ERROR = 17630001 : 调用三方算法库API出错。

参考：

OH_CryptoAsymCipher_Final

OH_CryptoAsymCipher_Final()

OH_Crypto_ErrCode OH_CryptoAsymCipher_Final(OH_CryptoAsymCipher *ctx, const Crypto_DataBlob *in,Crypto_DataBlob *out)

描述

完成非对称加密。

起始版本： 20

参数：

参数项描述
OH_CryptoAsymCipher *ctx非对称加密上下文。
const Crypto_DataBlob *in要加密或解密的数据。
Crypto_DataBlob *out最终加密或解密的数据。

返回：

类型说明
OH_Crypto_ErrCodeCRYPTO_SUCCESS = 0 : 操作成功。
CRYPTO_INVALID_PARAMS = 401 : 参数无效。
CRYPTO_NOT_SUPPORTED = 801 : 操作不支持。
CRYPTO_MEMORY_ERROR = 17620001 : 内存错误。
CRYPTO_OPERTION_ERROR = 17630001 : 调用三方算法库API出错。

参考：

OH_CryptoAsymCipher_Init

OH_CryptoAsymCipher_Destroy()

void OH_CryptoAsymCipher_Destroy(OH_CryptoAsymCipher *ctx)

描述

销毁非对称加密上下文。

参数：

参数项描述
OH_CryptoAsymCipher *ctx非对称加密上下文。

OH_CryptoSm2CiphertextSpec_Create()

OH_Crypto_ErrCode OH_CryptoSm2CiphertextSpec_Create(Crypto_DataBlob *sm2Ciphertext, OH_CryptoSm2CiphertextSpec **spec)

描述

创建SM2密文规范。

起始版本： 20

参数：

参数项描述
Crypto_DataBlob *sm2CiphertextSM2密文DER格式数据，如果为NULL则创建空的SM2密文规范。
OH_CryptoSm2CiphertextSpec **spec输出的SM2密文规范。

返回：

类型说明
OH_Crypto_ErrCodeCRYPTO_SUCCESS = 0 : 操作成功。
CRYPTO_INVALID_PARAMS = 401 : 参数无效。
CRYPTO_NOT_SUPPORTED = 801 : 操作不支持。
CRYPTO_MEMORY_ERROR = 17620001 : 内存错误。
CRYPTO_OPERTION_ERROR = 17630001 : 调用三方算法库API出错。

OH_CryptoSm2CiphertextSpec_GetItem()

OH_Crypto_ErrCode OH_CryptoSm2CiphertextSpec_GetItem(OH_CryptoSm2CiphertextSpec *spec,CryptoSm2CiphertextSpec_item item, Crypto_DataBlob *out)

描述

获取SM2密文规范中的指定项。

起始版本： 20

参数：

参数项描述
OH_CryptoSm2CiphertextSpec *specSM2密文规范。
CryptoSm2CiphertextSpec_item itemSM2密文规范项。
Crypto_DataBlob *out输出数据。

返回：

类型说明
OH_Crypto_ErrCodeCRYPTO_SUCCESS = 0 : 操作成功。
CRYPTO_INVALID_PARAMS = 401 : 参数无效。
CRYPTO_NOT_SUPPORTED = 801 : 操作不支持。
CRYPTO_MEMORY_ERROR = 17620001 : 内存错误。
CRYPTO_OPERTION_ERROR = 17630001 : 调用三方算法库API出错。

OH_CryptoSm2CiphertextSpec_SetItem()

OH_Crypto_ErrCode OH_CryptoSm2CiphertextSpec_SetItem(OH_CryptoSm2CiphertextSpec *spec,CryptoSm2CiphertextSpec_item item, Crypto_DataBlob *in)

描述

设置SM2密文规范中的指定项。

起始版本： 20

参数：

参数项描述
OH_CryptoSm2CiphertextSpec *specSM2密文规范。
CryptoSm2CiphertextSpec_item itemSM2密文规范项。
Crypto_DataBlob *in输入数据。

返回：

类型说明
OH_Crypto_ErrCodeCRYPTO_SUCCESS = 0 : 操作成功。
CRYPTO_INVALID_PARAMS = 401 : 参数无效。
CRYPTO_NOT_SUPPORTED = 801 : 操作不支持。
CRYPTO_MEMORY_ERROR = 17620001 : 内存错误。
CRYPTO_OPERTION_ERROR = 17630001 : 调用三方算法库API出错。

OH_CryptoSm2CiphertextSpec_Encode()

OH_Crypto_ErrCode OH_CryptoSm2CiphertextSpec_Encode(OH_CryptoSm2CiphertextSpec *spec, Crypto_DataBlob *out)

描述

将SM2密文规范编码为DER格式密文。

起始版本： 20

参数：

参数项描述
OH_CryptoSm2CiphertextSpec *specSM2密文规范。
Crypto_DataBlob *out输出数据。

返回：

类型说明
OH_Crypto_ErrCodeCRYPTO_SUCCESS = 0 : 操作成功。
CRYPTO_INVALID_PARAMS = 401 : 参数无效。
CRYPTO_NOT_SUPPORTED = 801 : 操作不支持。
CRYPTO_MEMORY_ERROR = 17620001 : 内存错误。
CRYPTO_OPERTION_ERROR = 17630001 : 调用三方算法库API出错。

OH_CryptoSm2CiphertextSpec_Destroy()

void OH_CryptoSm2CiphertextSpec_Destroy(OH_CryptoSm2CiphertextSpec *spec)

描述

销毁SM2密文规范。

起始版本： 20

参数：

参数项描述
OH_CryptoSm2CiphertextSpec *specSM2密文规范。

你可能感兴趣的鸿蒙文章

harmony 鸿蒙Crypto Architecture Kit（加解密算法框架服务）

harmony 鸿蒙crypto_architecture_kit.h

harmony 鸿蒙crypto_asym_key.h

harmony 鸿蒙crypto_common.h

harmony 鸿蒙Crypto_DataBlob

harmony 鸿蒙crypto_digest.h

harmony 鸿蒙crypto_kdf.h

harmony 鸿蒙crypto_key_agreement.h

harmony 鸿蒙crypto_mac.h

harmony 鸿蒙crypto_rand.h

  • 所属分类： 后端技术
  • 本文标签： 软件 鸿蒙
  • 版权声明： 本文链接 https://seaxiang.com/blog/Gv1d1L