1# CryptoCommonApi
2
3
4## 概述
5
6为应用提供算法库通用接口功能。
7
8**起始版本:** 12
9
10
11## 汇总
12
13
14### 文件
15
16| 名称 | 描述 |
17| -------- | -------- |
18| [crypto_common.h](crypto__common_8h.md) | 定义通用API接口。 |
19
20
21### 结构体
22
23| 名称 | 描述 |
24| -------- | -------- |
25| struct  [Crypto_DataBlob](_crypto___data_blob.md) | 加解密数据结构体。 |
26
27
28### 类型定义
29
30| 名称 | 描述 |
31| -------- | -------- |
32| typedef struct [Crypto_DataBlob](_crypto___data_blob.md) [Crypto_DataBlob](#crypto_datablob) | 加解密数据结构体。 |
33
34
35### 枚举
36
37| 名称 | 描述 |
38| -------- | -------- |
39| [OH_Crypto_ErrCode](#oh_crypto_errcode) {<br/>CRYPTO_SUCCESS = 0, CRYPTO_INVALID_PARAMS = 401,<br/>CRYPTO_NOT_SUPPORT = 801, CRYPTO_MEMORY_ERROR = 17620001,<br/>CRYPTO_OPERTION_ERROR = 17630001<br/>} | 加解密错误返回码枚举。 |
40| [Crypto_CipherMode](#crypto_ciphermode) {<br/>CRYPTO_ENCRYPT_MODE = 0,<br/>CRYPTO_DECRYPT_MODE = 1<br/>} | 定义加解密操作类型。 |
41
42
43### 函数
44
45| 名称 | 描述 |
46| -------- | -------- |
47| void [OH_Crypto_FreeDataBlob](#oh_crypto_freedatablob) ([Crypto_DataBlob](_crypto___data_blob.md) \*dataBlob) | 释放dataBlob数据。 |
48
49
50## 类型定义说明
51
52
53### Crypto_DataBlob
54
55```
56typedef struct Crypto_DataBlob Crypto_DataBlob
57```
58
59**描述**
60
61加解密数据结构体。
62
63**起始版本:** 12
64
65
66## 枚举类型说明
67
68
69### Crypto_CipherMode
70
71```
72enum Crypto_CipherMode
73```
74
75**描述**
76
77定义加解密操作类型。
78
79**起始版本:** 12
80
81| 枚举值 | 描述 |
82| -------- | -------- |
83| CRYPTO_ENCRYPT_MODE | 加密操作。 |
84| CRYPTO_DECRYPT_MODE | 解密操作。 |
85
86
87### OH_Crypto_ErrCode
88
89```
90enum OH_Crypto_ErrCode
91```
92
93**描述**
94
95加解密错误返回码枚举。
96
97**起始版本:** 12
98
99| 枚举值 | 描述 |
100| -------- | -------- |
101| CRYPTO_SUCCESS | 表示操作成功。 |
102| CRYPTO_INVALID_PARAMS | 输入参数不合法。 |
103| CRYPTO_NOT_SUPPORT | 不支持的函数或算法。 |
104| CRYPTO_MEMORY_ERROR | 内存错误。 |
105| CRYPTO_OPERTION_ERROR | 表示加解密操作错误。 |
106
107
108## 函数说明
109
110
111### OH_Crypto_FreeDataBlob()
112
113```
114void OH_Crypto_FreeDataBlob (Crypto_DataBlob *dataBlob)
115```
116
117**描述**
118
119释放dataBlob数据。
120
121**起始版本:** 12
122
123**参数:**
124
125| 名称 | 描述 |
126| -------- | -------- |
127| dataBlob | 需要释放的dataBlob数据。 |
128