harmony 鸿蒙crypto_asym_key.h

2025-06-12
浏览 (1)

crypto_asym_key.h

概述

声明非对称密钥接口。

库： libohcrypto.so

引用文件：

系统能力： SystemCapability.Security.CryptoFramework

起始版本： 12

相关模块： CryptoAsymKeyApi

汇总

结构体

枚举

函数

枚举类型说明

CryptoAsymKey_ParamType

enum CryptoAsymKey_ParamType

描述

定义非对称密钥参数类型。

起始版本： 12

Crypto_EncodingType

enum Crypto_EncodingType

描述

定义编码格式。

起始版本： 12

|枚举项|描述| |–|–| |CRYPTO_PEM = 0|PEM格式密钥类型。| |CRYPTO_DER = 1|DER格式密钥类型。|

CryptoPrivKeyEncoding_ParamType

enum CryptoPrivKeyEncoding_ParamType

描述

定义私钥编码参数类型。

起始版本： 20

|枚举项|描述| |–|–| |CRYPTO_PRIVATE_KEY_ENCODING_PASSWORD_STR = 0|表示密码字符串。| |CRYPTO_PRIVATE_KEY_ENCODING_SYMMETRIC_CIPHER_STR = 1|表示对称加密字符串。|

CryptoAsymKeySpec_Type

enum CryptoAsymKeySpec_Type

描述

定义非对称密钥规格类型。

起始版本： 20

函数说明

OH_CryptoAsymKeyGenerator_Create()

OH_Crypto_ErrCode OH_CryptoAsymKeyGenerator_Create(const char *algoName, OH_CryptoAsymKeyGenerator **ctx)

描述

通过指定算法名称的字符串，获取相应的非对称密钥生成器实例。

起始版本： 12

参数：

|参数项|描述| |–|–| |const char *algoName| 用于生成生成器的算法名称。
例如”RSA1024|PRIMES_2”。| |OH_CryptoAsymKeyGenerator **ctx| 指向非对称密钥生成器上下文的指针。|

返回：

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

OH_CryptoAsymKeyGenerator_Generate()

OH_Crypto_ErrCode OH_CryptoAsymKeyGenerator_Generate(OH_CryptoAsymKeyGenerator *ctx, OH_CryptoKeyPair **keyCtx)

描述

随机生成非对称密钥（密钥对）。

起始版本： 12

参数：

|参数项|描述| |–|–| |OH_CryptoAsymKeyGenerator *ctx| 非对称密钥生成器实例。| |OH_CryptoKeyPair **keyCtx| 指向非对称密钥对实例的指针。|

返回：

OH_CryptoAsymKeyGenerator_Convert()

OH_Crypto_ErrCode OH_CryptoAsymKeyGenerator_Convert(OH_CryptoAsymKeyGenerator *ctx, Crypto_EncodingType type,Crypto_DataBlob *pubKeyData, Crypto_DataBlob *priKeyData, OH_CryptoKeyPair **keyCtx)

描述

将非对称密钥数据转换为密钥对。

起始版本： 12

参数：

返回：

OH_CryptoAsymKeyGenerator_GetAlgoName()

const char *OH_CryptoAsymKeyGenerator_GetAlgoName(OH_CryptoAsymKeyGenerator *ctx)

描述

获取非对称密钥算法名称。

起始版本： 12

参数：

|参数项|描述| |–|–| |OH_CryptoAsymKeyGenerator *ctx|非对称密钥生成器实例。|

返回：

|类型|说明| |–|–| |const char|返回非对称密钥算法名称。|

OH_CryptoAsymKeyGenerator_Destroy()

void OH_CryptoAsymKeyGenerator_Destroy(OH_CryptoAsymKeyGenerator *ctx)

描述

销毁非对称密钥生成器实例。

起始版本： 12

参数：

|参数项|描述| |–|–| |OH_CryptoAsymKeyGenerator *ctx| 非对称密钥生成器实例。|

OH_CryptoKeyPair_Destroy()

void OH_CryptoKeyPair_Destroy(OH_CryptoKeyPair *keyCtx)

描述

销毁非对称密钥对实例。

起始版本： 12

参数：

|参数项|描述| |–|–| |OH_CryptoKeyPair *keyCtx| 密钥对实例。|

OH_CryptoKeyPair_GetPubKey()

OH_CryptoPubKey *OH_CryptoKeyPair_GetPubKey(OH_CryptoKeyPair *keyCtx)

