ohos-crypto-sys 0.1.0

Raw bindings to the CryptoArchitectureKit NDK of OpenHarmony
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174

// automatically generated by rust-bindgen 0.71.1

#![allow(non_upper_case_globals)]
#![allow(non_camel_case_types)]
#![allow(non_snake_case)]
use crate::common::{CryptoResult, Crypto_DataBlob};

/// Define the symmetric key structure.
///
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
#[repr(C)]
pub struct OH_CryptoSymKey {
    _unused: [u8; 0],
}
/// Define the symmetric key generator structure.
///
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
#[repr(C)]
pub struct OH_CryptoSymKeyGenerator {
    _unused: [u8; 0],
}
extern "C" {
    /// Create a symmetric key generator according to the given algorithm name. Example AES256.
    ///
    /// # Arguments
    ///
    /// * `algoName` - Indicates the algorithm name for generating the generator.
    ///
    /// * `ctx` - Indicates the pointer to the symmetric key generator context.
    ///
    /// # Returns
    ///
    /// * [`OH_Crypto_ErrCode#CRYPTO_SUCCESS`] 0 - If the operation is successful.
    /// [`OH_Crypto_ErrCode#CRYPTO_INVALID_PARAMS`] 401 - If parameter is invalid.
    /// [`OH_Crypto_ErrCode#CRYPTO_NOT_SUPPORTED`] 801 - If the operation is not supported.
    /// [`OH_Crypto_ErrCode#CRYPTO_MEMORY_ERROR`] 17620001 - If memory operation failed.
    /// [`OH_Crypto_ErrCode#CRYPTO_OPERTION_ERROR`] 17630001 - If crypto opertion failed.
    ///
    /// Available since API-level: 12
    #[cfg(feature = "api-12")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
    pub fn OH_CryptoSymKeyGenerator_Create(
        algoName: *const ::core::ffi::c_char,
        ctx: *mut *mut OH_CryptoSymKeyGenerator,
    ) -> CryptoResult;
    /// Generate a symmetric key.
    ///
    /// # Arguments
    ///
    /// * `ctx` - Indicates the Symmetric key generator context.
    ///
    /// * `keyCtx` - Indicates the pointer to the symmetric key context.
    ///
    /// # Returns
    ///
    /// * [`OH_Crypto_ErrCode#CRYPTO_SUCCESS`] 0 - If the operation is successful.
    /// [`OH_Crypto_ErrCode#CRYPTO_INVALID_PARAMS`] 401 - If parameter is invalid.
    /// [`OH_Crypto_ErrCode#CRYPTO_NOT_SUPPORTED`] 801 - If the operation is not supported.
    /// [`OH_Crypto_ErrCode#CRYPTO_MEMORY_ERROR`] 17620001 - If memory operation failed.
    /// [`OH_Crypto_ErrCode#CRYPTO_OPERTION_ERROR`] 17630001 - If crypto opertion failed.
    ///
    /// Available since API-level: 12
    #[cfg(feature = "api-12")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
    pub fn OH_CryptoSymKeyGenerator_Generate(
        ctx: *mut OH_CryptoSymKeyGenerator,
        keyCtx: *mut *mut OH_CryptoSymKey,
    ) -> CryptoResult;
    /// Convert the symmetric key data to a key.
    ///
    /// # Arguments
    ///
    /// * `ctx` - Indicates the symmetric key generator context.
    ///
    /// * `keyData` - Indicates the data to generate the Symkey.
    ///
    /// * `keyCtx` - Indicates the pointer to the symmetric key context.
    ///
    /// # Returns
    ///
    /// * [`OH_Crypto_ErrCode#CRYPTO_SUCCESS`] 0 - If the operation is successful.
    /// [`OH_Crypto_ErrCode#CRYPTO_INVALID_PARAMS`] 401 - If parameter is invalid.
    /// [`OH_Crypto_ErrCode#CRYPTO_NOT_SUPPORTED`] 801 - If the operation is not supported.
    /// [`OH_Crypto_ErrCode#CRYPTO_MEMORY_ERROR`] 17620001 - If memory operation failed.
    /// [`OH_Crypto_ErrCode#CRYPTO_OPERTION_ERROR`] 17630001 - If crypto opertion failed.
    ///
    /// Available since API-level: 12
    #[cfg(feature = "api-12")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
    pub fn OH_CryptoSymKeyGenerator_Convert(
        ctx: *mut OH_CryptoSymKeyGenerator,
        keyData: *const Crypto_DataBlob,
        keyCtx: *mut *mut OH_CryptoSymKey,
    ) -> CryptoResult;
    /// Get the algorithm name of the symmetric key generator.
    ///
    /// # Arguments
    ///
    /// * `ctx` - Indicates the symmetric key generator context.
    ///
    /// # Returns
    ///
    /// * Return symmetric key algorithm name.
    ///
    /// Available since API-level: 12
    #[cfg(feature = "api-12")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
    pub fn OH_CryptoSymKeyGenerator_GetAlgoName(
        ctx: *mut OH_CryptoSymKeyGenerator,
    ) -> *const ::core::ffi::c_char;
    /// Destroy the symmetric key generator.
    ///
    /// # Arguments
    ///
    /// * `ctx` - Indicates the symmetric key generator context.
    ///
    /// Available since API-level: 12
    #[cfg(feature = "api-12")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
    pub fn OH_CryptoSymKeyGenerator_Destroy(ctx: *mut OH_CryptoSymKeyGenerator);
    /// Get the symmetric key algorithm name from a symmetric key.
    ///
    /// # Arguments
    ///
    /// * `keyCtx` - Indicates the symmetric key context.
    ///
    /// # Returns
    ///
    /// * Return algorithm name.
    ///
    /// Available since API-level: 12
    #[cfg(feature = "api-12")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
    pub fn OH_CryptoSymKey_GetAlgoName(keyCtx: *mut OH_CryptoSymKey) -> *const ::core::ffi::c_char;
    /// Get the symmetric key data from a symmetric key.
    ///
    /// # Arguments
    ///
    /// * `keyCtx` - Indicates the symmetric key context.
    ///
    /// * `out` - Indicate to obtain the result.
    ///
    /// # Returns
    ///
    /// * [`OH_Crypto_ErrCode#CRYPTO_SUCCESS`] 0 - If the operation is successful.
    /// [`OH_Crypto_ErrCode#CRYPTO_INVALID_PARAMS`] 401 - If parameter is invalid.
    /// [`OH_Crypto_ErrCode#CRYPTO_NOT_SUPPORTED`] 801 - If the operation is not supported.
    /// [`OH_Crypto_ErrCode#CRYPTO_MEMORY_ERROR`] 17620001 - If memory operation failed.
    /// [`OH_Crypto_ErrCode#CRYPTO_OPERTION_ERROR`] 17630001 - If crypto opertion failed.
    ///
    /// Available since API-level: 12
    #[cfg(feature = "api-12")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
    pub fn OH_CryptoSymKey_GetKeyData(
        keyCtx: *mut OH_CryptoSymKey,
        out: *mut Crypto_DataBlob,
    ) -> CryptoResult;
    /// Destroy the symmetric key.
    ///
    /// # Arguments
    ///
    /// * `keyCtx` - Indicates the symmetric key context.
    ///
    /// Available since API-level: 12
    #[cfg(feature = "api-12")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
    pub fn OH_CryptoSymKey_Destroy(keyCtx: *mut OH_CryptoSymKey);
}