Botan::EC_PrivateKey_Data Class Reference

#include <ec_key_data.h>

Public Member Functions
	EC_PrivateKey_Data (const EC_Group &group, std::span< const uint8_t > bytes)
	EC_PrivateKey_Data (const EC_PrivateKey_Data &)=default
	EC_PrivateKey_Data (EC_Group group, EC_Scalar x)
	EC_PrivateKey_Data (EC_PrivateKey_Data &&)=default
const EC_Group &	group () const
const BigInt &	legacy_bigint () const
EC_PrivateKey_Data &	operator= (const EC_PrivateKey_Data &)=default
EC_PrivateKey_Data &	operator= (EC_PrivateKey_Data &&)=default
const EC_Scalar &	private_key () const
std::shared_ptr< EC_PublicKey_Data >	public_key (bool with_modular_inverse) const
std::shared_ptr< EC_PublicKey_Data >	public_key (RandomNumberGenerator &rng, bool with_modular_inverse) const
template<typename T >
T	serialize () const
void	serialize_to (std::span< uint8_t > output) const
	~EC_PrivateKey_Data ()

Detailed Description

Definition at line 47 of file ec_key_data.h.

Constructor & Destructor Documentation

EC_PrivateKey_Data() [1/4]

Botan::EC_PrivateKey_Data::EC_PrivateKey_Data	(	EC_Group	group,
		EC_Scalar	x )

Definition at line 25 of file ec_key_data.cpp.

                                                                  :
      m_group(std::move(group)), m_scalar(std::move(x)), m_legacy_x(m_scalar.to_bigint()) {
   // Checking that the scalar is lower than the group order is ensured in the
   // deserialization of the EC_Scalar or during the random generation respectively.
   BOTAN_ARG_CHECK(m_scalar.is_nonzero(), "ECC private key cannot be zero");
}

References BOTAN_ARG_CHECK, and Botan::EC_Scalar::is_nonzero().

EC_PrivateKey_Data() [2/4]

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

Definition at line 61 of file ec_key_data.cpp.

                                                                                          :
      Botan::EC_PrivateKey_Data(group, decode_ec_secret_key_scalar(group, bytes)) {}

EC_PrivateKey_Data() [3/4]

Botan::EC_PrivateKey_Data::EC_PrivateKey_Data ( const EC_PrivateKey_Data & )

default

EC_PrivateKey_Data() [4/4]

Botan::EC_PrivateKey_Data::EC_PrivateKey_Data ( EC_PrivateKey_Data && )

default

~EC_PrivateKey_Data()

Botan::EC_PrivateKey_Data::~EC_PrivateKey_Data

(

)

Definition at line 64 of file ec_key_data.cpp.

                                        {
   m_scalar.zeroize();
}

References Botan::EC_Scalar::zeroize().

Member Function Documentation

group()

const EC_Group & Botan::EC_PrivateKey_Data::group ( ) const

inline

Definition at line 72 of file ec_key_data.h.

{ return m_group; }

Referenced by serialize().

legacy_bigint()

const BigInt & Botan::EC_PrivateKey_Data::legacy_bigint ( ) const

inline

Definition at line 76 of file ec_key_data.h.

{ return m_legacy_x; }

operator=() [1/2]

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

default

operator=() [2/2]

EC_PrivateKey_Data & Botan::EC_PrivateKey_Data::operator= ( EC_PrivateKey_Data && )

default

private_key()

const EC_Scalar & Botan::EC_PrivateKey_Data::private_key ( ) const

inline

Definition at line 74 of file ec_key_data.h.

{ return m_scalar; }

public_key() [1/2]

std::shared_ptr< EC_PublicKey_Data > Botan::EC_PrivateKey_Data::public_key

(

bool

with_modular_inverse

)

const

Definition at line 81 of file ec_key_data.cpp.

                                                                                               {
   Null_RNG null_rng;
   return this->public_key(null_rng, with_modular_inverse);
}

References public_key().

public_key() [2/2]

std::shared_ptr< EC_PublicKey_Data > Botan::EC_PrivateKey_Data::public_key	(	RandomNumberGenerator &	rng,
		bool	with_modular_inverse ) const

Definition at line 68 of file ec_key_data.cpp.

                                                                                                   {
   auto public_point = [&] {
      if(with_modular_inverse) {
         return EC_AffinePoint::g_mul(m_scalar.invert(), rng);
      } else {
         return EC_AffinePoint::g_mul(m_scalar, rng);
      }
   };
 
   return std::make_shared<EC_PublicKey_Data>(m_group, public_point());
}

References Botan::EC_AffinePoint::g_mul(), and Botan::EC_Scalar::invert().

Referenced by public_key().

serialize()

template<typename T >

T Botan::EC_PrivateKey_Data::serialize ( ) const

inline

Definition at line 66 of file ec_key_data.h.

                          {
         T bytes(this->group().get_order_bytes());
         this->serialize_to(bytes);
         return bytes;
      }

References group(), serialize_to(), and T.

serialize_to()

void Botan::EC_PrivateKey_Data::serialize_to

(

std::span< uint8_t >

output

)

const

Definition at line 86 of file ec_key_data.cpp.

                                                                   {
   m_scalar.serialize_to(output);
}

References Botan::EC_Scalar::serialize_to().

Referenced by serialize().

---

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

• src/lib/pubkey/ecc_key/ec_key_data.h
• src/lib/pubkey/ecc_key/ec_key_data.cpp