#include <ecc_key.h>

Inheritance diagram for Botan::EC_PrivateKey:

Public Member Functions
virtual std::string	algo_name () const =0

AlgorithmIdentifier	algorithm_identifier () const override

bool	check_key (RandomNumberGenerator &rng, bool strong) 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

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

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

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

virtual 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

	EC_PrivateKey (const EC_PrivateKey &other)=default

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

virtual std::unique_ptr< Private_Key >	generate_another (RandomNumberGenerator &rng) const =0

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

OID	get_oid () const

size_t	key_length () const override

virtual size_t	message_part_size () const

virtual size_t	message_parts () const

virtual OID	object_identifier () const

EC_PrivateKey &	operator= (const EC_PrivateKey &other)=default

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

virtual std::unique_ptr< Public_Key >	public_key () const =0

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

const EC_Point &	public_point () const

secure_vector< uint8_t >	raw_private_key_bits () const final

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

virtual bool	supports_operation (PublicKeyOperation op) const =0

	~EC_PrivateKey () override=default

Protected Member Functions
	EC_PrivateKey ()=default

	EC_PrivateKey (const AlgorithmIdentifier &alg_id, std::span< const uint8_t > key_bits, bool with_modular_inverse=false)

	EC_PrivateKey (RandomNumberGenerator &rng, const EC_Group &domain, const BigInt &x, bool with_modular_inverse=false)

Protected Attributes
EC_Group_Encoding	m_domain_encoding

EC_Group	m_domain_params

EC_Point_Format	m_point_encoding = EC_Point_Format::Uncompressed

BigInt	m_private_key

EC_Point	m_public_key

Detailed Description

This abstract class represents ECC private keys

Definition at line 121 of file ecc_key.h.

Constructor & Destructor Documentation

◆ EC_PrivateKey() [1/4]

Botan::EC_PrivateKey::EC_PrivateKey ( const EC_PrivateKey & other )

default

◆ ~EC_PrivateKey()

Botan::EC_PrivateKey::~EC_PrivateKey ( )

overridedefault

◆ EC_PrivateKey() [2/4]

Botan::EC_PrivateKey::EC_PrivateKey	(	RandomNumberGenerator &	rng,
		const EC_Group &	ec_group,
		const BigInt &	x,
		bool	with_modular_inverse = false )

protected

EC_PrivateKey constructor

Definition at line 88 of file ecc_key.cpp.

                                                        {
   m_domain_params = ec_group;
   m_domain_encoding = default_encoding_for(m_domain_params);
 
   if(x == 0) {
      m_private_key = ec_group.random_scalar(rng);
   } else {
      m_private_key = x;
   }
 
   std::vector<BigInt> ws;
 
   if(with_modular_inverse) {
      // ECKCDSA
      m_public_key = domain().blinded_base_point_multiply(m_domain_params.inverse_mod_order(m_private_key), rng, ws);
   } else {
      m_public_key = domain().blinded_base_point_multiply(m_private_key, rng, ws);
   }
 
   BOTAN_ASSERT(m_public_key.on_the_curve(), "Generated public key point was on the curve");
}

References Botan::EC_Group::blinded_base_point_multiply(), BOTAN_ASSERT, Botan::EC_PublicKey::domain(), Botan::EC_Group::inverse_mod_order(), Botan::EC_PublicKey::m_domain_encoding, Botan::EC_PublicKey::m_domain_params, m_private_key, Botan::EC_PublicKey::m_public_key, Botan::EC_Point::on_the_curve(), and Botan::EC_Group::random_scalar().

◆ EC_PrivateKey() [3/4]

Botan::EC_PrivateKey::EC_PrivateKey	(	const AlgorithmIdentifier &	alg_id,
		std::span< const uint8_t >	key_bits,
		bool	with_modular_inverse = false )

protected

