Botan 3.0.0-alpha0
Crypto and TLS for C&
Classes | Functions | Variables
Botan_FFI Namespace Reference

Classes

struct  botan_struct
 
class  FFI_Error
 

Functions

template<typename T , uint32_t M, typename F >
int apply_fn (botan_struct< T, M > *o, const char *func_name, F func)
 
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, int rc)
 
int ffi_guard_thunk (const char *func_name, const std::function< int()> &thunk)
 
template<typename T , uint32_t M>
Tsafe_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::string &str)
 
int write_str_output (char out[], size_t *out_len, const std::vector< uint8_t > &str_vec)
 
int write_str_output (uint8_t out[], size_t *out_len, const std::string &str)
 
template<typename Alloc >
int write_vec_output (uint8_t out[], size_t *out_len, const std::vector< uint8_t, Alloc > &buf)
 

Variables

thread_local std::string g_last_exception_what
 

Function Documentation

◆ apply_fn()

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

Definition at line 81 of file ffi_util.h.

82 {
83 if(!o)
85
86 if(o->magic_ok() == false)
88
89 T* p = o->unsafe_get();
90 if(p == nullptr)
92
93 return ffi_guard_thunk(func_name, [&]() { return func(*p); });
94 }
@ BOTAN_FFI_ERROR_INVALID_OBJECT
Definition: ffi.h:84
@ BOTAN_FFI_ERROR_NULL_POINTER
Definition: ffi.h:77
fe T
Definition: ge.cpp:36
int ffi_guard_thunk(const char *func_name, const std::function< int()> &thunk)
Definition: ffi.cpp:92
T * unsafe_get() const
Definition: ffi_util.h:46
bool magic_ok() const
Definition: ffi_util.h:44

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

◆ 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 110 of file ffi_util.h.

111 {
112 return ffi_guard_thunk(func_name, [=]() -> int
113 {
114 // ignore delete of null objects
115 if(obj == nullptr)
116 return BOTAN_FFI_SUCCESS;
117
118 if(obj->magic_ok() == false)
120
121 delete obj;
122 return BOTAN_FFI_SUCCESS;
123 });
124 }
@ BOTAN_FFI_SUCCESS
Definition: ffi.h:63

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()

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

Definition at line 21 of file ffi.cpp.

22 {
23 g_last_exception_what.assign(exn);
24
25 std::string val;
26 if(Botan::OS::read_env_variable(val, "BOTAN_FFI_PRINT_EXCEPTIONS") == true && !val.empty())
27 {
28 std::fprintf(stderr, "in %s exception '%s' returning %d\n", func_name, exn, rc);
29 }
30 return rc;
31 }
bool read_env_variable(std::string &value_out, const std::string &var_name)
Definition: os_utils.cpp:452
thread_local std::string g_last_exception_what
Definition: ffi.cpp:19

References g_last_exception_what, and Botan::OS::read_env_variable().

Referenced by ffi_guard_thunk().

◆ ffi_guard_thunk()

int Botan_FFI::ffi_guard_thunk ( const char *  func_name,
const std::function< int()> &  thunk 
)

Definition at line 92 of file ffi.cpp.

93 {
95
96 try
97 {
98 return thunk();
99 }
100 catch(std::bad_alloc&)
101 {
102 return ffi_error_exception_thrown(func_name, "bad_alloc", BOTAN_FFI_ERROR_OUT_OF_MEMORY);
103 }
104 catch(Botan_FFI::FFI_Error& e)
105 {
106 return ffi_error_exception_thrown(func_name, e.what(), e.error_code());
107 }
108 catch(Botan::Exception& e)
109 {
110 return ffi_error_exception_thrown(func_name, e.what(), ffi_map_error_type(e.error_type()));
111 }
112 catch(std::exception& e)
113 {
114 return ffi_error_exception_thrown(func_name, e.what());
115 }
116 catch(...)
117 {
118 return ffi_error_exception_thrown(func_name, "unknown exception");
119 }
120
122 }
const char * what() const noexcept override
Definition: exceptn.h:94
virtual ErrorType error_type() const noexcept
Definition: exceptn.h:99
int error_code() const noexcept override
Definition: ffi_util.h:27
@ BOTAN_FFI_ERROR_OUT_OF_MEMORY
Definition: ffi.h:72
@ BOTAN_FFI_ERROR_UNKNOWN_ERROR
Definition: ffi.h:90
int ffi_error_exception_thrown(const char *func_name, const char *exn, int rc)
Definition: ffi.cpp:21

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

