#include <ec_apoint.h>

Public Member Functions
const std::shared_ptr< const EC_Group_Data > &	_group () const

const EC_AffinePoint_Data &	_inner () const

	EC_AffinePoint (const EC_AffinePoint &other)

	EC_AffinePoint (const EC_Group &group, const EC_Point &pt)

	EC_AffinePoint (const EC_Group &group, std::span< const uint8_t > bytes)

	EC_AffinePoint (EC_AffinePoint &&other) noexcept

size_t	field_element_bytes () const

bool	is_identity () const
	Return true if this point is the identity element.

EC_AffinePoint	mul (const EC_Scalar &scalar, RandomNumberGenerator &rng, std::vector< BigInt > &ws) const

EC_AffinePoint &	operator= (const EC_AffinePoint &other)

EC_AffinePoint &	operator= (EC_AffinePoint &&other) noexcept

template<concepts::resizable_byte_buffer T = std::vector<uint8_t>>
T	serialize_compressed () const

void	serialize_compressed_to (std::span< uint8_t > bytes) const

template<concepts::resizable_byte_buffer T = std::vector<uint8_t>>
T	serialize_uncompressed () const

void	serialize_uncompressed_to (std::span< uint8_t > bytes) const

void	serialize_x_to (std::span< uint8_t > bytes) const

void	serialize_xy_to (std::span< uint8_t > bytes) const

void	serialize_y_to (std::span< uint8_t > bytes) const

EC_Point	to_legacy_point () const

template<concepts::resizable_byte_buffer T = secure_vector<uint8_t>>
T	x_bytes () const

template<concepts::resizable_byte_buffer T = secure_vector<uint8_t>>
T	xy_bytes () const

template<concepts::resizable_byte_buffer T = secure_vector<uint8_t>>
T	y_bytes () const

	~EC_AffinePoint ()

Static Public Member Functions
static EC_AffinePoint	_from_inner (std::unique_ptr< EC_AffinePoint_Data > inner)

static std::optional< EC_AffinePoint >	deserialize (const EC_Group &group, std::span< const uint8_t > bytes)

static std::optional< EC_AffinePoint >	from_bigint_xy (const EC_Group &group, const BigInt &x, const BigInt &y)

static EC_AffinePoint	g_mul (const EC_Scalar &scalar, RandomNumberGenerator &rng, std::vector< BigInt > &ws)

static EC_AffinePoint	generator (const EC_Group &group)
	Return the standard group generator.

static EC_AffinePoint	hash_to_curve_nu (const EC_Group &group, std::string_view hash_fn, std::span< const uint8_t > input, std::span< const uint8_t > domain_sep)

static EC_AffinePoint	hash_to_curve_ro (const EC_Group &group, std::string_view hash_fn, std::span< const uint8_t > input, std::span< const uint8_t > domain_sep)

static EC_AffinePoint	identity (const EC_Group &group)
	Return the identity element.

Friends
class	EC_Mul2Table

Detailed Description

Definition at line 29 of file ec_apoint.h.

Constructor & Destructor Documentation

◆ EC_AffinePoint() [1/4]

Botan::EC_AffinePoint::EC_AffinePoint	(	const EC_Group &	group,
		std::span< const uint8_t >	bytes )

Point deserialization. Throws if wrong length or not a valid point

This accepts SEC1 compressed or uncompressed formats

Definition at line 35 of file ec_apoint.cpp.

                                                                                  {
   m_point = group._data()->point_deserialize(bytes);
   if(!m_point) {
      throw Decoding_Error("Failed to deserialize elliptic curve point");
   }
}

References Botan::EC_Group::_data().

Referenced by _from_inner(), deserialize(), g_mul(), generator(), hash_to_curve_nu(), hash_to_curve_ro(), identity(), and mul().

◆ EC_AffinePoint() [2/4]

Botan::EC_AffinePoint::EC_AffinePoint ( const EC_AffinePoint & other )

Definition at line 19 of file ec_apoint.cpp.

19: m_point(other.inner().clone()) {}

◆ EC_AffinePoint() [3/4]

Botan::EC_AffinePoint::EC_AffinePoint ( EC_AffinePoint && other )

noexcept

Definition at line 21 of file ec_apoint.cpp.

21: m_point(std::move(other.m_point)) {}

◆ EC_AffinePoint() [4/4]

Botan::EC_AffinePoint::EC_AffinePoint	(	const EC_Group &	group,
		const EC_Point &	pt )

Deprecated conversion

Definition at line 42 of file ec_apoint.cpp.

42 :

43 EC_AffinePoint(group, pt.encode(EC_Point_Format::Uncompressed)) {}

Botan::EC_AffinePoint::EC_AffinePoint

EC_AffinePoint(const EC_Group &group, std::span< const uint8_t > bytes)

