crypto_asym_cipher.h
Overview
Defines APIs for encrypting and decrypting asymmetric keys.
Header file: <CryptoArchitectureKit/crypto_asym_cipher.h>
Library: libohcrypto.so
System capability: SystemCapability.Security.CryptoFramework
Since: 20
Related module: CryptoAsymCipherApi
Summary
Structs
| Name | typedef Keyword | Description |
|---|---|---|
| OH_CryptoAsymCipher | OH_CryptoAsymCipher | Defines asymmetric encryption. |
| OH_CryptoSm2CiphertextSpec | OH_CryptoSm2CiphertextSpec | Defines SM2 ciphertext specifications. |
Enums
| Name | typedef Keyword | Description |
|---|---|---|
| CryptoSm2CiphertextSpec_item | CryptoSm2CiphertextSpec_item | Defines the type of SM2 ciphertext specification items. |
Functions
Enum Description
CryptoSm2CiphertextSpec_item
enum CryptoSm2CiphertextSpec_item
Description
Defines the type of SM2 ciphertext specification items.
Since: 20
| Enum Item | Description |
|---|---|
| CRYPTO_SM2_CIPHERTEXT_C1_X = 0 | Public key x, also called C1x. |
| CRYPTO_SM2_CIPHERTEXT_C1_Y = 1 | Public key y, also called C1y. |
| CRYPTO_SM2_CIPHERTEXT_C2 = 2 | Hash value, also called C2. |
| CRYPTO_SM2_CIPHERTEXT_C3 = 3 | Ciphertext data, also called C3. |
Function Description
OH_CryptoAsymCipher_Create()
OH_Crypto_ErrCode OH_CryptoAsymCipher_Create(const char *algoName, OH_CryptoAsymCipher **ctx)
Description
Creates an asymmetric encryption instance based on the given algorithm name.
Note: The created resource must be destroyed by calling OH_CryptoAsymCipher_Destroy.
Since: 20
Parameters
| Name | Description |
|---|---|
| const char *algoName | Pointer to the algorithm used to generate an encryption instance. For example, RSA|PKCS1_OAEP|SHA384|MGF1_SHA384 or SM2|SM3. |
| OH_CryptoAsymCipher **ctx | Pointer to the asymmetric encryption context. |
Returns
| Type | Description |
|---|---|
| OH_Crypto_ErrCode | CRYPTO_SUCCESS: The operation is successful. CRYPTO_NOT_SUPPORTED: The operation is not supported. CRYPTO_MEMORY_ERROR: A memory error occurs. CRYPTO_PARAMETER_CHECK_FAILED: The parameter check failed. CRYPTO_OPERTION_ERROR: Failed to call an API of a third-party algorithm library. |
OH_CryptoAsymCipher_Init()
OH_Crypto_ErrCode OH_CryptoAsymCipher_Init(OH_CryptoAsymCipher *ctx, Crypto_CipherMode mode, OH_CryptoKeyPair *key)
Description
Initializes asymmetric encryption.
Since: 20
Parameters
| Name | Description |
|---|---|
| OH_CryptoAsymCipher *ctx | Pointer to the asymmetric encryption context. |
| Crypto_CipherMode mode | Cipher mode (encryption or decryption). |
| OH_CryptoKeyPair *key | Pointer to the asymmetric key. |
Returns
| Type | Description |
|---|---|
| OH_Crypto_ErrCode | CRYPTO_SUCCESS: The operation is successful. CRYPTO_NOT_SUPPORTED: The operation is not supported. CRYPTO_MEMORY_ERROR: A memory error occurs. CRYPTO_PARAMETER_CHECK_FAILED: The parameter check failed. CRYPTO_OPERTION_ERROR: Failed to call an API of a third-party algorithm library. |
Reference
OH_CryptoAsymCipher_Final()
OH_Crypto_ErrCode OH_CryptoAsymCipher_Final(OH_CryptoAsymCipher *ctx, const Crypto_DataBlob *in, Crypto_DataBlob *out)
Description
Finalizes asymmetric encryption.
Note: After the use is complete, the memory for storing the out parameter must be released by calling OH_Crypto_FreeDataBlob.
Since: 20
Parameters
| Name | Description |
|---|---|
| OH_CryptoAsymCipher *ctx | Pointer to the asymmetric encryption context. |
| const Crypto_DataBlob *in | Pointer to the data to be encrypted or decrypted. |
| Crypto_DataBlob *out | Pointer to the encrypted or decrypted data. |
Returns
| Type | Description |
|---|---|
| OH_Crypto_ErrCode | CRYPTO_SUCCESS: The operation is successful. CRYPTO_NOT_SUPPORTED: The operation is not supported. CRYPTO_MEMORY_ERROR: A memory error occurs. CRYPTO_PARAMETER_CHECK_FAILED: The parameter check failed. CRYPTO_OPERTION_ERROR: Failed to call an API of a third-party algorithm library. |
Reference
OH_CryptoAsymCipher_Destroy()
void OH_CryptoAsymCipher_Destroy(OH_CryptoAsymCipher *ctx)
Description
Destroys an asymmetric encryption context.
Parameters
| Name | Description |
|---|---|
| OH_CryptoAsymCipher *ctx | Pointer to the asymmetric encryption context. |
OH_CryptoSm2CiphertextSpec_Create()
OH_Crypto_ErrCode OH_CryptoSm2CiphertextSpec_Create(Crypto_DataBlob *sm2Ciphertext, OH_CryptoSm2CiphertextSpec **spec)
Description
Creates SM2 ciphertext specifications.
Note: The created resource must be destroyed by calling OH_CryptoSm2CiphertextSpec_Destroy.
Since: 20
Parameters
| Name | Description |
|---|---|
| Crypto_DataBlob *sm2Ciphertext | Pointer to the SM2 ciphertext in DER format. If the value is NULL, an empty SM2 ciphertext specification is created. |
| OH_CryptoSm2CiphertextSpec **spec | Pointer to the output SM2 ciphertext specifications. |
Returns
| Type | Description |
|---|---|
| OH_Crypto_ErrCode | CRYPTO_SUCCESS: The operation is successful. CRYPTO_NOT_SUPPORTED: The operation is not supported. CRYPTO_MEMORY_ERROR: A memory error occurs. CRYPTO_PARAMETER_CHECK_FAILED: The parameter check failed. CRYPTO_OPERTION_ERROR: Failed to call an API of a third-party algorithm library. |
OH_CryptoSm2CiphertextSpec_GetItem()
OH_Crypto_ErrCode OH_CryptoSm2CiphertextSpec_GetItem(OH_CryptoSm2CiphertextSpec *spec, CryptoSm2CiphertextSpec_item item, Crypto_DataBlob *out)
Description
Obtains a specified item in SM2 ciphertext specifications.
Note: After the use is complete, the memory for storing the out parameter must be released by calling OH_Crypto_FreeDataBlob.
Since: 20
Parameters
| Name | Description |
|---|---|
| OH_CryptoSm2CiphertextSpec *spec | Pointer to the SM2 ciphertext specifications. |
| CryptoSm2CiphertextSpec_item item | Pointer to the SM2 ciphertext specifications. |
| Crypto_DataBlob *out | Pointer to the output data. |
Returns
| Type | Description |
|---|---|
| OH_Crypto_ErrCode | CRYPTO_SUCCESS: The operation is successful. CRYPTO_NOT_SUPPORTED: The operation is not supported. CRYPTO_MEMORY_ERROR: A memory error occurs. CRYPTO_PARAMETER_CHECK_FAILED: The parameter check failed. CRYPTO_OPERTION_ERROR: Failed to call an API of a third-party algorithm library. |
OH_CryptoSm2CiphertextSpec_SetItem()
OH_Crypto_ErrCode OH_CryptoSm2CiphertextSpec_SetItem(OH_CryptoSm2CiphertextSpec *spec, CryptoSm2CiphertextSpec_item item, Crypto_DataBlob *in)
Description
Sets a specified item in SM2 ciphertext specifications.
Since: 20
Parameters
| Name | Description |
|---|---|
| OH_CryptoSm2CiphertextSpec *spec | Pointer to the SM2 ciphertext specifications. |
| CryptoSm2CiphertextSpec_item item | Pointer to the SM2 ciphertext specifications. |
| Crypto_DataBlob *in | Pointer to the input data. |
Returns
| Type | Description |
|---|---|
| OH_Crypto_ErrCode | CRYPTO_SUCCESS: The operation is successful. CRYPTO_NOT_SUPPORTED: The operation is not supported. CRYPTO_MEMORY_ERROR: A memory error occurs. CRYPTO_PARAMETER_CHECK_FAILED: The parameter check failed. CRYPTO_OPERTION_ERROR: Failed to call an API of a third-party algorithm library. |
OH_CryptoSm2CiphertextSpec_Encode()
OH_Crypto_ErrCode OH_CryptoSm2CiphertextSpec_Encode(OH_CryptoSm2CiphertextSpec *spec, Crypto_DataBlob *out)
Description
Encodes SM2 ciphertext specifications into DER ciphertext.
Note: After the use is complete, the memory for storing the out parameter must be released by calling OH_Crypto_FreeDataBlob.
Since: 20
Parameters
| Name | Description |
|---|---|
| OH_CryptoSm2CiphertextSpec *spec | Pointer to the SM2 ciphertext specifications. |
| Crypto_DataBlob *out | Pointer to the output data. |
Returns
| Type | Description |
|---|---|
| OH_Crypto_ErrCode | CRYPTO_SUCCESS: The operation is successful. CRYPTO_NOT_SUPPORTED: The operation is not supported. CRYPTO_MEMORY_ERROR: A memory error occurs. CRYPTO_PARAMETER_CHECK_FAILED: The parameter check failed. CRYPTO_OPERTION_ERROR: Failed to call an API of a third-party algorithm library. |
OH_CryptoSm2CiphertextSpec_Destroy()
void OH_CryptoSm2CiphertextSpec_Destroy(OH_CryptoSm2CiphertextSpec *spec)
Description
Destroys SM2 ciphertext specifications.
Since: 20
Parameters
| Name | Description |
|---|---|
| OH_CryptoSm2CiphertextSpec *spec | Pointer to the SM2 ciphertext specifications. |
你可能感兴趣的鸿蒙文章
openharmony 鸿蒙 capi-cryptosymkeyapi-oh-cryptosymkey
openharmony 鸿蒙 capi-cryptoasymkeyapi-oh-cryptoasymkeygeneratorwithspec
openharmony 鸿蒙 capi-cryptoasymcipherapi-oh-cryptoasymcipher
openharmony 鸿蒙 capi-cryptokdfapi-oh-cryptokdfparams
openharmony 鸿蒙 capi-cryptomacapi
openharmony 鸿蒙 capi-cryptodigestapi-oh-cryptodigest
openharmony 鸿蒙 capi-cryptomacapi-oh-cryptomac
openharmony 鸿蒙 capi-cryptosignatureapi-oh-cryptoeccsignaturespec
openharmony 鸿蒙 capi-cryptocommonapi-crypto-datablob
openharmony 鸿蒙 capi-cryptoasymcipherapi-oh-cryptosm2ciphertextspec