描述

从密钥对中获取公钥实例。

起始版本： 12

参数：

|参数项|描述| |–|–| |OH_CryptoKeyPair *keyCtx|密钥对实例。|

返回：

|类型|说明| |–|–| |OH_CryptoPubKey|返回从密钥对中得到的公钥实例。|

OH_CryptoKeyPair_GetPrivKey()

OH_CryptoPrivKey *OH_CryptoKeyPair_GetPrivKey(OH_CryptoKeyPair *keyCtx)

描述

获取密钥对的私钥。

起始版本： 20

参数：

|参数项|描述| |–|–| |OH_CryptoKeyPair *keyCtx|密钥对实例。|

返回：

|类型|说明| |–|–| |OH_CryptoPrivKey|返回从密钥对中得到的私钥实例。|

OH_CryptoPubKey_Encode()

OH_Crypto_ErrCode OH_CryptoPubKey_Encode(OH_CryptoPubKey *key, Crypto_EncodingType type,const char *encodingStandard, Crypto_DataBlob *out)

描述

根据指定的编码格式输出公钥数据。

起始版本： 12

参数：

返回：

OH_CryptoPubKey_GetParam()

OH_Crypto_ErrCode OH_CryptoPubKey_GetParam(OH_CryptoPubKey *key, CryptoAsymKey_ParamType item, Crypto_DataBlob *value)

描述

从公钥实例获取指定参数。

起始版本： 12

参数：

返回：

OH_CryptoPrivKeyEncodingParams_Create()

OH_Crypto_ErrCode OH_CryptoPrivKeyEncodingParams_Create(OH_CryptoPrivKeyEncodingParams **ctx)

描述

创建私钥编码参数。

起始版本： 20

参数：

|参数项|描述| |–|–| |OH_CryptoPrivKeyEncodingParams **ctx| 私钥编码参数。|

返回：

OH_CryptoPrivKeyEncodingParams_SetParam()

OH_Crypto_ErrCode OH_CryptoPrivKeyEncodingParams_SetParam(OH_CryptoPrivKeyEncodingParams *ctx,CryptoPrivKeyEncoding_ParamType type, Crypto_DataBlob *value)

描述

设置私钥编码参数。

起始版本： 20

参数：

返回：

OH_CryptoPrivKeyEncodingParams_Destroy()

void OH_CryptoPrivKeyEncodingParams_Destroy(OH_CryptoPrivKeyEncodingParams *ctx)

描述

销毁私钥编码参数。

起始版本： 20

参数：

|参数项|描述| |–|–| |OH_CryptoPrivKeyEncodingParams *ctx| 私钥编码参数。|

OH_CryptoPrivKey_Encode()

OH_Crypto_ErrCode OH_CryptoPrivKey_Encode(OH_CryptoPrivKey *key, Crypto_EncodingType type,const char *encodingStandard, OH_CryptoPrivKeyEncodingParams *params, Crypto_DataBlob *out)

描述

从私钥实例获取指定参数。

起始版本： 20

参数：

返回：

OH_CryptoPrivKey_GetParam()

OH_Crypto_ErrCode OH_CryptoPrivKey_GetParam(OH_CryptoPrivKey *key, CryptoAsymKey_ParamType item,Crypto_DataBlob *value)

描述

获取私钥的指定参数。

起始版本： 20

参数：

|参数项|描述| |–|–| |OH_CryptoPrivKey *key|私钥。| |CryptoAsymKey_ParamType item|非对称密钥参数类型。| |Crypto_DataBlob *value| 输出数据。|

返回：

OH_CryptoAsymKeySpec_GenEcCommonParamsSpec()

OH_Crypto_ErrCode OH_CryptoAsymKeySpec_GenEcCommonParamsSpec(const char *curveName, OH_CryptoAsymKeySpec **spec)

描述

生成EC通用参数规格。

起始版本： 20

参数：

|参数项|描述| |–|–| |const char *curveName|curveName ECC曲线名称。| |OH_CryptoAsymKeySpec **spec| 指向EC通用参数规格的指针。|

返回：

OH_CryptoAsymKeySpec_GenDhCommonParamsSpec()

OH_Crypto_ErrCode OH_CryptoAsymKeySpec_GenDhCommonParamsSpec(int pLen, int skLen, OH_CryptoAsymKeySpec **spec)

描述

生成DH通用参数规格。