Definition ec_apoint.cpp:35

Botan::EC_Point_Format::Uncompressed

@ Uncompressed

◆ ~EC_AffinePoint()

Botan::EC_AffinePoint::~EC_AffinePoint ( )

default

Member Function Documentation

◆ _from_inner()

EC_AffinePoint Botan::EC_AffinePoint::_from_inner ( std::unique_ptr< EC_AffinePoint_Data > inner )

static

Definition at line 143 of file ec_apoint.cpp.

                                                                                   {
   return EC_AffinePoint(std::move(inner));
}

References EC_AffinePoint().

Referenced by Botan::EC_Group::Mul2Table::mul2_vartime().

◆ _group()

const std::shared_ptr< const EC_Group_Data > & Botan::EC_AffinePoint::_group ( ) const

Definition at line 147 of file ec_apoint.cpp.

                                                                       {
   return inner().group();
}

References Botan::EC_AffinePoint_Data::group().

◆ _inner()

const EC_AffinePoint_Data & Botan::EC_AffinePoint::_inner ( ) const

inline

Definition at line 190 of file ec_apoint.h.

190{ return inner(); }

◆ deserialize()

std::optional< EC_AffinePoint > Botan::EC_AffinePoint::deserialize	(	const EC_Group &	group,
		std::span< const uint8_t >	bytes )

static

Point deserialization. Returns nullopt if wrong length or not a valid point

This accepts SEC1 compressed or uncompressed formats

Definition at line 97 of file ec_apoint.cpp.

                                                                                                           {
   if(auto pt = group._data()->point_deserialize(bytes)) {
      return EC_AffinePoint(std::move(pt));
   } else {
      return {};
   }
}

References Botan::EC_Group::_data(), and EC_AffinePoint().

Referenced by from_bigint_xy().

◆ field_element_bytes()

size_t Botan::EC_AffinePoint::field_element_bytes ( ) const

Return the number of bytes of a field element

A point consists of two field elements, plus possibly a header

Definition at line 71 of file ec_apoint.cpp.

                                                 {
   return inner().field_element_bytes();
}

References Botan::EC_AffinePoint_Data::field_element_bytes().

◆ from_bigint_xy()

std::optional< EC_AffinePoint > Botan::EC_AffinePoint::from_bigint_xy	(	const EC_Group &	group,
		const BigInt &	x,
		const BigInt &	y )

static

Create a point from a pair (x,y) of integers

The integers must be within the field - in the range [0,p) and must satisfy the curve equation

Definition at line 54 of file ec_apoint.cpp.

                                                                                                                  {
   if(x.is_negative() || x >= group.get_p()) {
      return {};
   }
   if(y.is_negative() || y >= group.get_p()) {
      return {};
   }
 
   const size_t fe_bytes = group.get_p_bytes();
   std::vector<uint8_t> sec1(1 + 2 * fe_bytes);
   sec1[0] = 0x04;
   x.serialize_to(std::span{sec1}.subspan(1, fe_bytes));
   y.serialize_to(std::span{sec1}.last(fe_bytes));
 
   return EC_AffinePoint::deserialize(group, sec1);
}

References deserialize(), Botan::EC_Group::get_p(), Botan::EC_Group::get_p_bytes(), Botan::BigInt::is_negative(), and Botan::BigInt::serialize_to().

◆ g_mul()

EC_AffinePoint Botan::EC_AffinePoint::g_mul	(	const EC_Scalar &	scalar,
		RandomNumberGenerator &	rng,
		std::vector< BigInt > &	ws )

static

Multiply by the group generator returning a complete point

Workspace argument is transitional

Definition at line 105 of file ec_apoint.cpp.

                                                                                                               {
   auto pt = scalar._inner().group()->point_g_mul(scalar.inner(), rng, ws);
   return EC_AffinePoint(std::move(pt));
}

References Botan::EC_Scalar::_inner(), EC_AffinePoint(), and Botan::EC_Scalar_Data::group().

Referenced by Botan::EC_PrivateKey_Data::public_key().

◆ generator()

EC_AffinePoint Botan::EC_AffinePoint::generator ( const EC_Group & group )

static

Return the standard group generator.

Definition at line 50 of file ec_apoint.cpp.

                                                              {
   return EC_AffinePoint(group, group.get_base_point());
}

References EC_AffinePoint(), and Botan::EC_Group::get_base_point().

◆ hash_to_curve_nu()

EC_AffinePoint Botan::EC_AffinePoint::hash_to_curve_nu	(	const EC_Group &	group,
		std::string_view	hash_fn,
		std::span< const uint8_t >	input,
		std::span< const uint8_t >	domain_sep )

static

Hash to curve (RFC 9380), non uniform variant

Only supported for specific groups

