ffi_mp.cpp File Reference

#include <botan/ffi.h>
#include <botan/internal/ffi_util.h>
#include <botan/internal/ffi_rng.h>
#include <botan/internal/ffi_mp.h>
#include <botan/reducer.h>
#include <botan/numthry.h>
#include <botan/internal/divide.h>

Go to the source code of this file.

Functions
int	botan_mp_add (botan_mp_t result, const botan_mp_t x, const botan_mp_t y)
int	botan_mp_add_u32 (botan_mp_t result, const botan_mp_t x, uint32_t y)
int	botan_mp_clear (botan_mp_t mp)
int	botan_mp_clear_bit (botan_mp_t mp, size_t bit)
int	botan_mp_cmp (int *result, const botan_mp_t x_w, const botan_mp_t y_w)
int	botan_mp_destroy (botan_mp_t mp)
int	botan_mp_div (botan_mp_t quotient, botan_mp_t remainder, const botan_mp_t x, const botan_mp_t y)
int	botan_mp_equal (const botan_mp_t x_w, const botan_mp_t y_w)
int	botan_mp_flip_sign (botan_mp_t mp)
int	botan_mp_from_bin (botan_mp_t mp, const uint8_t bin[], size_t bin_len)
int	botan_mp_gcd (botan_mp_t out, const botan_mp_t x, const botan_mp_t y)
int	botan_mp_get_bit (const botan_mp_t mp, size_t bit)
int	botan_mp_init (botan_mp_t *mp_out)
int	botan_mp_is_even (const botan_mp_t mp)
int	botan_mp_is_negative (const botan_mp_t mp)
int	botan_mp_is_odd (const botan_mp_t mp)
int	botan_mp_is_positive (const botan_mp_t mp)
int	botan_mp_is_prime (const botan_mp_t mp, botan_rng_t rng, size_t test_prob)
int	botan_mp_is_zero (const botan_mp_t mp)
int	botan_mp_lshift (botan_mp_t out, const botan_mp_t in, size_t shift)
int	botan_mp_mod_inverse (botan_mp_t out, const botan_mp_t in, const botan_mp_t modulus)
int	botan_mp_mod_mul (botan_mp_t out, const botan_mp_t x, const botan_mp_t y, const botan_mp_t modulus)
int	botan_mp_mul (botan_mp_t result, const botan_mp_t x, const botan_mp_t y)
int	botan_mp_num_bits (const botan_mp_t mp, size_t *bits)
int	botan_mp_num_bytes (const botan_mp_t mp, size_t *bytes)
int	botan_mp_powmod (botan_mp_t out, const botan_mp_t base, const botan_mp_t exponent, const botan_mp_t modulus)
int	botan_mp_rand_bits (botan_mp_t rand_out, botan_rng_t rng, size_t bits)
int	botan_mp_rand_range (botan_mp_t rand_out, botan_rng_t rng, const botan_mp_t lower, const botan_mp_t upper)
int	botan_mp_rshift (botan_mp_t out, const botan_mp_t in, size_t shift)
int	botan_mp_set_bit (botan_mp_t mp, size_t bit)
int	botan_mp_set_from_int (botan_mp_t mp, int initial_value)
int	botan_mp_set_from_mp (botan_mp_t dest, const botan_mp_t source)
int	botan_mp_set_from_radix_str (botan_mp_t mp, const char *str, size_t radix)
int	botan_mp_set_from_str (botan_mp_t mp, const char *str)
int	botan_mp_sub (botan_mp_t result, const botan_mp_t x, const botan_mp_t y)
int	botan_mp_sub_u32 (botan_mp_t result, const botan_mp_t x, uint32_t y)
int	botan_mp_swap (botan_mp_t x_w, botan_mp_t y_w)
int	botan_mp_to_bin (const botan_mp_t mp, uint8_t vec[])
int	botan_mp_to_hex (const botan_mp_t mp, char *out)
int	botan_mp_to_str (const botan_mp_t mp, uint8_t digit_base, char *out, size_t *out_len)
int	botan_mp_to_uint32 (const botan_mp_t mp, uint32_t *val)

