#include <ecgdsa.h>

Inheritance diagram for Botan::ECGDSA_PrivateKey:

Public Member Functions
virtual Signature_Format	_default_x509_signature_format () const

const EC_Scalar &	_private_key () const

const EC_AffinePoint &	_public_ec_point () const

std::optional< size_t >	_signature_element_size_for_DER_encoding () const override

std::string	algo_name () const override

AlgorithmIdentifier	algorithm_identifier () const override

bool	check_key (RandomNumberGenerator &rng, bool) const override

virtual std::unique_ptr< PK_Ops::Decryption >	create_decryption_op (RandomNumberGenerator &rng, std::string_view params, std::string_view provider) const

virtual std::unique_ptr< PK_Ops::Encryption >	create_encryption_op (RandomNumberGenerator &rng, std::string_view params, std::string_view provider) const

virtual std::unique_ptr< PK_Ops::KEM_Decryption >	create_kem_decryption_op (RandomNumberGenerator &rng, std::string_view params, std::string_view provider) const

virtual std::unique_ptr< PK_Ops::KEM_Encryption >	create_kem_encryption_op (std::string_view params, std::string_view provider) const

virtual std::unique_ptr< PK_Ops::Key_Agreement >	create_key_agreement_op (RandomNumberGenerator &rng, std::string_view params, std::string_view provider) const

std::unique_ptr< PK_Ops::Signature >	create_signature_op (RandomNumberGenerator &rng, std::string_view params, std::string_view provider) const override

std::unique_ptr< PK_Ops::Verification >	create_verification_op (std::string_view params, std::string_view provider) const override

std::unique_ptr< PK_Ops::Verification >	create_x509_verification_op (const AlgorithmIdentifier &signature_algorithm, std::string_view provider) const override

Signature_Format	default_x509_signature_format () const

std::vector< uint8_t >	DER_domain () const

const EC_Group &	domain () const

EC_Group_Encoding	domain_format () const

	ECGDSA_PrivateKey (const AlgorithmIdentifier &alg_id, std::span< const uint8_t > key_bits)

	ECGDSA_PrivateKey (EC_Group group, EC_Scalar x)

	ECGDSA_PrivateKey (RandomNumberGenerator &rng, const EC_Group &group, const BigInt &x)

	ECGDSA_PrivateKey (RandomNumberGenerator &rng, EC_Group group)

size_t	estimated_strength () const override

std::string	fingerprint_private (std::string_view alg) const

std::string	fingerprint_public (std::string_view alg="SHA-256") const

std::unique_ptr< Private_Key >	generate_another (RandomNumberGenerator &rng) const final

const BigInt &	get_int_field (std::string_view field) const final

OID	get_oid () const

size_t	key_length () const override

size_t	message_part_size () const

size_t	message_parts () const

virtual OID	object_identifier () const

virtual AlgorithmIdentifier	pkcs8_algorithm_identifier () const

EC_Point_Format	point_encoding () const

secure_vector< uint8_t >	private_key_bits () const final

secure_vector< uint8_t >	private_key_info () const

const BigInt &	private_value () const

std::unique_ptr< Public_Key >	public_key () const override

std::vector< uint8_t >	public_key_bits () const override

secure_vector< uint8_t >	raw_private_key_bits () const final

std::vector< uint8_t >	raw_public_key_bits () const override

virtual std::optional< uint64_t >	remaining_operations () const
	Retrieves the number of remaining operations if this is a stateful private key.

void	set_parameter_encoding (EC_Group_Encoding enc)

void	set_point_encoding (EC_Point_Format enc)

virtual bool	stateful_operation () const

std::vector< uint8_t >	subject_public_key () const

bool	supports_operation (PublicKeyOperation op) const override

Protected Attributes
EC_Group_Encoding	m_domain_encoding = EC_Group_Encoding::NamedCurve

EC_Point_Format	m_point_encoding = EC_Point_Format::Uncompressed

std::shared_ptr< const EC_PrivateKey_Data >	m_private_key

std::shared_ptr< const EC_PublicKey_Data >	m_public_key

Detailed Description

This class represents ECGDSA private keys.

Definition at line 75 of file ecgdsa.h.

Constructor & Destructor Documentation

◆ ECGDSA_PrivateKey() [1/4]

Botan::ECGDSA_PrivateKey::ECGDSA_PrivateKey	(	const AlgorithmIdentifier &	alg_id,
		std::span< const uint8_t >	key_bits )

inline

Load a private key.

Parameters

alg_id	the X.509 algorithm identifier
key_bits	ECPrivateKey bits

Definition at line 83 of file ecgdsa.h.

83 :

84 EC_PrivateKey(alg_id, key_bits, true) {}

Botan::EC_PrivateKey::EC_PrivateKey

EC_PrivateKey()=default

◆ ECGDSA_PrivateKey() [2/4]

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

inline

Create a private key from a given secret x

Parameters

group	curve parameters to bu used for this key
x	the private key

Definition at line 91 of file ecgdsa.h.

91: EC_PrivateKey(std::move(group), std::move(x), true) {}

◆ ECGDSA_PrivateKey() [3/4]

Botan::ECGDSA_PrivateKey::ECGDSA_PrivateKey	(	RandomNumberGenerator &	rng,
		EC_Group	group )

inline

Create a new private key

Parameters

