Botan 3.8.1
Crypto and TLS for C&
Botan_FFI Namespace Reference

Classes

struct  botan_struct
 
struct  botan_view_bounce_struct
 
class  FFI_Error
 

Functions

template<typename T, uint32_t M, typename F>
int botan_ffi_visit (botan_struct< T, M > *o, F func, const char *func_name)
 
int botan_view_bin_bounce_fn (botan_view_ctx vctx, const uint8_t *buf, size_t len)
 
int botan_view_str_bounce_fn (botan_view_ctx vctx, const char *str, size_t len)
 
template<typename Fn, typename... Args>
int copy_view_bin (uint8_t out[], size_t *out_len, Fn fn, Args... args)
 
template<typename Fn, typename... Args>
int copy_view_str (uint8_t out[], size_t *out_len, Fn fn, Args... args)
 
void ffi_clear_last_exception ()
 
template<typename T, uint32_t M>
int ffi_delete_object (botan_struct< T, M > *obj, const char *func_name)
 
int ffi_error_exception_thrown (const char *func_name, const char *exn, Botan::ErrorType err)
 
int ffi_error_exception_thrown (const char *func_name, const char *exn, int rc)
 
template<std::invocable T>
int ffi_guard_thunk (const char *func_name, T thunk)
 
int invoke_view_callback (botan_view_bin_fn view, botan_view_ctx ctx, std::span< const uint8_t > buf)
 
int invoke_view_callback (botan_view_str_fn view, botan_view_ctx ctx, std::string_view str)
 
template<typename T, uint32_t M>
T & safe_get (botan_struct< T, M > *p)
 
int write_output (uint8_t out[], size_t *out_len, const uint8_t buf[], size_t buf_len)
 
int write_str_output (char out[], size_t *out_len, const std::vector< uint8_t > &str_vec)
 
int write_str_output (char out[], size_t *out_len, std::string_view str)
 
int write_str_output (uint8_t out[], size_t *out_len, std::string_view str)
 
int write_vec_output (uint8_t out[], size_t *out_len, std::span< const uint8_t > buf)
 

Function Documentation

◆ botan_ffi_visit()

template<typename T, uint32_t M, typename F>
int Botan_FFI::botan_ffi_visit ( botan_struct< T, M > * o,
F func,
const char * func_name )

Definition at line 102 of file ffi_util.h.

102 {
103 using RetT = std::invoke_result_t<F, T&>;
104 static_assert(std::is_void_v<RetT> || std::is_same_v<RetT, BOTAN_FFI_ERROR> || std::is_same_v<RetT, int>,
105 "BOTAN_FFI_DO must be used with a block that returns either nothing, int or BOTAN_FFI_ERROR");
106
107 if(!o) {
109 }
110
111 if(o->magic_ok() == false) {
113 }
114
115 T* p = o->unsafe_get();
116 if(p == nullptr) {
118 }
119
120 if constexpr(std::is_void_v<RetT>) {
121 return ffi_guard_thunk(func_name, [&] {
122 func(*p);
123 return BOTAN_FFI_SUCCESS;
124 });
125 } else {
126 return ffi_guard_thunk(func_name, [&] { return func(*p); });
127 }
128}
@ BOTAN_FFI_ERROR_INVALID_OBJECT
Definition ffi.h:137
@ BOTAN_FFI_ERROR_NULL_POINTER
Definition ffi.h:130
@ BOTAN_FFI_SUCCESS
Definition ffi.h:113
int ffi_guard_thunk(const char *func_name, T thunk)
Definition ffi_util.h:83
T * unsafe_get() const
Definition ffi_util.h:44
bool magic_ok() const
Definition ffi_util.h:42

References BOTAN_FFI_ERROR_INVALID_OBJECT, BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, ffi_guard_thunk(), Botan_FFI::botan_struct< T, MAGIC >::magic_ok(), and Botan_FFI::botan_struct< T, MAGIC >::unsafe_get().

◆ botan_view_bin_bounce_fn()

int Botan_FFI::botan_view_bin_bounce_fn ( botan_view_ctx vctx,
const uint8_t * buf,
size_t len )

Definition at line 111 of file ffi.cpp.