Definition at line 87 of file ec_apoint.cpp.

                                                                                   {
   auto pt = group._data()->point_hash_to_curve_nu(hash_fn, input, domain_sep);
   return EC_AffinePoint(std::move(pt));
}

References Botan::EC_Group::_data(), and EC_AffinePoint().

◆ hash_to_curve_ro()

EC_AffinePoint Botan::EC_AffinePoint::hash_to_curve_ro	(	const EC_Group &	group,
		std::string_view	hash_fn,
		std::span< const uint8_t >	input,
		std::span< const uint8_t >	domain_sep )

static

Hash to curve (RFC 9380), random oracle variant

Only supported for specific groups

Definition at line 79 of file ec_apoint.cpp.

                                                                                   {
   auto pt = group._data()->point_hash_to_curve_ro(hash_fn, input, domain_sep);
   return EC_AffinePoint(std::move(pt));
}

References Botan::EC_Group::_data(), and EC_AffinePoint().

◆ identity()

EC_AffinePoint Botan::EC_AffinePoint::identity ( const EC_Group & group )

static

Return the identity element.

Definition at line 45 of file ec_apoint.cpp.

                                                             {
   const uint8_t id_encoding[1] = {0};
   return EC_AffinePoint(group, id_encoding);
}

References EC_AffinePoint().

◆ is_identity()

bool Botan::EC_AffinePoint::is_identity ( ) const

Return true if this point is the identity element.

Definition at line 75 of file ec_apoint.cpp.

                                       {
   return inner().is_identity();
}

References Botan::EC_AffinePoint_Data::is_identity().

Referenced by serialize_compressed_to(), serialize_uncompressed_to(), serialize_x_to(), serialize_xy_to(), and serialize_y_to().

◆ mul()

EC_AffinePoint Botan::EC_AffinePoint::mul	(	const EC_Scalar &	scalar,
		RandomNumberGenerator &	rng,
		std::vector< BigInt > &	ws ) const

Multiply a point by a scalar returning a complete point

Workspace argument is transitional

Definition at line 110 of file ec_apoint.cpp.

                                                                                                                   {
   return EC_AffinePoint(inner().mul(scalar._inner(), rng, ws));
}

References Botan::EC_Scalar::_inner(), EC_AffinePoint(), and mul().

Referenced by mul().

◆ operator=() [1/2]

EC_AffinePoint & Botan::EC_AffinePoint::operator= ( const EC_AffinePoint & other )

Definition at line 23 of file ec_apoint.cpp.

                                                                     {
   if(this != &other) {
      m_point = other.inner().clone();
   }
   return (*this);
}

References Botan::EC_AffinePoint_Data::clone().

◆ operator=() [2/2]

EC_AffinePoint & Botan::EC_AffinePoint::operator= ( EC_AffinePoint && other )

noexcept

Definition at line 30 of file ec_apoint.cpp.

                                                                         {
   m_point.swap(other.m_point);
   return (*this);
}

◆ serialize_compressed()

template<concepts::resizable_byte_buffer T = std::vector<uint8_t>>

T Botan::EC_AffinePoint::serialize_compressed ( ) const

inline

Return the bytes of the affine x and y coordinates in a container

This function will fail if this point is the identity element

Definition at line 166 of file ec_apoint.h.

                                     {
         T bytes(1 + this->field_element_bytes());
         this->serialize_compressed_to(bytes);
         return bytes;
      }

References T.

◆ serialize_compressed_to()

void Botan::EC_AffinePoint::serialize_compressed_to ( std::span< uint8_t > bytes ) const

Write the fixed length SEC1 compressed encoding

The output span must be exactly 1 + field_element_bytes long

This function will fail if this point is the identity element

Definition at line 129 of file ec_apoint.cpp.

                                                                         {
   BOTAN_STATE_CHECK(!this->is_identity());
   m_point->serialize_compressed_to(bytes);
}

References BOTAN_STATE_CHECK, and is_identity().

◆ serialize_uncompressed()

template<concepts::resizable_byte_buffer T = std::vector<uint8_t>>

T Botan::EC_AffinePoint::serialize_uncompressed ( ) const

inline

Return the bytes of the affine x and y coordinates in a container

This function will fail if this point is the identity element

Definition at line 156 of file ec_apoint.h.

                                       {
         T bytes(1 + 2 * this->field_element_bytes());
         this->serialize_uncompressed_to(bytes);
         return bytes;
      }

References T.

◆ serialize_uncompressed_to()

void Botan::EC_AffinePoint::serialize_uncompressed_to ( std::span< uint8_t > bytes ) const

Return the fixed length encoding of SEC1 uncompressed encoding

The output span must be exactly 1 + 2*field_element_bytes long

This function will fail if this point is the identity element