Function Documentation

botan_mp_add()

int botan_mp_add	(	botan_mp_t	result,
		const botan_mp_t	x,
		const botan_mp_t	y
	)

Definition at line 132 of file ffi_mp.cpp.

   {
   return BOTAN_FFI_VISIT(result, [=](auto& res) {
      if(result == x)
         res += safe_get(y);
      else
         res = safe_get(x) + safe_get(y);
      });
   }

References BOTAN_FFI_VISIT, Botan_FFI::safe_get(), and y.

botan_mp_add_u32()

int botan_mp_add_u32	(	botan_mp_t	result,
		const botan_mp_t	x,
		uint32_t	y
	)

Definition at line 152 of file ffi_mp.cpp.

   {
   return BOTAN_FFI_VISIT(result, [=](auto& res) {
      if(result == x)
         res += static_cast<Botan::word>(y);
      else
         res = safe_get(x) + static_cast<Botan::word>(y);
      });
   }

References BOTAN_FFI_VISIT, Botan_FFI::safe_get(), and y.

botan_mp_clear()

int botan_mp_clear

(

botan_mp_t

mp

)

Set the MPI to zero

Definition at line 32 of file ffi_mp.cpp.

   {
   return BOTAN_FFI_VISIT(mp, [](auto& bn) { bn.clear(); });
   }

References BOTAN_FFI_VISIT.

botan_mp_clear_bit()

int botan_mp_clear_bit	(	botan_mp_t	n,
		size_t	bit
	)

Clear the specified bit

Definition at line 290 of file ffi_mp.cpp.

   {
   return BOTAN_FFI_VISIT(mp, [=](auto& n) { n.clear_bit(bit); });
   }

References BOTAN_FFI_VISIT.

botan_mp_cmp()

int botan_mp_cmp	(	int *	result,
		const botan_mp_t	x_w,
		const botan_mp_t	y_w
	)

Definition at line 213 of file ffi_mp.cpp.

   {
   return BOTAN_FFI_VISIT(x_w, [=](auto& x) { *result = x.cmp(safe_get(y_w)); });
   }

References BOTAN_FFI_VISIT, and Botan_FFI::safe_get().

botan_mp_destroy()

int botan_mp_destroy

(

botan_mp_t

mp

)

Destroy (deallocate) an MPI

Returns

0 if success, error if invalid object handle

Definition at line 127 of file ffi_mp.cpp.

   {
   return BOTAN_FFI_CHECKED_DELETE(mp);
   }

References BOTAN_FFI_CHECKED_DELETE.

botan_mp_div()

int botan_mp_div	(	botan_mp_t	quotient,
		botan_mp_t	remainder,
		const botan_mp_t	x,
		const botan_mp_t	y
	)

Definition at line 182 of file ffi_mp.cpp.

   {
   return BOTAN_FFI_VISIT(quotient, [=](auto& q) {
      Botan::BigInt r;
      Botan::vartime_divide(safe_get(x), safe_get(y), q, r);
      safe_get(remainder) = r;
      });
   }

References BOTAN_FFI_VISIT, Botan_FFI::safe_get(), Botan::vartime_divide(), and y.

botan_mp_equal()

int botan_mp_equal	(	const botan_mp_t	x_w,
		const botan_mp_t	y_w
	)

Definition at line 193 of file ffi_mp.cpp.

   {
   return BOTAN_FFI_VISIT(x_w, [=](const auto& x) -> int { return x == safe_get(y_w); });
   }

References BOTAN_FFI_VISIT, and Botan_FFI::safe_get().

botan_mp_flip_sign()

int botan_mp_flip_sign

(

botan_mp_t

mp

)

Definition at line 83 of file ffi_mp.cpp.

   {
   return BOTAN_FFI_VISIT(mp, [](auto& bn) { bn.flip_sign(); });
   }