111 {
112 if(vctx == nullptr || buf == nullptr) {
114 }
115
116 botan_view_bounce_struct* ctx = static_cast<botan_view_bounce_struct*>(vctx);
117
118 const size_t avail = *ctx->out_len;
119 *ctx->out_len = len;
120
121 if(avail < len || ctx->out_ptr == nullptr) {
122 if(ctx->out_ptr) {
123 Botan::clear_mem(ctx->out_ptr, avail);
124 }
126 } else {
127 Botan::copy_mem(ctx->out_ptr, buf, len);
128 return BOTAN_FFI_SUCCESS;
129 }
130}
@ BOTAN_FFI_ERROR_INSUFFICIENT_BUFFER_SPACE
Definition ffi.h:121
constexpr void copy_mem(T *out, const T *in, size_t n)
Definition mem_ops.h:149
constexpr void clear_mem(T *ptr, size_t n)
Definition mem_ops.h:123

References BOTAN_FFI_ERROR_INSUFFICIENT_BUFFER_SPACE, BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, Botan::clear_mem(), Botan::copy_mem(), Botan_FFI::botan_view_bounce_struct::out_len, and Botan_FFI::botan_view_bounce_struct::out_ptr.

Referenced by botan_view_str_bounce_fn(), and copy_view_bin().

◆ botan_view_str_bounce_fn()

int Botan_FFI::botan_view_str_bounce_fn ( botan_view_ctx vctx,
const char * str,
size_t len )

Definition at line 107 of file ffi.cpp.

107 {
108 return botan_view_bin_bounce_fn(vctx, reinterpret_cast<const uint8_t*>(str), len);
109}
int botan_view_bin_bounce_fn(botan_view_ctx vctx, const uint8_t *buf, size_t len)
Definition ffi.cpp:111

References botan_view_bin_bounce_fn().

Referenced by copy_view_str().

◆ copy_view_bin()

template<typename Fn, typename... Args>
int Botan_FFI::copy_view_bin ( uint8_t out[],
size_t * out_len,
Fn fn,
Args... args )

◆ copy_view_str()

template<typename Fn, typename... Args>
int Botan_FFI::copy_view_str ( uint8_t out[],
size_t * out_len,
Fn fn,
Args... args )

Definition at line 197 of file ffi_util.h.

197 {
198 if(fn == nullptr) {
200 }
201 botan_view_bounce_struct ctx;
202 ctx.out_ptr = out;
203 ctx.out_len = out_len;
204 return fn(args..., &ctx, botan_view_str_bounce_fn);
205}
int botan_view_str_bounce_fn(botan_view_ctx vctx, const char *str, size_t len)
Definition ffi.cpp:107

References BOTAN_FFI_ERROR_NULL_POINTER, botan_view_str_bounce_fn(), Botan_FFI::botan_view_bounce_struct::out_len, and Botan_FFI::botan_view_bounce_struct::out_ptr.

Referenced by botan_privkey_export(), botan_privkey_export_encrypted_pbkdf_iter(), botan_privkey_export_encrypted_pbkdf_msec(), botan_pubkey_export(), and botan_x509_cert_to_string().

◆ ffi_clear_last_exception()

void Botan_FFI::ffi_clear_last_exception ( )

Definition at line 86 of file ffi.cpp.

86 {
87 g_last_exception_what.clear();
88}

Referenced by ffi_guard_thunk().

◆ ffi_delete_object()

template<typename T, uint32_t M>
int Botan_FFI::ffi_delete_object ( botan_struct< T, M > * obj,
const char * func_name )

Definition at line 148 of file ffi_util.h.

148 {
149 return ffi_guard_thunk(func_name, [=]() -> int {
150 // ignore delete of null objects
151 if(obj == nullptr) {
152 return BOTAN_FFI_SUCCESS;
153 }
154
155 if(obj->magic_ok() == false) {
157 }
158
159 delete obj;
160 return BOTAN_FFI_SUCCESS;
161 });
162}

References BOTAN_FFI_ERROR_INVALID_OBJECT, BOTAN_FFI_SUCCESS, ffi_guard_thunk(), and Botan_FFI::botan_struct< T, MAGIC >::magic_ok().

◆ ffi_error_exception_thrown() [1/2]

int Botan_FFI::ffi_error_exception_thrown ( const char * func_name,
const char * exn,
Botan::ErrorType err )

Definition at line 103 of file ffi.cpp.

