Botan::GOST_3410_PrivateKey Class Reference

#include <gost_3410.h>

Inheritance diagram for Botan::GOST_3410_PrivateKey:

Public Member Functions
std::string	algo_name () const override
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
std::unique_ptr< PK_Ops::Signature >	create_signature_op (RandomNumberGenerator &rng, std::string_view params, std::string_view provider) const override
std::unique_ptr< PK_Ops::Verification >	create_verification_op (std::string_view params, std::string_view provider) const override
std::unique_ptr< PK_Ops::Verification >	create_x509_verification_op (const AlgorithmIdentifier &signature_algorithm, std::string_view provider) const override
Signature_Format	default_x509_signature_format () const override
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
const BigInt &	get_int_field (std::string_view field) const override
const BigInt &	get_int_field (std::string_view field) const override final
OID	get_oid () const
	GOST_3410_PrivateKey (const AlgorithmIdentifier &alg_id, std::span< const uint8_t > key_bits)
	GOST_3410_PrivateKey (RandomNumberGenerator &rng, const EC_Group &domain, const BigInt &x=BigInt::zero())
size_t	key_length () const override
size_t	message_part_size () const override
size_t	message_parts () const override
virtual OID	object_identifier () const
AlgorithmIdentifier	pkcs8_algorithm_identifier () const override
EC_Point_Format	point_encoding () const
secure_vector< uint8_t >	private_key_bits () const override 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
const EC_Point &	public_point () const
secure_vector< uint8_t >	raw_private_key_bits () const override final
void	set_parameter_encoding (EC_Group_Encoding enc)
void	set_point_encoding (EC_Point_Format enc)
virtual bool	stateful_operation () const
std::vector< uint8_t >	subject_public_key () const
bool	supports_operation (PublicKeyOperation op) const override

Protected Attributes
EC_Group_Encoding	m_domain_encoding
EC_Group	m_domain_params
EC_Point_Format	m_point_encoding = EC_Point_Format::Uncompressed
BigInt	m_private_key
EC_Point	m_public_key

Detailed Description

GOST-34.10 Private Key

Definition at line 82 of file gost_3410.h.

Constructor & Destructor Documentation

GOST_3410_PrivateKey() [1/2]

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

inline

Load a private key.

Parameters

alg_id	the X.509 algorithm identifier
key_bits	ECPrivateKey bits

Definition at line 91 of file gost_3410.h.

                                                            :
         EC_PrivateKey(alg_id, key_bits) {}

GOST_3410_PrivateKey() [2/2]

Botan::GOST_3410_PrivateKey::GOST_3410_PrivateKey	(	RandomNumberGenerator &	rng,
		const EC_Group &	domain,
		const BigInt &	x = BigInt::zero()
	)

Generate a new private key

Parameters

rng	a random number generator
domain	parameters to used for this key
x	the private key; if zero, a new random key is generated

Definition at line 104 of file gost_3410.cpp.

                                                            :
   EC_PrivateKey(rng, domain, x)
   {
   const size_t p_bits = m_domain_params.get_p_bits();
   if(p_bits != 256 && p_bits != 512)
      {
      throw Decoding_Error(fmt("GOST-34.10-2012 is not defined for parameters of size {}", p_bits));
      }
   }

References Botan::fmt(), Botan::EC_Group::get_p_bits(), and Botan::EC_PublicKey::m_domain_params.

Member Function Documentation

algo_name()

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

overridevirtualinherited

Get this keys algorithm name.

Returns

this keys algorithm name

Implements Botan::Asymmetric_Key.

Definition at line 44 of file gost_3410.cpp.

   {
   const size_t p_bits = domain().get_p_bits();
 
   if(p_bits == 256 || p_bits == 512)
      return fmt("GOST-34.10-2012-{}", p_bits);
   else
      throw Encoding_Error("GOST-34.10-2012 is not defined for parameters of this size");
   }

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

Referenced by create_signature_op(), Botan::GOST_3410_PublicKey::create_verification_op(), and Botan::GOST_3410_PublicKey::create_x509_verification_op().

algorithm_identifier()

AlgorithmIdentifier Botan::GOST_3410_PublicKey::algorithm_identifier ( ) const

overridevirtualinherited

Returns

X.509 AlgorithmIdentifier for this key