起始版本： 20

参数：

返回：

OH_CryptoAsymKeySpec_Create()

OH_Crypto_ErrCode OH_CryptoAsymKeySpec_Create(const char *algoName, CryptoAsymKeySpec_Type type,OH_CryptoAsymKeySpec **spec)

描述

根据给定的算法名称和规格类型创建非对称密钥规格。

起始版本： 20

参数：

返回：

OH_CryptoAsymKeySpec_SetParam()

OH_Crypto_ErrCode OH_CryptoAsymKeySpec_SetParam(OH_CryptoAsymKeySpec *spec, CryptoAsymKey_ParamType type,Crypto_DataBlob *value)

描述

设置非对称密钥规格的指定参数。

起始版本： 20

参数：

返回：

OH_CryptoAsymKeySpec_SetCommonParamsSpec()

OH_Crypto_ErrCode OH_CryptoAsymKeySpec_SetCommonParamsSpec(OH_CryptoAsymKeySpec *spec,OH_CryptoAsymKeySpec *commonParamsSpec)

描述

设置非对称密钥规格的通用参数规格。

起始版本： 20

参数：

|参数项|描述| |–|–| |OH_CryptoAsymKeySpec *spec| 非对称密钥规格。| |OH_CryptoAsymKeySpec *commonParamsSpec|通用参数规格。|

返回：

OH_CryptoAsymKeySpec_GetParam()

OH_Crypto_ErrCode OH_CryptoAsymKeySpec_GetParam(OH_CryptoAsymKeySpec *spec, CryptoAsymKey_ParamType type,Crypto_DataBlob *value)

描述

获取非对称密钥规格的指定参数。

起始版本： 20

参数：

返回：

OH_CryptoAsymKeySpec_Destroy()

void OH_CryptoAsymKeySpec_Destroy(OH_CryptoAsymKeySpec *spec)

描述

销毁非对称密钥规格。

起始版本： 20

参数：

|参数项|描述| |–|–| |OH_CryptoAsymKeySpec *spec| 非对称密钥规格。|

OH_CryptoAsymKeyGeneratorWithSpec_Create()

OH_Crypto_ErrCode OH_CryptoAsymKeyGeneratorWithSpec_Create(OH_CryptoAsymKeySpec *keySpec,OH_CryptoAsymKeyGeneratorWithSpec **generator)

描述

创建带规格的非对称密钥生成器。

起始版本： 20

参数：

|参数项|描述| |–|–| |OH_CryptoAsymKeySpec *keySpec|非对称密钥规格。| |OH_CryptoAsymKeyGeneratorWithSpec **generator|带规格的非对称密钥生成器。|

返回：

OH_CryptoAsymKeyGeneratorWithSpec_GenKeyPair()

OH_Crypto_ErrCode OH_CryptoAsymKeyGeneratorWithSpec_GenKeyPair(OH_CryptoAsymKeyGeneratorWithSpec *generator,OH_CryptoKeyPair **keyPair)

描述

根据非对称密钥规格生成密钥对。

起始版本： 20

参数：

|参数项|描述| |–|–| |OH_CryptoAsymKeyGeneratorWithSpec *generator|带规格的非对称密钥生成器。| |OH_CryptoKeyPair **keyPair|指向密钥对的指针。|

返回：

OH_CryptoAsymKeyGeneratorWithSpec_Destroy()

void OH_CryptoAsymKeyGeneratorWithSpec_Destroy(OH_CryptoAsymKeyGeneratorWithSpec *generator)

描述

销毁带规格的非对称密钥生成器。

起始版本： 20

参数：

|参数项|描述| |–|–| |OH_CryptoAsymKeyGeneratorWithSpec *generator|带规格的非对称密钥生成器。|

OH_CryptoEcPoint_Create()

OH_Crypto_ErrCode OH_CryptoEcPoint_Create(const char *curveName, Crypto_DataBlob *ecKeyData, OH_CryptoEcPoint **point)

描述

创建EC点。

起始版本： 20

参数：

|参数项|描述| |–|–| |const char *curveName|curveName 曲线名称。| |Crypto_DataBlob *ecKeyData|EC点数据，支持”04 ||x ||y”、”02 ||x”或”03 ||x”格式。如果ecKeyData参数为NULL，将创建一个空的EC点规格。| |OH_CryptoEcPoint **point| 指向EC点的指针。|

返回：

OH_CryptoEcPoint_GetCoordinate()

