ffi_ec.cpp File Reference

#include <botan/ffi.h>
#include <botan/internal/ffi_ec.h>
#include <botan/internal/ffi_mp.h>
#include <botan/internal/ffi_oid.h>
#include <botan/internal/ffi_util.h>
#include <functional>

Go to the source code of this file.

Functions
int	botan_ec_group_destroy (botan_ec_group_t ec_group)
int	botan_ec_group_equal (botan_ec_group_t curve1_w, botan_ec_group_t curve2_w)
int	botan_ec_group_from_ber (botan_ec_group_t *ec_group, const uint8_t *ber, size_t ber_len)
int	botan_ec_group_from_name (botan_ec_group_t *ec_group, const char *name)
int	botan_ec_group_from_oid (botan_ec_group_t *ec_group, botan_asn1_oid_t oid)
int	botan_ec_group_from_params (botan_ec_group_t *ec_group, botan_asn1_oid_t oid, botan_mp_t p, botan_mp_t a, botan_mp_t b, botan_mp_t base_x, botan_mp_t base_y, botan_mp_t order)
int	botan_ec_group_from_pem (botan_ec_group_t *ec_group, const char *pem)
int	botan_ec_group_get_a (botan_mp_t *a, botan_ec_group_t ec_group)
int	botan_ec_group_get_b (botan_mp_t *b, botan_ec_group_t ec_group)
int	botan_ec_group_get_curve_oid (botan_asn1_oid_t *oid, botan_ec_group_t ec_group)
int	botan_ec_group_get_g_x (botan_mp_t *g_x, botan_ec_group_t ec_group)
int	botan_ec_group_get_g_y (botan_mp_t *g_y, botan_ec_group_t ec_group)
int	botan_ec_group_get_order (botan_mp_t *order, botan_ec_group_t ec_group)
int	botan_ec_group_get_p (botan_mp_t *p, botan_ec_group_t ec_group)
int	botan_ec_group_supports_application_specific_group (int *out)
int	botan_ec_group_supports_named_group (const char *name, int *out)
int	botan_ec_group_view_der (botan_ec_group_t ec_group, botan_view_ctx ctx, botan_view_bin_fn view)
int	botan_ec_group_view_pem (botan_ec_group_t ec_group, botan_view_ctx ctx, botan_view_str_fn view)

Function Documentation

botan_ec_group_destroy()

int botan_ec_group_destroy

(

botan_ec_group_t

ec_group

)

Returns

negative number on error, or zero on success

Definition at line 20 of file ffi_ec.cpp.

                                                      {
   return BOTAN_FFI_CHECKED_DELETE(ec_group);
}

References BOTAN_FFI_CHECKED_DELETE.

botan_ec_group_equal()

int botan_ec_group_equal	(	botan_ec_group_t	curve1,
		botan_ec_group_t	curve2 )

Returns

0 if curve1 != curve2

1 if curve1 == curve2

negative number on error

Definition at line 185 of file ffi_ec.cpp.

                                                                               {
   return BOTAN_FFI_VISIT(curve1_w, [=](const auto& curve1) -> int { return curve1 == safe_get(curve2_w); });
}

References BOTAN_FFI_VISIT, and Botan_FFI::safe_get().

botan_ec_group_from_ber()

int botan_ec_group_from_ber	(	botan_ec_group_t *	ec_group,
		const uint8_t *	ber,
		size_t	ber_len )

Decode a BER encoded ECC domain parameter set

Parameters

ec_group	the new object will be placed here
ber	encoding
ber_len	size of the encoding in bytes

Returns

negative number on error, or zero on success

Definition at line 71 of file ffi_ec.cpp.

                                                                                            {
   return ffi_guard_thunk(__func__, [=]() -> int {
      if(ec_group == nullptr || ber == nullptr) {
         return BOTAN_FFI_ERROR_NULL_POINTER;
      }
 
      Botan::EC_Group group(ber, ber_len);
 
      auto group_ptr = std::make_unique<Botan::EC_Group>(std::move(group));
      return ffi_new_object(ec_group, std::move(group_ptr));
   });
}

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

botan_ec_group_from_name()

int botan_ec_group_from_name	(	botan_ec_group_t *	ec_group,
		const char *	name )

Initialize an EC Group from a common group name (eg "secp256r1")

Parameters

ec_group	the new object will be placed here
name	a known group name

Returns

negative number on error, or zero on success

Definition at line 110 of file ffi_ec.cpp.

                                                                           {
   return ffi_guard_thunk(__func__, [=]() -> int {
      if(ec_group == nullptr || name == nullptr) {
         return BOTAN_FFI_ERROR_NULL_POINTER;
      }
 
      Botan::EC_Group group = Botan::EC_Group::from_name(name);
 
      auto group_ptr = std::make_unique<Botan::EC_Group>(std::move(group));
      return ffi_new_object(ec_group, std::move(group_ptr));
   });
}