Reimplemented from Botan::EC_PublicKey.

Definition at line 54 of file gost_3410.cpp.

   {
   std::vector<uint8_t> params;
 
   const OID gost_oid = object_identifier();
   const OID domain_oid = domain().get_curve_oid();
 
   DER_Encoder(params).start_sequence().encode(domain_oid).end_cons();
 
   return AlgorithmIdentifier(gost_oid, params);
   }

References Botan::EC_PublicKey::domain(), Botan::DER_Encoder::encode(), Botan::DER_Encoder::end_cons(), Botan::EC_Group::get_curve_oid(), Botan::Asymmetric_Key::object_identifier(), and Botan::DER_Encoder::start_sequence().

check_key()

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

overridevirtualinherited

Implements Botan::Public_Key.

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

Definition at line 58 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_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 131 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 102 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::Kyber_PrivateKey, Botan::McEliece_PrivateKey, and Botan::RSA_PrivateKey.

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

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

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

create_signature_op()

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

overridevirtual

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

Return a signature operation for this key/params or throw

Parameters

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

Reimplemented from Botan::Private_Key.

Definition at line 307 of file gost_3410.cpp.

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

References Botan::GOST_3410_PublicKey::algo_name().

create_verification_op()

std::unique_ptr< PK_Ops::Verification > Botan::GOST_3410_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 287 of file gost_3410.cpp.

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

References Botan::GOST_3410_PublicKey::algo_name().

create_x509_verification_op()

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

overridevirtualinherited

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

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

Parameters

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

Reimplemented from Botan::Public_Key.

Definition at line 296 of file gost_3410.cpp.

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

References Botan::GOST_3410_PublicKey::algo_name().

default_x509_signature_format()

Signature_Format Botan::GOST_3410_PublicKey::default_x509_signature_format ( ) const

inlineoverridevirtualinherited

Reimplemented from Botan::Public_Key.

Definition at line 56 of file gost_3410.h.

         { return Signature_Format::Standard; }

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::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(), 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::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 96 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 88 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().

get_int_field() [1/2]

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

overridevirtualinherited

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.

Reimplemented in Botan::EC_PrivateKey.

Definition at line 197 of file ecc_key.cpp.

   {
   if(field == "public_x")
      {
      BOTAN_ASSERT_NOMSG(this->public_point().is_affine());
      return this->public_point().get_x();
      }
   else if(field == "public_y")
      {
      BOTAN_ASSERT_NOMSG(this->public_point().is_affine());
      return this->public_point().get_y();
      }
   else if(field == "base_x")
      return this->domain().get_g_x();
   else if(field == "base_y")
      return this->domain().get_g_y();
   else if(field == "p")
      return this->domain().get_p();
   else if(field == "a")
      return this->domain().get_a();
   else if(field == "b")
      return this->domain().get_b();
   else if(field == "cofactor")
      return this->domain().get_cofactor();
   else if(field == "order")
      return this->domain().get_order();
   else
      return Public_Key::get_int_field(field);
   }

References BOTAN_ASSERT_NOMSG, Botan::EC_PublicKey::domain(), Botan::EC_Group::get_a(), Botan::EC_Group::get_b(), Botan::EC_Group::get_cofactor(), Botan::EC_Group::get_g_x(), Botan::EC_Group::get_g_y(), Botan::Asymmetric_Key::get_int_field(), Botan::EC_Group::get_order(), Botan::EC_Group::get_p(), Botan::EC_Point::get_x(), Botan::EC_Point::get_y(), and Botan::EC_PublicKey::public_point().

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

get_int_field() [2/2]

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

finaloverridevirtualinherited

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::EC_PublicKey.

Definition at line 227 of file ecc_key.cpp.

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

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

get_oid()

OID Botan::Public_Key::get_oid ( ) const

inlineinherited

Deprecated version of object_identifier

