#include <curve_gfp.h>

Public Member Functions
bool	a_is_minus_3 () const

bool	a_is_zero () const

	CurveGFp ()=default

	CurveGFp (const BigInt &p, const BigInt &a, const BigInt &b)

	CurveGFp (const CurveGFp &)=default

void	from_rep (BigInt &x, secure_vector< word > &ws) const

BigInt	from_rep (const BigInt &x, secure_vector< word > &ws) const

const BigInt &	get_1_rep () const

const BigInt &	get_a () const

const BigInt &	get_a_rep () const

const BigInt &	get_b () const

const BigInt &	get_b_rep () const

const BigInt &	get_p () const

size_t	get_p_words () const

size_t	get_ws_size () const

BigInt	invert_element (const BigInt &x, secure_vector< word > &ws) const

bool	is_one (const BigInt &x) const

void	mul (BigInt &z, const BigInt &x, const BigInt &y, secure_vector< word > &ws) const

void	mul (BigInt &z, const word x_w[], size_t x_size, const BigInt &y, secure_vector< word > &ws) const

BigInt	mul (const BigInt &x, const BigInt &y, secure_vector< word > &ws) const

BigInt	mul_to_tmp (const BigInt &x, const BigInt &y, secure_vector< word > &ws) const

CurveGFp &	operator= (const CurveGFp &)=default

bool	operator== (const CurveGFp &other) const

void	redc_mod_p (BigInt &z, secure_vector< word > &ws) const

void	sqr (BigInt &z, const BigInt &x, secure_vector< word > &ws) const

void	sqr (BigInt &z, const word x_w[], size_t x_size, secure_vector< word > &ws) const

BigInt	sqr (const BigInt &x, secure_vector< word > &ws) const

BigInt	sqr_to_tmp (const BigInt &x, secure_vector< word > &ws) const

void	swap (CurveGFp &other)

void	to_rep (BigInt &x, secure_vector< word > &ws) const

Detailed Description

This class represents an elliptic curve over GF(p)

There should not be any reason for applications to use this type. If you need EC primitives use the interfaces EC_Group and PointGFp

It is likely this class will be removed entirely in a future major release.

Definition at line 95 of file curve_gfp.h.

Constructor & Destructor Documentation

◆ CurveGFp() [1/3]

Botan::CurveGFp::CurveGFp ( )

default

Create an uninitialized CurveGFp

◆ CurveGFp() [2/3]

Botan::CurveGFp::CurveGFp	(	const BigInt &	p,
		const BigInt &	a,
		const BigInt &	b
	)

inline

Construct the elliptic curve E: y^2 = x^3 + ax + b over GF(p)

Parameters

p	prime number of the field
a	first coefficient
b	second coefficient

Definition at line 110 of file curve_gfp.h.

                                                                   :
          m_repr(choose_repr(p, a, b))
          {
          }

◆ CurveGFp() [3/3]

Botan::CurveGFp::CurveGFp ( const CurveGFp & )

default

Member Function Documentation

◆ a_is_minus_3()

bool Botan::CurveGFp::a_is_minus_3 ( ) const

inline

Definition at line 145 of file curve_gfp.h.

Referenced by Botan::PointGFp::mult2().

145 { return m_repr->a_is_minus_3(); }

◆ a_is_zero()

bool Botan::CurveGFp::a_is_zero ( ) const

inline

Definition at line 146 of file curve_gfp.h.

Referenced by Botan::PointGFp::mult2().

146 { return m_repr->a_is_zero(); }

◆ from_rep() [1/2]

void Botan::CurveGFp::from_rep	(	BigInt &	x,
		secure_vector< word > &	ws
	)		const

inline

Definition at line 160 of file curve_gfp.h.

Referenced by Botan::PointGFp::get_affine_x(), Botan::PointGFp::get_affine_y(), and Botan::PointGFp::on_the_curve().

          {
          m_repr->from_curve_rep(x, ws);
          }

◆ from_rep() [2/2]

BigInt Botan::CurveGFp::from_rep	(	const BigInt &	x,
		secure_vector< word > &	ws
	)		const

inline

Definition at line 165 of file curve_gfp.h.

          {
          BigInt xt(x);
          m_repr->from_curve_rep(xt, ws);
          return xt;
          }

◆ get_1_rep()

const BigInt& Botan::CurveGFp::get_1_rep ( ) const

inline

Definition at line 143 of file curve_gfp.h.

Referenced by Botan::PointGFp::add(), Botan::PointGFp::add_affine(), Botan::PointGFp::force_affine(), and Botan::PointGFp::force_all_affine().

