Botan 3.0.0
Crypto and TLS for C&
|
#include <ecdsa.h>
Public Member Functions | |
std::string | algo_name () const override |
AlgorithmIdentifier | algorithm_identifier () const override |
bool | check_key (RandomNumberGenerator &rng, bool) 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 |
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 |
ECDSA_PrivateKey (const AlgorithmIdentifier &alg_id, std::span< const uint8_t > key_bits) | |
ECDSA_PrivateKey (RandomNumberGenerator &rng, const EC_Group &domain, const BigInt &x=BigInt::zero()) | |
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 |
size_t | key_length () const override |
size_t | message_part_size () const override |
size_t | message_parts () const override |
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 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 |
uint8_t | recovery_param (const std::vector< uint8_t > &msg, const BigInt &r, const BigInt &s) const |
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 |
|
inline |
Load a private key
alg_id | the X.509 algorithm identifier |
key_bits | ECPrivateKey bits |
|
inline |
|
inlineoverridevirtualinherited |
Get this keys algorithm name.
Implements Botan::Asymmetric_Key.
Definition at line 61 of file ecdsa.h.
Referenced by create_signature_op(), Botan::ECDSA_PublicKey::create_verification_op(), and Botan::ECDSA_PublicKey::create_x509_verification_op().
|
overridevirtualinherited |
Implements Botan::Public_Key.
Reimplemented in Botan::GOST_3410_PublicKey.
Definition at line 66 of file ecc_key.cpp.
References Botan::EC_PublicKey::DER_domain(), and Botan::Asymmetric_Key::object_identifier().
|
overridevirtual |
Reimplemented from Botan::EC_PublicKey.
Definition at line 117 of file ecdsa.cpp.
References Botan::EC_PublicKey::public_point(), and Botan::KeyPair::signature_consistency_check().
|
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
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.
References Botan::Asymmetric_Key::algo_name(), and Botan::fmt().
Referenced by Botan::PK_Decryptor_EME::PK_Decryptor_EME().
|
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
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.
References Botan::Asymmetric_Key::algo_name(), and Botan::fmt().
Referenced by Botan::PK_Encryptor_EME::PK_Encryptor_EME().
|
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
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.
References Botan::Asymmetric_Key::algo_name(), and Botan::fmt().
Referenced by Botan::PK_KEM_Decryptor::PK_KEM_Decryptor().
|
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
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.
References Botan::Asymmetric_Key::algo_name(), and Botan::fmt().
Referenced by Botan::PK_KEM_Encryptor::PK_KEM_Encryptor().
|
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
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.
References Botan::Asymmetric_Key::algo_name(), and Botan::fmt().
|
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
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 298 of file ecdsa.cpp.
References Botan::ECDSA_PublicKey::algo_name().
|
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
params | additional parameters |
provider | the provider to use |
Reimplemented from Botan::Public_Key.
Definition at line 278 of file ecdsa.cpp.
References Botan::ECDSA_PublicKey::algo_name().
|
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.
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 288 of file ecdsa.cpp.
References Botan::ECDSA_PublicKey::algo_name().
|
inlinevirtualinherited |
Reimplemented in Botan::GOST_3410_PublicKey.
Definition at line 184 of file pk_keys.h.
Referenced by Botan::X509_Object::choose_sig_format(), and Botan::PK_Verifier::PK_Verifier().
|
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.
Referenced by Botan::EC_PublicKey::algorithm_identifier().
|
inlineinherited |
Get the domain parameters of this key.
Invalid_State | is thrown if the domain parameters of this point are not set |
Definition at line 56 of file ecc_key.h.
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(), 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().
|
inlineinherited |
|
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.
Implements Botan::Asymmetric_Key.
Definition at line 25 of file ecc_key.cpp.
References Botan::ecp_work_factor(), and Botan::EC_PublicKey::key_length().
|
inherited |
Definition at line 96 of file pk_keys.cpp.
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().
|
inherited |
Definition at line 88 of file pk_keys.cpp.
References Botan::create_hex_fingerprint(), and Botan::Public_Key::subject_public_key().
|
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.
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().
|
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.
References Botan::EC_PublicKey::get_int_field(), and Botan::EC_PrivateKey::private_value().
|
inlineinherited |
Deprecated version of object_identifier
|
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.
References Botan::EC_PublicKey::domain(), and Botan::EC_Group::get_p_bits().
Referenced by Botan::EC_PublicKey::estimated_strength().
|
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.
Reimplemented from Botan::Public_Key.
Definition at line 65 of file ecdsa.h.
|
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.
Reimplemented from Botan::Public_Key.
Definition at line 63 of file ecdsa.h.
|
virtualinherited |
Get the OID of the underlying public key scheme.
Reimplemented in Botan::Dilithium_PublicKey, and Botan::Kyber_PublicKey.
Definition at line 22 of file pk_keys.cpp.
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().
|
inlinevirtualinherited |
Reimplemented in Botan::GOST_3410_PrivateKey.
Definition at line 285 of file pk_keys.h.
Referenced by Botan::Private_Key::private_key_info().
|
inlineinherited |
Get the point encoding method to be used when encoding this key.
Definition at line 88 of file ecc_key.h.
Referenced by Botan::EC_PublicKey::public_key_bits().
|
finaloverridevirtualinherited |
Implements Botan::Private_Key.
Definition at line 144 of file ecc_key.cpp.
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.
|
inherited |
Definition at line 67 of file pk_keys.cpp.
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().
|
inherited |
Get the private key value of this key object.
Definition at line 94 of file ecc_key.cpp.
References Botan::EC_PrivateKey::m_private_key.
Referenced by Botan::EC_PrivateKey::get_int_field().
|
overridevirtual |
Allocate a new object for the public key associated with this private key.
Implements Botan::Private_Key.
Definition at line 112 of file ecdsa.cpp.
References Botan::EC_PublicKey::domain(), and Botan::EC_PublicKey::public_point().
|
overridevirtualinherited |
Implements Botan::Public_Key.
Reimplemented in Botan::GOST_3410_PublicKey.
Definition at line 71 of file ecc_key.cpp.
References Botan::EC_Point::encode(), Botan::EC_PublicKey::point_encoding(), and Botan::EC_PublicKey::public_point().
Referenced by Botan::EC_PrivateKey::EC_PrivateKey().
|
inlineinherited |
Get the public point of this key.
Invalid_State | is thrown if the domain parameters of this point are not set |
Definition at line 41 of file ecc_key.h.
Referenced by botan_pubkey_sm2_compute_za(), Botan::EC_PublicKey::check_key(), 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(), 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().
|
finaloverridevirtualinherited |
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.
References Botan::BigInt::encode_locked(), and Botan::EC_PrivateKey::m_private_key.
|
inherited |
Definition at line 88 of file ecdsa.cpp.
References Botan::EC_PublicKey::domain(), and Botan::EC_PublicKey::public_point().
|
inherited |
Set the domain parameter encoding to be used when encoding this key.
enc | the encoding to use |
Definition at line 86 of file ecc_key.cpp.
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.
|
inherited |
Set the point encoding method to be used when encoding this key.
enc | the encoding to use |
Definition at line 76 of file ecc_key.cpp.
References Botan::Compressed, Botan::Hybrid, Botan::EC_PublicKey::m_point_encoding, and Botan::Uncompressed.
|
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.
|
inherited |
Definition at line 55 of file pk_keys.cpp.
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().
|
inlineoverridevirtualinherited |
Return true if this key could be used for the specified type of operation.
Implements Botan::Asymmetric_Key.
Definition at line 68 of file ecdsa.h.
|
protectedinherited |
Definition at line 118 of file ecc_key.h.
Referenced by Botan::EC_PrivateKey::EC_PrivateKey(), and Botan::EC_PublicKey::set_parameter_encoding().
|
protectedinherited |
Definition at line 116 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().
|
protectedinherited |
Definition at line 119 of file ecc_key.h.
Referenced by Botan::EC_PublicKey::set_point_encoding().
|
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().
|
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().