rng	a random number generator
group	parameters to used for this key

Definition at line 98 of file ecgdsa.h.

98: EC_PrivateKey(rng, std::move(group), true) {}

◆ ECGDSA_PrivateKey() [4/4]

Botan::ECGDSA_PrivateKey::ECGDSA_PrivateKey	(	RandomNumberGenerator &	rng,
		const EC_Group &	group,
		const BigInt &	x )

inline

Generate a new private key.

Parameters

rng	a random number generator
group	parameters to used for this key
x	the private key (if zero, generate a new random key)

Definition at line 107 of file ecgdsa.h.

107 :

108 EC_PrivateKey(rng, group, x, true) {}

Member Function Documentation

◆ _default_x509_signature_format()

Signature_Format Botan::Asymmetric_Key::_default_x509_signature_format ( ) const

virtualinherited

Reimplemented in Botan::GOST_3410_PublicKey.

Definition at line 30 of file pk_keys.cpp.

                                                                      {
   if(_signature_element_size_for_DER_encoding()) {
      return Signature_Format::DerSequence;
   } else {
      return Signature_Format::Standard;
   }
}

References Botan::Asymmetric_Key::_signature_element_size_for_DER_encoding(), Botan::DerSequence, and Botan::Standard.

Referenced by Botan::X509_Object::choose_sig_format(), and Botan::PK_Verifier::PK_Verifier().

◆ _private_key()

const EC_Scalar & Botan::EC_PrivateKey::_private_key ( ) const

inherited

Definition at line 122 of file ecc_key.cpp.

                                                   {
   BOTAN_STATE_CHECK(m_private_key != nullptr);
   return m_private_key->private_key();
}

References BOTAN_STATE_CHECK, and Botan::EC_PrivateKey::m_private_key.

◆ _public_ec_point()

const EC_AffinePoint & Botan::EC_PublicKey::_public_ec_point ( ) const

inherited

Definition at line 75 of file ecc_key.cpp.

                                                           {
   BOTAN_STATE_CHECK(m_public_key != nullptr);
   return m_public_key->public_key();
}

References BOTAN_STATE_CHECK, and Botan::EC_PublicKey::m_public_key.

Referenced by botan_pubkey_sm2_compute_za(), Botan::EC_PublicKey::check_key(), Botan::ECDH_PrivateKey::public_key(), Botan::ECDSA_PrivateKey::public_key(), public_key(), Botan::ECKCDSA_PrivateKey::public_key(), Botan::GOST_3410_PrivateKey::public_key(), Botan::SM2_PrivateKey::public_key(), Botan::GOST_3410_PublicKey::public_key_bits(), Botan::ECDH_PublicKey::public_value(), Botan::EC_PublicKey::raw_public_key_bits(), and Botan::ECDSA_PublicKey::recovery_param().

◆ _signature_element_size_for_DER_encoding()

std::optional< size_t > Botan::ECGDSA_PublicKey::_signature_element_size_for_DER_encoding ( ) const

inlineoverridevirtualinherited

Certain signatures schemes such as ECDSA have more than one element, and certain unfortunate protocols decided the thing to do was not concatenate them as normally done, but instead DER encode each of the elements as independent values.

If this returns a value x then the signature is checked to be exactly 2*x bytes and split in half for DER encoding.

Reimplemented from Botan::Asymmetric_Key.

Definition at line 50 of file ecgdsa.h.

                                                                                    {
         return domain().get_order_bytes();
      }

◆ algo_name()

std::string Botan::ECGDSA_PublicKey::algo_name ( ) const

inlineoverridevirtualinherited

Get this keys algorithm name.

Returns: this keys algorithm name ("ECGDSA")

Implements Botan::Asymmetric_Key.

Definition at line 48 of file ecgdsa.h.

48{ return "ECGDSA"; }

◆ algorithm_identifier()

AlgorithmIdentifier Botan::EC_PublicKey::algorithm_identifier ( ) const

overridevirtualinherited

Returns: X.509 AlgorithmIdentifier for this key

Implements Botan::Public_Key.

Reimplemented in Botan::GOST_3410_PublicKey.

Definition at line 85 of file ecc_key.cpp.

                                                             {
   return AlgorithmIdentifier(object_identifier(), DER_domain());
}

References Botan::EC_PublicKey::DER_domain(), and Botan::Asymmetric_Key::object_identifier().

Referenced by Botan::GOST_3410_PrivateKey::pkcs8_algorithm_identifier().

◆ check_key()

bool Botan::ECGDSA_PrivateKey::check_key	(	RandomNumberGenerator &	rng,
		bool	strong ) const

overridevirtual

Reimplemented from Botan::EC_PublicKey.

Definition at line 20 of file ecgdsa.cpp.

                                                                               {
   if(!EC_PrivateKey::check_key(rng, strong)) {
      return false;
   }
 
   if(!strong) {
      return true;
   }
 
   return KeyPair::signature_consistency_check(rng, *this, "SHA-256");
}

References Botan::EC_PrivateKey::check_key(), and Botan::KeyPair::signature_consistency_check().

◆ create_decryption_op()

std::unique_ptr< PK_Ops::Decryption > Botan::Private_Key::create_decryption_op	(	RandomNumberGenerator &	rng,
		std::string_view	params,
		std::string_view	provider ) const

virtualinherited

