Botan::SM2_PrivateKey Class Reference

#include <sm2.h>

Inheritance diagram for Botan::SM2_PrivateKey:

Public Member Functions
virtual Signature_Format	_default_x509_signature_format () const
const EC_Scalar &	_get_da_inv () 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 strong) const override
std::unique_ptr< PK_Ops::Decryption >	create_decryption_op (RandomNumberGenerator &rng, std::string_view params, std::string_view provider) const override
std::unique_ptr< PK_Ops::Encryption >	create_encryption_op (RandomNumberGenerator &rng, std::string_view params, std::string_view provider) const override
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
virtual std::unique_ptr< PK_Ops::Verification >	create_x509_verification_op (const AlgorithmIdentifier &signature_algorithm, std::string_view provider) const
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
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_da_inv () const
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)
	SM2_PrivateKey (const AlgorithmIdentifier &alg_id, std::span< const uint8_t > key_bits)
	SM2_PrivateKey (const EC_Group &group, const EC_Scalar &x)
	SM2_PrivateKey (RandomNumberGenerator &rng, const EC_Group &group)
	SM2_PrivateKey (RandomNumberGenerator &rng, const EC_Group &group, const BigInt &x)
virtual bool	stateful_operation () const
std::vector< uint8_t >	subject_public_key () const
bool	supports_operation (PublicKeyOperation op) const override

Static Protected Member Functions
static const AlgorithmIdentifier &	assert_algorithm_identifier (const AlgorithmIdentifier &alg_id, std::string_view alg_name)

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
bool	m_with_modular_inverse

Detailed Description

This class represents SM2 private keys

Definition at line 77 of file sm2.h.

Constructor & Destructor Documentation

SM2_PrivateKey() [1/4]

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

Load a private key

Parameters

alg_id	the X.509 algorithm identifier
key_bits	ECPrivateKey bits

Definition at line 70 of file sm2.cpp.

                                                                                                 :
      EC_PrivateKey(assert_sm2_algorithm_identifier(alg_id), key_bits),
      m_da_inv((this->_private_key() + EC_Scalar::one(domain())).invert()),
      m_da_inv_legacy(m_da_inv.to_bigint()) {
   if(m_da_inv.is_zero()) {
      throw Decoding_Error("SM2 private key cannot equal n-1");
   }
}

References Botan::EC_PrivateKey::_private_key(), Botan::EC_PublicKey::domain(), and Botan::EC_PrivateKey::EC_PrivateKey().

Referenced by SM2_PrivateKey().

SM2_PrivateKey() [2/4]

Botan::SM2_PrivateKey::SM2_PrivateKey	(	const EC_Group &	group,
		const EC_Scalar &	x )

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 79 of file sm2.cpp.

                                                                        :
      EC_PrivateKey(group, x),
      m_da_inv((this->_private_key() + EC_Scalar::one(domain())).invert()),
      m_da_inv_legacy(m_da_inv.to_bigint()) {
   BOTAN_ARG_CHECK(m_da_inv.is_nonzero(), "SM2 private key cannot equal n-1");
}

References Botan::EC_PrivateKey::_private_key(), BOTAN_ARG_CHECK, Botan::EC_PublicKey::domain(), and Botan::EC_PrivateKey::EC_PrivateKey().

SM2_PrivateKey() [3/4]

Botan::SM2_PrivateKey::SM2_PrivateKey	(	RandomNumberGenerator &	rng,
		const EC_Group &	group )

Create a new private key

Parameters

Random Number Generators	a random number generator
group	parameters to used for this key

Definition at line 104 of file sm2.cpp.

                                                                                :
      SM2_PrivateKey(group, generate_sm2_private_key(rng, group)) {}

References SM2_PrivateKey().

SM2_PrivateKey() [4/4]

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

Create a private key.

Parameters

Random Number Generators	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 sm2.cpp.

                                                                                                 :
      EC_PrivateKey(rng, group, x),
      m_da_inv((this->_private_key() + EC_Scalar::one(domain())).invert()),
      m_da_inv_legacy(m_da_inv.to_bigint()) {
   BOTAN_ARG_CHECK(m_da_inv.is_nonzero(), "SM2 private key cannot equal n-1");
}