Definition at line 129 of file ecc_key.cpp.

                                                        {
   m_domain_params = EC_Group(alg_id.parameters());
   m_domain_encoding = default_encoding_for(m_domain_params);
 
   OID key_parameters;
   secure_vector<uint8_t> public_key_bits;
 
   BER_Decoder(key_bits)
      .start_sequence()
      .decode_and_check<size_t>(1, "Unknown version code for ECC key")
      .decode_octet_string_bigint(m_private_key)
      .decode_optional(key_parameters, ASN1_Type(0), ASN1_Class::ExplicitContextSpecific)
      .decode_optional_string(public_key_bits, ASN1_Type::BitString, 1, ASN1_Class::ExplicitContextSpecific)
      .end_cons();
 
   if(public_key_bits.empty()) {
      if(with_modular_inverse) {
         // ECKCDSA
         m_public_key = domain().get_base_point() * m_domain_params.inverse_mod_order(m_private_key);
      } else {
         m_public_key = domain().get_base_point() * m_private_key;
      }
 
      BOTAN_ASSERT(m_public_key.on_the_curve(), "Public point derived from loaded key was on the curve");
   } else {
      m_public_key = domain().OS2ECP(public_key_bits);
      // OS2ECP verifies that the point is on the curve
   }
}

References Botan::BitString, BOTAN_ASSERT, Botan::BER_Decoder::decode_and_check(), Botan::BER_Decoder::decode_optional(), Botan::EC_PublicKey::domain(), Botan::BER_Decoder::end_cons(), Botan::ExplicitContextSpecific, Botan::EC_Group::get_base_point(), Botan::EC_Group::inverse_mod_order(), Botan::EC_PublicKey::m_domain_encoding, Botan::EC_PublicKey::m_domain_params, m_private_key, Botan::EC_PublicKey::m_public_key, Botan::EC_Point::on_the_curve(), Botan::EC_Group::OS2ECP(), Botan::AlgorithmIdentifier::parameters(), Botan::EC_PublicKey::public_key_bits(), and Botan::BER_Decoder::start_sequence().

◆ EC_PrivateKey() [4/4]

Botan::EC_PrivateKey::EC_PrivateKey ( )

protecteddefault

Member Function Documentation

◆ algo_name()

virtual std::string Botan::Asymmetric_Key::algo_name ( ) const

pure virtualinherited

Get the name of the underlying public key scheme.

Returns: name of the public key scheme

Implemented in Botan::TPM_PrivateKey, Botan::Curve25519_PublicKey, Botan::Ed448_PublicKey, Botan::X448_PublicKey, Botan::DH_PublicKey, Botan::Dilithium_PublicKey, Botan::DSA_PublicKey, Botan::ECDH_PublicKey, Botan::ECDSA_PublicKey, Botan::ECGDSA_PublicKey, Botan::ECKCDSA_PublicKey, Botan::Ed25519_PublicKey, Botan::ElGamal_PublicKey, Botan::FrodoKEM_PublicKey, Botan::GOST_3410_PublicKey, Botan::Kyber_PublicKey, Botan::McEliece_PublicKey, Botan::RSA_PublicKey, Botan::SM2_PublicKey, Botan::SphincsPlus_PublicKey, Botan::XMSS_PublicKey, Botan::TLS::Hybrid_KEM_PublicKey, and Botan::TLS::KEX_to_KEM_Adapter_PublicKey.

Referenced by Botan::PKCS8::BER_encode(), botan_pubkey_sm2_compute_za(), Botan::TLS::Policy::check_peer_key_acceptable(), Botan::X509_Object::choose_sig_format(), Botan::TLS::Handshake_State::choose_sig_format(), Botan::TLS::Client_Key_Exchange::Client_Key_Exchange(), Botan::TLS::Client_Key_Exchange::Client_Key_Exchange(), Botan::Private_Key::create_decryption_op(), Botan::Public_Key::create_encryption_op(), Botan::Private_Key::create_kem_decryption_op(), Botan::Public_Key::create_kem_encryption_op(), Botan::Private_Key::create_key_agreement_op(), Botan::Private_Key::create_signature_op(), Botan::Public_Key::create_verification_op(), Botan::Public_Key::create_x509_verification_op(), Botan::Asymmetric_Key::get_int_field(), Botan::Asymmetric_Key::object_identifier(), Botan::TLS::Handshake_State::parse_sig_format(), Botan::PK_Decryptor_EME::PK_Decryptor_EME(), Botan::PK_Encryptor_EME::PK_Encryptor_EME(), Botan::PK_KEM_Decryptor::PK_KEM_Decryptor(), Botan::PK_KEM_Encryptor::PK_KEM_Encryptor(), Botan::PK_Key_Agreement::PK_Key_Agreement(), Botan::PK_Signer::PK_Signer(), Botan::PK_Verifier::PK_Verifier(), Botan::PK_Verifier::PK_Verifier(), and Botan::Private_Key::raw_private_key_bits().

