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)
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 Alloc >
int	invoke_view_callback (botan_view_bin_fn view, botan_view_ctx ctx, const std::vector< uint8_t, Alloc > &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)
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

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

                                                                          {
   using RetT = std::invoke_result_t<F, T&>;
   static_assert(std::is_void_v<RetT> || std::is_same_v<RetT, BOTAN_FFI_ERROR> || std::is_same_v<RetT, int>,
                 "BOTAN_FFI_DO must be used with a block that returns either nothing, int or BOTAN_FFI_ERROR");
 
   if(!o) {
      return BOTAN_FFI_ERROR_NULL_POINTER;
   }
 
   if(o->magic_ok() == false) {
      return BOTAN_FFI_ERROR_INVALID_OBJECT;
   }
 
   T* p = o->unsafe_get();
   if(p == nullptr) {
      return BOTAN_FFI_ERROR_INVALID_OBJECT;
   }
 
   if constexpr(std::is_void_v<RetT>) {
      return ffi_guard_thunk(func_name, [&] {
         func(*p);
         return BOTAN_FFI_SUCCESS;
      });
   } else {
      return ffi_guard_thunk(func_name, [&] { return func(*p); });
   }
}

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(), T, 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 38 of file ffi.cpp.

                                                                                  {
   if(vctx == nullptr || buf == nullptr) {
      return BOTAN_FFI_ERROR_NULL_POINTER;
   }
 
   botan_view_bounce_struct* ctx = static_cast<botan_view_bounce_struct*>(vctx);
 
   const size_t avail = *ctx->out_len;
   *ctx->out_len = len;
 
   if(avail < len || ctx->out_ptr == nullptr) {
      if(ctx->out_ptr) {
         Botan::clear_mem(ctx->out_ptr, avail);
      }
      return BOTAN_FFI_ERROR_INSUFFICIENT_BUFFER_SPACE;
   } else {
      Botan::copy_mem(ctx->out_ptr, buf, len);
      return BOTAN_FFI_SUCCESS;
   }
}

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 34 of file ffi.cpp.

                                                                               {
   return botan_view_bin_bounce_fn(vctx, reinterpret_cast<const uint8_t*>(str), len);
}

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 )

Definition at line 163 of file ffi_util.h.

                                                                       {
   botan_view_bounce_struct ctx;
   ctx.out_ptr = out;
   ctx.out_len = out_len;
   return fn(args..., &ctx, botan_view_bin_bounce_fn);
}

References botan_view_bin_bounce_fn(), Botan_FFI::botan_view_bounce_struct::out_len, and Botan_FFI::botan_view_bounce_struct::out_ptr.

Referenced by botan_pk_op_key_agreement_export_public(), botan_privkey_export(), botan_privkey_export_encrypted_pbkdf_iter(), botan_privkey_export_encrypted_pbkdf_msec(), botan_pubkey_export(), and botan_x509_cert_get_public_key_bits().

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

                                                                       {
   if(fn == nullptr) {
      return BOTAN_FFI_ERROR_NULL_POINTER;
   }
   botan_view_bounce_struct ctx;
   ctx.out_ptr = out;
   ctx.out_len = out_len;
   return fn(args..., &ctx, botan_view_str_bounce_fn);
}

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_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 127 of file ffi_util.h.

                                                                      {
   return ffi_guard_thunk(func_name, [=]() -> int {
      // ignore delete of null objects
      if(obj == nullptr) {
         return BOTAN_FFI_SUCCESS;
      }
 
      if(obj->magic_ok() == false) {
         return BOTAN_FFI_ERROR_INVALID_OBJECT;
      }
 
      delete obj;
      return BOTAN_FFI_SUCCESS;
   });
}

References 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 24 of file ffi.cpp.

                                                                               {
   g_last_exception_what.assign(exn);
 
   std::string val;
   if(Botan::OS::read_env_variable(val, "BOTAN_FFI_PRINT_EXCEPTIONS") == true && !val.empty()) {
      static_cast<void>(std::fprintf(stderr, "in %s exception '%s' returning %d\n", func_name, exn, rc));
   }
   return rc;
}

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 116 of file ffi.cpp.

                                                                            {
   g_last_exception_what.clear();
 
   try {
      return thunk();
   } catch(std::bad_alloc&) {
      return ffi_error_exception_thrown(func_name, "bad_alloc", BOTAN_FFI_ERROR_OUT_OF_MEMORY);
   } catch(Botan_FFI::FFI_Error& e) {
      return ffi_error_exception_thrown(func_name, e.what(), e.error_code());
   } catch(Botan::Exception& e) {
      return ffi_error_exception_thrown(func_name, e.what(), ffi_map_error_type(e.error_type()));
   } catch(std::exception& e) {
      return ffi_error_exception_thrown(func_name, e.what());
   } catch(...) {
      return ffi_error_exception_thrown(func_name, "unknown exception");
   }
 
   return BOTAN_FFI_ERROR_UNKNOWN_ERROR;
}

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 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_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_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_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_kyber(), botan_privkey_load_rsa(), botan_privkey_load_rsa_pkcs1(), 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_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_kyber(), botan_pubkey_load_rsa(), 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_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]

