Botan 3.7.1
Crypto and TLS for C&
Botan::SM2_PrivateKey Class Referencefinal

#include <sm2.h>

Inheritance diagram for Botan::SM2_PrivateKey:
Botan::SM2_PublicKey Botan::EC_PrivateKey Botan::EC_PublicKey Botan::EC_PublicKey Botan::Private_Key Botan::Public_Key Botan::Public_Key Botan::Public_Key Botan::Asymmetric_Key Botan::Asymmetric_Key Botan::Asymmetric_Key

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) const override
 
std::unique_ptr< PK_Ops::Decryptioncreate_decryption_op (RandomNumberGenerator &rng, std::string_view params, std::string_view provider) const override
 
std::unique_ptr< PK_Ops::Encryptioncreate_encryption_op (RandomNumberGenerator &rng, std::string_view params, std::string_view provider) const override
 
virtual std::unique_ptr< PK_Ops::KEM_Decryptioncreate_kem_decryption_op (RandomNumberGenerator &rng, std::string_view params, std::string_view provider) const
 
virtual std::unique_ptr< PK_Ops::KEM_Encryptioncreate_kem_encryption_op (std::string_view params, std::string_view provider) const
 
virtual std::unique_ptr< PK_Ops::Key_Agreementcreate_key_agreement_op (RandomNumberGenerator &rng, std::string_view params, std::string_view provider) const
 
std::unique_ptr< PK_Ops::Signaturecreate_signature_op (RandomNumberGenerator &rng, std::string_view params, std::string_view provider) const override
 
std::unique_ptr< PK_Ops::Verificationcreate_verification_op (std::string_view params, std::string_view provider) const override
 
virtual std::unique_ptr< PK_Ops::Verificationcreate_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_Groupdomain () 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_Keygenerate_another (RandomNumberGenerator &rng) const final
 
const BigIntget_da_inv () const
 
const BigIntget_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 BigIntprivate_value () const
 