References BOTAN_FFI_VISIT.

botan_mp_from_bin()

int botan_mp_from_bin	(	botan_mp_t	mp,
		const uint8_t	bin[],
		size_t	bin_len
	)

Definition at line 88 of file ffi_mp.cpp.

   {
   return BOTAN_FFI_VISIT(mp, [=](auto& bn) { bn.binary_decode(bin, bin_len); });
   }

References BOTAN_FFI_VISIT.

botan_mp_gcd()

int botan_mp_gcd	(	botan_mp_t	out,
		const botan_mp_t	x,
		const botan_mp_t	y
	)

Definition at line 268 of file ffi_mp.cpp.

   {
   return BOTAN_FFI_VISIT(out, [=] (auto& o) {
      o = Botan::gcd(safe_get(x), safe_get(y)); });
   }

References BOTAN_FFI_VISIT, Botan::gcd(), Botan_FFI::safe_get(), and y.

botan_mp_get_bit()

int botan_mp_get_bit	(	const botan_mp_t	n,
		size_t	bit
	)

Returns 0 if specified bit of n is not set Returns 1 if specified bit of n is set Returns negative number on error

Definition at line 280 of file ffi_mp.cpp.

   {
   return BOTAN_FFI_VISIT(mp, [=](const auto& n) -> int { return n.get_bit(bit); });
   }

References BOTAN_FFI_VISIT.

botan_mp_init()

int botan_mp_init

(

botan_mp_t *

mp

)

Initialize an MPI

Definition at line 20 of file ffi_mp.cpp.

   {
   return ffi_guard_thunk(__func__, [=]() -> int {
      if(mp_out == nullptr)
         return BOTAN_FFI_ERROR_NULL_POINTER;
 
      auto mp = std::make_unique<Botan::BigInt>();
      *mp_out = new botan_mp_struct(std::move(mp));
      return BOTAN_FFI_SUCCESS;
      });
   }

References BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, and Botan_FFI::ffi_guard_thunk().

botan_mp_is_even()

int botan_mp_is_even

(

const botan_mp_t

mp

)

Definition at line 208 of file ffi_mp.cpp.

   {
   return BOTAN_FFI_VISIT(mp, [](const auto& bn) -> int { return bn.is_even(); });
   }

References BOTAN_FFI_VISIT.

botan_mp_is_negative()

int botan_mp_is_negative

(

const botan_mp_t

mp

)

Return 1 iff mp is less than 0

Definition at line 73 of file ffi_mp.cpp.

   {
   return BOTAN_FFI_VISIT(mp, [](const auto& bn) { return bn.is_negative() ? 1 : 0; });
   }

References BOTAN_FFI_VISIT.

botan_mp_is_odd()

int botan_mp_is_odd

(

const botan_mp_t

mp

)

Definition at line 203 of file ffi_mp.cpp.

   {
   return BOTAN_FFI_VISIT(mp, [](const auto& bn) -> int { return bn.is_odd(); });
   }

References BOTAN_FFI_VISIT.

botan_mp_is_positive()

int botan_mp_is_positive

(

const botan_mp_t

mp

)

This function should have been named mp_is_non_negative. Returns 1 iff mp is greater than or equal to zero. Use botan_mp_is_negative to detect negative numbers, botan_mp_is_zero to check for zero.

Definition at line 78 of file ffi_mp.cpp.

   {
   return BOTAN_FFI_VISIT(mp, [](const auto& bn) { return bn.is_positive() ? 1 : 0; });
   }

References BOTAN_FFI_VISIT.

botan_mp_is_prime()

int botan_mp_is_prime	(	const botan_mp_t	n,
		botan_rng_t	rng,
		size_t	test_prob
	)

Returns 0 if n is not prime Returns 1 if n is prime Returns negative number on error