This is an internal library function exposed on key types. In all cases applications should use wrappers in pubkey.h

Return an decryption operation for this key/params or throw

Parameters

rng	a random number generator. The PK_Op may maintain a reference to the RNG and use it many times. The rng must outlive any operations which reference it.
params	additional parameters
provider	the provider to use

Reimplemented in Botan::ElGamal_PrivateKey, Botan::RSA_PrivateKey, Botan::SM2_PrivateKey, and Botan::TPM2::RSA_PrivateKey.

Definition at line 119 of file pk_keys.cpp.

                                                                                              {
   throw Lookup_Error(fmt("{} does not support decryption", algo_name()));
}

References Botan::Asymmetric_Key::algo_name(), and Botan::fmt().

Referenced by Botan::PK_Decryptor_EME::PK_Decryptor_EME().

◆ create_encryption_op()

std::unique_ptr< PK_Ops::Encryption > Botan::Public_Key::create_encryption_op	(	RandomNumberGenerator &	rng,
		std::string_view	params,
		std::string_view	provider ) const

virtualinherited

This is an internal library function exposed on key types. In almost all cases applications should use wrappers in pubkey.h

Return an encryption operation for this key/params or throw

Parameters

rng	a random number generator. The PK_Op may maintain a reference to the RNG and use it many times. The rng must outlive any operations which reference it.
params	additional parameters
provider	the provider to use

Reimplemented in Botan::ElGamal_PublicKey, Botan::RSA_PublicKey, Botan::SM2_PublicKey, and Botan::TPM2::RSA_PublicKey.

Definition at line 98 of file pk_keys.cpp.

                                                                                             {
   throw Lookup_Error(fmt("{} does not support encryption", algo_name()));
}

References Botan::Asymmetric_Key::algo_name(), and Botan::fmt().

Referenced by Botan::PK_Encryptor_EME::PK_Encryptor_EME().

◆ create_kem_decryption_op()

std::unique_ptr< PK_Ops::KEM_Decryption > Botan::Private_Key::create_kem_decryption_op	(	RandomNumberGenerator &	rng,
		std::string_view	params,
		std::string_view	provider ) const

virtualinherited

This is an internal library function exposed on key types. In all cases applications should use wrappers in pubkey.h

Return a KEM decryption operation for this key/params or throw

Parameters

rng	a random number generator. The PK_Op may maintain a reference to the RNG and use it many times. The rng must outlive any operations which reference it.
params	additional parameters
provider	the provider to use

Reimplemented in Botan::Classic_McEliece_PrivateKey, Botan::FrodoKEM_PrivateKey, Botan::Kyber_PrivateKey, Botan::McEliece_PrivateKey, Botan::RSA_PrivateKey, Botan::TLS::Hybrid_KEM_PrivateKey, and Botan::TLS::KEX_to_KEM_Adapter_PrivateKey.

Definition at line 125 of file pk_keys.cpp.

                                                                                                      {
   throw Lookup_Error(fmt("{} does not support KEM decryption", algo_name()));
}

References Botan::Asymmetric_Key::algo_name(), and Botan::fmt().

Referenced by Botan::PK_KEM_Decryptor::PK_KEM_Decryptor().

◆ create_kem_encryption_op()

std::unique_ptr< PK_Ops::KEM_Encryption > Botan::Public_Key::create_kem_encryption_op	(	std::string_view	params,
		std::string_view	provider ) const

virtualinherited

This is an internal library function exposed on key types. In almost all cases applications should use wrappers in pubkey.h

Return a KEM encryption operation for this key/params or throw

Parameters

params	additional parameters
provider	the provider to use

Reimplemented in Botan::Classic_McEliece_PublicKey, Botan::FrodoKEM_PublicKey, Botan::Kyber_PublicKey, Botan::McEliece_PublicKey, Botan::RSA_PublicKey, Botan::TLS::Hybrid_KEM_PublicKey, and Botan::TLS::KEX_to_KEM_Adapter_PublicKey.

Definition at line 104 of file pk_keys.cpp.

                                                                                                     {
   throw Lookup_Error(fmt("{} does not support KEM encryption", algo_name()));
}

References Botan::Asymmetric_Key::algo_name(), and Botan::fmt().

Referenced by Botan::PK_KEM_Encryptor::PK_KEM_Encryptor().

◆ create_key_agreement_op()

std::unique_ptr< PK_Ops::Key_Agreement > Botan::Private_Key::create_key_agreement_op	(	RandomNumberGenerator &	rng,
		std::string_view	params,
		std::string_view	provider ) const

virtualinherited

This is an internal library function exposed on key types. In all cases applications should use wrappers in pubkey.h

Return a key agreement operation for this key/params or throw

Parameters

rng	a random number generator. The PK_Op may maintain a reference to the RNG and use it many times. The rng must outlive any operations which reference it.
params	additional parameters
provider	the provider to use

Reimplemented in Botan::DH_PrivateKey, Botan::ECDH_PrivateKey, Botan::X25519_PrivateKey, and Botan::X448_PrivateKey.

Definition at line 137 of file pk_keys.cpp.

                                                                                                    {
   throw Lookup_Error(fmt("{} does not support key agreement", algo_name()));
}

References Botan::Asymmetric_Key::algo_name(), and Botan::fmt().

