Botan 3.14.1
Crypto and TLS for C&
Botan::EC_PrivateKey_Data Class Referencefinal

#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 46 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 68 of file ec_key_data.cpp.

68 :
69 m_group(std::move(group)), m_scalar(std::move(x)), m_legacy_x(m_scalar.to_bigint()) {
70 if(m_scalar.group()._data() != m_group._data()) {
71 if(m_scalar.group() != m_group) {
72 throw Decoding_Error("ECC private key scalar is not an element of the specified group");
73 }
74
75 if(auto rebound = EC_Scalar::deserialize(m_group, m_scalar.serialize<secure_vector<uint8_t>>())) {
76 m_scalar = std::move(rebound).value();
77 } else {
78 throw Decoding_Error("ECC private key scalar is not an element of the specified group");
79 }
80 }
81
82 // Checking that the scalar is lower than the group order is ensured in the
83 // deserialization of the EC_Scalar or during the random generation respectively.
84 if(m_scalar.is_zero()) {
85 throw Decoding_Error("ECC private key cannot be zero");
86 }
87}
const EC_Group & group() const
Definition ec_key_data.h:71
static std::optional< EC_Scalar > deserialize(const EC_Group &group, std::span< const uint8_t > bytes)
std::vector< T, secure_allocator< T > > secure_vector
Definition secmem.h:128

References Botan::EC_Scalar::deserialize(), EC_PrivateKey_Data(), and group().

Referenced by EC_PrivateKey_Data(), EC_PrivateKey_Data(), EC_PrivateKey_Data(), EC_PrivateKey_Data(), operator=(), and operator=().

◆ 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 118 of file ec_key_data.cpp.

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

References EC_PrivateKey_Data(), and group().

◆ EC_PrivateKey_Data() [3/4]

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

References EC_PrivateKey_Data().

◆ EC_PrivateKey_Data() [4/4]

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

References EC_PrivateKey_Data().

◆ ~EC_PrivateKey_Data()

Botan::EC_PrivateKey_Data::~EC_PrivateKey_Data ( )

Definition at line 121 of file ec_key_data.cpp.

121 {
122 m_scalar.zeroize();
123}

Member Function Documentation

◆ group()

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

Definition at line 71 of file ec_key_data.h.

71{ return m_group; }

Referenced by EC_PrivateKey_Data(), EC_PrivateKey_Data(), and serialize().

◆ legacy_bigint()

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

Definition at line 75 of file ec_key_data.h.

75{ return m_legacy_x; }

◆ operator=() [1/2]

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

References EC_PrivateKey_Data().

◆ operator=() [2/2]

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

References EC_PrivateKey_Data().

◆ private_key()

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

Definition at line 73 of file ec_key_data.h.

73{ 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 138 of file ec_key_data.cpp.

138 {
139 Null_RNG null_rng;
140 return this->public_key(null_rng, with_modular_inverse);
141}
std::shared_ptr< EC_PublicKey_Data > public_key(RandomNumberGenerator &rng, bool with_modular_inverse) const

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 125 of file ec_key_data.cpp.

126 {
127 const auto public_point = [&] {
128 const auto scope = CT::scoped_poison(m_scalar);
129 auto pt =
130 with_modular_inverse ? EC_AffinePoint::g_mul(m_scalar.invert(), rng) : EC_AffinePoint::g_mul(m_scalar, rng);
131 CT::unpoison(pt);
132 return pt;
133 };
134
135 return std::make_shared<EC_PublicKey_Data>(m_group, public_point());
136}
static EC_AffinePoint g_mul(const EC_Scalar &scalar, RandomNumberGenerator &rng)
Multiply by the group generator returning a complete point.
constexpr auto scoped_poison(const Ts &... xs)
Definition ct_utils.h:222
constexpr void unpoison(const T *p, size_t n)
Definition ct_utils.h:67

References Botan::EC_AffinePoint::g_mul(), Botan::CT::scoped_poison(), and Botan::CT::unpoison().

Referenced by public_key().

◆ serialize()

template<typename T>
T Botan::EC_PrivateKey_Data::serialize ( ) const
inline

Definition at line 65 of file ec_key_data.h.

65 {
66 T bytes(this->group().get_order_bytes());
67 this->serialize_to(bytes);
68 return bytes;
69 }
void serialize_to(std::span< uint8_t > output) const

References group(), and serialize_to().

◆ serialize_to()

void Botan::EC_PrivateKey_Data::serialize_to ( std::span< uint8_t > output) const

Definition at line 143 of file ec_key_data.cpp.

143 {
144 m_scalar.serialize_to(output);
145}

Referenced by serialize().


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