143 { return m_repr->get_1_rep(); }

◆ get_a()

const BigInt& Botan::CurveGFp::get_a ( ) const

inline

Returns: curve coefficient a

Definition at line 122 of file curve_gfp.h.

Referenced by operator==(), and Botan::OS2ECP().

122 { return m_repr->get_a(); }

◆ get_a_rep()

const BigInt& Botan::CurveGFp::get_a_rep ( ) const

inline

Definition at line 139 of file curve_gfp.h.

Referenced by Botan::PointGFp::mult2(), and Botan::PointGFp::on_the_curve().

139 { return m_repr->get_a_rep(); }

◆ get_b()

const BigInt& Botan::CurveGFp::get_b ( ) const

inline

Returns: curve coefficient b

Definition at line 127 of file curve_gfp.h.

Referenced by operator==(), and Botan::OS2ECP().

127 { return m_repr->get_b(); }

◆ get_b_rep()

const BigInt& Botan::CurveGFp::get_b_rep ( ) const

inline

Definition at line 141 of file curve_gfp.h.

Referenced by Botan::PointGFp::on_the_curve().

141 { return m_repr->get_b_rep(); }

◆ get_p()

const BigInt& Botan::CurveGFp::get_p ( ) const

inline

Get prime modulus of the field of the curve

Returns: prime modulus of the field of the curve

Definition at line 133 of file curve_gfp.h.

Referenced by Botan::PointGFp::add(), Botan::PointGFp::add_affine(), Botan::PointGFp::encode(), Botan::PointGFp::mult2(), operator==(), Botan::OS2ECP(), Botan::PointGFp::PointGFp(), and Botan::PointGFp::randomize_repr().

133 { return m_repr->get_p(); }

◆ get_p_words()

size_t Botan::CurveGFp::get_p_words ( ) const

inline

Definition at line 135 of file curve_gfp.h.

135 { return m_repr->get_p_words(); }

◆ get_ws_size()

size_t Botan::CurveGFp::get_ws_size ( ) const

inline

Definition at line 137 of file curve_gfp.h.

Referenced by Botan::PointGFp::add(), Botan::PointGFp::add_affine(), Botan::PointGFp::force_all_affine(), Botan::PointGFp::mult2(), Botan::PointGFp::PointGFp(), and Botan::PointGFp::randomize_repr().

137 { return m_repr->get_ws_size(); }

◆ invert_element()

BigInt Botan::CurveGFp::invert_element	(	const BigInt &	x,
		secure_vector< word > &	ws
	)		const

inline

Definition at line 150 of file curve_gfp.h.

Referenced by Botan::PointGFp::force_affine(), Botan::PointGFp::force_all_affine(), Botan::PointGFp::get_affine_x(), and Botan::PointGFp::get_affine_y().

          {
          return m_repr->invert_element(x, ws);
          }

◆ is_one()

bool Botan::CurveGFp::is_one ( const BigInt & x ) const

inline

Definition at line 148 of file curve_gfp.h.

Referenced by Botan::PointGFp::is_affine().

148 { return m_repr->is_one(x); }

◆ mul() [1/3]

void Botan::CurveGFp::mul	(	BigInt &	z,
		const BigInt &	x,
		const BigInt &	y,
		secure_vector< word > &	ws
	)		const

inline

Definition at line 179 of file curve_gfp.h.

Referenced by Botan::PointGFp::add(), Botan::PointGFp::add_affine(), Botan::PointGFp::force_all_affine(), Botan::PointGFp::get_affine_x(), Botan::PointGFp::get_affine_y(), and Botan::PointGFp::mult2().

          {
          m_repr->curve_mul(z, x, y, ws);
          }

◆ mul() [2/3]

void Botan::CurveGFp::mul	(	BigInt &	z,
		const word	x_w[],
		size_t	x_size,
		const BigInt &	y,
		secure_vector< word > &	ws
	)		const

inline

Definition at line 184 of file curve_gfp.h.

          {
          m_repr->curve_mul_words(z, x_w, x_size, y, ws);
          }

◆ mul() [3/3]

BigInt Botan::CurveGFp::mul	(	const BigInt &	x,
		const BigInt &	y,
		secure_vector< word > &	ws
	)		const

inline

Definition at line 200 of file curve_gfp.h.

          {
          return mul_to_tmp(x, y, ws);
          }

◆ mul_to_tmp()

BigInt Botan::CurveGFp::mul_to_tmp	(	const BigInt &	x,
		const BigInt &	y,
		secure_vector< word > &	ws
	)		const