Referenced by apply_fn(), 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_fpe_decrypt(), botan_fpe_encrypt(), botan_fpe_fe1_init(), botan_generate_srp6_verifier(), botan_hash_init(), botan_hex_decode(), botan_hex_encode(), botan_hotp_init(), botan_kdf(), botan_key_unwrap3394(), botan_key_wrap3394(), botan_mac_init(), botan_mp_init(), botan_pk_op_decrypt_create(), botan_pk_op_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_dh(), botan_privkey_load_dsa(), botan_privkey_load_ecdh(), botan_privkey_load_ecdsa(), botan_privkey_load_ed25519(), botan_privkey_load_elgamal(), botan_privkey_load_rsa(), botan_privkey_load_rsa_pkcs1(), botan_privkey_load_sm2(), botan_privkey_load_x25519(), botan_pubkey_load(), botan_pubkey_load_dh(), botan_pubkey_load_dsa(), botan_pubkey_load_ecdh(), botan_pubkey_load_ecdsa(), botan_pubkey_load_ed25519(), botan_pubkey_load_elgamal(), botan_pubkey_load_rsa(), botan_pubkey_load_sm2(), botan_pubkey_load_x25519(), botan_pubkey_sm2_compute_za(), botan_pwdhash(), botan_pwdhash_timed(), botan_rng_init(), botan_rng_init_custom(), botan_srp6_client_agree(), botan_srp6_server_session_init(), botan_totp_init(), 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(), and ffi_delete_object().

◆ safe_get()

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

Definition at line 65 of file ffi_util.h.

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

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

Referenced by botan_bcrypt_generate(), botan_cipher_start(), botan_cipher_update(), 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_pk_op_decrypt_create(), botan_pk_op_encrypt(), botan_pk_op_encrypt_create(), 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_encrypted_pbkdf_iter(), botan_privkey_export_encrypted_pbkdf_msec(), 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_pubkey_check_key(), 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_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 128 of file ffi_util.h.

129 {
130 if(out_len == nullptr)
132
133 const size_t avail = *out_len;
134 *out_len = buf_len;
135
136 if((avail >= buf_len) && (out != nullptr))
137 {
138 Botan::copy_mem(out, buf, buf_len);
139 return BOTAN_FFI_SUCCESS;
140 }
141 else
142 {
143 if(out != nullptr)
144 {
145 Botan::clear_mem(out, avail);
146 }
148 }
149 }
@ BOTAN_FFI_ERROR_INSUFFICIENT_BUFFER_SPACE
Definition: ffi.h:69
constexpr void copy_mem(T *out, const T *in, size_t n)
Definition: mem_ops.h:126
constexpr void clear_mem(T *ptr, size_t n)
Definition: mem_ops.h:115

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(), and write_vec_output().

◆ write_str_output() [1/3]

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

Definition at line 164 of file ffi_util.h.

165 {
166 return write_str_output(Botan::cast_char_ptr_to_uint8(out), out_len, str);
167 }
int write_str_output(char out[], size_t *out_len, const std::vector< uint8_t > &str_vec)
Definition: ffi_util.h:169
const uint8_t * cast_char_ptr_to_uint8(const char *s)
Definition: mem_ops.h:183

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

◆ write_str_output() [2/3]

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

Definition at line 169 of file ffi_util.h.

170 {
172 out_len,
173 str_vec.data(),
174 str_vec.size());
175 }
int write_output(uint8_t out[], size_t *out_len, const uint8_t buf[], size_t buf_len)
Definition: ffi_util.h:128

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

◆ write_str_output() [3/3]

int Botan_FFI::write_str_output ( uint8_t  out[],
size_t *  out_len,
const std::string &  str 
)
inline

◆ write_vec_output()

template<typename Alloc >
int Botan_FFI::write_vec_output ( uint8_t  out[],
size_t *  out_len,
const std::vector< uint8_t, Alloc > &  buf 
)

Variable Documentation

◆ g_last_exception_what

thread_local std::string Botan_FFI::g_last_exception_what