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

2025-06-12 浏览 (1)

crypto_asym_key.h

概述

声明非对称密钥接口。

库： libohcrypto.so

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

系统能力： SystemCapability.Security.CryptoFramework

起始版本： 12

相关模块： CryptoAsymKeyApi

汇总

结构体

名称typedef关键字描述
OH_CryptoKeyPairOH_CryptoKeyPair定义密钥对结构体。
OH_CryptoPubKeyOH_CryptoPubKey定义公钥结构体。
OH_CryptoPrivKeyOH_CryptoPrivKey定义私钥结构体。
OH_CryptoAsymKeyGeneratorOH_CryptoAsymKeyGenerator定义非对称密钥生成器结构体。
OH_CryptoPrivKeyEncodingParamsOH_CryptoPrivKeyEncodingParams定义私钥编码参数结构体。
OH_CryptoAsymKeySpecOH_CryptoAsymKeySpec定义非对称密钥规格结构体。
OH_CryptoAsymKeyGeneratorWithSpecOH_CryptoAsymKeyGeneratorWithSpec定义带规格的非对称密钥生成器。
OH_CryptoEcPointOH_CryptoEcPoint定义EC点结构体。

枚举

名称typedef关键字描述
CryptoAsymKey_ParamTypeCryptoAsymKey_ParamType定义非对称密钥参数类型。
Crypto_EncodingTypeCrypto_EncodingType定义编码格式。
CryptoPrivKeyEncoding_ParamTypeCryptoPrivKeyEncoding_ParamType定义私钥编码参数类型。
CryptoAsymKeySpec_TypeCryptoAsymKeySpec_Type定义非对称密钥规格类型。

函数