103 {
104 return ffi_error_exception_thrown(func_name, exn, ffi_map_error_type(err));
105}
int ffi_error_exception_thrown(const char *func_name, const char *exn, int rc)
Definition ffi.cpp:90

References ffi_error_exception_thrown().

◆ ffi_error_exception_thrown() [2/2]

int Botan_FFI::ffi_error_exception_thrown ( const char * func_name,
const char * exn,
int rc )

Definition at line 90 of file ffi.cpp.

90 {
91 g_last_exception_what.assign(exn);
92
93#if defined(BOTAN_HAS_OS_UTILS)
94 std::string val;
95 if(Botan::OS::read_env_variable(val, "BOTAN_FFI_PRINT_EXCEPTIONS") == true && !val.empty()) {
96 static_cast<void>(std::fprintf(stderr, "in %s exception '%s' returning %d\n", func_name, exn, rc));
97 }
98#endif
99
100 return rc;
101}
bool read_env_variable(std::string &value_out, std::string_view var_name)
Definition os_utils.cpp:435

References Botan::OS::read_env_variable().

Referenced by ffi_error_exception_thrown(), and ffi_guard_thunk().

◆ ffi_guard_thunk()

template<std::invocable T>
int Botan_FFI::ffi_guard_thunk ( const char * func_name,
T thunk )

Definition at line 83 of file ffi_util.h.

83 {
85
86 try {
87 return thunk();
88 } catch(std::bad_alloc&) {
89 return ffi_error_exception_thrown(func_name, "bad_alloc", BOTAN_FFI_ERROR_OUT_OF_MEMORY);
90 } catch(Botan_FFI::FFI_Error& e) {
91 return ffi_error_exception_thrown(func_name, e.what(), e.error_code());
92 } catch(Botan::Exception& e) {
93 return ffi_error_exception_thrown(func_name, e.what(), e.error_type());
94 } catch(std::exception& e) {
96 } catch(...) {
97 return ffi_error_exception_thrown(func_name, "unknown exception", BOTAN_FFI_ERROR_EXCEPTION_THROWN);
98 }
99}
const char * what() const noexcept override
Definition exceptn.h:93
virtual ErrorType error_type() const noexcept
Definition exceptn.h:98
int error_code() const noexcept override
Definition ffi_util.h:24
@ BOTAN_FFI_ERROR_EXCEPTION_THROWN
Definition ffi.h:124
@ BOTAN_FFI_ERROR_OUT_OF_MEMORY
Definition ffi.h:125
void ffi_clear_last_exception()
Definition ffi.cpp:86

References BOTAN_FFI_ERROR_EXCEPTION_THROWN, BOTAN_FFI_ERROR_OUT_OF_MEMORY, Botan_FFI::FFI_Error::error_code(), Botan_FFI::FFI_Error::error_type(), ffi_clear_last_exception(), ffi_error_exception_thrown(), and Botan::Exception::what().