◆ 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 53 of file ecc_key.cpp.

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

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

◆ check_key()

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

overridevirtual

Implements Botan::Public_Key.

Reimplemented in Botan::ECDSA_PrivateKey, Botan::ECGDSA_PrivateKey, Botan::ECKCDSA_PrivateKey, and Botan::SM2_PrivateKey.

Definition at line 161 of file ecc_key.cpp.

                                                                           {
   if(m_private_key < 1 || m_private_key >= m_domain_params.get_order()) {
      return false;
   }
 
   return EC_PublicKey::check_key(rng, strong);
}

References Botan::EC_PublicKey::check_key(), Botan::EC_Group::get_order(), and Botan::EC_PublicKey::m_domain_params.

Referenced by Botan::ECDSA_PrivateKey::check_key(), Botan::ECGDSA_PrivateKey::check_key(), Botan::ECKCDSA_PrivateKey::check_key(), and Botan::SM2_PrivateKey::check_key().

◆ 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, and Botan::SM2_PrivateKey.

Definition at line 111 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, and Botan::SM2_PublicKey.

Definition at line 90 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::TLS::Hybrid_KEM_PrivateKey, Botan::TLS::KEX_to_KEM_Adapter_PrivateKey, Botan::FrodoKEM_PrivateKey, Botan::Kyber_PrivateKey, Botan::McEliece_PrivateKey, and Botan::RSA_PrivateKey.

Definition at line 117 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::TLS::Hybrid_KEM_PublicKey, Botan::TLS::KEX_to_KEM_Adapter_PublicKey, Botan::FrodoKEM_PublicKey, Botan::Kyber_PublicKey, Botan::McEliece_PublicKey, and Botan::RSA_PublicKey.

Definition at line 96 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::Curve25519_PrivateKey, Botan::X448_PrivateKey, Botan::DH_PrivateKey, and Botan::ECDH_PrivateKey.

Definition at line 129 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::Private_Key::create_signature_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 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 in Botan::Dilithium_PrivateKey, Botan::XMSS_PrivateKey, Botan::TPM_PrivateKey, Botan::Ed448_PrivateKey, Botan::DSA_PrivateKey, Botan::ECDSA_PrivateKey, Botan::ECGDSA_PrivateKey, Botan::ECKCDSA_PrivateKey, Botan::Ed25519_PrivateKey, Botan::GOST_3410_PrivateKey, Botan::RSA_PrivateKey, Botan::SM2_PrivateKey, and Botan::SphincsPlus_PrivateKey.

Definition at line 123 of file pk_keys.cpp.

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

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

Referenced by Botan::PK_Signer::PK_Signer().

◆ create_verification_op()