Referenced by Botan::PK_Key_Agreement::PK_Key_Agreement().

◆ create_signature_op()

std::unique_ptr< PK_Ops::Signature > Botan::ECGDSA_PrivateKey::create_signature_op	(	RandomNumberGenerator &	rng,
		std::string_view	params,
		std::string_view	provider ) const

overridevirtual

This is an internal library function exposed on key types. In all cases applications should use wrappers in pubkey.h

Return a signature operation for this key/params or throw

Parameters

rng	a random number generator. The PK_Op may maintain a reference to the RNG and use it many times. The rng must outlive any operations which reference it.
params	additional parameters
provider	the provider to use

Reimplemented from Botan::Private_Key.

Definition at line 137 of file ecgdsa.cpp.

                                                                                                         {
   if(provider == "base" || provider.empty()) {
      return std::make_unique<ECGDSA_Signature_Operation>(*this, params);
   }
   throw Provider_Not_Found(algo_name(), provider);
}

◆ create_verification_op()

std::unique_ptr< PK_Ops::Verification > Botan::ECGDSA_PublicKey::create_verification_op	(	std::string_view	params,
		std::string_view	provider ) const

overridevirtualinherited

This is an internal library function exposed on key types. In all cases applications should use wrappers in pubkey.h

Return a verification operation for this key/params or throw

Parameters

params	additional parameters
provider	the provider to use

Reimplemented from Botan::Public_Key.

Definition at line 120 of file ecgdsa.cpp.

                                                                                                              {
   if(provider == "base" || provider.empty()) {
      return std::make_unique<ECGDSA_Verification_Operation>(*this, params);
   }
   throw Provider_Not_Found(algo_name(), provider);
}

◆ create_x509_verification_op()

std::unique_ptr< PK_Ops::Verification > Botan::ECGDSA_PublicKey::create_x509_verification_op	(	const AlgorithmIdentifier &	signature_algorithm,
		std::string_view	provider ) const

overridevirtualinherited

This is an internal library function exposed on key types. In all cases applications should use wrappers in pubkey.h

Return a verification operation for this combination of key and signature algorithm or throw.

Parameters

signature_algorithm	is the X.509 algorithm identifier encoding the padding scheme and hash hash function used in the signature if applicable.
provider	the provider to use

Reimplemented from Botan::Public_Key.

Definition at line 128 of file ecgdsa.cpp.

                                                                                  {
   if(provider == "base" || provider.empty()) {
      return std::make_unique<ECGDSA_Verification_Operation>(*this, signature_algorithm);
   }
 
   throw Provider_Not_Found(algo_name(), provider);
}

◆ default_x509_signature_format()

Signature_Format Botan::Public_Key::default_x509_signature_format ( ) const

inlineinherited

Definition at line 227 of file pk_keys.h.

                                                                                                           {
         return _default_x509_signature_format();
      }

◆ DER_domain()

std::vector< uint8_t > Botan::EC_PublicKey::DER_domain ( ) const

inherited

Return the DER encoding of this keys domain in whatever format is preset for this particular key

Definition at line 97 of file ecc_key.cpp.

                                                  {
   return domain().DER_encode(domain_format());
}

References Botan::EC_Group::DER_encode(), Botan::EC_PublicKey::domain(), and Botan::EC_PublicKey::domain_format().

Referenced by Botan::EC_PublicKey::algorithm_identifier().

◆ domain()

const EC_Group & Botan::EC_PublicKey::domain ( ) const

inherited

Get the domain parameters of this key.

Exceptions

Invalid_State is thrown if the domain parameters of this point are not set

Returns: the domain parameters of this key

Definition at line 63 of file ecc_key.cpp.

                                           {
   BOTAN_STATE_CHECK(m_public_key != nullptr);
   return m_public_key->group();
}

References BOTAN_STATE_CHECK, and Botan::EC_PublicKey::m_public_key.

Referenced by Botan::GOST_3410_PublicKey::_signature_element_size_for_DER_encoding(), Botan::GOST_3410_PublicKey::algo_name(), Botan::GOST_3410_PublicKey::algorithm_identifier(), botan_pubkey_ecc_key_used_explicit_encoding(), botan_pubkey_sm2_compute_za(), Botan::EC_PublicKey::check_key(), Botan::SM2_PrivateKey::check_key(), Botan::EC_PublicKey::DER_domain(), Botan::EC_PrivateKey::EC_PrivateKey(), Botan::EC_PrivateKey::EC_PrivateKey(), Botan::EC_PrivateKey::EC_PrivateKey(), Botan::EC_PrivateKey::EC_PrivateKey(), Botan::EC_PublicKey::EC_PublicKey(), Botan::EC_PublicKey::EC_PublicKey(), Botan::ECDH_PublicKey::generate_another(), Botan::ECDSA_PublicKey::generate_another(), Botan::EC_PublicKey::get_int_field(), Botan::EC_PublicKey::key_length(), Botan::ECDH_PrivateKey::public_key(), Botan::ECDSA_PrivateKey::public_key(), public_key(), Botan::ECKCDSA_PrivateKey::public_key(), Botan::GOST_3410_PrivateKey::public_key(), Botan::SM2_PrivateKey::public_key(), Botan::TPM2::EC_PrivateKey::public_key(), Botan::ECDSA_PublicKey::recovery_param(), and Botan::EC_PublicKey::set_parameter_encoding().

