Botan 3.0.0-alpha0
Crypto and TLS for C&
|
#include <ecc_key.h>
Public Member Functions | |
virtual std::string | algo_name () const =0 |
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, const std::string ¶ms, const std::string &provider) const |
virtual std::unique_ptr< PK_Ops::Encryption > | create_encryption_op (RandomNumberGenerator &rng, const std::string ¶ms, const std::string &provider) const |
virtual std::unique_ptr< PK_Ops::KEM_Decryption > | create_kem_decryption_op (RandomNumberGenerator &rng, const std::string ¶ms, const std::string &provider) const |
virtual std::unique_ptr< PK_Ops::KEM_Encryption > | create_kem_encryption_op (RandomNumberGenerator &rng, const std::string ¶ms, const std::string &provider) const |
virtual std::unique_ptr< PK_Ops::Key_Agreement > | create_key_agreement_op (RandomNumberGenerator &rng, const std::string ¶ms, const std::string &provider) const |
virtual std::unique_ptr< PK_Ops::Signature > | create_signature_op (RandomNumberGenerator &rng, const std::string ¶ms, const std::string &provider) const |
virtual std::unique_ptr< PK_Ops::Verification > | create_verification_op (const std::string ¶ms, const std::string &provider) const |
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 |
EC_PrivateKey (const EC_PrivateKey &other)=default | |
size_t | estimated_strength () const override |
std::string | fingerprint_private (const std::string &alg) const |
std::string | fingerprint_public (const std::string &alg="SHA-256") const |
virtual OID | get_oid () const |
size_t | key_length () const override |
virtual size_t | message_part_size () const |
virtual size_t | message_parts () const |
EC_PrivateKey & | operator= (const EC_PrivateKey &other)=default |
virtual AlgorithmIdentifier | pkcs8_algorithm_identifier () const |
PointGFp::Compression_Type | point_encoding () const |
secure_vector< uint8_t > | private_key_bits () const override |
secure_vector< uint8_t > | private_key_info () const |
const BigInt & | private_value () const |
virtual std::unique_ptr< Public_Key > | public_key () const =0 |
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) |
virtual bool | stateful_operation () const |
std::vector< uint8_t > | subject_public_key () const |
~EC_PrivateKey ()=default | |
Protected Member Functions | |
EC_PrivateKey ()=default | |
EC_PrivateKey (const AlgorithmIdentifier &alg_id, const secure_vector< uint8_t > &key_bits, bool with_modular_inverse=false) | |
EC_PrivateKey (RandomNumberGenerator &rng, const EC_Group &domain, const BigInt &x, bool with_modular_inverse=false) | |
Protected Attributes | |
EC_Group_Encoding | m_domain_encoding |
EC_Group | m_domain_params |
PointGFp::Compression_Type | m_point_encoding = PointGFp::UNCOMPRESSED |
BigInt | m_private_key |
PointGFp | m_public_key |
|
default |
|
default |
|
protected |
EC_PrivateKey constructor
Definition at line 109 of file ecc_key.cpp.
References Botan::EC_Group::blinded_base_point_multiply(), BOTAN_ASSERT, Botan::EC_PublicKey::domain(), Botan::EC_Group::inverse_mod_order(), Botan::EC_PublicKey::m_domain_encoding, Botan::EC_PublicKey::m_domain_params, m_private_key, Botan::EC_PublicKey::m_public_key, Botan::PointGFp::on_the_curve(), and Botan::EC_Group::random_scalar().
|
protected |
Definition at line 156 of file ecc_key.cpp.
References Botan::BitString, BOTAN_ASSERT, Botan::BER_Decoder::decode_and_check(), Botan::BER_Decoder::decode_optional(), Botan::EC_PublicKey::domain(), Botan::BER_Decoder::end_cons(), Botan::ExplicitContextSpecific, Botan::EC_Group::get_base_point(), Botan::AlgorithmIdentifier::get_parameters(), Botan::EC_Group::inverse_mod_order(), Botan::EC_PublicKey::m_domain_encoding, Botan::EC_PublicKey::m_domain_params, m_private_key, Botan::EC_PublicKey::m_public_key, Botan::PointGFp::on_the_curve(), Botan::EC_Group::OS2ECP(), Botan::EC_PublicKey::public_key_bits(), and Botan::BER_Decoder::start_sequence().
|
protecteddefault |
|
pure virtualinherited |
Get the name of the underlying public key scheme.
Implemented in Botan::TPM_PrivateKey, Botan::Curve25519_PublicKey, Botan::DH_PublicKey, Botan::DSA_PublicKey, Botan::ECDH_PublicKey, Botan::ECDSA_PublicKey, Botan::ECGDSA_PublicKey, Botan::ECKCDSA_PublicKey, Botan::Ed25519_PublicKey, Botan::ElGamal_PublicKey, Botan::GOST_3410_PublicKey, Botan::Kyber_PublicKey, Botan::McEliece_PublicKey, Botan::RSA_PublicKey, Botan::SM2_PublicKey, Botan::XMSS_PublicKey, Botan::XMSS_WOTS_PublicKey, and Botan::XMSS_WOTS_Addressed_PublicKey.
Referenced by Botan::PKCS8::BER_encode(), botan_pubkey_sm2_compute_za(), Botan::TLS::Policy::check_peer_key_acceptable(), Botan::TLS::Handshake_State::choose_sig_format(), Botan::TLS::Client_Key_Exchange::Client_Key_Exchange(), Botan::EMSA1::config_for_x509(), Botan::EMSA_PKCS1v15::config_for_x509(), Botan::PSSR::config_for_x509(), Botan::Private_Key::create_decryption_op(), Botan::Public_Key::create_encryption_op(), Botan::Private_Key::create_kem_decryption_op(), Botan::Public_Key::create_kem_encryption_op(), Botan::Private_Key::create_key_agreement_op(), Botan::Private_Key::create_signature_op(), Botan::Public_Key::create_verification_op(), Botan::Public_Key::get_oid(), Botan::TLS::Handshake_State::parse_sig_format(), Botan::PK_Decryptor_EME::PK_Decryptor_EME(), Botan::PK_Encryptor_EME::PK_Encryptor_EME(), Botan::PK_KEM_Decryptor::PK_KEM_Decryptor(), Botan::PK_KEM_Encryptor::PK_KEM_Encryptor(), Botan::PK_Signer::PK_Signer(), Botan::PK_Verifier::PK_Verifier(), Botan::verify_cert_constraints_valid_for_key_type(), and Botan::X509_Object::verify_signature().
|
overridevirtualinherited |
Implements Botan::Public_Key.
Reimplemented in Botan::GOST_3410_PublicKey.
Definition at line 70 of file ecc_key.cpp.
References Botan::EC_PublicKey::DER_domain(), and Botan::Public_Key::get_oid().
Referenced by Botan::GOST_3410_PrivateKey::pkcs8_algorithm_identifier().
|
overridevirtualinherited |
Test the key values for consistency.
rng | rng to use |
strong | whether to perform strong and lengthy version of the test |
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.
References Botan::EC_PublicKey::m_domain_params, Botan::EC_PublicKey::public_point(), Botan::EC_Group::verify_group(), and Botan::EC_Group::verify_public_element().
|
virtualinherited |
This is an internal library function exposed on key types. In almost 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 114 of file pk_keys.cpp.
References Botan::Public_Key::algo_name().
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 91 of file pk_keys.cpp.
References Botan::Public_Key::algo_name().
Referenced by Botan::PK_Encryptor_EME::PK_Encryptor_EME().
|
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 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 122 of file pk_keys.cpp.
References Botan::Public_Key::algo_name().
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
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.
References Botan::Public_Key::algo_name().
Referenced by Botan::PK_KEM_Encryptor::PK_KEM_Encryptor().
|
virtualinherited |
This is an internal library function exposed on key types. In almost 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 138 of file pk_keys.cpp.
References Botan::Public_Key::algo_name().
|
virtualinherited |
This is an internal library function exposed on key types. In almost 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 in Botan::XMSS_PrivateKey, Botan::TPM_PrivateKey, Botan::DSA_PrivateKey, Botan::ECDSA_PrivateKey, Botan::ECGDSA_PrivateKey, Botan::ECKCDSA_PrivateKey, Botan::Ed25519_PrivateKey, Botan::GOST_3410_PrivateKey, Botan::RSA_PrivateKey, and Botan::SM2_PrivateKey.
Definition at line 130 of file pk_keys.cpp.
References Botan::Public_Key::algo_name().
Referenced by Botan::PK_Signer::PK_Signer().
|
virtualinherited |
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
params | additional parameters |
provider | the provider to use |
Reimplemented in Botan::XMSS_PublicKey, Botan::DSA_PublicKey, Botan::ECDSA_PublicKey, Botan::ECGDSA_PublicKey, Botan::ECKCDSA_PublicKey, Botan::Ed25519_PublicKey, Botan::GOST_3410_PublicKey, Botan::RSA_PublicKey, Botan::SM2_PublicKey, and Botan::XMSS_WOTS_Addressed_PublicKey.
Definition at line 107 of file pk_keys.cpp.
References Botan::Public_Key::algo_name().
Referenced by Botan::XMSS_WOTS_Addressed_PublicKey::create_verification_op(), and Botan::PK_Verifier::PK_Verifier().
|
inlinevirtualinherited |
Reimplemented in Botan::GOST_3410_PublicKey.
Definition at line 125 of file pk_keys.h.
References Botan::DER_SEQUENCE, and Botan::IEEE_1363.
Referenced by Botan::X509_Object::choose_sig_format(), and Botan::X509_Object::verify_signature().
|
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(), 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().
|
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::Public_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 85 of file pk_keys.cpp.
References Botan::create_hex_fingerprint(), hash_algo, 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 77 of file pk_keys.cpp.
References Botan::create_hex_fingerprint(), hash_algo, and Botan::Public_Key::subject_public_key().
|
virtualinherited |
Get the OID of the underlying public key scheme.
Reimplemented in Botan::XMSS_WOTS_Addressed_PublicKey.
Definition at line 53 of file pk_keys.cpp.
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().
|
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().
|
inlinevirtualinherited |
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 in Botan::DSA_PublicKey, Botan::ECDSA_PublicKey, Botan::ECGDSA_PublicKey, Botan::ECKCDSA_PublicKey, Botan::GOST_3410_PublicKey, and Botan::SM2_PublicKey.
Definition at line 123 of file pk_keys.h.
Referenced by Botan::PK_Signer::PK_Signer(), and Botan::PK_Verifier::PK_Verifier().
|
inlinevirtualinherited |
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 in Botan::DSA_PublicKey, Botan::ECDSA_PublicKey, Botan::ECGDSA_PublicKey, Botan::ECKCDSA_PublicKey, Botan::GOST_3410_PublicKey, and Botan::SM2_PublicKey.
Definition at line 112 of file pk_keys.h.
Referenced by Botan::PK_Signer::PK_Signer(), and Botan::PK_Verifier::PK_Verifier().
|
default |
|
inlinevirtualinherited |
Reimplemented in Botan::GOST_3410_PrivateKey, Botan::XMSS_WOTS_PrivateKey, and Botan::XMSS_WOTS_Addressed_PrivateKey.
Definition at line 212 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().
|
overridevirtual |
Implements Botan::Private_Key.
Definition at line 143 of file ecc_key.cpp.
References Botan::BitString, Botan::BigInt::bytes(), Botan::DER_Encoder::encode(), Botan::PointGFp::encode(), Botan::BigInt::encode_1363(), Botan::DER_Encoder::end_cons(), Botan::DER_Encoder::get_contents(), m_private_key, Botan::EC_PublicKey::m_public_key, Botan::OctetString, Botan::DER_Encoder::start_explicit_context_specific(), and Botan::DER_Encoder::start_sequence().
|
inherited |
Definition at line 61 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().
const BigInt & Botan::EC_PrivateKey::private_value | ( | ) | const |
Get the private key value of this key object.
Definition at line 98 of file ecc_key.cpp.
References m_private_key.
|
pure virtualinherited |
Allocate a new object for the public key associated with this private key.
Implemented in Botan::TPM_PrivateKey, Botan::Curve25519_PrivateKey, Botan::DH_PrivateKey, Botan::DSA_PrivateKey, Botan::ECDH_PrivateKey, Botan::ECDSA_PrivateKey, Botan::ECGDSA_PrivateKey, Botan::ECKCDSA_PrivateKey, Botan::Ed25519_PrivateKey, Botan::ElGamal_PrivateKey, Botan::GOST_3410_PrivateKey, Botan::Kyber_PrivateKey, Botan::McEliece_PrivateKey, Botan::RSA_PrivateKey, Botan::SM2_PrivateKey, Botan::XMSS_PrivateKey, and Botan::XMSS_WOTS_PrivateKey.
|
overridevirtualinherited |
Implements Botan::Public_Key.
Reimplemented in Botan::GOST_3410_PublicKey.
Definition at line 75 of file ecc_key.cpp.
References Botan::PointGFp::encode(), Botan::EC_PublicKey::point_encoding(), and Botan::EC_PublicKey::public_point().
Referenced by 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(), 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().
|
inherited |
Set the domain parameter encoding to be used when encoding this key.
enc | the encoding to use |
Definition at line 90 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 80 of file ecc_key.cpp.
References Botan::PointGFp::COMPRESSED, Botan::PointGFp::HYBRID, Botan::EC_PublicKey::m_point_encoding, and Botan::PointGFp::UNCOMPRESSED.
|
inlinevirtualinherited |
Reimplemented in Botan::XMSS_PrivateKey.
Definition at line 188 of file pk_keys.h.
|
inherited |
Definition at line 38 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().
|
protectedinherited |
Definition at line 116 of file ecc_key.h.
Referenced by EC_PrivateKey(), and Botan::EC_PublicKey::set_parameter_encoding().
|
protectedinherited |
Definition at line 114 of file ecc_key.h.
Referenced by Botan::EC_PublicKey::check_key(), 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 117 of file ecc_key.h.
Referenced by Botan::EC_PublicKey::set_point_encoding().
|
protected |
Definition at line 168 of file ecc_key.h.
Referenced by EC_PrivateKey(), private_key_bits(), private_value(), and Botan::SM2_PrivateKey::SM2_PrivateKey().
|
protectedinherited |
Definition at line 115 of file ecc_key.h.
Referenced by EC_PrivateKey(), Botan::GOST_3410_PublicKey::GOST_3410_PublicKey(), and private_key_bits().