Definition at line 134 of file ec_apoint.cpp.

                                                                           {
   BOTAN_STATE_CHECK(!this->is_identity());
   m_point->serialize_uncompressed_to(bytes);
}

References BOTAN_STATE_CHECK, and is_identity().

◆ serialize_x_to()

void Botan::EC_AffinePoint::serialize_x_to ( std::span< uint8_t > bytes ) const

Write the fixed length encoding of affine x coordinate

The output span must be exactly field_element_bytes long

This function will fail if this point is the identity element

Definition at line 114 of file ec_apoint.cpp.

                                                                {
   BOTAN_STATE_CHECK(!this->is_identity());
   m_point->serialize_x_to(bytes);
}

References BOTAN_STATE_CHECK, and is_identity().

◆ serialize_xy_to()

void Botan::EC_AffinePoint::serialize_xy_to ( std::span< uint8_t > bytes ) const

Write the fixed length encoding of affine x and y coordinates

The output span must be exactly 2*field_element_bytes long

This function will fail if this point is the identity element

Definition at line 124 of file ec_apoint.cpp.

                                                                 {
   BOTAN_STATE_CHECK(!this->is_identity());
   m_point->serialize_xy_to(bytes);
}

References BOTAN_STATE_CHECK, and is_identity().

◆ serialize_y_to()

void Botan::EC_AffinePoint::serialize_y_to ( std::span< uint8_t > bytes ) const

Write the fixed length encoding of affine y coordinate

The output span must be exactly field_element_bytes long

This function will fail if this point is the identity element

Definition at line 119 of file ec_apoint.cpp.

                                                                {
   BOTAN_STATE_CHECK(!this->is_identity());
   m_point->serialize_y_to(bytes);
}

References BOTAN_STATE_CHECK, and is_identity().

◆ to_legacy_point()

EC_Point Botan::EC_AffinePoint::to_legacy_point ( ) const

Deprecated conversion

Definition at line 139 of file ec_apoint.cpp.

                                               {
   return m_point->to_legacy_point();
}

Referenced by Botan::EC_Group::OS2ECP().

◆ x_bytes()

template<concepts::resizable_byte_buffer T = secure_vector<uint8_t>>

T Botan::EC_AffinePoint::x_bytes ( ) const

inline

Return the bytes of the affine x coordinate in a container

This function will fail if this point is the identity element

Definition at line 126 of file ec_apoint.h.

                        {
         T bytes(this->field_element_bytes());
         this->serialize_x_to(bytes);
         return bytes;
      }

References T.

◆ xy_bytes()

template<concepts::resizable_byte_buffer T = secure_vector<uint8_t>>

T Botan::EC_AffinePoint::xy_bytes ( ) const

inline

Return the bytes of the affine x and y coordinates in a container

This function will fail if this point is the identity element

Definition at line 146 of file ec_apoint.h.

                         {
         T bytes(2 * this->field_element_bytes());
         this->serialize_xy_to(bytes);
         return bytes;
      }

References T.

◆ y_bytes()

template<concepts::resizable_byte_buffer T = secure_vector<uint8_t>>

T Botan::EC_AffinePoint::y_bytes ( ) const

inline

Return the bytes of the affine y coordinate in a container

This function will fail if this point is the identity element

Definition at line 136 of file ec_apoint.h.

                        {
         T bytes(this->field_element_bytes());
         this->serialize_y_to(bytes);
         return bytes;
      }

References T.

Friends And Related Symbol Documentation

◆ EC_Mul2Table

friend class EC_Mul2Table

friend

Definition at line 197 of file ec_apoint.h.

The documentation for this class was generated from the following files:

src/lib/pubkey/ec_group/ec_apoint.h
src/lib/pubkey/ec_group/ec_apoint.cpp

Public Member Functions

Static Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ EC_AffinePoint() [1/4]

◆ EC_AffinePoint() [2/4]

◆ EC_AffinePoint() [3/4]

◆ EC_AffinePoint() [4/4]

◆ ~EC_AffinePoint()

Member Function Documentation

◆ _from_inner()

◆ _group()

◆ _inner()

◆ deserialize()

◆ field_element_bytes()

◆ from_bigint_xy()

◆ g_mul()

◆ generator()

◆ hash_to_curve_nu()

◆ hash_to_curve_ro()

◆ identity()

◆ is_identity()

◆ mul()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ serialize_compressed()

◆ serialize_compressed_to()

◆ serialize_uncompressed()

◆ serialize_uncompressed_to()

◆ serialize_x_to()

◆ serialize_xy_to()

◆ serialize_y_to()

◆ to_legacy_point()

◆ x_bytes()

◆ xy_bytes()

◆ y_bytes()

Friends And Related Symbol Documentation

◆ EC_Mul2Table