std::unique_ptr< Public_Keypublic_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 (EC_Group group, EC_Scalar x)
 
 SM2_PrivateKey (RandomNumberGenerator &rng, EC_Group group)
 
 SM2_PrivateKey (RandomNumberGenerator &rng, 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
 

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_Datam_private_key
 
std::shared_ptr< const EC_PublicKey_Datam_public_key
 

Detailed Description

This class represents SM2 private keys

Definition at line 78 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_idthe X.509 algorithm identifier
key_bitsECPrivateKey bits

Definition at line 48 of file sm2.cpp.

48 :
49 EC_PrivateKey(alg_id, key_bits),
50 m_da_inv((this->_private_key() + EC_Scalar::one(domain())).invert()),
51 m_da_inv_legacy(m_da_inv.to_bigint()) {}
const EC_Scalar & _private_key() const
Definition ecc_key.cpp:122
const EC_Group & domain() const
Definition ecc_key.cpp:63
static EC_Scalar one(const EC_Group &group)
Definition ec_scalar.cpp:61
BigInt to_bigint() const
Definition ec_scalar.cpp:73

◆ SM2_PrivateKey() [2/4]

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

Create a private key from a given secret x

Parameters
groupcurve parameters to bu used for this key
xthe private key

Definition at line 53 of file sm2.cpp.

53 :
54 EC_PrivateKey(std::move(group), std::move(x)),
55 m_da_inv((this->_private_key() + EC_Scalar::one(domain())).invert()),
56 m_da_inv_legacy(m_da_inv.to_bigint()) {}

◆ SM2_PrivateKey() [3/4]

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

Create a new private key

Parameters
rnga random number generator
groupparameters to used for this key

Definition at line 58 of file sm2.cpp.

58 :
59 EC_PrivateKey(rng, std::move(group)),
60 m_da_inv((this->_private_key() + EC_Scalar::one(domain())).invert()),
61 m_da_inv_legacy(m_da_inv.to_bigint()) {}

◆ SM2_PrivateKey() [4/4]

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

Create a private key.

Parameters
rnga random number generator
groupparameters to used for this key
xthe private key (if zero, generate a new random key)

Definition at line 63 of file sm2.cpp.

63 :
64 EC_PrivateKey(rng, std::move(group), x),
65 m_da_inv((this->_private_key() + EC_Scalar::one(domain())).invert()),
66 m_da_inv_legacy(m_da_inv.to_bigint()) {}

Member Function Documentation

◆ _default_x509_signature_format()

Signature_Format Botan::Asymmetric_Key::_default_x509_signature_format ( ) const
virtualinherited

◆ _get_da_inv()

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

Definition at line 125 of file sm2.h.

125{ return m_da_inv; }

◆ _private_key()

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

Definition at line 122 of file ecc_key.cpp.

122 {
124 return m_private_key->private_key();
125}
#define BOTAN_STATE_CHECK(expr)
Definition assert.h:41
std::shared_ptr< const EC_PrivateKey_Data > m_private_key
Definition ecc_key.h:219

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

◆ _public_ec_point()

◆ _signature_element_size_for_DER_encoding()

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

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

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

Reimplemented from Botan::Asymmetric_Key.

Definition at line 56 of file sm2.h.

56 {
57 return domain().get_order_bytes();
58 }
size_t get_order_bytes() const
Definition ec_group.cpp:510

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

19 {
20 return "SM2";
21}

Referenced by create_decryption_op(), and Botan::SM2_PublicKey::create_encryption_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 85 of file ecc_key.cpp.

85 {
86 return AlgorithmIdentifier(object_identifier(), DER_domain());
87}
virtual OID object_identifier() const
Definition pk_keys.cpp:22
std::vector< uint8_t > DER_domain() const
Definition ecc_key.cpp:97

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

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

◆ check_key()

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

Reimplemented from Botan::EC_PublicKey.

Definition at line 27 of file sm2.cpp.

27 {
28 if(!EC_PrivateKey::check_key(rng, strong)) {
29 return false;
30 }
31
32 // SM2 has an oddity in private key generation when compared to
33 // other EC*DSA style signature algorithms described in ISO14888-3:
34 // the private key x MUST be in [0, q-1) instead of [0, q).
35 //
36 // The lower bound is already checked by the default impl
37 if(private_value() >= domain().get_order() - 1) {
38 return false;
39 }
40
41 if(!strong) {
42 return true;
43 }
44
45 return KeyPair::signature_consistency_check(rng, *this, "user@example.com,SM3");
46}
const BigInt & private_value() const
Definition ecc_key.cpp:117
bool check_key(RandomNumberGenerator &rng, bool strong) const override
Definition ecc_key.cpp:200
bool signature_consistency_check(RandomNumberGenerator &rng, const Private_Key &private_key, const Public_Key &public_key, std::string_view padding)
Definition keypair.cpp:49

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
rnga 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.
paramsadditional parameters
providerthe provider to use

Reimplemented from Botan::Private_Key.

Definition at line 206 of file sm2_enc.cpp.

208 {
209 if(provider == "base" || provider.empty()) {
210 if(params.empty()) {
211 return std::make_unique<SM2_Decryption_Operation>(*this, rng, "SM3");
212 } else {
213 return std::make_unique<SM2_Decryption_Operation>(*this, rng, params);
214 }
215 }
216
217 throw Provider_Not_Found(algo_name(), provider);
218}
std::string algo_name() const override
Definition sm2.cpp:19

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
rnga 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.
paramsadditional parameters
providerthe provider to use

Reimplemented from Botan::Public_Key.

Definition at line 190 of file sm2_enc.cpp.

192 {
193 BOTAN_UNUSED(rng);
194
195 if(provider == "base" || provider.empty()) {
196 if(params.empty()) {
197 return std::make_unique<SM2_Encryption_Operation>(*this, "SM3");
198 } else {
199 return std::make_unique<SM2_Encryption_Operation>(*this, params);
200 }
201 }
202
203 throw Provider_Not_Found(algo_name(), provider);
204}
#define BOTAN_UNUSED
Definition assert.h:118

References Botan::SM2_PublicKey::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
rnga 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.
paramsadditional parameters
providerthe provider to use

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

Definition at line 125 of file pk_keys.cpp.

127 {
128 throw Lookup_Error(fmt("{} does not support KEM decryption", algo_name()));
129}
virtual std::string algo_name() const =0
std::string fmt(std::string_view format, const T &... args)
Definition fmt.h:53

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
paramsadditional parameters
providerthe provider to use

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

Definition at line 104 of file pk_keys.cpp.

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

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
rnga 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.
paramsadditional parameters
providerthe provider to use

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

Definition at line 137 of file pk_keys.cpp.

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

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
rnga 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.
paramsadditional parameters
providerthe provider to use

Reimplemented from Botan::Private_Key.

Definition at line 264 of file sm2.cpp.

266 {
267 if(provider == "base" || provider.empty()) {
268 std::string userid, hash;
269 parse_sm2_param_string(params, userid, hash);
270 return std::make_unique<SM2_Signature_Operation>(*this, userid, hash);
271 }
272
273 throw Provider_Not_Found(algo_name(), provider);
274}

◆ 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
paramsadditional parameters
providerthe provider to use

Reimplemented from Botan::Public_Key.

Definition at line 253 of file sm2.cpp.

254 {
255 if(provider == "base" || provider.empty()) {
256 std::string userid, hash;
257 parse_sm2_param_string(params, userid, hash);
258 return std::make_unique<SM2_Verification_Operation>(*this, userid, hash);
259 }
260
261 throw Provider_Not_Found(algo_name(), provider);
262}

◆ 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_algorithmis the X.509 algorithm identifier encoding the padding scheme and hash hash function used in the signature if applicable.
providerthe 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 114 of file pk_keys.cpp.

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

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

227 {
229 }
virtual Signature_Format _default_x509_signature_format() const
Definition pk_keys.cpp:30

◆ DER_domain()

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

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

Definition at line 97 of file ecc_key.cpp.

97 {
99}
std::vector< uint8_t > DER_encode(EC_Group_Encoding form) const
Definition ec_group.cpp:604
EC_Group_Encoding domain_format() const
Definition ecc_key.h:92

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

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

◆ domain()

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

◆ domain_format()

EC_Group_Encoding Botan::EC_PublicKey::domain_format ( ) const
inlineinherited

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

Returns
the encoding to use

Definition at line 92 of file ecc_key.h.

92{ return m_domain_encoding; }
EC_Group_Encoding m_domain_encoding
Definition ecc_key.h:136

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

◆ estimated_strength()

size_t Botan::EC_PublicKey::estimated_strength ( ) const
overridevirtualinherited

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

Returns
estimated strength in bits

Implements Botan::Asymmetric_Key.

Definition at line 29 of file ecc_key.cpp.

29 {
31}
size_t key_length() const override
Definition ecc_key.cpp:25
size_t ecp_work_factor(size_t bits)

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

◆ fingerprint_private()

std::string Botan::Private_Key::fingerprint_private ( std::string_view alg) const
inherited
Returns
Hash of the PKCS #8 encoding for this key object

Definition at line 94 of file pk_keys.cpp.

94 {
95 return create_hex_fingerprint(private_key_bits(), hash_algo);
96}
virtual secure_vector< uint8_t > private_key_bits() const =0
std::string create_hex_fingerprint(const uint8_t bits[], size_t bits_len, std::string_view hash_name)
Definition pk_keys.cpp:38

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

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

◆ fingerprint_public()

std::string Botan::Public_Key::fingerprint_public ( std::string_view alg = "SHA-256") const
inherited
Returns
Hash of the subject public key

Definition at line 87 of file pk_keys.cpp.

87 {
88 return create_hex_fingerprint(subject_public_key(), hash_algo);
89}
std::vector< uint8_t > subject_public_key() const
Definition pk_keys.cpp:56

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

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

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

◆ get_da_inv()

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

Definition at line 123 of file sm2.h.

123{ return m_da_inv_legacy; }

◆ get_int_field()

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

Access an algorithm specific field

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

Some algorithms may not implement this method at all.

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

TODO(Botan4) Change this to return by value

Reimplemented from Botan::Asymmetric_Key.

Definition at line 230 of file ecc_key.cpp.

230 {
231 if(field == "x") {
232 return this->private_value();
233 } else {
234 return EC_PublicKey::get_int_field(field);
235 }
236}
const BigInt & get_int_field(std::string_view field) const override
Definition ecc_key.cpp:208

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

◆ get_oid()

OID Botan::Public_Key::get_oid ( ) const
inlineinherited

Deprecated version of object_identifier

Definition at line 160 of file pk_keys.h.

160{ return this->object_identifier(); }

◆ key_length()

size_t Botan::EC_PublicKey::key_length ( ) const
overridevirtualinherited

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

Implements Botan::Public_Key.

Definition at line 25 of file ecc_key.cpp.

25 {
26 return domain().get_p_bits();
27}
size_t get_p_bits() const
Definition ec_group.cpp:498

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

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

◆ message_part_size()

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

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

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

Returns
size of the message parts in bits

Definition at line 220 of file pk_keys.h.

220 {
221 return _signature_element_size_for_DER_encoding().value_or(0);
222 }

◆ message_parts()

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

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

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

Returns
number of message parts

Definition at line 207 of file pk_keys.h.

207 {
209 }

◆ object_identifier()

◆ pkcs8_algorithm_identifier()

virtual AlgorithmIdentifier Botan::Private_Key::pkcs8_algorithm_identifier ( ) const
inlinevirtualinherited
Returns
PKCS #8 AlgorithmIdentifier for this key Might be different from the X.509 identifier, but normally is not

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

Definition at line 322 of file pk_keys.h.

322{ return algorithm_identifier(); }
virtual AlgorithmIdentifier algorithm_identifier() const =0

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

◆ point_encoding()

EC_Point_Format Botan::EC_PublicKey::point_encoding ( ) const
inlineinherited

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

Returns
the encoding to use

Definition at line 98 of file ecc_key.h.

98{ return m_point_encoding; }
EC_Point_Format m_point_encoding
Definition ecc_key.h:137

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

◆ private_key_bits()

secure_vector< uint8_t > Botan::EC_PrivateKey::private_key_bits ( ) const
finalvirtualinherited
Returns
BER encoded private key bits

Implements Botan::Private_Key.

Definition at line 158 of file ecc_key.cpp.

158 {
159 BOTAN_STATE_CHECK(m_private_key != nullptr && m_public_key != nullptr);
160
161 return DER_Encoder()
162 .start_sequence()
163 .encode(static_cast<size_t>(1))
165 .start_explicit_context_specific(1)
166 .encode(m_public_key->public_key().serialize_uncompressed(), ASN1_Type::BitString)
167 .end_cons()
168 .end_cons()
169 .get_contents();
170}
secure_vector< uint8_t > raw_private_key_bits() const final
Definition ecc_key.cpp:153

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

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

◆ private_key_info()

secure_vector< uint8_t > Botan::Private_Key::private_key_info ( ) const
inherited
Returns
PKCS #8 private key encoding for this key object

Definition at line 68 of file pk_keys.cpp.

68 {
69 const size_t PKCS8_VERSION = 0;
70
71 return DER_Encoder()
72 .start_sequence()
73 .encode(PKCS8_VERSION)
76 .end_cons()
77 .get_contents();
78}
virtual AlgorithmIdentifier pkcs8_algorithm_identifier() const
Definition pk_keys.h:322

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

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

◆ private_value()

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

Get the private key value of this key object.

Returns
the private key value of this key object

Definition at line 117 of file ecc_key.cpp.

117 {
119 return m_private_key->legacy_bigint();
120}

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

Referenced by check_key(), and Botan::EC_PrivateKey::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 23 of file sm2.cpp.

23 {
24 return std::make_unique<SM2_Signature_PublicKey>(domain(), _public_ec_point());
25}
const EC_AffinePoint & _public_ec_point() const
Definition ecc_key.cpp:75

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

◆ public_key_bits()

std::vector< uint8_t > Botan::EC_PublicKey::public_key_bits ( ) const
overridevirtualinherited
Returns
BER encoded public key bits

Implements Botan::Public_Key.

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

Definition at line 93 of file ecc_key.cpp.

93 {
94 return raw_public_key_bits();
95}
std::vector< uint8_t > raw_public_key_bits() const override
Definition ecc_key.cpp:89

References Botan::EC_PublicKey::raw_public_key_bits().

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

◆ raw_private_key_bits()

secure_vector< uint8_t > Botan::EC_PrivateKey::raw_private_key_bits ( ) const
finalvirtualinherited
Returns
binary private key bits, with no additional encoding

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

Reimplemented from Botan::Private_Key.

Definition at line 153 of file ecc_key.cpp.

153 {
155 return m_private_key->serialize<secure_vector<uint8_t>>();
156}
std::vector< T, secure_allocator< T > > secure_vector
Definition secmem.h:61

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

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

◆ raw_public_key_bits()

std::vector< uint8_t > Botan::EC_PublicKey::raw_public_key_bits ( ) const
overridevirtualinherited
Returns
binary public key bits, with no additional encoding

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

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

Implements Botan::Public_Key.

Reimplemented in Botan::TPM2::EC_PublicKey.

Definition at line 89 of file ecc_key.cpp.

89 {
91}
std::vector< uint8_t > serialize(EC_Point_Format format) const
Return an encoding depending on the requested format.
EC_Point_Format point_encoding() const
Definition ecc_key.h:98

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

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

◆ remaining_operations()

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

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

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

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

Definition at line 335 of file pk_keys.h.

335{ return std::nullopt; }

◆ set_parameter_encoding()

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

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

Parameters
encthe encoding to use

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

Definition at line 109 of file ecc_key.cpp.

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

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

◆ set_point_encoding()

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

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

Parameters
encthe encoding to use

Definition at line 101 of file ecc_key.cpp.

101 {
103 throw Invalid_Argument("Invalid point encoding for EC_PublicKey");
104 }
105
106 m_point_encoding = enc;
107}

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

◆ stateful_operation()

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

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

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

Definition at line 328 of file pk_keys.h.

328{ return false; }

◆ subject_public_key()

std::vector< uint8_t > Botan::Public_Key::subject_public_key ( ) const
inherited
Returns
X.509 subject key encoding for this key object

Definition at line 56 of file pk_keys.cpp.

56 {
57 std::vector<uint8_t> output;
58
59 DER_Encoder(output)
60 .start_sequence()
61 .encode(algorithm_identifier())
63 .end_cons();
64
65 return output;
66}
virtual std::vector< uint8_t > public_key_bits() const =0

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::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 52 of file sm2.h.

Member Data Documentation

◆ m_domain_encoding

◆ m_point_encoding

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

Definition at line 137 of file ecc_key.h.

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

◆ m_private_key

◆ m_public_key


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