References Botan::EC_PrivateKey::_private_key(), BOTAN_ARG_CHECK, Botan::EC_PublicKey::domain(), and Botan::EC_PrivateKey::EC_PrivateKey().

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 _signature_element_size_for_DER_encoding(), Botan::DerSequence, and Botan::Standard.

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

_get_da_inv()

const EC_Scalar & Botan::SM2_PrivateKey::_get_da_inv ( ) const

inline

Definition at line 125 of file sm2.h.

{ return m_da_inv; }

_private_key()

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

inherited

Definition at line 135 of file ecc_key.cpp.

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

References BOTAN_STATE_CHECK, and m_private_key.

Referenced by botan_ec_privkey_get_private_key(), Botan::SM2_PrivateKey::SM2_PrivateKey(), Botan::SM2_PrivateKey::SM2_PrivateKey(), Botan::SM2_PrivateKey::SM2_PrivateKey(), and ~EC_PrivateKey().

_public_ec_point()

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

inherited

Definition at line 88 of file ecc_key.cpp.

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

References BOTAN_STATE_CHECK, and m_public_key.

Referenced by botan_pubkey_sm2_compute_za(), Botan::EC_PrivateKey::check_key(), check_key(), 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::TPM2::EC_PrivateKey::public_key(), Botan::GOST_3410_PublicKey::public_key_bits(), Botan::ECDH_PublicKey::public_value(), raw_public_key_bits(), and Botan::ECDSA_PublicKey::recovery_param().

_signature_element_size_for_DER_encoding()

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

overridevirtualinherited

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 41 of file sm2.cpp.

                                                                                  {
   return domain().get_order_bytes();
}

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

algo_name()

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

overridevirtualinherited

Get this keys algorithm name.

Returns

this keys algorithm name

Implements Botan::Asymmetric_Key.

Definition at line 20 of file sm2.cpp.

                                         {
   return "SM2";
}

Referenced by Botan::SM2_PrivateKey::create_decryption_op(), create_encryption_op(), Botan::SM2_PrivateKey::create_signature_op(), and create_verification_op().

algorithm_identifier()

AlgorithmIdentifier Botan::EC_PublicKey::algorithm_identifier ( ) const

overridevirtualinherited

Return the X.509 AlgorithmIdentifier for this key

Implements Botan::Public_Key.

Reimplemented in Botan::GOST_3410_PublicKey.

Definition at line 98 of file ecc_key.cpp.

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

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

Referenced by ~EC_PublicKey().

assert_algorithm_identifier()

const AlgorithmIdentifier & Botan::EC_PublicKey::assert_algorithm_identifier ( const AlgorithmIdentifier & alg_id, std::string_view alg_name )

staticprotectedinherited

Definition at line 48 of file ecc_key.cpp.

                                                                                              {
   if(alg_id.oid() != OID::from_string(alg_name)) {
      throw Decoding_Error(
         fmt("Unexpected AlgorithmIdentifier OID {} in association with {} key", alg_id.oid(), alg_name));
   }
 
   return alg_id;  // NOLINT(*-return-const-ref-from-parameter)
}

References Botan::fmt(), Botan::OID::from_string(), and Botan::AlgorithmIdentifier::oid().

Referenced by Botan::ECDSA_PrivateKey::ECDSA_PrivateKey(), Botan::ECDSA_PublicKey::ECDSA_PublicKey(), Botan::ECGDSA_PrivateKey::ECGDSA_PrivateKey(), Botan::ECGDSA_PublicKey::ECGDSA_PublicKey(), Botan::ECKCDSA_PrivateKey::ECKCDSA_PrivateKey(), and Botan::ECKCDSA_PublicKey::ECKCDSA_PublicKey().

check_key()

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

overridevirtual

Test the key values for consistency.

Note this function is always "best effort"; for many algorithms it is not computationally possible to ensure the key is correctly formed in all respects. There is always the possibility a malformed key will be accepted; this is especially the case for public keys.

Parameters