std::unique_ptr< PK_Ops::Verification > Botan::Public_Key::create_verification_op	(	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 verification operation for this key/params or throw

Parameters

params	additional parameters
provider	the provider to use

Reimplemented in Botan::Ed448_PublicKey, Botan::Dilithium_PublicKey, Botan::DSA_PublicKey, Botan::ECDSA_PublicKey, Botan::ECGDSA_PublicKey, Botan::ECKCDSA_PublicKey, Botan::Ed25519_PublicKey, Botan::GOST_3410_PublicKey, Botan::RSA_PublicKey, Botan::SM2_PublicKey, Botan::SphincsPlus_PublicKey, and Botan::XMSS_PublicKey.

Definition at line 101 of file pk_keys.cpp.

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

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

Referenced by Botan::PK_Verifier::PK_Verifier().

◆ create_x509_verification_op()

std::unique_ptr< PK_Ops::Verification > Botan::Public_Key::create_x509_verification_op	(	const AlgorithmIdentifier &	signature_algorithm,
		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 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 in Botan::RSA_PublicKey, Botan::XMSS_PublicKey, Botan::Ed448_PublicKey, Botan::Dilithium_PublicKey, Botan::DSA_PublicKey, Botan::ECDSA_PublicKey, Botan::ECGDSA_PublicKey, Botan::ECKCDSA_PublicKey, Botan::Ed25519_PublicKey, Botan::GOST_3410_PublicKey, and Botan::SphincsPlus_PublicKey.

Definition at line 106 of file pk_keys.cpp.

                                                                                                      {
   throw Lookup_Error(fmt("{} does not support X.509 verification", algo_name()));
}

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

Referenced by Botan::PK_Verifier::PK_Verifier().

◆ default_x509_signature_format()

virtual Signature_Format Botan::Public_Key::default_x509_signature_format ( ) const

inlinevirtualinherited

Reimplemented in Botan::GOST_3410_PublicKey.

Definition at line 190 of file pk_keys.h.

                                                                     {
         return (this->message_parts() >= 2) ? Signature_Format::DerSequence : Signature_Format::Standard;
      }

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

◆ DER_domain()

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

inlineinherited

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

Definition at line 72 of file ecc_key.h.

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

Botan::EC_Group::DER_encode

std::vector< uint8_t > DER_encode(EC_Group_Encoding form) const

Definition ec_group.cpp:642

Botan::EC_PublicKey::domain_format

EC_Group_Encoding domain_format() const

Definition ecc_key.h:78

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

◆ domain()

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

inlineinherited

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 54 of file ecc_key.h.

54{ return m_domain_params; }

Referenced by Botan::GOST_3410_PublicKey::algo_name(), Botan::GOST_3410_PublicKey::algorithm_identifier(), botan_pubkey_ecc_key_used_explicit_encoding(), botan_pubkey_sm2_compute_za(), EC_PrivateKey(), EC_PrivateKey(), Botan::ECDH_PublicKey::generate_another(), Botan::ECDSA_PublicKey::generate_another(), Botan::EC_PublicKey::get_int_field(), Botan::GOST_3410_PublicKey::GOST_3410_PublicKey(), Botan::EC_PublicKey::key_length(), Botan::ECDH_PrivateKey::public_key(), Botan::ECDSA_PrivateKey::public_key(), Botan::ECGDSA_PrivateKey::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::ECDSA_PublicKey::recovery_param(), Botan::SM2_PrivateKey::SM2_PrivateKey(), and Botan::SM2_PrivateKey::SM2_PrivateKey().

◆ 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 78 of file ecc_key.h.

78{ return m_domain_encoding; }

◆ 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 25 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 86 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 79 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()

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

pure virtualinherited

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.

Implemented in Botan::TPM_PrivateKey, Botan::Curve25519_PublicKey, Botan::Ed448_PublicKey, Botan::X448_PublicKey, Botan::DH_PublicKey, Botan::Dilithium_PublicKey, Botan::DSA_PublicKey, Botan::ECDH_PublicKey, Botan::ECGDSA_PublicKey, Botan::ECKCDSA_PublicKey, Botan::Ed25519_PublicKey, Botan::ElGamal_PublicKey, Botan::FrodoKEM_PublicKey, Botan::GOST_3410_PublicKey, Botan::Kyber_PublicKey, Botan::McEliece_PublicKey, Botan::SM2_PublicKey, Botan::SphincsPlus_PublicKey, Botan::XMSS_PublicKey, Botan::TLS::Hybrid_KEM_PublicKey, Botan::TLS::KEX_to_KEM_Adapter_PublicKey, Botan::ECDSA_PublicKey, and Botan::RSA_PublicKey.

◆ get_int_field()

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

finalvirtual

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.

Reimplemented from Botan::Asymmetric_Key.

Definition at line 195 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 private_value().

◆ get_oid()

OID Botan::Public_Key::get_oid ( ) const

inlineinherited

Deprecated version of object_identifier

Definition at line 132 of file pk_keys.h.

132{ 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 21 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()

virtual size_t Botan::Public_Key::message_part_size ( ) const

inlinevirtualinherited

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

Reimplemented in Botan::DSA_PublicKey, Botan::ECDSA_PublicKey, Botan::ECGDSA_PublicKey, Botan::ECKCDSA_PublicKey, Botan::GOST_3410_PublicKey, and Botan::SM2_PublicKey.

Definition at line 188 of file pk_keys.h.

188{ return 0; }

Referenced by Botan::PK_Signer::PK_Signer(), Botan::PK_Verifier::PK_Verifier(), and Botan::PK_Verifier::PK_Verifier().

◆ message_parts()

virtual size_t Botan::Public_Key::message_parts ( ) const

inlinevirtualinherited

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

Reimplemented in Botan::DSA_PublicKey, Botan::ECDSA_PublicKey, Botan::ECGDSA_PublicKey, Botan::ECKCDSA_PublicKey, Botan::GOST_3410_PublicKey, and Botan::SM2_PublicKey.

Definition at line 177 of file pk_keys.h.

177{ return 1; }

Referenced by Botan::PK_Signer::PK_Signer(), Botan::PK_Verifier::PK_Verifier(), and Botan::PK_Verifier::PK_Verifier().

◆ 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::Dilithium_PublicKey, Botan::FrodoKEM_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().

◆ operator=()

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

default

◆ 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.

Definition at line 285 of file pk_keys.h.

285{ 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 84 of file ecc_key.h.

84{ return m_point_encoding; }

Botan::EC_PublicKey::m_point_encoding

EC_Point_Format m_point_encoding

Definition ecc_key.h:111

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

◆ private_key_bits()

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

finalvirtual

Returns: BER encoded private key bits

Implements Botan::Private_Key.

Definition at line 117 of file ecc_key.cpp.

                                                             {
   return DER_Encoder()
      .start_sequence()
      .encode(static_cast<size_t>(1))
      .encode(BigInt::encode_1363(m_private_key, m_private_key.bytes()), ASN1_Type::OctetString)
      .start_explicit_context_specific(1)
      .encode(m_public_key.encode(EC_Point_Format::Uncompressed), ASN1_Type::BitString)
      .end_cons()
      .end_cons()
      .get_contents();
}

References Botan::BitString, Botan::BigInt::bytes(), Botan::DER_Encoder::encode(), Botan::EC_Point::encode(), Botan::BigInt::encode_1363(), Botan::DER_Encoder::end_cons(), Botan::DER_Encoder::get_contents(), m_private_key, Botan::EC_PublicKey::m_public_key, Botan::OctetString, Botan::DER_Encoder::start_explicit_context_specific(), Botan::DER_Encoder::start_sequence(), and Botan::Uncompressed.

◆ 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 60 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

Get the private key value of this key object.

Returns: the private key value of this key object

Definition at line 77 of file ecc_key.cpp.

                                                 {
   if(m_private_key == 0) {
      throw Invalid_State("EC_PrivateKey::private_value - uninitialized");
   }
 
   return m_private_key;
}

References m_private_key.

Referenced by get_int_field().

◆ public_key()

virtual std::unique_ptr< Public_Key > Botan::Private_Key::public_key ( ) const

pure virtualinherited

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

Returns: public key

◆ 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.

Definition at line 57 of file ecc_key.cpp.

                                                       {
   return public_point().encode(point_encoding());
}

References Botan::EC_Point::encode(), Botan::EC_PublicKey::point_encoding(), and Botan::EC_PublicKey::public_point().

Referenced by EC_PrivateKey().

◆ public_point()

const EC_Point & Botan::EC_PublicKey::public_point ( ) const

inlineinherited

Get the public point of this key.

Exceptions

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

Returns: the public point of this key

Definition at line 40 of file ecc_key.h.

40{ return m_public_key; }

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

◆ raw_private_key_bits()

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

finalvirtual

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 113 of file ecc_key.cpp.

                                                                 {
   return BigInt::encode_locked(m_private_key);
}

References Botan::BigInt::encode_locked(), and m_private_key.

◆ 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::XMSS_PrivateKey.

Definition at line 298 of file pk_keys.h.

298{ 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

Definition at line 69 of file ecc_key.cpp.

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

References Botan::OID::empty(), Botan::EC_Group::get_curve_oid(), Botan::EC_PublicKey::m_domain_encoding, Botan::EC_PublicKey::m_domain_params, 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 61 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::XMSS_PrivateKey.

Definition at line 291 of file pk_keys.h.

291{ 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 48 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()

virtual bool Botan::Asymmetric_Key::supports_operation ( PublicKeyOperation op ) const

pure virtualinherited

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

Implemented in Botan::TPM_PrivateKey, Botan::Curve25519_PublicKey, Botan::Ed448_PublicKey, Botan::X448_PublicKey, Botan::DH_PublicKey, Botan::Dilithium_PublicKey, Botan::DSA_PublicKey, Botan::ECDH_PublicKey, Botan::ECDSA_PublicKey, Botan::ECGDSA_PublicKey, Botan::ECKCDSA_PublicKey, Botan::Ed25519_PublicKey, Botan::ElGamal_PublicKey, Botan::FrodoKEM_PublicKey, Botan::GOST_3410_PublicKey, Botan::Kyber_PublicKey, Botan::McEliece_PublicKey, Botan::RSA_PublicKey, Botan::SM2_PublicKey, Botan::SphincsPlus_PublicKey, Botan::XMSS_PublicKey, Botan::TLS::Hybrid_KEM_PublicKey, and Botan::TLS::KEX_to_KEM_Adapter_PublicKey.

Referenced by Botan::Key_Constraints::compatible_with().

Member Data Documentation

◆ m_domain_encoding

EC_Group_Encoding Botan::EC_PublicKey::m_domain_encoding

protectedinherited

Definition at line 110 of file ecc_key.h.

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

◆ m_domain_params

EC_Group Botan::EC_PublicKey::m_domain_params

protectedinherited

Definition at line 108 of file ecc_key.h.

Referenced by Botan::EC_PublicKey::check_key(), check_key(), Botan::SM2_PrivateKey::check_key(), EC_PrivateKey(), EC_PrivateKey(), Botan::GOST_3410_PrivateKey::GOST_3410_PrivateKey(), Botan::GOST_3410_PublicKey::GOST_3410_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 111 of file ecc_key.h.

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

◆ m_private_key

BigInt Botan::EC_PrivateKey::m_private_key

protected

Definition at line 171 of file ecc_key.h.

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

◆ m_public_key

EC_Point Botan::EC_PublicKey::m_public_key

protectedinherited

Definition at line 109 of file ecc_key.h.

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

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ EC_PrivateKey() [1/4]

◆ ~EC_PrivateKey()

◆ EC_PrivateKey() [2/4]

◆ EC_PrivateKey() [3/4]

◆ EC_PrivateKey() [4/4]

Member Function Documentation

◆ 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()

◆ operator=()

◆ pkcs8_algorithm_identifier()

◆ point_encoding()

◆ private_key_bits()

◆ private_key_info()

◆ private_value()

◆ public_key()

◆ public_key_bits()

◆ public_point()

◆ raw_private_key_bits()

◆ remaining_operations()

◆ set_parameter_encoding()

◆ set_point_encoding()

◆ stateful_operation()

◆ subject_public_key()

◆ supports_operation()

Member Data Documentation

◆ m_domain_encoding

◆ m_domain_params

◆ m_point_encoding

◆ m_private_key

◆ m_public_key