1# crypto_common.h 2 3<!--Kit: Crypto Architecture Kit--> 4<!--Subsystem: Security--> 5<!--Owner: @zxz--3--> 6<!--Designer: @lanming--> 7<!--Tester: @PAFT--> 8<!--Adviser: @zengyawen--> 9 10## 概述 11 12定义通用API接口。 13 14**引用文件：** <CryptoArchitectureKit/crypto_common.h> 15 16**库：** libohcrypto.so 17 18**系统能力：** SystemCapability.Security.CryptoFramework 19 20**起始版本：** 12 21 22**相关模块：** [CryptoCommonApi](capi-cryptocommonapi.md) 23 24## 汇总 25 26### 结构体 27 28| 名称 | typedef关键字 | 描述 | 29| -- | -- | -- | 30| [Crypto_DataBlob](capi-cryptocommonapi-crypto-datablob.md) | Crypto_DataBlob | 加解密数据结构体。 | 31 32### 枚举 33 34| 名称 | typedef关键字 | 描述 | 35| -- | -- | -- | 36| [OH_Crypto_ErrCode](#oh_crypto_errcode) | OH_Crypto_ErrCode | 加解密错误返回码枚举。 | 37| [Crypto_CipherMode](#crypto_ciphermode) | Crypto_CipherMode | 定义加解密操作类型。 | 38 39### 函数 40 41| 名称 | 描述 | 42| -- | -- | 43| [void OH_Crypto_FreeDataBlob(Crypto_DataBlob *dataBlob)](#oh_crypto_freedatablob) | 释放dataBlob数据。 | 44 45## 枚举类型说明 46 47### OH_Crypto_ErrCode 48 49``` 50enum OH_Crypto_ErrCode 51``` 52 53**描述** 54 55加解密错误返回码枚举。 56 57**起始版本：** 12 58 59| 枚举项 | 描述 | 60| -- | -- | 61| CRYPTO_SUCCESS = 0 | 表示操作成功。 | 62| CRYPTO_INVALID_PARAMS = 401 | 输入参数不合法。 | 63| CRYPTO_NOT_SUPPORTED = 801 | 不支持的函数或算法。 | 64| CRYPTO_MEMORY_ERROR = 17620001 | 内存错误。 | 65| CRYPTO_PARAMETER_CHECK_FAILED = 17620003 | 参数检查失败。<br>**起始版本：** 20 | 66| CRYPTO_OPERTION_ERROR = 17630001 | 表示加解密操作错误。 | 67 68### Crypto_CipherMode 69 70``` 71enum Crypto_CipherMode 72``` 73 74**描述** 75 76定义加解密操作类型。 77 78**起始版本：** 12 79 80| 枚举项 | 描述 | 81| -- | -- | 82| CRYPTO_ENCRYPT_MODE = 0 | 加密操作。 | 83| CRYPTO_DECRYPT_MODE = 1 | 解密操作。 | 84 85 86## 函数说明 87 88### OH_Crypto_FreeDataBlob() 89 90``` 91void OH_Crypto_FreeDataBlob(Crypto_DataBlob *dataBlob) 92``` 93 94**描述** 95 96释放dataBlob数据。 97 98**起始版本：** 12 99 100 101**参数：** 102 103| 参数项 | 描述 | 104| -- | -- | 105| [Crypto_DataBlob](capi-cryptocommonapi-crypto-datablob.md) *dataBlob | 需要释放的dataBlob数据。 | 106 107 108