References BOTAN_FFI_ERROR_NULL_POINTER, Botan_FFI::ffi_guard_thunk(), Botan_FFI::ffi_new_object(), and Botan::EC_Group::from_name().

botan_ec_group_from_oid()

int botan_ec_group_from_oid	(	botan_ec_group_t *	ec_group,
		botan_asn1_oid_t	oid )

Initialize an EC Group from a group named by an object identifier

Parameters

ec_group	the new object will be placed here
oid	a known OID

Returns

negative number on error, or zero on success

Definition at line 97 of file ffi_ec.cpp.

                                                                              {
   return ffi_guard_thunk(__func__, [=]() -> int {
      if(ec_group == nullptr) {
         return BOTAN_FFI_ERROR_NULL_POINTER;
      }
 
      Botan::EC_Group group = Botan::EC_Group::from_OID(safe_get(oid));
 
      auto group_ptr = std::make_unique<Botan::EC_Group>(std::move(group));
      return ffi_new_object(ec_group, std::move(group_ptr));
   });
}

References BOTAN_FFI_ERROR_NULL_POINTER, Botan_FFI::ffi_guard_thunk(), Botan_FFI::ffi_new_object(), Botan::EC_Group::from_OID(), and Botan_FFI::safe_get().

botan_ec_group_from_params()

int botan_ec_group_from_params	(	botan_ec_group_t *	ec_group,
		botan_asn1_oid_t	oid,
		botan_mp_t	p,
		botan_mp_t	a,
		botan_mp_t	b,
		botan_mp_t	base_x,
		botan_mp_t	base_y,
		botan_mp_t	order )

Create a new EC Group from parameters

Warning

use only elliptic curve parameters that you trust

Parameters

ec_group	the new object will be placed here
p	the elliptic curve prime (at most 521 bits)
a	the elliptic curve a param
b	the elliptic curve b param
base_x	the x coordinate of the group generator
base_y	the y coordinate of the group generator
order	the order of the group

Returns

negative number on error, or zero on success

Definition at line 50 of file ffi_ec.cpp.

                                                 {
   return ffi_guard_thunk(__func__, [=]() -> int {
      if(ec_group == nullptr) {
         return BOTAN_FFI_ERROR_NULL_POINTER;
      }
 
      Botan::EC_Group group(
         safe_get(oid), safe_get(p), safe_get(a), safe_get(b), safe_get(base_x), safe_get(base_y), safe_get(order));
 
      auto group_ptr = std::make_unique<Botan::EC_Group>(std::move(group));
      return ffi_new_object(ec_group, std::move(group_ptr));
   });
}

References BOTAN_FFI_ERROR_NULL_POINTER, Botan_FFI::ffi_guard_thunk(), Botan_FFI::ffi_new_object(), and Botan_FFI::safe_get().

botan_ec_group_from_pem()

int botan_ec_group_from_pem	(	botan_ec_group_t *	ec_group,
		const char *	pem )

Initialize an EC Group from the PEM/ASN.1 encoding

Parameters

ec_group	the new object will be placed here
pem	encoding

Returns

negative number on error, or zero on success

Definition at line 84 of file ffi_ec.cpp.

                                                                         {
   return ffi_guard_thunk(__func__, [=]() -> int {
      if(ec_group == nullptr || pem == nullptr) {
         return BOTAN_FFI_ERROR_NULL_POINTER;
      }
 
      Botan::EC_Group group = Botan::EC_Group::from_PEM(pem);
 
      auto group_ptr = std::make_unique<Botan::EC_Group>(std::move(group));
      return ffi_new_object(ec_group, std::move(group_ptr));
   });
}

References BOTAN_FFI_ERROR_NULL_POINTER, Botan_FFI::ffi_guard_thunk(), Botan_FFI::ffi_new_object(), and Botan::EC_Group::from_PEM().

botan_ec_group_get_a()

int botan_ec_group_get_a	(	botan_mp_t *	a,
		botan_ec_group_t	ec_group )

Get the a parameter of the elliptic curve equation

Definition at line 162 of file ffi_ec.cpp.

                                                                   {
   return botan_ec_group_get_component(a, ec_group, [](const auto& g) -> const Botan::BigInt& { return g.get_a(); });
}

botan_ec_group_get_b()

int botan_ec_group_get_b	(	botan_mp_t *	b,
		botan_ec_group_t	ec_group )

Get the b parameter of the elliptic curve equation

Definition at line 166 of file ffi_ec.cpp.

                                                                   {
   return botan_ec_group_get_component(b, ec_group, [](const auto& g) -> const Botan::BigInt& { return g.get_b(); });
}

botan_ec_group_get_curve_oid()

int botan_ec_group_get_curve_oid	(	botan_asn1_oid_t *	oid,
		botan_ec_group_t	ec_group )

Get the curve OID of an EC Group