Referenced by botan_base64_decode(), botan_base64_encode(), botan_bcrypt_generate(), botan_bcrypt_is_valid(), botan_block_cipher_init(), botan_cipher_init(), botan_cipher_start(), botan_cipher_update(), botan_ec_group_from_ber(), botan_ec_group_from_name(), botan_ec_group_from_oid(), botan_ec_group_from_params(), botan_ec_group_from_pem(), botan_ec_group_supports_named_group(), botan_ec_privkey_create(), botan_ffi_visit(), botan_fpe_decrypt(), botan_fpe_encrypt(), botan_fpe_fe1_init(), botan_hash_init(), botan_hex_decode(), botan_hex_encode(), botan_hotp_init(), botan_kdf(), botan_mac_init(), botan_mp_init(), botan_nist_kw_dec(), botan_nist_kw_enc(), botan_oid_from_string(), botan_pk_op_decrypt_create(), botan_pk_op_encrypt_create(), botan_pk_op_kem_decrypt_create(), botan_pk_op_kem_encrypt_create(), botan_pk_op_key_agreement_create(), botan_pk_op_sign_create(), botan_pk_op_verify_create(), botan_pkcs_hash_id(), botan_privkey_create(), botan_privkey_create_dsa(), botan_privkey_create_elgamal(), botan_privkey_export_pubkey(), botan_privkey_load(), botan_privkey_load_classic_mceliece(), botan_privkey_load_dh(), botan_privkey_load_dsa(), botan_privkey_load_ecdh(), botan_privkey_load_ecdsa(), botan_privkey_load_ed25519(), botan_privkey_load_ed448(), botan_privkey_load_elgamal(), botan_privkey_load_frodokem(), botan_privkey_load_kyber(), botan_privkey_load_ml_dsa(), botan_privkey_load_ml_kem(), botan_privkey_load_rsa(), botan_privkey_load_rsa_pkcs1(), botan_privkey_load_slh_dsa(), botan_privkey_load_sm2(), botan_privkey_load_x25519(), botan_privkey_load_x448(), botan_pubkey_ecc_key_used_explicit_encoding(), botan_pubkey_load(), botan_pubkey_load_classic_mceliece(), botan_pubkey_load_dh(), botan_pubkey_load_dsa(), botan_pubkey_load_ecdh(), botan_pubkey_load_ecdsa(), botan_pubkey_load_ed25519(), botan_pubkey_load_ed448(), botan_pubkey_load_elgamal(), botan_pubkey_load_frodokem(), botan_pubkey_load_ml_dsa(), botan_pubkey_load_ml_kem(), botan_pubkey_load_rsa(), botan_pubkey_load_slh_dsa(), botan_pubkey_load_sm2(), botan_pubkey_load_x25519(), botan_pubkey_load_x448(), botan_pubkey_sm2_compute_za(), botan_pwdhash(), botan_pwdhash_timed(), botan_rng_init(), botan_rng_init_custom(), botan_srp6_client_agree(), botan_srp6_generate_verifier(), botan_srp6_group_size(), botan_srp6_server_session_init(), botan_system_rng_get(), botan_totp_init(), botan_tpm2_ctx_from_esys(), botan_tpm2_ctx_init(), botan_tpm2_ctx_init_ex(), botan_tpm2_enable_crypto_backend(), botan_x509_cert_dup(), botan_x509_cert_get_public_key(), botan_x509_cert_load(), botan_x509_cert_load_file(), botan_x509_cert_verify(), botan_x509_cert_verify_with_crl(), botan_x509_crl_load(), botan_x509_crl_load_file(), botan_zfec_decode(), botan_zfec_encode(), and ffi_delete_object().

◆ invoke_view_callback() [1/2]

◆ invoke_view_callback() [2/2]

int Botan_FFI::invoke_view_callback ( botan_view_str_fn view,
botan_view_ctx ctx,
std::string_view str )
inline

Definition at line 173 of file ffi_util.h.

173 {
174 if(view == nullptr) {
176 }
177 return view(ctx, str.data(), str.size() + 1);
178}

References BOTAN_FFI_ERROR_NULL_POINTER.

◆ safe_get()

template<typename T, uint32_t M>
T & Botan_FFI::safe_get ( botan_struct< T, M > * p)

Definition at line 67 of file ffi_util.h.

67 {
68 if(!p) {
69 throw FFI_Error("Null pointer argument", BOTAN_FFI_ERROR_NULL_POINTER);
70 }
71 if(p->magic_ok() == false) {
72 throw FFI_Error("Bad magic in ffi object", BOTAN_FFI_ERROR_INVALID_OBJECT);
73 }
74
75 if(T* t = p->unsafe_get()) {
76 return *t;
77 }
78
79 throw FFI_Error("Invalid object pointer", BOTAN_FFI_ERROR_INVALID_OBJECT);
80}

References BOTAN_FFI_ERROR_INVALID_OBJECT, BOTAN_FFI_ERROR_NULL_POINTER, Botan_FFI::botan_struct< T, MAGIC >::magic_ok(), and Botan_FFI::botan_struct< T, MAGIC >::unsafe_get().

