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

// automatically generated by rust-bindgen 0.71.1

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

/// Defines the key agreement structure.
///
///
/// Available since API-level: 20
#[cfg(feature = "api-20")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-20")))]
#[repr(C)]
pub struct OH_CryptoKeyAgreement {
    _unused: [u8; 0],
}
extern "C" {
    /// Creates a key agreement context according to the given algorithm name.
    ///
    /// # Arguments
    ///
    /// * `algoName` - Indicates the algorithm name used to generate a key agreement context. e.g. "ECC", "X25519".
    ///
    /// * `ctx` - Indicates the key agreement context.
    ///
    /// # Returns
    ///
    /// * [`OH_Crypto_ErrCode#CRYPTO_SUCCESS`] 0 - If the operation is successful.
    /// [`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_PARAMETER_CHECK_FAILED`] 17620003 - If parameter check failed.
    /// [`OH_Crypto_ErrCode#CRYPTO_OPERTION_ERROR`] 17630001 - If crypto operation failed.
    ///
    /// Available since API-level: 20
    #[cfg(feature = "api-20")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-20")))]
    pub fn OH_CryptoKeyAgreement_Create(
        algoName: *const ::core::ffi::c_char,
        ctx: *mut *mut OH_CryptoKeyAgreement,
    ) -> CryptoResult;
    /// Generates a secret value.
    ///
    /// # Arguments
    ///
    /// * `ctx` - Indicates the key agreement context.
    ///
    /// * `privkey` - Indicates the private key.
    ///
    /// * `pubkey` - Indicates the public key.
    ///
    /// * `secret` - Indicates the secret value.
    ///
    /// # Returns
    ///
    /// * [`OH_Crypto_ErrCode#CRYPTO_SUCCESS`] 0 - If the operation is successful.
    /// [`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_PARAMETER_CHECK_FAILED`] 17620003 - If parameter check failed.
    /// [`OH_Crypto_ErrCode#CRYPTO_OPERTION_ERROR`] 17630001 - If crypto operation failed.
    ///
    /// Available since API-level: 20
    #[cfg(feature = "api-20")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-20")))]
    pub fn OH_CryptoKeyAgreement_GenerateSecret(
        ctx: *mut OH_CryptoKeyAgreement,
        privkey: *mut OH_CryptoPrivKey,
        pubkey: *mut OH_CryptoPubKey,
        secret: *mut Crypto_DataBlob,
    ) -> CryptoResult;
    /// Destroys the key agreement context.
    ///
    /// # Arguments
    ///
    /// * `ctx` - Indicates the key agreement context.
    ///
    /// Available since API-level: 20
    #[cfg(feature = "api-20")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-20")))]
    pub fn OH_CryptoKeyAgreement_Destroy(ctx: *mut OH_CryptoKeyAgreement);
}