Definition at line 274 of file ffi_mp.cpp.

   {
   return BOTAN_FFI_VISIT(mp, [=](const auto& n)
                       { return (Botan::is_prime(n, safe_get(rng), test_prob)) ? 1 : 0; });
   }

References BOTAN_FFI_VISIT, Botan::is_prime(), and Botan_FFI::safe_get().

botan_mp_is_zero()

int botan_mp_is_zero

(

const botan_mp_t

mp

)

Definition at line 198 of file ffi_mp.cpp.

   {
   return BOTAN_FFI_VISIT(mp, [](const auto& bn) -> int { return bn.is_zero(); });
   }

References BOTAN_FFI_VISIT.

botan_mp_lshift()

int botan_mp_lshift	(	botan_mp_t	out,
		const botan_mp_t	in,
		size_t	shift
	)

Definition at line 230 of file ffi_mp.cpp.

   {
   return BOTAN_FFI_VISIT(out, [=](auto& o) { o = safe_get(in) << shift; });
   }

References BOTAN_FFI_VISIT, and Botan_FFI::safe_get().

botan_mp_mod_inverse()

int botan_mp_mod_inverse	(	botan_mp_t	out,
		const botan_mp_t	in,
		const botan_mp_t	modulus
	)

Definition at line 240 of file ffi_mp.cpp.

   {
   return BOTAN_FFI_VISIT(out, [=](auto& o) { o = Botan::inverse_mod(safe_get(in), safe_get(modulus)); });
   }

References BOTAN_FFI_VISIT, Botan::inverse_mod(), and Botan_FFI::safe_get().

botan_mp_mod_mul()

int botan_mp_mod_mul	(	botan_mp_t	out,
		const botan_mp_t	x,
		const botan_mp_t	y,
		const botan_mp_t	modulus
	)

Definition at line 245 of file ffi_mp.cpp.

   {
   return BOTAN_FFI_VISIT(out, [=](auto& o) {
      Botan::Modular_Reducer reducer(safe_get(modulus));
      o = reducer.multiply(safe_get(x), safe_get(y));
      });
   }

References BOTAN_FFI_VISIT, Botan::Modular_Reducer::multiply(), Botan_FFI::safe_get(), and y.

botan_mp_mul()

int botan_mp_mul	(	botan_mp_t	result,
		const botan_mp_t	x,
		const botan_mp_t	y
	)

Definition at line 172 of file ffi_mp.cpp.

   {
   return BOTAN_FFI_VISIT(result, [=](auto& res) {
      if(result == x)
         res *= safe_get(y);
      else
         res = safe_get(x) * safe_get(y);
      });
   }

References BOTAN_FFI_VISIT, Botan_FFI::safe_get(), and y.

botan_mp_num_bits()

int botan_mp_num_bits	(	const botan_mp_t	n,
		size_t *	bits
	)

Return the number of significant bits in the MPI

Definition at line 295 of file ffi_mp.cpp.

   {
   return BOTAN_FFI_VISIT(mp, [=](const auto& n) { *bits = n.bits(); });
   }

References BOTAN_FFI_VISIT.

botan_mp_num_bytes()

int botan_mp_num_bytes	(	const botan_mp_t	n,
		size_t *	bytes
	)

Return the number of significant bytes in the MPI

Definition at line 300 of file ffi_mp.cpp.

   {
   return BOTAN_FFI_VISIT(mp, [=](const auto& n) { *bytes = n.bytes(); });
   }

References BOTAN_FFI_VISIT.

botan_mp_powmod()

int botan_mp_powmod	(	botan_mp_t	out,
		const botan_mp_t	base,
		const botan_mp_t	exponent,
		const botan_mp_t	modulus
	)

Definition at line 224 of file ffi_mp.cpp.

   {
   return BOTAN_FFI_VISIT(out, [=](auto& o)
                       { o = Botan::power_mod(safe_get(base), safe_get(exponent), safe_get(modulus)); });
   }

References BOTAN_FFI_VISIT, Botan::power_mod(), and Botan_FFI::safe_get().