Definition at line 122 of file pk_keys.h.

         {
         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 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::GOST_3410_PublicKey::message_part_size ( ) const

inlineoverridevirtualinherited

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 53 of file gost_3410.h.

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

message_parts()

size_t Botan::GOST_3410_PublicKey::message_parts ( ) const

inlineoverridevirtualinherited

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 51 of file gost_3410.h.

{ return 2; }

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, and Botan::Kyber_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().

Referenced by Botan::TPM_PrivateKey::algorithm_identifier(), Botan::Curve25519_PublicKey::algorithm_identifier(), Botan::DH_PublicKey::algorithm_identifier(), Botan::DSA_PublicKey::algorithm_identifier(), Botan::EC_PublicKey::algorithm_identifier(), Botan::Ed25519_PublicKey::algorithm_identifier(), Botan::ElGamal_PublicKey::algorithm_identifier(), Botan::GOST_3410_PublicKey::algorithm_identifier(), Botan::McEliece_PublicKey::algorithm_identifier(), and Botan::RSA_PublicKey::algorithm_identifier().

pkcs8_algorithm_identifier()

AlgorithmIdentifier Botan::GOST_3410_PrivateKey::pkcs8_algorithm_identifier ( ) const

inlineoverridevirtual

Returns

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

Reimplemented from Botan::Private_Key.

Definition at line 107 of file gost_3410.h.

         { return EC_PublicKey::algorithm_identifier(); }

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

         { return m_point_encoding; }

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

private_key_bits()

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

finaloverridevirtualinherited

Returns

BER encoded private key bits

Implements Botan::Private_Key.

Definition at line 144 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(), Botan::EC_PrivateKey::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 67 of file pk_keys.cpp.

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

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

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

private_value()

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

inherited

Get the private key value of this key object.

Returns

the private key value of this key object

Definition at line 94 of file ecc_key.cpp.

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

References Botan::EC_PrivateKey::m_private_key.

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

public_key()

std::unique_ptr< Public_Key > Botan::GOST_3410_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 116 of file gost_3410.cpp.

   {
   return std::make_unique<GOST_3410_PublicKey>(domain(), public_point());
   }

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

public_key_bits()

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

overridevirtualinherited

Returns

BER encoded public key bits

Reimplemented from Botan::EC_PublicKey.

Definition at line 20 of file gost_3410.cpp.

   {
   const BigInt x = public_point().get_affine_x();
   const BigInt y = public_point().get_affine_y();
 
   size_t part_size = std::max(x.bytes(), y.bytes());
 
   std::vector<uint8_t> bits(2*part_size);
 
   x.binary_encode(&bits[part_size - x.bytes()]);
   y.binary_encode(&bits[2*part_size - y.bytes()]);
 
   // Keys are stored in little endian format (WTF)
   for(size_t i = 0; i != part_size / 2; ++i)
      {
      std::swap(bits[i], bits[part_size-1-i]);
      std::swap(bits[part_size+i], bits[2*part_size-1-i]);
      }
 
   std::vector<uint8_t> output;
   DER_Encoder(output).encode(bits, ASN1_Type::OctetString);
   return output;
   }

References Botan::BigInt::binary_encode(), Botan::BigInt::bytes(), Botan::DER_Encoder::encode(), Botan::EC_Point::get_affine_x(), Botan::EC_Point::get_affine_y(), Botan::OctetString, Botan::EC_PublicKey::public_point(), and y.

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 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::get_int_field(), Botan::ECDH_PrivateKey::public_key(), Botan::ECDSA_PrivateKey::public_key(), Botan::ECGDSA_PrivateKey::public_key(), Botan::ECKCDSA_PrivateKey::public_key(), 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

finaloverridevirtualinherited

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

   {
   return BigInt::encode_locked(m_private_key);
   }

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

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 86 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 76 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 292 of file pk_keys.h.

{ 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 55 of file pk_keys.cpp.

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

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

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

supports_operation()

bool Botan::GOST_3410_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 59 of file gost_3410.h.

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

Member Data Documentation

m_domain_encoding

EC_Group_Encoding Botan::EC_PublicKey::m_domain_encoding

protectedinherited

Definition at line 118 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 116 of file ecc_key.h.

Referenced by Botan::EC_PublicKey::check_key(), Botan::EC_PrivateKey::EC_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 119 of file ecc_key.h.

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

m_private_key

BigInt Botan::EC_PrivateKey::m_private_key

protectedinherited

Definition at line 178 of file ecc_key.h.

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

m_public_key

EC_Point Botan::EC_PublicKey::m_public_key

protectedinherited

Definition at line 117 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/gost_3410/gost_3410.h
• src/lib/pubkey/gost_3410/gost_3410.cpp