◆ domain_format()

EC_Group_Encoding Botan::EC_PublicKey::domain_format ( ) const

inlineinherited

Get the domain parameter encoding to be used when encoding this key.

Returns: the encoding to use

Definition at line 92 of file ecc_key.h.

92{ return m_domain_encoding; }

Botan::EC_PublicKey::m_domain_encoding

EC_Group_Encoding m_domain_encoding

Definition ecc_key.h:136

Referenced by Botan::EC_PublicKey::DER_domain().

◆ estimated_strength()

size_t Botan::EC_PublicKey::estimated_strength ( ) const

overridevirtualinherited

Return the estimated strength of the underlying key against the best currently known attack. Note that this ignores anything but pure attacks against the key itself and do not take into account padding schemes, usage mistakes, etc which might reduce the strength. However it does suffice to provide an upper bound.

Returns: estimated strength in bits

Implements Botan::Asymmetric_Key.

Definition at line 29 of file ecc_key.cpp.

                                              {
   return ecp_work_factor(key_length());
}

References Botan::ecp_work_factor(), and Botan::EC_PublicKey::key_length().

◆ fingerprint_private()

std::string Botan::Private_Key::fingerprint_private ( std::string_view alg ) const

inherited

Returns: Hash of the PKCS #8 encoding for this key object

Definition at line 94 of file pk_keys.cpp.

                                                                         {
   return create_hex_fingerprint(private_key_bits(), hash_algo);
}

References Botan::create_hex_fingerprint(), and Botan::Private_Key::private_key_bits().

Referenced by Botan::Certificate_Store_In_SQL::find_certs_for_key(), Botan::Certificate_Store_In_SQL::insert_key(), and Botan::Certificate_Store_In_SQL::remove_key().

◆ fingerprint_public()

std::string Botan::Public_Key::fingerprint_public ( std::string_view alg = "SHA-256" ) const

inherited

Returns: Hash of the subject public key

Definition at line 87 of file pk_keys.cpp.

                                                                       {
   return create_hex_fingerprint(subject_public_key(), hash_algo);
}

References Botan::create_hex_fingerprint(), and Botan::Public_Key::subject_public_key().

◆ generate_another()

std::unique_ptr< Private_Key > Botan::ECGDSA_PublicKey::generate_another ( RandomNumberGenerator & rng ) const

finalvirtualinherited

Generate another (cryptographically independent) key pair using the same algorithm parameters as this key. This is most useful for algorithms that support PublicKeyOperation::KeyAgreement to generate a fitting ephemeral key pair. For other key types it might throw Not_Implemented.

Implements Botan::Asymmetric_Key.

Definition at line 116 of file ecgdsa.cpp.

                                                                                              {
   return std::make_unique<ECGDSA_PrivateKey>(rng, domain());
}

◆ get_int_field()

const BigInt & Botan::EC_PrivateKey::get_int_field ( std::string_view field ) const

finalvirtualinherited

Access an algorithm specific field

If the field is not known for this algorithm, an Invalid_Argument is thrown. The interpretation of the result requires knowledge of which algorithm is involved. For instance for RSA "p" represents one of the secret primes, while for DSA "p" is the public prime.

Some algorithms may not implement this method at all.

This is primarily used to implement the FFI botan_pubkey_get_field and botan_privkey_get_field functions.

TODO(Botan4) Change this to return by value

Reimplemented from Botan::Asymmetric_Key.

Definition at line 230 of file ecc_key.cpp.

                                                                     {
   if(field == "x") {
      return this->private_value();
   } else {
      return EC_PublicKey::get_int_field(field);
   }
}

References Botan::EC_PublicKey::get_int_field(), and Botan::EC_PrivateKey::private_value().

◆ get_oid()

OID Botan::Public_Key::get_oid ( ) const

inlineinherited

Deprecated version of object_identifier

Definition at line 160 of file pk_keys.h.

160{ return this->object_identifier(); }

◆ key_length()

size_t Botan::EC_PublicKey::key_length ( ) const

overridevirtualinherited

Return an integer value best approximating the length of the primary security parameter. For example for RSA this will be the size of the modulus, for ECDSA the size of the ECC group, and for McEliece the size of the code will be returned.

Implements Botan::Public_Key.

Definition at line 25 of file ecc_key.cpp.

                                      {
   return domain().get_p_bits();
}

References Botan::EC_PublicKey::domain(), and Botan::EC_Group::get_p_bits().

Referenced by Botan::EC_PublicKey::estimated_strength().

◆ message_part_size()

size_t Botan::Public_Key::message_part_size ( ) const

inlineinherited

Returns how large each of the message parts refered to by message_parts() is

This function is public but applications should have few reasons to ever call this.

Returns: size of the message parts in bits

Definition at line 220 of file pk_keys.h.

                                                                                     {
         return _signature_element_size_for_DER_encoding().value_or(0);
      }

◆ message_parts()

size_t Botan::Public_Key::message_parts ( ) const

inlineinherited

Returns more than 1 if the output of this algorithm (ciphertext, signature) should be treated as more than one value. This is used for algorithms like DSA and ECDSA, where the (r,s) output pair can be encoded as either a plain binary list or a TLV tagged DER encoding depending on the protocol.

This function is public but applications should have few reasons to ever call this.

Returns: number of message parts