名称描述
OH_Crypto_ErrCode OH_CryptoAsymKeyGenerator_Create(const char *algoName, OH_CryptoAsymKeyGenerator **ctx)通过指定算法名称的字符串，获取相应的非对称密钥生成器实例。
OH_Crypto_ErrCode OH_CryptoAsymKeyGenerator_Generate(OH_CryptoAsymKeyGenerator *ctx, OH_CryptoKeyPair **keyCtx)随机生成非对称密钥（密钥对）。
OH_Crypto_ErrCode OH_CryptoAsymKeyGenerator_Convert(OH_CryptoAsymKeyGenerator *ctx, Crypto_EncodingType type,Crypto_DataBlob *pubKeyData, Crypto_DataBlob *priKeyData, OH_CryptoKeyPair **keyCtx)将非对称密钥数据转换为密钥对。
const char *OH_CryptoAsymKeyGenerator_GetAlgoName(OH_CryptoAsymKeyGenerator *ctx)获取非对称密钥算法名称。
void OH_CryptoAsymKeyGenerator_Destroy(OH_CryptoAsymKeyGenerator *ctx)销毁非对称密钥生成器实例。
void OH_CryptoKeyPair_Destroy(OH_CryptoKeyPair *keyCtx)销毁非对称密钥对实例。
OH_CryptoPubKey *OH_CryptoKeyPair_GetPubKey(OH_CryptoKeyPair *keyCtx)从密钥对中获取公钥实例。
OH_CryptoPrivKey *OH_CryptoKeyPair_GetPrivKey(OH_CryptoKeyPair *keyCtx)获取密钥对的私钥。
OH_Crypto_ErrCode OH_CryptoPubKey_Encode(OH_CryptoPubKey *key, Crypto_EncodingType type,const char *encodingStandard, Crypto_DataBlob *out)根据指定的编码格式输出公钥数据。
OH_Crypto_ErrCode OH_CryptoPubKey_GetParam(OH_CryptoPubKey *key, CryptoAsymKey_ParamType item, Crypto_DataBlob *value)从公钥实例获取指定参数。
OH_Crypto_ErrCode OH_CryptoPrivKeyEncodingParams_Create(OH_CryptoPrivKeyEncodingParams **ctx)创建私钥编码参数。
OH_Crypto_ErrCode OH_CryptoPrivKeyEncodingParams_SetParam(OH_CryptoPrivKeyEncodingParams *ctx,CryptoPrivKeyEncoding_ParamType type, Crypto_DataBlob *value)设置私钥编码参数。
void OH_CryptoPrivKeyEncodingParams_Destroy(OH_CryptoPrivKeyEncodingParams *ctx)销毁私钥编码参数。
OH_Crypto_ErrCode OH_CryptoPrivKey_Encode(OH_CryptoPrivKey *key, Crypto_EncodingType type,const char *encodingStandard, OH_CryptoPrivKeyEncodingParams *params, Crypto_DataBlob *out)从私钥实例获取指定参数。
OH_Crypto_ErrCode OH_CryptoPrivKey_GetParam(OH_CryptoPrivKey *key, CryptoAsymKey_ParamType item,Crypto_DataBlob *value)获取私钥的指定参数。
OH_Crypto_ErrCode OH_CryptoAsymKeySpec_GenEcCommonParamsSpec(const char *curveName, OH_CryptoAsymKeySpec **spec)生成EC通用参数规格。
OH_Crypto_ErrCode OH_CryptoAsymKeySpec_GenDhCommonParamsSpec(int pLen, int skLen, OH_CryptoAsymKeySpec **spec)生成DH通用参数规格。
OH_Crypto_ErrCode OH_CryptoAsymKeySpec_Create(const char *algoName, CryptoAsymKeySpec_Type type,OH_CryptoAsymKeySpec **spec)根据给定的算法名称和规格类型创建非对称密钥规格。
OH_Crypto_ErrCode OH_CryptoAsymKeySpec_SetParam(OH_CryptoAsymKeySpec *spec, CryptoAsymKey_ParamType type,Crypto_DataBlob *value)设置非对称密钥规格的指定参数。
OH_Crypto_ErrCode OH_CryptoAsymKeySpec_SetCommonParamsSpec(OH_CryptoAsymKeySpec *spec,OH_CryptoAsymKeySpec *commonParamsSpec)设置非对称密钥规格的通用参数规格。
OH_Crypto_ErrCode OH_CryptoAsymKeySpec_GetParam(OH_CryptoAsymKeySpec *spec, CryptoAsymKey_ParamType type,Crypto_DataBlob *value)获取非对称密钥规格的指定参数。
void OH_CryptoAsymKeySpec_Destroy(OH_CryptoAsymKeySpec *spec)销毁非对称密钥规格。
OH_Crypto_ErrCode OH_CryptoAsymKeyGeneratorWithSpec_Create(OH_CryptoAsymKeySpec *keySpec,OH_CryptoAsymKeyGeneratorWithSpec **generator)创建带规格的非对称密钥生成器。
OH_Crypto_ErrCode OH_CryptoAsymKeyGeneratorWithSpec_GenKeyPair(OH_CryptoAsymKeyGeneratorWithSpec *generator,OH_CryptoKeyPair **keyPair)根据非对称密钥规格生成密钥对。
void OH_CryptoAsymKeyGeneratorWithSpec_Destroy(OH_CryptoAsymKeyGeneratorWithSpec *generator)销毁带规格的非对称密钥生成器。
OH_Crypto_ErrCode OH_CryptoEcPoint_Create(const char *curveName, Crypto_DataBlob *ecKeyData, OH_CryptoEcPoint **point)创建EC点。
OH_Crypto_ErrCode OH_CryptoEcPoint_GetCoordinate(OH_CryptoEcPoint *point, Crypto_DataBlob *x, Crypto_DataBlob *y)获取EC点的x和y坐标。
OH_Crypto_ErrCode OH_CryptoEcPoint_SetCoordinate(OH_CryptoEcPoint *point, Crypto_DataBlob *x, Crypto_DataBlob *y)设置EC点的x和y坐标。
OH_Crypto_ErrCode OH_CryptoEcPoint_Encode(OH_CryptoEcPoint *point, const char *format, Crypto_DataBlob *out)将EC点编码为指定格式。
void OH_CryptoEcPoint_Destroy(OH_CryptoEcPoint *point)销毁EC点。

枚举类型说明

CryptoAsymKey_ParamType

enum CryptoAsymKey_ParamType

描述

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

起始版本： 12