Random Number Generators	rng to use for randomized testing (may be ignored)
strong	whether to perform strong and lengthy version of the test, however for many algorithms this has no effect

Returns

true if the tests passed

Reimplemented from Botan::EC_PublicKey.

Definition at line 49 of file sm2.cpp.

                                                                            {
   if(!EC_PrivateKey::check_key(rng, strong)) {
      return false;
   }
 
   // SM2 has an oddity in private key generation when compared to
   // other EC*DSA style signature algorithms described in ISO14888-3:
   // the private key x MUST be in [0, q-1) instead of [0, q).
   //
   // The lower bound is already checked by the default impl
   if(private_value() >= domain().get_order() - 1) {
      return false;
   }
 
   if(!strong) {
      return true;
   }
 
   return KeyPair::signature_consistency_check(rng, *this, "user@example.com,SM3");
}

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

create_decryption_op()

std::unique_ptr< PK_Ops::Decryption > Botan::SM2_PrivateKey::create_decryption_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 an decryption operation for this key/params or throw

Parameters

Random Number Generators	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 222 of file sm2_enc.cpp.

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

References Botan::SM2_PublicKey::algo_name().

create_encryption_op()

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

overridevirtualinherited

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

Random Number Generators	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::Public_Key.

Definition at line 206 of file sm2_enc.cpp.

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

References algo_name(), and BOTAN_UNUSED.

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

Random Number Generators	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::KEX_to_KEM_Adapter_PrivateKey, Botan::Kyber_PrivateKey, Botan::McEliece_PrivateKey, Botan::RSA_PrivateKey, and Botan::TLS::Hybrid_KEM_PrivateKey.

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

Definition at line 111 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

Random Number Generators	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 144 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::SM2_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

Random Number Generators	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 331 of file sm2.cpp.

                                                                                                      {
   if(provider == "base" || provider.empty()) {
      const auto [userid, hash] = parse_sm2_param_string(params);
      return std::make_unique<SM2_Signature_Operation>(*this, userid, hash);
   }
 
   throw Provider_Not_Found(algo_name(), provider);
}

References Botan::SM2_PublicKey::algo_name().

create_verification_op()

std::unique_ptr< PK_Ops::Verification > Botan::SM2_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 321 of file sm2.cpp.

                                                                                                           {
   if(provider == "base" || provider.empty()) {
      const auto [userid, hash] = parse_sm2_param_string(params);
      return std::make_unique<SM2_Verification_Operation>(*this, userid, hash);
   }
 
   throw Provider_Not_Found(algo_name(), provider);
}

References algo_name().

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::Dilithium_PublicKey, Botan::DSA_PublicKey, Botan::ECDSA_PublicKey, Botan::ECGDSA_PublicKey, Botan::ECKCDSA_PublicKey, Botan::Ed25519_PublicKey, Botan::Ed448_PublicKey, Botan::GOST_3410_PublicKey, Botan::HSS_LMS_PublicKey, Botan::RSA_PublicKey, Botan::SphincsPlus_PublicKey, and Botan::XMSS_PublicKey.

Definition at line 121 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()

Signature_Format Botan::Public_Key::default_x509_signature_format ( ) const

inlineinherited

Definition at line 241 of file pk_keys.h.

                                                                                                           {
         return _default_x509_signature_format();
      }

References Botan::Asymmetric_Key::_default_x509_signature_format(), and default_x509_signature_format().

Referenced by 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 110 of file ecc_key.cpp.

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

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

Referenced by algorithm_identifier(), and ~EC_PublicKey().

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

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

References BOTAN_STATE_CHECK, and m_public_key.