Definition at line 207 of file pk_keys.h.

                                                                                 {
         return _signature_element_size_for_DER_encoding() ? 2 : 1;
      }

◆ object_identifier()

OID Botan::Asymmetric_Key::object_identifier ( ) const

virtualinherited

Get the OID of the underlying public key scheme.

Returns: OID of the public key scheme

Reimplemented in Botan::Classic_McEliece_PublicKey, Botan::Dilithium_PublicKey, Botan::FrodoKEM_PublicKey, Botan::HSS_LMS_PublicKey, Botan::Kyber_PublicKey, and Botan::SphincsPlus_PublicKey.

Definition at line 22 of file pk_keys.cpp.

                                            {
   try {
      return OID::from_string(algo_name());
   } catch(Lookup_Error&) {
      throw Lookup_Error(fmt("Public key algorithm {} has no defined OIDs", algo_name()));
   }
}

References Botan::Asymmetric_Key::algo_name(), Botan::fmt(), and Botan::OID::from_string().

◆ pkcs8_algorithm_identifier()

virtual AlgorithmIdentifier Botan::Private_Key::pkcs8_algorithm_identifier ( ) const

inlinevirtualinherited

Returns: PKCS #8 AlgorithmIdentifier for this key Might be different from the X.509 identifier, but normally is not

Reimplemented in Botan::GOST_3410_PrivateKey, and Botan::HSS_LMS_PrivateKey.

Definition at line 322 of file pk_keys.h.

322{ return algorithm_identifier(); }

Botan::Public_Key::algorithm_identifier

virtual AlgorithmIdentifier algorithm_identifier() const =0

Referenced by Botan::Private_Key::private_key_info().

◆ point_encoding()

EC_Point_Format Botan::EC_PublicKey::point_encoding ( ) const

inlineinherited

Get the point encoding method to be used when encoding this key.

Returns: the encoding to use

Definition at line 98 of file ecc_key.h.

98{ return m_point_encoding; }

Botan::EC_PublicKey::m_point_encoding

EC_Point_Format m_point_encoding

Definition ecc_key.h:137

Referenced by Botan::EC_PublicKey::raw_public_key_bits().

◆ private_key_bits()

secure_vector< uint8_t > Botan::EC_PrivateKey::private_key_bits ( ) const

finalvirtualinherited

Returns: BER encoded private key bits

Implements Botan::Private_Key.

Definition at line 158 of file ecc_key.cpp.

                                                             {
   BOTAN_STATE_CHECK(m_private_key != nullptr && m_public_key != nullptr);
 
   return DER_Encoder()
      .start_sequence()
      .encode(static_cast<size_t>(1))
      .encode(raw_private_key_bits(), ASN1_Type::OctetString)
      .start_explicit_context_specific(1)
      .encode(m_public_key->public_key().serialize_uncompressed(), ASN1_Type::BitString)
      .end_cons()
      .end_cons()
      .get_contents();
}

References Botan::BitString, BOTAN_STATE_CHECK, Botan::DER_Encoder::encode(), Botan::DER_Encoder::end_cons(), Botan::DER_Encoder::get_contents(), Botan::EC_PrivateKey::m_private_key, Botan::EC_PublicKey::m_public_key, Botan::OctetString, Botan::EC_PrivateKey::raw_private_key_bits(), Botan::DER_Encoder::start_explicit_context_specific(), and Botan::DER_Encoder::start_sequence().

Referenced by Botan::EC_PrivateKey::EC_PrivateKey().

◆ private_key_info()

secure_vector< uint8_t > Botan::Private_Key::private_key_info ( ) const

inherited

Returns: PKCS #8 private key encoding for this key object

Definition at line 68 of file pk_keys.cpp.

                                                           {
   const size_t PKCS8_VERSION = 0;
 
   return DER_Encoder()
      .start_sequence()
      .encode(PKCS8_VERSION)
      .encode(pkcs8_algorithm_identifier())
      .encode(private_key_bits(), ASN1_Type::OctetString)
      .end_cons()
      .get_contents();
}

References Botan::DER_Encoder::encode(), Botan::DER_Encoder::end_cons(), Botan::DER_Encoder::get_contents(), Botan::OctetString, Botan::Private_Key::pkcs8_algorithm_identifier(), Botan::Private_Key::private_key_bits(), and Botan::DER_Encoder::start_sequence().

Referenced by Botan::PKCS8::BER_encode(), Botan::PKCS8::BER_encode_encrypted_pbkdf_iter(), Botan::PKCS8::BER_encode_encrypted_pbkdf_msec(), and Botan::PKCS8::PEM_encode().

◆ private_value()

const BigInt & Botan::EC_PrivateKey::private_value ( ) const

inherited

Get the private key value of this key object.

Returns: the private key value of this key object

Definition at line 117 of file ecc_key.cpp.

                                                 {
   BOTAN_STATE_CHECK(m_private_key != nullptr);
   return m_private_key->legacy_bigint();
}

References BOTAN_STATE_CHECK, and Botan::EC_PrivateKey::m_private_key.

Referenced by Botan::SM2_PrivateKey::check_key(), and Botan::EC_PrivateKey::get_int_field().

◆ public_key()

std::unique_ptr< Public_Key > Botan::ECGDSA_PrivateKey::public_key ( ) const

overridevirtual