OH_Crypto_ErrCode OH_CryptoEcPoint_GetCoordinate(OH_CryptoEcPoint *point, Crypto_DataBlob *x, Crypto_DataBlob *y)

描述

获取EC点的x和y坐标。

起始版本： 20

参数：

|参数项|描述| |–|–| |OH_CryptoEcPoint *point| EC点。| |Crypto_DataBlob *x| EC点的x坐标,可以为NULL。| |OH_CryptoEcPoint *y|EC点的y坐标,可以为NULL。|

返回：

OH_CryptoEcPoint_SetCoordinate()

OH_Crypto_ErrCode OH_CryptoEcPoint_SetCoordinate(OH_CryptoEcPoint *point, Crypto_DataBlob *x, Crypto_DataBlob *y)

描述

设置EC点的x和y坐标。

起始版本： 20

参数：

|参数项|描述| |–|–| |OH_CryptoEcPoint *point| EC点。| |Crypto_DataBlob *x| EC点的x坐标。| |OH_CryptoEcPoint *y|EC点的y坐标。|

返回：

OH_CryptoEcPoint_Encode()

OH_Crypto_ErrCode OH_CryptoEcPoint_Encode(OH_CryptoEcPoint *point, const char *format, Crypto_DataBlob *out)

描述

将EC点编码为指定格式。

起始版本： 20

参数：

|参数项|描述| |–|–| |OH_CryptoEcPoint *point| EC点。| |const char *format|编码格式,支持”UNCOMPRESSED”和”COMPRESSED”。| |Crypto_DataBlob *out| 编码后的EC点数据。|

返回：

OH_CryptoEcPoint_Destroy()

void OH_CryptoEcPoint_Destroy(OH_CryptoEcPoint *point)

描述

销毁EC点。

起始版本： 20

参数：

|参数项|描述| |–|–| |OH_CryptoEcPoint *point| EC点。|

你可能感兴趣的鸿蒙文章

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

harmony 鸿蒙crypto_architecture_kit.h

harmony 鸿蒙crypto_asym_cipher.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

0 赞

所属分类： 后端技术
本文标签：
版权声明： 原创文章如转载，请注明本文链接: https://m.seaxiang.com/blog/h5Cd1S

harmony 鸿蒙crypto_asym_key.h

crypto_asym_key.h

概述

汇总

结构体

枚举

函数

枚举类型说明

CryptoAsymKey_ParamType

Crypto_EncodingType

CryptoPrivKeyEncoding_ParamType

CryptoAsymKeySpec_Type

函数说明

OH_CryptoAsymKeyGenerator_Create()

OH_CryptoAsymKeyGenerator_Generate()

OH_CryptoAsymKeyGenerator_Convert()

OH_CryptoAsymKeyGenerator_GetAlgoName()

OH_CryptoAsymKeyGenerator_Destroy()

OH_CryptoKeyPair_Destroy()

OH_CryptoKeyPair_GetPubKey()

OH_CryptoKeyPair_GetPrivKey()

OH_CryptoPubKey_Encode()

OH_CryptoPubKey_GetParam()

OH_CryptoPrivKeyEncodingParams_Create()

OH_CryptoPrivKeyEncodingParams_SetParam()

OH_CryptoPrivKeyEncodingParams_Destroy()

OH_CryptoPrivKey_Encode()

OH_CryptoPrivKey_GetParam()

OH_CryptoAsymKeySpec_GenEcCommonParamsSpec()

OH_CryptoAsymKeySpec_GenDhCommonParamsSpec()

OH_CryptoAsymKeySpec_Create()

OH_CryptoAsymKeySpec_SetParam()

OH_CryptoAsymKeySpec_SetCommonParamsSpec()

OH_CryptoAsymKeySpec_GetParam()

OH_CryptoAsymKeySpec_Destroy()

OH_CryptoAsymKeyGeneratorWithSpec_Create()

OH_CryptoAsymKeyGeneratorWithSpec_GenKeyPair()

OH_CryptoAsymKeyGeneratorWithSpec_Destroy()

OH_CryptoEcPoint_Create()

OH_CryptoEcPoint_GetCoordinate()

OH_CryptoEcPoint_SetCoordinate()

OH_CryptoEcPoint_Encode()

OH_CryptoEcPoint_Destroy()

你可能感兴趣的鸿蒙文章

热门推荐

标签云

最新文章

本文目录