harmony 鸿蒙crypto_asym_key.h

2025-06-12
浏览 (4)

crypto_asym_key.h

Overview

Provides APIs for asymmetric keys.

Library: libohcrypto.so

System capability: SystemCapability.Security.CryptoFramework

Since: 12

Related module: CryptoAsymKeyApi

Summary

Types

Name	Description
typedef struct OH_CryptoKeyPair OH_CryptoKeyPair	Defines an asymmetric key pair.
typedef struct OH_CryptoPubKey OH_CryptoPubKey	Defines the public key in an asymmetric key pair.
typedef struct OH_CryptoAsymKeyGenerator OH_CryptoAsymKeyGenerator	Defines an asymmetric key generator.

Enums

Name	Description
CryptoAsymKey_ParamType { CRYPTO_DSA_P_DATABLOB = 101, CRYPTO_DSA_Q_DATABLOB = 102, CRYPTO_DSA_G_DATABLOB = 103, CRYPTO_DSA_SK_DATABLOB = 104, CRYPTO_DSA_PK_DATABLOB = 105, CRYPTO_ECC_FP_P_DATABLOB = 201, CRYPTO_ECC_A_DATABLOB = 202, CRYPTO_ECC_B_DATABLOB = 203, CRYPTO_ECC_G_X_DATABLOB = 204, CRYPTO_ECC_G_Y_DATABLOB = 205, CRYPTO_ECC_N_DATABLOB = 206, CRYPTO_ECC_H_INT = 207, CRYPTO_ECC_SK_DATABLOB = 208, CRYPTO_ECC_PK_X_DATABLOB = 209, CRYPTO_ECC_PK_Y_DATABLOB = 210, CRYPTO_ECC_FIELD_TYPE_STR = 211, CRYPTO_ECC_FIELD_SIZE_INT = 212, CRYPTO_ECC_CURVE_NAME_STR = 213, CRYPTO_RSA_N_DATABLOB = 301, CRYPTO_RSA_D_DATABLOB = 302, CRYPTO_RSA_E_DATABLOB = 303, CRYPTO_DH_P_DATABLOB = 401, CRYPTO_DH_G_DATABLOB = 402, CRYPTO_DH_L_NUM = 403, CRYPTO_DH_SK_DATABLOB = 404, CRYPTO_DH_PK_DATABLOB = 405, CRYPTO_ED25519_SK_DATABLOB = 501, CRYPTO_ED25519_PK_DATABLOB = 502, CRYPTO_X25519_SK_DATABLOB = 601, CRYPTO_X25519_PK_DATABLOB = 602 }	Enumerates the types of the asymmetric key parameters.
Crypto_EncodingType { CRYPTO_PEM = 0, CRYPTO_DER = 1 }	Enumerates the encoding types.

Name

Description

CryptoAsymKey_ParamType {
CRYPTO_DSA_P_DATABLOB = 101, CRYPTO_DSA_Q_DATABLOB = 102,
CRYPTO_DSA_G_DATABLOB = 103, CRYPTO_DSA_SK_DATABLOB = 104,
CRYPTO_DSA_PK_DATABLOB = 105, CRYPTO_ECC_FP_P_DATABLOB = 201,
CRYPTO_ECC_A_DATABLOB = 202, CRYPTO_ECC_B_DATABLOB = 203,
CRYPTO_ECC_G_X_DATABLOB = 204, CRYPTO_ECC_G_Y_DATABLOB = 205,
CRYPTO_ECC_N_DATABLOB = 206, CRYPTO_ECC_H_INT = 207,
CRYPTO_ECC_SK_DATABLOB = 208, CRYPTO_ECC_PK_X_DATABLOB = 209,
CRYPTO_ECC_PK_Y_DATABLOB = 210, CRYPTO_ECC_FIELD_TYPE_STR = 211,
CRYPTO_ECC_FIELD_SIZE_INT = 212, CRYPTO_ECC_CURVE_NAME_STR = 213,
CRYPTO_RSA_N_DATABLOB = 301, CRYPTO_RSA_D_DATABLOB = 302,
CRYPTO_RSA_E_DATABLOB = 303, CRYPTO_DH_P_DATABLOB = 401,
CRYPTO_DH_G_DATABLOB = 402, CRYPTO_DH_L_NUM = 403,
CRYPTO_DH_SK_DATABLOB = 404, CRYPTO_DH_PK_DATABLOB = 405,
CRYPTO_ED25519_SK_DATABLOB = 501, CRYPTO_ED25519_PK_DATABLOB = 502,
CRYPTO_X25519_SK_DATABLOB = 601, CRYPTO_X25519_PK_DATABLOB = 602
}

Enumerates the types of the asymmetric key parameters.

Crypto_EncodingType { CRYPTO_PEM = 0, CRYPTO_DER = 1 }

Enumerates the encoding types.

Functions

Name	Description
OH_Crypto_ErrCode OH_CryptoAsymKeyGenerator_Create (const char algoName, OH_CryptoAsymKeyGenerator *ctx)	Creates an asymmetric key generator instance based on the specified algorithm.
OH_Crypto_ErrCode OH_CryptoAsymKeyGenerator_Generate (OH_CryptoAsymKeyGenerator ctx, OH_CryptoKeyPair *keyCtx)	Randomly generates an asymmetric key pair.
OH_Crypto_ErrCode OH_CryptoAsymKeyGenerator_Convert (OH_CryptoAsymKeyGenerator ctx, Crypto_EncodingType type, Crypto_DataBlob pubKeyData, Crypto_DataBlob priKeyData, OH_CryptoKeyPair *keyCtx)	Converts asymmetric key data into a key pair.
const char * OH_CryptoAsymKeyGenerator_GetAlgoName (OH_CryptoAsymKeyGenerator *ctx)	Obtains the asymmetric key algorithm.
void OH_CryptoAsymKeyGenerator_Destroy (OH_CryptoAsymKeyGenerator *ctx)	Destroys an asymmetric key generator instance.
void OH_CryptoKeyPair_Destroy (OH_CryptoKeyPair *keyCtx)	Destroys an asymmetric key pair instance.
OH_CryptoPubKey * OH_CryptoKeyPair_GetPubKey (OH_CryptoKeyPair *keyCtx)	Obtains the public key instance from a key pair.
OH_Crypto_ErrCode OH_CryptoPubKey_Encode (OH_CryptoPubKey key, Crypto_EncodingType type, const char encodingStandard, Crypto_DataBlob *out)	Obtains public key data in the specified encoding format.
OH_Crypto_ErrCode OH_CryptoPubKey_GetParam (OH_CryptoPubKey key, CryptoAsymKey_ParamType item, Crypto_DataBlob value)	Obtains the specified parameter from a public key instance.