Botan::SM2_PublicKey Class Reference

#include <sm2.h>

Inheritance diagram for Botan::SM2_PublicKey:

Public Member Functions
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::Encryption >	create_encryption_op (RandomNumberGenerator &rng, const std::string &params, const std::string &provider) const override
virtual std::unique_ptr< PK_Ops::KEM_Encryption >	create_kem_encryption_op (RandomNumberGenerator &rng, const std::string &params, const std::string &provider) const
std::unique_ptr< PK_Ops::Verification >	create_verification_op (const std::string &params, const std::string &provider) const override
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
size_t	estimated_strength () const override
std::string	fingerprint_public (const std::string &alg="SHA-256") const
virtual OID	get_oid () const
size_t	key_length () const override
size_t	message_part_size () const override
size_t	message_parts () const override
PointGFp::Compression_Type	point_encoding () const
std::vector< uint8_t >	public_key_bits () const override
const PointGFp &	public_point () const
void	set_parameter_encoding (EC_Group_Encoding enc)
void	set_point_encoding (PointGFp::Compression_Type enc)
	SM2_PublicKey (const AlgorithmIdentifier &alg_id, const std::vector< uint8_t > &key_bits)
	SM2_PublicKey (const EC_Group &dom_par, const PointGFp &public_point)
std::vector< uint8_t >	subject_public_key () const

Protected Member Functions
	SM2_PublicKey ()=default

Protected Attributes
EC_Group_Encoding	m_domain_encoding
EC_Group	m_domain_params
PointGFp::Compression_Type	m_point_encoding = PointGFp::UNCOMPRESSED
PointGFp	m_public_key

Detailed Description

This class represents SM2 public keys

Definition at line 18 of file sm2.h.

Constructor & Destructor Documentation

SM2_PublicKey() [1/3]

Botan::SM2_PublicKey::SM2_PublicKey ( const EC_Group &  dom_par, const PointGFp &  public_point  )

inline

Create a public key from a given public point.

Parameters

dom_par	the domain parameters associated with this key
public_point	the public point defining this key

Definition at line 27 of file sm2.h.

                                                  :
         EC_PublicKey(dom_par, public_point) {}

SM2_PublicKey() [2/3]

Botan::SM2_PublicKey::SM2_PublicKey ( const AlgorithmIdentifier &  alg_id, const std::vector< uint8_t > &  key_bits  )

inline

Load a public key.

Parameters

alg_id	the X.509 algorithm identifier
key_bits	DER encoded public key bits

Definition at line 36 of file sm2.h.

                                                        :
         EC_PublicKey(alg_id, key_bits) {}

SM2_PublicKey() [3/3]

Botan::SM2_PublicKey::SM2_PublicKey ( )

protecteddefault

Member Function Documentation

algo_name()

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

overridevirtual

Get this keys algorithm name.

Returns

this keys algorithm name

Implements Botan::Public_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

Returns

X.509 AlgorithmIdentifier for this key

Implements Botan::Public_Key.

Reimplemented in Botan::GOST_3410_PublicKey.

Definition at line 70 of file ecc_key.cpp.

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

References Botan::EC_PublicKey::DER_domain(), and Botan::Public_Key::get_oid().

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

check_key()

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

overridevirtualinherited

Test the key values for consistency.

Parameters

rng	rng to use
strong	whether to perform strong and lengthy version of the test

Returns

true if the test is passed

Implements Botan::Public_Key.

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

Definition at line 62 of file ecc_key.cpp.

   {
   return m_domain_params.verify_group(rng) &&
          m_domain_params.verify_public_element(public_point());
   }

References Botan::EC_PublicKey::m_domain_params, Botan::EC_PublicKey::public_point(), Botan::EC_Group::verify_group(), and Botan::EC_Group::verify_public_element().

create_encryption_op()

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

overridevirtual

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 from Botan::Public_Key.

Definition at line 240 of file sm2_enc.cpp.

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

References algo_name().

create_kem_encryption_op()