botan_mp_rand_bits()

int botan_mp_rand_bits	(	botan_mp_t	rand_out,
		botan_rng_t	rng,
		size_t	bits
	)

Definition at line 253 of file ffi_mp.cpp.

   {
   return BOTAN_FFI_VISIT(rng, [=] (auto& r) {
      safe_get(rand_out).randomize(r, bits); });
   }

References BOTAN_FFI_VISIT, and Botan_FFI::safe_get().

botan_mp_rand_range()

int botan_mp_rand_range	(	botan_mp_t	rand_out,
		botan_rng_t	rng,
		const botan_mp_t	lower,
		const botan_mp_t	upper
	)

Definition at line 259 of file ffi_mp.cpp.

   {
   return BOTAN_FFI_VISIT(rng, [=] (auto& r) {
      safe_get(rand_out) = Botan::BigInt::random_integer(r, safe_get(lower), safe_get(upper)); });
   }

References BOTAN_FFI_VISIT, Botan::BigInt::random_integer(), and Botan_FFI::safe_get().

botan_mp_rshift()

int botan_mp_rshift	(	botan_mp_t	out,
		const botan_mp_t	in,
		size_t	shift
	)

Definition at line 235 of file ffi_mp.cpp.

   {
   return BOTAN_FFI_VISIT(out, [=](auto& o) { o = safe_get(in) >> shift; });
   }

References BOTAN_FFI_VISIT, and Botan_FFI::safe_get().

botan_mp_set_bit()

int botan_mp_set_bit	(	botan_mp_t	n,
		size_t	bit
	)

Set the specified bit

Definition at line 285 of file ffi_mp.cpp.

   {
   return BOTAN_FFI_VISIT(mp, [=](auto& n) { n.set_bit(bit); });
   }

References BOTAN_FFI_VISIT.

botan_mp_set_from_int()

int botan_mp_set_from_int	(	botan_mp_t	mp,
		int	initial_value
	)

Set the MPI value from an int

Definition at line 37 of file ffi_mp.cpp.

   {
   return BOTAN_FFI_VISIT(mp, [=](auto& bn) {
      bn = Botan::BigInt::from_s32(initial_value);
      });
   }

References BOTAN_FFI_VISIT, and Botan::BigInt::from_s32().

botan_mp_set_from_mp()

int botan_mp_set_from_mp	(	botan_mp_t	dest,
		const botan_mp_t	source
	)

Set the MPI value from another MP object

Definition at line 68 of file ffi_mp.cpp.

   {
   return BOTAN_FFI_VISIT(dest, [=](auto& bn) { bn = safe_get(source); });
   }

References BOTAN_FFI_VISIT, and Botan_FFI::safe_get().

botan_mp_set_from_radix_str()

int botan_mp_set_from_radix_str	(	botan_mp_t	dest,
		const char *	str,
		size_t	radix
	)

Set the MPI value from a string with arbitrary radix. For arbitrary being 10 or 16.

Definition at line 49 of file ffi_mp.cpp.

   {
   return BOTAN_FFI_VISIT(mp, [=](auto& bn) {
      Botan::BigInt::Base base;
      if(radix == 10)
         base = Botan::BigInt::Decimal;
      else if(radix == 16)
         base = Botan::BigInt::Hexadecimal;
      else
         return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
 
      const uint8_t* bytes = Botan::cast_char_ptr_to_uint8(str);
      const size_t len = strlen(str);
 
      bn = Botan::BigInt(bytes, len, base);
      return BOTAN_FFI_SUCCESS;
      });
   }

References BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_SUCCESS, BOTAN_FFI_VISIT, Botan::cast_char_ptr_to_uint8(), Botan::BigInt::Decimal, and Botan::BigInt::Hexadecimal.

botan_mp_set_from_str()

int botan_mp_set_from_str	(	botan_mp_t	dest,
		const char *	str
	)

Set the MPI value from a string