Referenced by Botan::ECDSA_PublicKey::_signature_element_size_for_DER_encoding(), Botan::ECGDSA_PublicKey::_signature_element_size_for_DER_encoding(), Botan::ECKCDSA_PublicKey::_signature_element_size_for_DER_encoding(), Botan::GOST_3410_PublicKey::_signature_element_size_for_DER_encoding(), Botan::SM2_PublicKey::_signature_element_size_for_DER_encoding(), Botan::GOST_3410_PublicKey::algo_name(), Botan::GOST_3410_PublicKey::algorithm_identifier(), botan_ec_privkey_get_group(), botan_ec_pubkey_get_group(), botan_pubkey_ecc_key_used_explicit_encoding(), botan_pubkey_sm2_compute_za(), check_key(), Botan::SM2_PrivateKey::check_key(), DER_domain(), Botan::EC_PrivateKey::EC_PrivateKey(), Botan::EC_PrivateKey::EC_PrivateKey(), Botan::EC_PrivateKey::EC_PrivateKey(), Botan::EC_PrivateKey::EC_PrivateKey(), EC_PublicKey(), EC_PublicKey(), Botan::ECDH_PublicKey::generate_another(), Botan::ECDSA_PublicKey::generate_another(), Botan::ECGDSA_PublicKey::generate_another(), Botan::ECKCDSA_PublicKey::generate_another(), Botan::GOST_3410_PublicKey::generate_another(), Botan::SM2_PublicKey::generate_another(), get_int_field(), Botan::GOST_3410_PrivateKey::GOST_3410_PrivateKey(), Botan::GOST_3410_PrivateKey::GOST_3410_PrivateKey(), Botan::GOST_3410_PrivateKey::GOST_3410_PrivateKey(), 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::TPM2::EC_PrivateKey::public_key(), Botan::ECDSA_PublicKey::recovery_param(), set_parameter_encoding(), Botan::SM2_PrivateKey::SM2_PrivateKey(), Botan::SM2_PrivateKey::SM2_PrivateKey(), Botan::SM2_PrivateKey::SM2_PrivateKey(), and ~EC_PublicKey().

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

{ return m_domain_encoding; }

References domain_format(), and m_domain_encoding.

Referenced by DER_domain(), and domain_format().

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

                                              {
   return ecp_work_factor(key_length());
}

References Botan::ecp_work_factor(), and 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 101 of file pk_keys.cpp.

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

References Botan::create_hex_fingerprint(), and 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 94 of file pk_keys.cpp.

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

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

Referenced by public_key_bits().

generate_another()

std::unique_ptr< Private_Key > Botan::SM2_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 317 of file sm2.cpp.

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

References Botan::EC_PublicKey::domain().

get_da_inv()

const BigInt & Botan::SM2_PrivateKey::get_da_inv ( ) const

inline

Definition at line 123 of file sm2.h.

{ return m_da_inv_legacy; }

References get_da_inv().

Referenced by get_da_inv().

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 272 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().

Referenced by ~EC_PrivateKey().

get_oid()

OID Botan::Public_Key::get_oid ( ) const

inlineinherited

Deprecated version of object_identifier

Definition at line 168 of file pk_keys.h.

{ return this->object_identifier(); }

References get_oid(), and Botan::Asymmetric_Key::object_identifier().

Referenced by get_oid().

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

                                      {
   return domain().get_p_bits();
}

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

Referenced by estimated_strength().

message_part_size()

size_t Botan::Public_Key::message_part_size ( ) const

inlineinherited

Returns how large each of the message parts referred 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 232 of file pk_keys.h.

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

References Botan::Asymmetric_Key::_signature_element_size_for_DER_encoding(), and message_part_size().

Referenced by message_part_size().

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 219 of file pk_keys.h.

                                                                                 {
         return _signature_element_size_for_DER_encoding() ? 2 : 1;
      }

References Botan::Asymmetric_Key::_signature_element_size_for_DER_encoding(), and message_parts().

Referenced by message_parts().

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 algo_name(), Botan::fmt(), and Botan::OID::from_string().

Referenced by Botan::DH_PublicKey::algorithm_identifier(), Botan::DSA_PublicKey::algorithm_identifier(), Botan::EC_PublicKey::algorithm_identifier(), Botan::Ed25519_PublicKey::algorithm_identifier(), Botan::Ed448_PublicKey::algorithm_identifier(), Botan::ElGamal_PublicKey::algorithm_identifier(), Botan::GOST_3410_PublicKey::algorithm_identifier(), Botan::McEliece_PublicKey::algorithm_identifier(), Botan::RSA_PublicKey::algorithm_identifier(), Botan::TPM_PrivateKey::algorithm_identifier(), Botan::X25519_PublicKey::algorithm_identifier(), Botan::X448_PublicKey::algorithm_identifier(), Botan::XMSS_PublicKey::algorithm_identifier(), estimated_strength(), and Botan::Public_Key::get_oid().