std::unique_ptr< PK_Ops::KEM_Encryption > Botan::Public_Key::create_kem_encryption_op ( RandomNumberGenerator &  rng, const std::string &  params, const std::string &  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

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::Kyber_PublicKey, Botan::McEliece_PublicKey, and Botan::RSA_PublicKey.

Definition at line 99 of file pk_keys.cpp.

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

References Botan::Public_Key::algo_name().

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

create_verification_op()

std::unique_ptr< PK_Ops::Verification > Botan::SM2_PublicKey::create_verification_op ( const std::string &  params, const std::string &  provider  ) const

overridevirtual

This is an internal library function exposed on key types. In almost 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 283 of file sm2.cpp.

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

References algo_name(), and hash.

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

         {
         return (this->message_parts() >= 2) ? DER_SEQUENCE : IEEE_1363;
         }

References Botan::DER_SEQUENCE, and Botan::IEEE_1363.

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

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

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

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

{ return m_domain_params; }

Referenced by Botan::GOST_3410_PublicKey::algo_name(), Botan::GOST_3410_PublicKey::algorithm_identifier(), botan_pubkey_sm2_compute_za(), Botan::EC_PrivateKey::EC_PrivateKey(), Botan::EC_PublicKey::EC_PublicKey(), 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::ECDSA_PublicKey::recovery_param(), 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 81 of file ecc_key.h.

         { 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::Public_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_public()

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

inherited

Returns

Hash of the subject public key

Definition at line 77 of file pk_keys.cpp.

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

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

get_oid()

OID Botan::Public_Key::get_oid ( ) const

virtualinherited

Get the OID of the underlying public key scheme.

Returns

OID of the public key scheme

Reimplemented in Botan::XMSS_WOTS_Addressed_PublicKey.

Definition at line 53 of file pk_keys.cpp.

   {
   OID o = OIDS::str2oid_or_empty(algo_name());
   if(o.empty())
      throw Lookup_Error("PK algo " + algo_name() + " has no defined OIDs");
   return o;
   }

References Botan::Public_Key::algo_name(), Botan::OID::empty(), and Botan::OIDS::str2oid_or_empty().

Referenced by Botan::TPM_PrivateKey::algorithm_identifier(), Botan::Curve25519_PublicKey::algorithm_identifier(), Botan::DL_Scheme_PublicKey::algorithm_identifier(), Botan::EC_PublicKey::algorithm_identifier(), Botan::Ed25519_PublicKey::algorithm_identifier(), Botan::GOST_3410_PublicKey::algorithm_identifier(), Botan::Kyber_PublicKey::algorithm_identifier(), Botan::McEliece_PublicKey::algorithm_identifier(), Botan::RSA_PublicKey::algorithm_identifier(), and Botan::XMSS_WOTS_Addressed_PublicKey::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 20 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::SM2_PublicKey::message_part_size ( ) const

inlineoverridevirtual

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 from Botan::Public_Key.

Definition at line 48 of file sm2.h.

         { return domain().get_order().bytes(); }

message_parts()

size_t Botan::SM2_PublicKey::message_parts ( ) const

inlineoverridevirtual

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 from Botan::Public_Key.

Definition at line 46 of file sm2.h.

{ return 2; }

point_encoding()

PointGFp::Compression_Type 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 88 of file ecc_key.h.

         { return m_point_encoding; }

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

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

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

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

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

public_point()

const PointGFp & 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 41 of file ecc_key.h.

{ return m_public_key; }

Referenced by botan_pubkey_sm2_compute_za(), Botan::EC_PublicKey::check_key(), Botan::ECDSA_PrivateKey::check_key(), Botan::ECGDSA_PrivateKey::check_key(), Botan::ECKCDSA_PrivateKey::check_key(), Botan::SM2_PrivateKey::check_key(), Botan::EC_PublicKey::EC_PublicKey(), 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().

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 90 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 ( PointGFp::Compression_Type  enc )

inherited

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

Parameters

enc	the encoding to use

Definition at line 80 of file ecc_key.cpp.

   {
   if(enc != PointGFp::COMPRESSED &&
      enc != PointGFp::UNCOMPRESSED &&
      enc != PointGFp::HYBRID)
      throw Invalid_Argument("Invalid point encoding for EC_PublicKey");
 
   m_point_encoding = enc;
   }

References Botan::PointGFp::COMPRESSED, Botan::PointGFp::HYBRID, Botan::EC_PublicKey::m_point_encoding, and Botan::PointGFp::UNCOMPRESSED.

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

Member Data Documentation

m_domain_encoding

EC_Group_Encoding Botan::EC_PublicKey::m_domain_encoding

protectedinherited

Definition at line 116 of file ecc_key.h.

Referenced by Botan::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 114 of file ecc_key.h.

Referenced by Botan::EC_PublicKey::check_key(), Botan::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

PointGFp::Compression_Type Botan::EC_PublicKey::m_point_encoding = PointGFp::UNCOMPRESSED

protectedinherited

Definition at line 117 of file ecc_key.h.

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

m_public_key

PointGFp Botan::EC_PublicKey::m_public_key

protectedinherited

Definition at line 115 of file ecc_key.h.

Referenced by Botan::EC_PrivateKey::EC_PrivateKey(), 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/sm2/sm2.h
• src/lib/pubkey/sm2/sm2.cpp
• src/lib/pubkey/sm2/sm2_enc.cpp