Definition at line 134 of file ffi_ec.cpp.

                                                                                   {
   return BOTAN_FFI_VISIT(ec_group, [=](const auto& g) -> int {
      if(oid == nullptr) {
         return BOTAN_FFI_ERROR_NULL_POINTER;
      }
      auto oid_ptr = std::make_unique<Botan::OID>(g.get_curve_oid());
      return ffi_new_object(oid, std::move(oid_ptr));
   });
}

References BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_VISIT, and Botan_FFI::ffi_new_object().

botan_ec_group_get_g_x()

int botan_ec_group_get_g_x	(	botan_mp_t *	g_x,
		botan_ec_group_t	ec_group )

Get the x coordinate of the base point

Definition at line 170 of file ffi_ec.cpp.

                                                                       {
   return botan_ec_group_get_component(
      g_x, ec_group, [](const auto& g) -> const Botan::BigInt& { return g.get_g_x(); });
}

botan_ec_group_get_g_y()

int botan_ec_group_get_g_y	(	botan_mp_t *	g_y,
		botan_ec_group_t	ec_group )

Get the y coordinate of the base point

Definition at line 175 of file ffi_ec.cpp.

                                                                       {
   return botan_ec_group_get_component(
      g_y, ec_group, [](const auto& g) -> const Botan::BigInt& { return g.get_g_y(); });
}

botan_ec_group_get_order()

int botan_ec_group_get_order	(	botan_mp_t *	order,
		botan_ec_group_t	ec_group )

Get the order of the base point

Definition at line 180 of file ffi_ec.cpp.

                                                                           {
   return botan_ec_group_get_component(
      order, ec_group, [](const auto& g) -> const Botan::BigInt& { return g.get_order(); });
}

botan_ec_group_get_p()

int botan_ec_group_get_p	(	botan_mp_t *	p,
		botan_ec_group_t	ec_group )

Get the prime modulus of the field

Definition at line 158 of file ffi_ec.cpp.

                                                                   {
   return botan_ec_group_get_component(p, ec_group, [](const auto& g) -> const Botan::BigInt& { return g.get_p(); });
}

botan_ec_group_supports_application_specific_group()

int botan_ec_group_supports_application_specific_group

(

int *

out

)

Checks if in this build configuration it is possible to register an application specific elliptic curve and sets

Parameters

out	to 1 if so, 0 otherwise

Returns

0 on success, a negative value on failure

Definition at line 24 of file ffi_ec.cpp.

                                                                 {
   if(out == nullptr) {
      return BOTAN_FFI_ERROR_NULL_POINTER;
   }
   if(Botan::EC_Group::supports_application_specific_group()) {
      *out = 1;
   } else {
      *out = 0;
   }
   return BOTAN_FFI_SUCCESS;
}

References BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, and Botan::EC_Group::supports_application_specific_group().

botan_ec_group_supports_named_group()

int botan_ec_group_supports_named_group	(	const char *	name,
		int *	out )

Checks if in this build configuration botan_ec_group_from_name(group_ptr, name) will succeed and sets

Parameters

out	to 1 if so, 0 otherwise.

Returns

negative number on error, or zero on success

Definition at line 36 of file ffi_ec.cpp.

                                                                    {
   return ffi_guard_thunk(__func__, [=]() -> int {
      if(name == nullptr || out == nullptr) {
         return BOTAN_FFI_ERROR_NULL_POINTER;
      }
      if(Botan::EC_Group::supports_named_group(name)) {
         *out = 1;
      } else {
         *out = 0;
      }
      return BOTAN_FFI_SUCCESS;
   });
}

References BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, Botan_FFI::ffi_guard_thunk(), and Botan::EC_Group::supports_named_group().

botan_ec_group_view_der()

int botan_ec_group_view_der	(	botan_ec_group_t	ec_group,
		botan_view_ctx	ctx,
		botan_view_bin_fn	view )

View an EC Group in DER encoding

Definition at line 123 of file ffi_ec.cpp.

                                                                                                   {
   return BOTAN_FFI_VISIT(ec_group,
                          [=](const auto& g) -> int { return invoke_view_callback(view, ctx, g.DER_encode()); });
}

References BOTAN_FFI_VISIT, and Botan_FFI::invoke_view_callback().

botan_ec_group_view_pem()

int botan_ec_group_view_pem	(	botan_ec_group_t	ec_group,
		botan_view_ctx	ctx,
		botan_view_str_fn	view )

View an EC Group in PEM encoding

Definition at line 128 of file ffi_ec.cpp.

                                                                                                   {
   return BOTAN_FFI_VISIT(ec_group, [=](const auto& g) -> int {
      return invoke_view_callback(view, ctx, g.PEM_encode(Botan::EC_Group_Encoding::NamedCurve));
   });
}

References BOTAN_FFI_VISIT, Botan_FFI::invoke_view_callback(), and Botan::NamedCurve.