Definition at line 44 of file ffi_mp.cpp.

   {
   return BOTAN_FFI_VISIT(mp, [=](auto& bn) { bn = Botan::BigInt(str); });
   }

References BOTAN_FFI_VISIT.

botan_mp_sub()

int botan_mp_sub	(	botan_mp_t	result,
		const botan_mp_t	x,
		const botan_mp_t	y
	)

Definition at line 142 of file ffi_mp.cpp.

   {
   return BOTAN_FFI_VISIT(result, [=](auto& res) {
      if(result == x)
         res -= safe_get(y);
      else
         res = safe_get(x) - safe_get(y);
      });
   }

References BOTAN_FFI_VISIT, Botan_FFI::safe_get(), and y.

botan_mp_sub_u32()

int botan_mp_sub_u32	(	botan_mp_t	result,
		const botan_mp_t	x,
		uint32_t	y
	)

Definition at line 162 of file ffi_mp.cpp.

   {
   return BOTAN_FFI_VISIT(result, [=](auto& res) {
      if(result == x)
         res -= static_cast<Botan::word>(y);
      else
         res = safe_get(x) - static_cast<Botan::word>(y);
      });
   }

References BOTAN_FFI_VISIT, Botan_FFI::safe_get(), and y.

botan_mp_swap()

int botan_mp_swap	(	botan_mp_t	x_w,
		botan_mp_t	y_w
	)

Definition at line 218 of file ffi_mp.cpp.

   {
   return BOTAN_FFI_VISIT(x_w, [=](auto& x) { x.swap(safe_get(y_w)); });
   }

References BOTAN_FFI_VISIT, and Botan_FFI::safe_get().

botan_mp_to_bin()

int botan_mp_to_bin	(	const botan_mp_t	mp,
		uint8_t	vec[]
	)

Definition at line 113 of file ffi_mp.cpp.

   {
   return BOTAN_FFI_VISIT(mp, [=](const auto &bn) { bn.binary_encode(vec); });
   }

References BOTAN_FFI_VISIT.

botan_mp_to_hex()

int botan_mp_to_hex	(	const botan_mp_t	mp,
		char *	out
	)

Convert the MPI to a hex string. Writes botan_mp_num_bytes(mp)*2 + 1 bytes

Definition at line 93 of file ffi_mp.cpp.

   {
   return BOTAN_FFI_VISIT(mp, [=](const auto &bn) {
      const std::string hex = bn.to_hex_string();
      std::memcpy(out, hex.c_str(), 1 + hex.size());
      });
   }

References BOTAN_FFI_VISIT.

botan_mp_to_str()

int botan_mp_to_str	(	const botan_mp_t	mp,
		uint8_t	base,
		char *	out,
		size_t *	out_len
	)

Convert the MPI to a string. Currently base == 10 and base == 16 are supported.

Definition at line 101 of file ffi_mp.cpp.

   {
   return BOTAN_FFI_VISIT(mp, [=](const auto &bn) -> int {
      if(digit_base == 0 || digit_base == 10)
         return write_str_output(out, out_len, bn.to_dec_string());
      else if(digit_base == 16)
         return write_str_output(out, out_len, bn.to_hex_string());
      else
         return BOTAN_FFI_ERROR_BAD_PARAMETER;
      });
   }

References BOTAN_FFI_ERROR_BAD_PARAMETER, BOTAN_FFI_VISIT, and Botan_FFI::write_str_output().

botan_mp_to_uint32()

int botan_mp_to_uint32	(	const botan_mp_t	mp,
		uint32_t *	val
	)

Definition at line 118 of file ffi_mp.cpp.

   {
   if(val == nullptr)
      {
      return BOTAN_FFI_ERROR_NULL_POINTER;
      }
   return BOTAN_FFI_VISIT(mp, [=](const auto &bn) { *val = bn.to_u32bit(); });
   }

References BOTAN_FFI_ERROR_NULL_POINTER, and BOTAN_FFI_VISIT.