Allocate a new object for the public key associated with this private key.

Returns: public key

Implements Botan::Private_Key.

Definition at line 16 of file ecgdsa.cpp.

                                                              {
   return std::make_unique<ECGDSA_PublicKey>(domain(), _public_ec_point());
}

References Botan::EC_PublicKey::_public_ec_point(), and Botan::EC_PublicKey::domain().

◆ public_key_bits()

std::vector< uint8_t > Botan::EC_PublicKey::public_key_bits ( ) const

overridevirtualinherited

Returns: BER encoded public key bits

Implements Botan::Public_Key.

Reimplemented in Botan::GOST_3410_PublicKey, and Botan::TPM2::EC_PublicKey.

Definition at line 93 of file ecc_key.cpp.

                                                       {
   return raw_public_key_bits();
}

References Botan::EC_PublicKey::raw_public_key_bits().

Referenced by Botan::EC_PrivateKey::EC_PrivateKey().

◆ raw_private_key_bits()

secure_vector< uint8_t > Botan::EC_PrivateKey::raw_private_key_bits ( ) const

finalvirtualinherited

Returns: binary private key bits, with no additional encoding

Note: some algorithms (for example RSA) do not have an obvious encoding for this value due to having many different values, and thus not implement this function. The default implementation throws Not_Implemented

Reimplemented from Botan::Private_Key.

Definition at line 153 of file ecc_key.cpp.

                                                                 {
   BOTAN_STATE_CHECK(m_private_key != nullptr);
   return m_private_key->serialize<secure_vector<uint8_t>>();
}

References BOTAN_STATE_CHECK, and Botan::EC_PrivateKey::m_private_key.

Referenced by Botan::EC_PrivateKey::private_key_bits().

◆ raw_public_key_bits()

std::vector< uint8_t > Botan::EC_PublicKey::raw_public_key_bits ( ) const

overridevirtualinherited

Returns: binary public key bits, with no additional encoding

For key agreements this is an alias for PK_Key_Agreement_Key::public_value.

Note: some algorithms (for example RSA) do not have an obvious encoding for this value due to having many different values, and thus throw Not_Implemented when invoking this method.

Implements Botan::Public_Key.

Reimplemented in Botan::TPM2::EC_PublicKey.

Definition at line 89 of file ecc_key.cpp.

                                                           {
   return _public_ec_point().serialize(point_encoding());
}

References Botan::EC_PublicKey::_public_ec_point(), Botan::EC_PublicKey::point_encoding(), and Botan::EC_AffinePoint::serialize().

Referenced by Botan::EC_PublicKey::public_key_bits(), Botan::TPM2::EC_PrivateKey::public_key_bits(), and Botan::TPM2::EC_PublicKey::public_key_bits().

◆ remaining_operations()

virtual std::optional< uint64_t > Botan::Private_Key::remaining_operations ( ) const

inlinevirtualinherited

Retrieves the number of remaining operations if this is a stateful private key.

Returns: the number of remaining operations or std::nullopt if not applicable.

Reimplemented in Botan::HSS_LMS_PrivateKey, and Botan::XMSS_PrivateKey.

Definition at line 335 of file pk_keys.h.

335{ return std::nullopt; }

◆ set_parameter_encoding()

void Botan::EC_PublicKey::set_parameter_encoding ( EC_Group_Encoding enc )

inherited

Set the domain parameter encoding to be used when encoding this key.

Parameters

enc	the encoding to use

This function is deprecated; in a future major release only namedCurve encoding of domain parameters will be allowed.

Definition at line 109 of file ecc_key.cpp.

                                                                {
   if(form == EC_Group_Encoding::NamedCurve && domain().get_curve_oid().empty()) {
      throw Invalid_Argument("Cannot used NamedCurve encoding for a curve without an OID");
   }
 
   m_domain_encoding = form;
}

References Botan::EC_PublicKey::domain(), Botan::EC_PublicKey::m_domain_encoding, and Botan::NamedCurve.

◆ set_point_encoding()

void Botan::EC_PublicKey::set_point_encoding ( EC_Point_Format enc )

inherited

Set the point encoding method to be used when encoding this key.

Parameters

enc	the encoding to use

Definition at line 101 of file ecc_key.cpp.

                                                         {
   if(enc != EC_Point_Format::Compressed && enc != EC_Point_Format::Uncompressed && enc != EC_Point_Format::Hybrid) {
      throw Invalid_Argument("Invalid point encoding for EC_PublicKey");
   }
 
   m_point_encoding = enc;
}

References Botan::Compressed, Botan::Hybrid, Botan::EC_PublicKey::m_point_encoding, and Botan::Uncompressed.

◆ stateful_operation()

virtual bool Botan::Private_Key::stateful_operation ( ) const

inlinevirtualinherited

Indicates if this key is stateful, ie that performing a private key operation requires updating the key storage.

Reimplemented in Botan::HSS_LMS_PrivateKey, and Botan::XMSS_PrivateKey.

Definition at line 328 of file pk_keys.h.

328{ return false; }

◆ subject_public_key()

std::vector< uint8_t > Botan::Public_Key::subject_public_key ( ) const

inherited

Returns: X.509 subject key encoding for this key object