inline

Definition at line 210 of file curve_gfp.h.

Referenced by Botan::PointGFp::force_affine(), Botan::PointGFp::force_all_affine(), Botan::PointGFp::get_affine_y(), Botan::PointGFp::on_the_curve(), and Botan::PointGFp::randomize_repr().

          {
          BigInt z;
          m_repr->curve_mul(z, x, y, ws);
          return z;
          }

◆ operator=()

CurveGFp& Botan::CurveGFp::operator= ( const CurveGFp & )

default

◆ operator==()

bool Botan::CurveGFp::operator== ( const CurveGFp & other ) const

inline

Equality operator

Parameters

other a curve

Returns: true iff *this is the same as other

Definition at line 234 of file curve_gfp.h.

References get_a(), get_b(), and get_p().

          {
          if(m_repr.get() == other.m_repr.get())
             return true;
 
          return (get_p() == other.get_p()) &&
                 (get_a() == other.get_a()) &&
                 (get_b() == other.get_b());
          }

◆ redc_mod_p()

void Botan::CurveGFp::redc_mod_p	(	BigInt &	z,
		secure_vector< word > &	ws
	)		const

inline

Definition at line 174 of file curve_gfp.h.

Referenced by Botan::PointGFp::mult2().

          {
          m_repr->redc_mod_p(z, ws);
          }

◆ sqr() [1/3]

void Botan::CurveGFp::sqr	(	BigInt &	z,
		const BigInt &	x,
		secure_vector< word > &	ws
	)		const

inline

Definition at line 190 of file curve_gfp.h.

Referenced by Botan::PointGFp::add(), Botan::PointGFp::add_affine(), Botan::PointGFp::force_all_affine(), and Botan::PointGFp::mult2().

          {
          m_repr->curve_sqr(z, x, ws);
          }

◆ sqr() [2/3]

void Botan::CurveGFp::sqr	(	BigInt &	z,
		const word	x_w[],
		size_t	x_size,
		secure_vector< word > &	ws
	)		const

inline

Definition at line 195 of file curve_gfp.h.

          {
          m_repr->curve_sqr_words(z, x_w, x_size, ws);
          }

◆ sqr() [3/3]

BigInt Botan::CurveGFp::sqr	(	const BigInt &	x,
		secure_vector< word > &	ws
	)		const

inline

Definition at line 205 of file curve_gfp.h.

          {
          return sqr_to_tmp(x, ws);
          }

◆ sqr_to_tmp()

BigInt Botan::CurveGFp::sqr_to_tmp	(	const BigInt &	x,
		secure_vector< word > &	ws
	)		const

inline

Definition at line 217 of file curve_gfp.h.

Referenced by Botan::PointGFp::force_affine(), Botan::PointGFp::get_affine_x(), Botan::PointGFp::get_affine_y(), Botan::PointGFp::on_the_curve(), and Botan::PointGFp::randomize_repr().

          {
          BigInt z;
          m_repr->curve_sqr(z, x, ws);
          return z;
          }

◆ swap()

void Botan::CurveGFp::swap ( CurveGFp & other )

inline

Definition at line 224 of file curve_gfp.h.

Referenced by Botan::PointGFp::swap().

          {
          std::swap(m_repr, other.m_repr);
          }

◆ to_rep()

void Botan::CurveGFp::to_rep	(	BigInt &	x,
		secure_vector< word > &	ws
	)		const

inline

Definition at line 155 of file curve_gfp.h.

Referenced by Botan::PointGFp::PointGFp().

          {
          m_repr->to_curve_rep(x, ws);
          }

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

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

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ CurveGFp() [1/3]

◆ CurveGFp() [2/3]

◆ CurveGFp() [3/3]

Member Function Documentation

◆ a_is_minus_3()

◆ a_is_zero()

◆ from_rep() [1/2]

◆ from_rep() [2/2]

◆ get_1_rep()

◆ get_a()

◆ get_a_rep()

◆ get_b()

◆ get_b_rep()

◆ get_p()

◆ get_p_words()

◆ get_ws_size()

◆ invert_element()

◆ is_one()

◆ mul() [1/3]

◆ mul() [2/3]

◆ mul() [3/3]

◆ mul_to_tmp()

◆ operator=()

◆ operator==()

◆ redc_mod_p()

◆ sqr() [1/3]

◆ sqr() [2/3]

◆ sqr() [3/3]

◆ sqr_to_tmp()

◆ swap()

◆ to_rep()