pkcs8_algorithm_identifier()

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

inlinevirtualinherited

Return the PKCS #8 AlgorithmIdentifier for this key

Note

normally this is the same as the public key identifier, but a few oddball algorithms use a different value

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

Definition at line 343 of file pk_keys.h.

{ return algorithm_identifier(); }

References Botan::Public_Key::algorithm_identifier().

Referenced by 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 102 of file ecc_key.h.

{ return m_point_encoding; }

References m_point_encoding.

Referenced by raw_public_key_bits().

private_key_bits()

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

finalvirtualinherited

Return the PKCS8 private key encoding

Note

this encoding omits the outer PKCS8 algorithm identifiers and will not be portably decodable on its own. Prefer private_key_info.

Implements Botan::Private_Key.

Definition at line 174 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_octet_aligned_bitstring(m_public_key->public_key().serialize_uncompressed())
      .end_cons()
      .end_cons()
      .get_contents();
}

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

Referenced by EC_PrivateKey().

private_key_info()

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

inherited

Return PKCS #8 private key encoding for this key object

Definition at line 75 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, pkcs8_algorithm_identifier(), 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(), Botan::PKCS8::PEM_encode(), and public_key().

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

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

References BOTAN_STATE_CHECK, and m_private_key.

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

public_key()

std::unique_ptr< Public_Key > Botan::SM2_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 45 of file sm2.cpp.

                                                           {
   return std::make_unique<SM2_Signature_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

Return the subject public key encoding of this public key

Note

this excludes the parameters field and may not be reliably decodable

Implements Botan::Public_Key.

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

Definition at line 106 of file ecc_key.cpp.

                                                       {
   return raw_public_key_bits();
}

References raw_public_key_bits().

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

raw_private_key_bits()

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

finalvirtualinherited

Return the 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 169 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 m_private_key.

Referenced by private_key_bits().

raw_public_key_bits()

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

overridevirtualinherited

Return the raw public key bits (algorithm specific) with no extra 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 102 of file ecc_key.cpp.

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

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

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

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 356 of file pk_keys.h.

{ 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 122 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 domain(), m_domain_encoding, and Botan::NamedCurve.

Referenced by ~EC_PublicKey().

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 114 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, m_point_encoding, and Botan::Uncompressed.

Referenced by ~EC_PublicKey().

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 349 of file pk_keys.h.

{ return false; }

subject_public_key()

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

inherited

Return the SubjectPublicKeyInfo encoding of this public key

This is the subjectPublicKey field plus the algorithm-specific parameters

Definition at line 63 of file pk_keys.cpp.

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

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

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

supports_operation()

bool Botan::SM2_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 53 of file sm2.h.

                                                                    {
         return (op == PublicKeyOperation::Signature || op == PublicKeyOperation::Encryption);
      }

References Botan::Encryption, and Botan::Signature.

Member Data Documentation

m_domain_encoding

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

protectedinherited

Definition at line 143 of file ecc_key.h.

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

m_point_encoding

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

protectedinherited

Definition at line 144 of file ecc_key.h.

Referenced by point_encoding(), and set_point_encoding().

m_private_key

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

protectedinherited

Definition at line 229 of file ecc_key.h.

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

m_public_key

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

protectedinherited

Definition at line 142 of file ecc_key.h.

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

m_with_modular_inverse

bool Botan::EC_PrivateKey::m_with_modular_inverse

protectedinherited

Definition at line 230 of file ecc_key.h.

Referenced by check_key(), EC_PrivateKey(), EC_PrivateKey(), EC_PrivateKey(), EC_PrivateKey(), and EC_PrivateKey().

---

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

• src/lib/pubkey/sm2/sm2.h
• src/lib/pubkey/sm2/sm2.cpp
• src/lib/pubkey/sm2/sm2_enc.cpp