目录

CryptoCommonApi

Overview

Provides common APIs for cryptographic operations.

Since: 12

Summary

[h2]Files

Name Description
crypto_common.h Defines common APIs for cryptographic operations.

[h2]Structs

Name Description
struct Crypto_DataBlob Defines the data used for encryption and decryption.

[h2]Types

Name Description
typedef struct Crypto_DataBlob Crypto_DataBlob Defines a struct for the data used for encryption and decryption.

[h2]Enums

Name Description

OH_Crypto_ErrCode {

CRYPTO_SUCCESS = 0, CRYPTO_INVALID_PARAMS = 401,

CRYPTO_NOT_SUPPORT = 801, CRYPTO_MEMORY_ERROR = 17620001,

CRYPTO_OPERTION_ERROR = 17630001

}

Enumerates the encryption and decryption error codes.

Crypto_CipherMode {

CRYPTO_ENCRYPT_MODE = 0,

CRYPTO_DECRYPT_MODE = 1

}

Enumerates the cryptographic operation types.

[h2]Functions

Name Description
void OH_Crypto_FreeDataBlob (Crypto_DataBlob *dataBlob) Releases a dataBlob instance.

Type Description

[h2]Crypto_DataBlob

typedef struct Crypto_DataBlob Crypto_DataBlob

Description

Defines a struct for the data used for encryption and decryption.

Since: 12

Enum Description

[h2]Crypto_CipherMode

enum Crypto_CipherMode

Description

Enumerates the cryptographic operation types.

Since: 12

Enum Description
CRYPTO_ENCRYPT_MODE Encrypt data.
CRYPTO_DECRYPT_MODE Decrypt data.

[h2]OH_Crypto_ErrCode

enum OH_Crypto_ErrCode

Description

Enumerates the encryption and decryption error codes.

Since: 12

Enum Description
CRYPTO_SUCCESS The operation is successful.
CRYPTO_INVALID_PARAMS Invalid parameters are detected.
CRYPTO_NOT_SUPPORT The function or algorithm is not supported.
CRYPTO_MEMORY_ERROR A memory error occurred.
CRYPTO_OPERTION_ERROR The encryption or decryption operation fails.

Function Description

[h2]OH_Crypto_FreeDataBlob()

void OH_Crypto_FreeDataBlob (Crypto_DataBlob *dataBlob)

Description

Releases a dataBlob instance.

Since: 12

Parameters

Name Description
dataBlob Pointer to the dataBlob instance to release.