botan-sys 1.20260811.1

FFI wrapper for Botan cryptography library
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

#![no_std]
#![allow(non_camel_case_types)]
#![allow(unused_imports)]

//! FFI declarations for the Botan cryptography library
//!
//! By default (and with the `static` or `vendored` features) this crate links
//! against the Botan library and detects at build time which functions the
//! installed headers declare. Functions the headers predate are replaced by
//! stubs returning [`BOTAN_FFI_ERROR_FUNCTION_NOT_AVAILABLE`].
//!
//! With the `dynamic-loading` feature the crate does not link against Botan;
//! the shared library is loaded at runtime (see `load_library`) and every
//! function is resolved on first use, so the set of available functions is
//! determined entirely by the library found at runtime.

#[cfg(feature = "dynamic-loading")]
extern crate std;

#[cfg(all(
    feature = "dynamic-loading",
    any(feature = "vendored", feature = "static")
))]
compile_error!("The dynamic-loading feature cannot be combined with vendored or static linking");

#[macro_use]
mod macros;

#[cfg(feature = "dynamic-loading")]
mod loader;

#[cfg(feature = "dynamic-loading")]
pub use loader::{LoadError, last_load_error, load_library, loaded_library_name};

mod block;
mod cipher;
mod ec_group;
mod errors;
mod fpe;
mod hash;
mod kdf;
mod keywrap;
mod mac;
mod mp;
mod oid;
mod otp;
mod passhash;
mod pk_ops;
mod pubkey;
mod rng;
mod spake2p;
mod srp6;
mod tpm2;
mod utils;
mod version;
mod x509;
mod xof;
mod zfec;

pub mod ffi_types {
    pub use core::ffi::{c_char, c_int, c_uint, c_void};

    pub type botan_view_ctx = *mut c_void;

    pub type botan_view_bin_fn =
        extern "C" fn(view_ctx: botan_view_ctx, data: *const u8, len: usize) -> c_int;

    pub type botan_view_str_fn =
        extern "C" fn(view_ctx: botan_view_ctx, data: *const c_char, len: usize) -> c_int;
}

pub use block::*;
pub use cipher::*;
pub use ec_group::*;
pub use errors::*;
pub use fpe::*;
pub use hash::*;
pub use kdf::*;
pub use keywrap::*;
pub use mac::*;
pub use mp::*;
pub use oid::*;
pub use otp::*;
pub use passhash::*;
pub use pk_ops::*;
pub use pubkey::*;
pub use rng::*;
pub use spake2p::*;
pub use srp6::*;
pub use tpm2::*;
pub use utils::*;
pub use version::*;
pub use x509::*;
pub use xof::*;
pub use zfec::*;

/// Returns a description of why the Botan library could not be loaded
///
/// This is only ever `Some` when the `dynamic-loading` feature is enabled and
/// loading the Botan shared library failed; in the linked build modes it
/// always returns `None`.
#[cfg(not(feature = "dynamic-loading"))]
pub fn last_load_error() -> Option<&'static str> {
    None
}