Botan
2.1.0
Crypto and TLS for C++11
|
#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::Encryption > | create_encryption_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::Verification > | create_verification_op (const std::string ¶ms, const std::string &provider) const |
std::vector< uint8_t > | DER_domain () const |
const EC_Group & | domain () const |
EC_Group_Encoding | domain_format () const |
EC_PublicKey (const EC_Group &dom_par, const PointGFp &pub_point) | |
EC_PublicKey (const AlgorithmIdentifier &alg_id, const std::vector< uint8_t > &key_bits) | |
EC_PublicKey (const EC_PublicKey &other)=default | |
size_t | estimated_strength () const override |
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_PublicKey & | operator= (const EC_PublicKey &other)=default |
std::vector< uint8_t > | public_key_bits () const override |
const PointGFp & | public_point () const |
void | set_parameter_encoding (EC_Group_Encoding enc) |
std::vector< uint8_t > | subject_public_key () const |
virtual | ~EC_PublicKey ()=default |
Protected Member Functions | |
EC_PublicKey () | |
Protected Attributes | |
EC_Group_Encoding | m_domain_encoding |
EC_Group | m_domain_params |
PointGFp | m_public_key |
This class represents abstract ECC public keys. When encoding a key via an encoder that can be accessed via the corresponding member functions, the key will decide upon its internally stored encoding information whether to encode itself with or without domain parameters, or using the domain parameter oid. Furthermore, a public key without domain parameters can be decoded. In that case, it cannot be used for verification until its domain parameters are set by calling the corresponding member function.
Create a public key.
dom_par | EC domain parameters |
pub_point | public point on the curve |
Definition at line 31 of file ecc_key.cpp.
References domain(), and public_point().
Botan::EC_PublicKey::EC_PublicKey | ( | const AlgorithmIdentifier & | alg_id, |
const std::vector< uint8_t > & | key_bits | ||
) |
Load a public key.
alg_id | the X.509 algorithm identifier |
key_bits | DER encoded public key bits |
Definition at line 40 of file ecc_key.cpp.
References Botan::AlgorithmIdentifier::parameters.
|
default |
|
virtualdefault |
|
inlineprotected |
Definition at line 99 of file ecc_key.h.
|
pure virtualinherited |
Get the name of the underlying public key scheme.
Implemented in Botan::XMSS_WOTS_PublicKey, Botan::XMSS_PublicKey, Botan::TPM_PrivateKey, Botan::XMSS_WOTS_Addressed_PublicKey, Botan::ECDSA_PublicKey, Botan::ECDH_PublicKey, Botan::GOST_3410_PublicKey, Botan::ECGDSA_PublicKey, Botan::ECKCDSA_PublicKey, Botan::RSA_PublicKey, Botan::McEliece_PublicKey, Botan::DH_PublicKey, Botan::DSA_PublicKey, Botan::ElGamal_PublicKey, and Botan::Curve25519_PublicKey.
Referenced by Botan::PKCS8::BER_encode(), Botan::TLS::Policy::check_peer_key_acceptable(), Botan::X509_Object::check_signature(), Botan::TLS::Handshake_State::choose_sig_format(), Botan::choose_sig_format(), Botan::TLS::Client_Key_Exchange::Client_Key_Exchange(), 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_Key_Agreement::PK_Key_Agreement(), Botan::PK_Signer::PK_Signer(), Botan::PK_Verifier::PK_Verifier(), and Botan::verify_cert_constraints_valid_for_key_type().
|
overridevirtual |
Implements Botan::Public_Key.
Reimplemented in Botan::GOST_3410_PublicKey.
Definition at line 81 of file ecc_key.cpp.
References DER_domain(), and Botan::Public_Key::get_oid().
Referenced by Botan::GOST_3410_PrivateKey::pkcs8_algorithm_identifier().
|
overridevirtual |
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, and Botan::ECKCDSA_PrivateKey.
Definition at line 47 of file ecc_key.cpp.
References Botan::EC_Group::get_cofactor(), Botan::EC_Group::get_order(), Botan::CT::is_zero(), Botan::PointGFp::is_zero(), m_domain_params, Botan::PointGFp::on_the_curve(), public_point(), and Botan::EC_Group::verify_group().
|
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::RSA_PublicKey, and Botan::ElGamal_PublicKey.
Definition at line 79 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 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::RSA_PublicKey, and Botan::McEliece_PublicKey.
Definition at line 87 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 verification operation for this key/params or throw
params | additional parameters |
provider | the provider to use |
Reimplemented in Botan::XMSS_WOTS_PublicKey, Botan::XMSS_PublicKey, Botan::RSA_PublicKey, Botan::XMSS_WOTS_Addressed_PublicKey, Botan::GOST_3410_PublicKey, Botan::ECDSA_PublicKey, Botan::ECGDSA_PublicKey, Botan::ECKCDSA_PublicKey, and Botan::DSA_PublicKey.
Definition at line 95 of file pk_keys.cpp.
References Botan::Public_Key::algo_name().
Referenced by Botan::PK_Verifier::PK_Verifier().
|
inline |
Return the DER encoding of this keys domain in whatever format is preset for this particular key
Definition at line 85 of file ecc_key.h.
Referenced by algorithm_identifier().
|
inline |
Get the domain parameters of this key.
Invalid_State | is thrown if the domain parameters of this point are not set |
Definition at line 73 of file ecc_key.h.
Referenced by Botan::GOST_3410_PublicKey::algorithm_identifier(), Botan::EC_PrivateKey::EC_PrivateKey(), EC_PublicKey(), Botan::GOST_3410_PublicKey::GOST_3410_PublicKey(), and key_length().
|
inline |
|
overridevirtual |
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 26 of file ecc_key.cpp.
References Botan::ecp_work_factor(), and key_length().
|
virtualinherited |
Get the OID of the underlying public key scheme.
Reimplemented in Botan::XMSS_WOTS_Addressed_PublicKey.
Definition at line 30 of file pk_keys.cpp.
References Botan::Public_Key::algo_name(), and Botan::OIDS::lookup().
Referenced by Botan::DL_Scheme_PublicKey::algorithm_identifier(), Botan::Curve25519_PublicKey::algorithm_identifier(), Botan::McEliece_PublicKey::algorithm_identifier(), Botan::RSA_PublicKey::algorithm_identifier(), Botan::GOST_3410_PublicKey::algorithm_identifier(), algorithm_identifier(), Botan::TPM_PrivateKey::algorithm_identifier(), and Botan::XMSS_WOTS_Addressed_PublicKey::get_oid().
|
overridevirtual |
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 21 of file ecc_key.cpp.
References Botan::BigInt::bits(), domain(), Botan::EC_Group::get_curve(), and Botan::CurveGFp::get_p().
Referenced by 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::GOST_3410_PublicKey, Botan::ECDSA_PublicKey, Botan::ECGDSA_PublicKey, Botan::ECKCDSA_PublicKey, and Botan::DSA_PublicKey.
Definition at line 114 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::GOST_3410_PublicKey, Botan::ECDSA_PublicKey, Botan::ECGDSA_PublicKey, Botan::ECKCDSA_PublicKey, and Botan::DSA_PublicKey.
Definition at line 103 of file pk_keys.h.
Referenced by Botan::X509_Object::check_signature(), Botan::choose_sig_format(), Botan::PK_Signer::PK_Signer(), and Botan::PK_Verifier::PK_Verifier().
|
default |
|
overridevirtual |
Implements Botan::Public_Key.
Reimplemented in Botan::GOST_3410_PublicKey.
Definition at line 86 of file ecc_key.cpp.
References Botan::PointGFp::COMPRESSED, Botan::EC2OSP(), public_point(), and Botan::unlock().
Referenced by Botan::EC_PrivateKey::EC_PrivateKey().
|
inline |
Get the public point of this key.
Invalid_State | is thrown if the domain parameters of this point are not set |
Definition at line 58 of file ecc_key.h.
Referenced by check_key(), Botan::ECGDSA_PrivateKey::check_key(), Botan::ECKCDSA_PrivateKey::check_key(), Botan::ECDSA_PrivateKey::check_key(), EC_PublicKey(), Botan::GOST_3410_PublicKey::public_key_bits(), and public_key_bits().
void Botan::EC_PublicKey::set_parameter_encoding | ( | EC_Group_Encoding | enc | ) |
Set the domain parameter encoding to be used when encoding this key.
enc | the encoding to use |
Definition at line 91 of file ecc_key.cpp.
References Botan::EC_DOMPAR_ENC_EXPLICIT, Botan::EC_DOMPAR_ENC_IMPLICITCA, Botan::EC_DOMPAR_ENC_OID, Botan::EC_Group::get_oid(), m_domain_encoding, and m_domain_params.
|
inherited |
Definition at line 17 of file pk_keys.cpp.
References Botan::Public_Key::algorithm_identifier(), Botan::BIT_STRING, Botan::DER_Encoder::encode(), Botan::DER_Encoder::end_cons(), Botan::DER_Encoder::get_contents_unlocked(), Botan::Public_Key::public_key_bits(), Botan::SEQUENCE, and Botan::DER_Encoder::start_cons().
Referenced by Botan::X509::BER_encode(), and Botan::X509::PEM_encode().
|
protected |
Definition at line 104 of file ecc_key.h.
Referenced by Botan::EC_PrivateKey::EC_PrivateKey(), and set_parameter_encoding().
|
protected |
Definition at line 102 of file ecc_key.h.
Referenced by check_key(), Botan::EC_PrivateKey::EC_PrivateKey(), Botan::GOST_3410_PublicKey::GOST_3410_PublicKey(), and set_parameter_encoding().
|
protected |
Definition at line 103 of file ecc_key.h.
Referenced by Botan::EC_PrivateKey::EC_PrivateKey(), and Botan::GOST_3410_PublicKey::GOST_3410_PublicKey().