Definition at line 56 of file pk_keys.cpp.

                                                        {
   std::vector<uint8_t> output;
 
   DER_Encoder(output)
      .start_sequence()
      .encode(algorithm_identifier())
      .encode(public_key_bits(), ASN1_Type::BitString)
      .end_cons();
 
   return output;
}

References Botan::Public_Key::algorithm_identifier(), Botan::BitString, Botan::DER_Encoder::encode(), Botan::DER_Encoder::end_cons(), Botan::Public_Key::public_key_bits(), and Botan::DER_Encoder::start_sequence().

Referenced by Botan::X509::BER_encode(), Botan::PKCS10_Request::create(), Botan::Public_Key::fingerprint_public(), and Botan::X509::PEM_encode().

◆ supports_operation()

bool Botan::ECGDSA_PublicKey::supports_operation ( PublicKeyOperation op ) const

inlineoverridevirtualinherited

Return true if this key could be used for the specified type of operation.

Implements Botan::Asymmetric_Key.

Definition at line 56 of file ecgdsa.h.

56{ return (op == PublicKeyOperation::Signature); }

Botan::PublicKeyOperation::Signature

@ Signature

Member Data Documentation

◆ m_domain_encoding

EC_Group_Encoding Botan::EC_PublicKey::m_domain_encoding = EC_Group_Encoding::NamedCurve

protectedinherited

Definition at line 136 of file ecc_key.h.

Referenced by Botan::EC_PrivateKey::EC_PrivateKey(), Botan::EC_PrivateKey::EC_PrivateKey(), Botan::EC_PrivateKey::EC_PrivateKey(), Botan::EC_PrivateKey::EC_PrivateKey(), Botan::EC_PublicKey::EC_PublicKey(), Botan::EC_PublicKey::EC_PublicKey(), and Botan::EC_PublicKey::set_parameter_encoding().

◆ m_point_encoding

EC_Point_Format Botan::EC_PublicKey::m_point_encoding = EC_Point_Format::Uncompressed

protectedinherited

Definition at line 137 of file ecc_key.h.

Referenced by Botan::EC_PublicKey::set_point_encoding().

◆ m_private_key

std::shared_ptr<const EC_PrivateKey_Data> Botan::EC_PrivateKey::m_private_key

protectedinherited

Definition at line 219 of file ecc_key.h.

Referenced by Botan::EC_PrivateKey::_private_key(), Botan::EC_PrivateKey::check_key(), Botan::EC_PrivateKey::EC_PrivateKey(), Botan::EC_PrivateKey::EC_PrivateKey(), Botan::EC_PrivateKey::EC_PrivateKey(), Botan::EC_PrivateKey::EC_PrivateKey(), Botan::EC_PrivateKey::private_key_bits(), Botan::EC_PrivateKey::private_value(), and Botan::EC_PrivateKey::raw_private_key_bits().

◆ m_public_key

std::shared_ptr<const EC_PublicKey_Data> Botan::EC_PublicKey::m_public_key

protectedinherited

Definition at line 135 of file ecc_key.h.

Referenced by Botan::EC_PublicKey::_public_ec_point(), Botan::EC_PublicKey::domain(), Botan::EC_PrivateKey::EC_PrivateKey(), Botan::EC_PrivateKey::EC_PrivateKey(), Botan::EC_PrivateKey::EC_PrivateKey(), Botan::EC_PrivateKey::EC_PrivateKey(), Botan::EC_PublicKey::EC_PublicKey(), Botan::EC_PublicKey::EC_PublicKey(), Botan::GOST_3410_PublicKey::GOST_3410_PublicKey(), and Botan::EC_PrivateKey::private_key_bits().

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

src/lib/pubkey/ecgdsa/ecgdsa.h
src/lib/pubkey/ecgdsa/ecgdsa.cpp

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ECGDSA_PrivateKey() [1/4]

◆ ECGDSA_PrivateKey() [2/4]

◆ ECGDSA_PrivateKey() [3/4]

◆ ECGDSA_PrivateKey() [4/4]

Member Function Documentation

◆ _default_x509_signature_format()

◆ _private_key()

◆ _public_ec_point()

◆ _signature_element_size_for_DER_encoding()

◆ algo_name()

◆ algorithm_identifier()

◆ check_key()

◆ create_decryption_op()

◆ create_encryption_op()

◆ create_kem_decryption_op()

◆ create_kem_encryption_op()

◆ create_key_agreement_op()

◆ create_signature_op()

◆ create_verification_op()

◆ create_x509_verification_op()

◆ default_x509_signature_format()

◆ DER_domain()

◆ domain()

◆ domain_format()

◆ estimated_strength()

◆ fingerprint_private()

◆ fingerprint_public()

◆ generate_another()

◆ get_int_field()

◆ get_oid()

◆ key_length()

◆ message_part_size()

◆ message_parts()

◆ object_identifier()

◆ pkcs8_algorithm_identifier()

◆ point_encoding()

◆ private_key_bits()

◆ private_key_info()

◆ private_value()

◆ public_key()

◆ public_key_bits()

◆ raw_private_key_bits()

◆ raw_public_key_bits()

◆ remaining_operations()

◆ set_parameter_encoding()

◆ set_point_encoding()

◆ stateful_operation()

◆ subject_public_key()

◆ supports_operation()

Member Data Documentation

◆ m_domain_encoding

◆ m_point_encoding

◆ m_private_key

◆ m_public_key