枚举项描述
CRYPTO_DSA_P_DATABLOB = 101DSA算法的素模数p。
CRYPTO_DSA_Q_DATABLOB = 102DSA算法中密钥参数q（p-1的素因子）。
CRYPTO_DSA_G_DATABLOB = 103DSA算法的参数g。
CRYPTO_DSA_SK_DATABLOB = 104DSA算法的私钥sk。
CRYPTO_DSA_PK_DATABLOB = 105DSA算法的公钥pk。
CRYPTO_ECC_FP_P_DATABLOB = 201ECC算法中表示椭圆曲线Fp域的素数p。
CRYPTO_ECC_A_DATABLOB = 202ECC算法中椭圆曲线的第一个系数a。
CRYPTO_ECC_B_DATABLOB = 203ECC算法中椭圆曲线的第二个系数b。
CRYPTO_ECC_G_X_DATABLOB = 204ECC算法中基点g的x坐标。
CRYPTO_ECC_G_Y_DATABLOB = 205ECC算法中基点g的y坐标。
CRYPTO_ECC_N_DATABLOB = 206ECC算法中基点g的阶n。
CRYPTO_ECC_H_INT = 207ECC算法中的余因子h。
CRYPTO_ECC_SK_DATABLOB = 208ECC算法中的私钥sk。
CRYPTO_ECC_PK_X_DATABLOB = 209ECC算法中，公钥pk（椭圆曲线上的一个点）的x坐标。
CRYPTO_ECC_PK_Y_DATABLOB = 210ECC算法中，公钥pk（椭圆曲线上的一个点）的y坐标。
CRYPTO_ECC_FIELD_TYPE_STR = 211ECC算法中，椭圆曲线的域类型（当前只支持Fp域）。
CRYPTO_ECC_FIELD_SIZE_INT = 212ECC算法中域的大小，单位为bits（注：对于Fp域，域的大小为素数p的bits长度）。
CRYPTO_ECC_CURVE_NAME_STR = 213ECC算法中的SECG（Standards for Efficient Cryptography Group）曲线名称。
CRYPTO_RSA_N_DATABLOB = 301RSA算法中的模数n。
CRYPTO_RSA_D_DATABLOB = 302RSA算法中的私钥sk（即私钥指数d）。
CRYPTO_RSA_E_DATABLOB = 303RSA算法中的公钥pk（即公钥指数e）。
CRYPTO_DH_P_DATABLOB = 401DH算法中的素数p。
CRYPTO_DH_G_DATABLOB = 402DH算法中的参数g。
CRYPTO_DH_L_INT = 403DH算法中私钥长度，单位为bit。
CRYPTO_DH_SK_DATABLOB = 404DH算法中的私钥sk。
CRYPTO_DH_PK_DATABLOB = 405DH算法中的公钥pk。
CRYPTO_ED25519_SK_DATABLOB = 501ED25519算法中的私钥sk。
CRYPTO_ED25519_PK_DATABLOB = 502ED25519算法中的公钥pk。
CRYPTO_X25519_SK_DATABLOB = 601X25519算法中的私钥sk。
CRYPTO_X25519_PK_DATABLOB = 602X25519算法中的公钥pk。

Crypto_EncodingType

enum Crypto_EncodingType

描述

定义编码格式。

起始版本： 12

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

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

枚举项描述
CRYPTO_ASYM_KEY_COMMON_PARAMS_SPEC = 0通用参数规格。
CRYPTO_ASYM_KEY_PRIVATE_KEY_SPEC = 1私钥规格。
CRYPTO_ASYM_KEY_PUBLIC_KEY_SPEC = 2公钥规格。
CRYPTO_ASYM_KEY_KEY_PAIR_SPEC = 3密钥对规格。

函数说明

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_ErrCodeCRYPTO_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_Crypto_ErrCodeCRYPTO_SUCCESS = 0 : 操作成功。
CRYPTO_INVALID_PARAMS = 401 : 参数无效。
CRYPTO_NOT_SUPPORTED = 801 : 操作不支持。
CRYPTO_MEMORY_ERROR = 17620001 : 内存错误。
CRYPTO_OPERTION_ERROR = 17630001 : 调用三方算法库API出错。

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 *ctx非对称密钥生成器实例。
Crypto_EncodingType type编码格式。
Crypto_DataBlob *pubKeyData公钥数据。
Crypto_DataBlob *priKeyData私钥数据。
OH_CryptoKeyPair **keyCtx指向非对称密钥对实例的指针。

返回：

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

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 *key公钥实例。
Crypto_EncodingType type编码类型。
const char *encodingStandard编码格式。
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_CryptoPubKey_GetParam()

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

描述

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

起始版本： 12

参数：

参数项描述
OH_CryptoPubKey *key公钥实例。
CryptoAsymKey_ParamType item非对称密钥参数类型。
Crypto_DataBlob *value参数输出值。

返回：

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

OH_CryptoPrivKeyEncodingParams_Create()

OH_Crypto_ErrCode OH_CryptoPrivKeyEncodingParams_Create(OH_CryptoPrivKeyEncodingParams **ctx)

描述

创建私钥编码参数。

起始版本： 20

参数：

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

返回：

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

OH_CryptoPrivKeyEncodingParams_SetParam()

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

描述

设置私钥编码参数。

起始版本： 20

参数：

参数项描述
OH_CryptoPrivKeyEncodingParams *ctx私钥编码参数。
CryptoPrivKeyEncoding_ParamType type私钥编码参数类型。
Crypto_DataBlob *value私钥编码参数值。