template<typename Alloc >

int Botan_FFI::invoke_view_callback ( botan_view_bin_fn view, botan_view_ctx ctx, const std::vector< uint8_t, Alloc > & buf )

inline

Definition at line 146 of file ffi_util.h.

                                                                                                                  {
   return view(ctx, buf.data(), buf.size());
}

Referenced by botan_pk_op_key_agreement_view_public(), botan_privkey_view_der(), botan_privkey_view_encrypted_der(), botan_privkey_view_encrypted_der_timed(), botan_privkey_view_encrypted_pem(), botan_privkey_view_encrypted_pem_timed(), botan_privkey_view_kyber_raw_key(), botan_privkey_view_pem(), botan_pubkey_view_der(), botan_pubkey_view_ec_public_point(), botan_pubkey_view_kyber_raw_key(), botan_pubkey_view_pem(), botan_x509_cert_view_as_string(), and botan_x509_cert_view_public_key_bits().

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

                                                                                                {
   return view(ctx, str.data(), str.size() + 1);
}

safe_get()

template<typename T , uint32_t M>

T & Botan_FFI::safe_get

(

botan_struct< T, M > *

p

)

Definition at line 63 of file ffi_util.h.

                                   {
   if(!p) {
      throw FFI_Error("Null pointer argument", BOTAN_FFI_ERROR_NULL_POINTER);
   }
   if(p->magic_ok() == false) {
      throw FFI_Error("Bad magic in ffi object", BOTAN_FFI_ERROR_INVALID_OBJECT);
   }
 
   if(T* t = p->unsafe_get()) {
      return *t;
   }
 
   throw FFI_Error("Invalid object pointer", BOTAN_FFI_ERROR_INVALID_OBJECT);
}

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_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_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 181 of file ffi_util.h.

                                                                                             {
   if(out_len == nullptr) {
      return BOTAN_FFI_ERROR_NULL_POINTER;
   }
 
   const size_t avail = *out_len;
   *out_len = buf_len;
 
   if((avail >= buf_len) && (out != nullptr)) {
      Botan::copy_mem(out, buf, buf_len);
      return BOTAN_FFI_SUCCESS;
   } else {
      if(out != nullptr) {
         Botan::clear_mem(out, avail);
      }
      return BOTAN_FFI_ERROR_INSUFFICIENT_BUFFER_SPACE;
   }
}

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

                                                                                            {
   return write_output(Botan::cast_char_ptr_to_uint8(out), out_len, str_vec.data(), str_vec.size());
}

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

                                                                             {
   return write_str_output(Botan::cast_char_ptr_to_uint8(out), out_len, str);
}

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

write_str_output() [3/3]

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

inline

Definition at line 205 of file ffi_util.h.

                                                                                {
   return write_output(out, out_len, Botan::cast_char_ptr_to_uint8(str.data()), str.size() + 1);
}

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

Referenced by botan_base64_encode(), botan_bcrypt_generate(), botan_block_cipher_name(), botan_cipher_name(), botan_hash_name(), botan_mac_name(), botan_mp_to_str(), botan_privkey_algo_name(), botan_privkey_rsa_get_privkey(), botan_pubkey_algo_name(), botan_x509_cert_get_fingerprint(), botan_x509_cert_get_issuer_dn(), botan_x509_cert_get_subject_dn(), botan_x509_cert_get_time_expires(), botan_x509_cert_get_time_starts(), and write_str_output().

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 )

Definition at line 201 of file ffi_util.h.

                                                                                           {
   return write_output(out, out_len, buf.data(), buf.size());
}

References write_output().

Referenced by botan_hex_decode(), botan_nist_kw_dec(), botan_nist_kw_enc(), botan_pk_op_decrypt(), botan_pk_op_encrypt(), botan_pk_op_kem_decrypt_shared_key(), botan_pk_op_kem_encrypt_create_shared_key(), botan_pk_op_key_agreement(), botan_pk_op_sign_finish(), botan_privkey_rsa_get_privkey(), botan_pubkey_fingerprint(), botan_pubkey_sm2_compute_za(), botan_srp6_client_agree(), botan_srp6_generate_verifier(), botan_srp6_server_session_step1(), botan_srp6_server_session_step2(), botan_x509_cert_get_authority_key_id(), botan_x509_cert_get_serial_number(), and botan_x509_cert_get_subject_key_id().

Variable Documentation

g_last_exception_what

thread_local std::string Botan_FFI::g_last_exception_what

Definition at line 22 of file ffi.cpp.

Referenced by botan_error_last_exception_message(), ffi_error_exception_thrown(), and ffi_guard_thunk().