Referenced by botan_bcrypt_generate(), botan_cipher_start(), botan_cipher_update(), botan_ec_group_equal(), botan_ec_group_from_oid(), botan_ec_group_from_params(), botan_ec_privkey_create(), botan_fpe_decrypt(), botan_fpe_encrypt(), botan_fpe_fe1_init(), botan_mp_add(), botan_mp_add_u32(), botan_mp_cmp(), botan_mp_div(), botan_mp_equal(), botan_mp_gcd(), botan_mp_is_prime(), botan_mp_lshift(), botan_mp_mod_inverse(), botan_mp_mod_mul(), botan_mp_mul(), botan_mp_powmod(), botan_mp_rand_bits(), botan_mp_rand_range(), botan_mp_rshift(), botan_mp_set_from_mp(), botan_mp_sub(), botan_mp_sub_u32(), botan_mp_swap(), botan_oid_cmp(), botan_oid_equal(), botan_pk_op_decrypt_create(), botan_pk_op_encrypt(), botan_pk_op_encrypt_create(), botan_pk_op_kem_decrypt_create(), botan_pk_op_kem_encrypt_create(), botan_pk_op_kem_encrypt_create_shared_key(), botan_pk_op_key_agreement_create(), botan_pk_op_sign_create(), botan_pk_op_sign_finish(), botan_pk_op_verify_create(), botan_privkey_check_key(), botan_privkey_create(), botan_privkey_create_dsa(), botan_privkey_create_elgamal(), botan_privkey_export_pubkey(), botan_privkey_get_field(), botan_privkey_load_dh(), botan_privkey_load_dsa(), botan_privkey_load_ecdh(), botan_privkey_load_ecdsa(), botan_privkey_load_elgamal(), botan_privkey_load_rsa(), botan_privkey_load_sm2(), botan_privkey_view_encrypted_der(), botan_privkey_view_encrypted_der_timed(), botan_privkey_view_encrypted_pem(), botan_privkey_view_encrypted_pem_timed(), botan_pubkey_check_key(), botan_pubkey_ecc_key_used_explicit_encoding(), botan_pubkey_get_field(), botan_pubkey_load_dh(), botan_pubkey_load_dsa(), botan_pubkey_load_ecdh(), botan_pubkey_load_ecdsa(), botan_pubkey_load_elgamal(), botan_pubkey_load_rsa(), botan_pubkey_load_sm2(), botan_pubkey_sm2_compute_za(), botan_rng_reseed_from_rng(), botan_srp6_client_agree(), botan_srp6_server_session_step1(), botan_tpm2_ctx_enable_crypto_backend(), botan_tpm2_enable_crypto_backend(), botan_x509_cert_dup(), botan_x509_cert_get_public_key(), botan_x509_cert_verify(), botan_x509_cert_verify_with_crl(), and botan_x509_is_revoked().

◆ write_output()

int Botan_FFI::write_output ( uint8_t out[],
size_t * out_len,
const uint8_t buf[],
size_t buf_len )
inline

Definition at line 207 of file ffi_util.h.

207 {
208 if(out_len == nullptr) {
210 }
211
212 const size_t avail = *out_len;
213 *out_len = buf_len;
214
215 if((avail >= buf_len) && (out != nullptr)) {
216 Botan::copy_mem(out, buf, buf_len);
217 return BOTAN_FFI_SUCCESS;
218 } else {
219 if(out != nullptr) {
220 Botan::clear_mem(out, avail);
221 }
223 }
224}

References BOTAN_FFI_ERROR_INSUFFICIENT_BUFFER_SPACE, BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, Botan::clear_mem(), and Botan::copy_mem().

Referenced by botan_pkcs_hash_id(), write_str_output(), write_str_output(), and write_vec_output().

◆ write_str_output() [1/3]

int Botan_FFI::write_str_output ( char out[],
size_t * out_len,
const std::vector< uint8_t > & str_vec )
inline

Definition at line 238 of file ffi_util.h.

238 {
239 return write_output(Botan::cast_char_ptr_to_uint8(out), out_len, str_vec.data(), str_vec.size());
240}
int write_output(uint8_t out[], size_t *out_len, const uint8_t buf[], size_t buf_len)
Definition ffi_util.h:207
const uint8_t * cast_char_ptr_to_uint8(const char *s)
Definition mem_ops.h:276

References Botan::cast_char_ptr_to_uint8(), and write_output().

◆ write_str_output() [2/3]

int Botan_FFI::write_str_output ( char out[],
size_t * out_len,
std::string_view str )
inline

Definition at line 234 of file ffi_util.h.

234 {
235 return write_str_output(Botan::cast_char_ptr_to_uint8(out), out_len, str);
236}
int write_str_output(uint8_t out[], size_t *out_len, std::string_view str)
Definition ffi_util.h:230

References Botan::cast_char_ptr_to_uint8(), and write_str_output().

◆ write_str_output() [3/3]

◆ write_vec_output()