返回：

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

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 *key私钥。
Crypto_EncodingType type私钥编码类型。
const char *encodingStandard编码标准。\n例如"PKCS8"。
OH_CryptoPrivKeyEncodingParams *paramsparams 私钥编码参数，可以为NULL，如果要加密私钥，则应设置此参数。
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_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_Crypto_ErrCodeCRYPTO_SUCCESS = 0 : 操作成功。
CRYPTO_INVALID_PARAMS = 401 : 参数无效。
CRYPTO_NOT_SUPPORTED = 801 : 操作不支持。
CRYPTO_MEMORY_ERROR = 17620001 : 内存错误。
CRYPTO_OPERTION_ERROR = 17630001 : 调用三方算法库API出错。

OH_CryptoAsymKeySpec_GenEcCommonParamsSpec()

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

描述

生成EC通用参数规格。

起始版本： 20

参数：

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

返回：

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

OH_CryptoAsymKeySpec_GenDhCommonParamsSpec()

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

描述

生成DH通用参数规格。

起始版本： 20

参数：

参数项描述
int pLen素数p的字节长度。
int skLen私钥的字节长度。
OH_CryptoAsymKeySpec **spec指向DH通用参数规格的指针。

返回：

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

OH_CryptoAsymKeySpec_Create()

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

描述

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

起始版本： 20

参数：

参数项描述
const char *algoName用于生成规格的算法名称。
例如"RSA"。
CryptoAsymKeySpec_Type type非对称密钥规格类型。
OH_CryptoAsymKeySpec **spec指向非对称密钥规格的指针。

返回：

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

OH_CryptoAsymKeySpec_SetParam()

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

描述

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

起始版本： 20

参数：

参数项描述
OH_CryptoAsymKeySpec *spec非对称密钥规格。
CryptoAsymKey_ParamType type非对称密钥参数类型。
Crypto_DataBlob *value输入数据。

返回：

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

OH_CryptoAsymKeySpec_SetCommonParamsSpec()

OH_Crypto_ErrCode OH_CryptoAsymKeySpec_SetCommonParamsSpec(OH_CryptoAsymKeySpec *spec,OH_CryptoAsymKeySpec *commonParamsSpec)

描述

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

起始版本： 20

参数：

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

返回：

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

OH_CryptoAsymKeySpec_GetParam()

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

描述

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

起始版本： 20

参数：

参数项描述
OH_CryptoAsymKeySpec *spec非对称密钥规格。
CryptoAsymKey_ParamType type非对称密钥参数类型。
Crypto_DataBlob *value输出数据。

返回：

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

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_Crypto_ErrCodeCRYPTO_SUCCESS = 0 : 操作成功。
CRYPTO_INVALID_PARAMS = 401 : 参数无效。
CRYPTO_NOT_SUPPORTED = 801 : 操作不支持。
CRYPTO_MEMORY_ERROR = 17620001 : 内存错误。
CRYPTO_OPERTION_ERROR = 17630001 : 调用三方算法库API出错。

OH_CryptoAsymKeyGeneratorWithSpec_GenKeyPair()

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

描述

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

起始版本： 20

参数：

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

返回：

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

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 *curveNamecurveName 曲线名称。
Crypto_DataBlob *ecKeyDataEC点数据，支持"04 ||x ||y"、"02 ||x"或"03 ||x"格式。如果ecKeyData参数为NULL，将创建一个空的EC点规格。
OH_CryptoEcPoint **point指向EC点的指针。

返回：

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

OH_CryptoEcPoint_GetCoordinate()

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

描述

获取EC点的x和y坐标。

起始版本： 20

参数：

参数项描述
OH_CryptoEcPoint *pointEC点。
Crypto_DataBlob *xEC点的x坐标,可以为NULL。
OH_CryptoEcPoint *yEC点的y坐标,可以为NULL。

返回：

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

OH_CryptoEcPoint_SetCoordinate()

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

描述

设置EC点的x和y坐标。

起始版本： 20

参数：

参数项描述
OH_CryptoEcPoint *pointEC点。
Crypto_DataBlob *xEC点的x坐标。
OH_CryptoEcPoint *yEC点的y坐标。

返回：

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

OH_CryptoEcPoint_Encode()

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

描述

将EC点编码为指定格式。

起始版本： 20

参数：

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

返回：

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

OH_CryptoEcPoint_Destroy()

void OH_CryptoEcPoint_Destroy(OH_CryptoEcPoint *point)

描述

销毁EC点。

起始版本： 20

参数：

参数项描述
OH_CryptoEcPoint *pointEC点。

你可能感兴趣的鸿蒙文章

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

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