Botan 3.14.1
Crypto and TLS for C&
Botan::ECDH_PublicKey Class Reference

#include <ecdh.h>

Inheritance diagram for Botan::ECDH_PublicKey:
Botan::EC_PublicKey Botan::Public_Key Botan::Asymmetric_Key Botan::ECDH_PrivateKey

Public Member Functions

virtual std::unique_ptr< PK_Ops::Encryption > _create_encryption_op (RandomNumberGenerator &rng, const PK_Encryption_Options_Reader &options) const
virtual std::unique_ptr< PK_Ops::KEM_Encryption > _create_kem_encryption_op (const PK_KEM_Options_Reader &options) const
virtual std::unique_ptr< PK_Ops::Verification > _create_verification_op (const PK_Signature_Options_Reader &options) const
virtual Signature_Format _default_x509_signature_format () const
const EC_AffinePoint & _public_ec_point () const
virtual std::optional< size_t > _signature_element_size_for_DER_encoding () const
std::string algo_name () const override
AlgorithmIdentifier algorithm_identifier () const override
bool check_key (RandomNumberGenerator &rng, bool strong) const override
std::unique_ptr< PK_Ops::Encryption > create_encryption_op (RandomNumberGenerator &rng, std::string_view params, std::string_view provider) const
std::unique_ptr< PK_Ops::KEM_Encryption > create_kem_encryption_op (std::string_view params, std::string_view provider) const
std::unique_ptr< PK_Ops::Verification > create_verification_op (std::string_view params, std::string_view provider) const
virtual std::unique_ptr< PK_Ops::Verification > create_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_Group & domain () const
EC_Group_Encoding domain_format () const
 ECDH_PublicKey (const AlgorithmIdentifier &alg_id, std::span< const uint8_t > key_bits)
 ECDH_PublicKey (const EC_Group &group, const EC_AffinePoint &public_key)
size_t estimated_strength () const override
std::string fingerprint_public (std::string_view alg="SHA-256") const
std::unique_ptr< Private_Key > generate_another (RandomNumberGenerator &rng) const final
const BigInt & get_int_field (std::string_view field) const override
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
EC_Point_Format point_encoding () const
const EC_AffinePoint & public_ec_point () const
std::vector< uint8_t > public_key_bits () const override
std::vector< uint8_t > public_value () const
std::vector< uint8_t > public_value (EC_Point_Format format) const
std::vector< uint8_t > raw_public_key_bits () const override
void set_parameter_encoding (EC_Group_Encoding enc)
void set_point_encoding (EC_Point_Format enc)
std::vector< uint8_t > subject_public_key () const
bool supports_operation (PublicKeyOperation op) const override

Protected Member Functions

 ECDH_PublicKey ()=default

Static Protected Member Functions

static const AlgorithmIdentifier & assert_algorithm_identifier (const AlgorithmIdentifier &alg_id, std::string_view alg_name)

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_PublicKey_Data > m_public_key

Detailed Description

This class represents ECDH Public Keys.

Definition at line 20 of file ecdh.h.

Constructor & Destructor Documentation

◆ ECDH_PublicKey() [1/3]

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

Create an ECDH public key.

Parameters
alg_idalgorithm identifier
key_bitsDER encoded public key bits

Definition at line 27 of file ecdh.h.

27 :
28 EC_PublicKey(alg_id, key_bits) {}
EC_PublicKey()=default

References Botan::EC_PublicKey::EC_PublicKey().

◆ ECDH_PublicKey() [2/3]

Botan::ECDH_PublicKey::ECDH_PublicKey ( const EC_Group & group,
const EC_AffinePoint & public_key )
inline

Construct a public key from a given public point.

Parameters
groupthe domain parameters associated with this key
public_keythe public point defining this key

Definition at line 44 of file ecdh.h.

44: EC_PublicKey(group, public_key) {}

References Botan::EC_PublicKey::EC_PublicKey().

◆ ECDH_PublicKey() [3/3]

Botan::ECDH_PublicKey::ECDH_PublicKey ( )
protecteddefault

Member Function Documentation

◆ _create_encryption_op()

std::unique_ptr< PK_Ops::Encryption > Botan::Public_Key::_create_encryption_op ( RandomNumberGenerator & rng,
const PK_Encryption_Options_Reader & options ) 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/options or throw

Parameters
Random Number Generatorsa 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.
optionswhich specify parameters of the encryption beyond those implicit to the public key itself

Reimplemented in Botan::ElGamal_PublicKey, Botan::RSA_PublicKey, Botan::SM2_PublicKey, and Botan::TPM2::RSA_PublicKey.

Definition at line 107 of file pk_keys.cpp.

108 {
109 BOTAN_UNUSED(rng, options);
110 throw Lookup_Error(fmt("{} does not support encryption", algo_name()));
111}
#define BOTAN_UNUSED
Definition assert.h:151
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(), BOTAN_UNUSED, and Botan::fmt().

Referenced by create_encryption_op(), and Botan::PK_Encryptor_EME::PK_Encryptor_EME().

◆ _create_kem_encryption_op()

std::unique_ptr< PK_Ops::KEM_Encryption > Botan::Public_Key::_create_kem_encryption_op ( const PK_KEM_Options_Reader & options) 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/options or throw

Parameters
optionswhich specify parameters of the KEM beyond those implicit to the public key itself

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

Definition at line 113 of file pk_keys.cpp.

114 {
115 BOTAN_UNUSED(options);
116 throw Lookup_Error(fmt("{} does not support KEM encryption", algo_name()));
117}

References Botan::Asymmetric_Key::algo_name(), BOTAN_UNUSED, and Botan::fmt().

Referenced by create_kem_encryption_op(), and Botan::PK_KEM_Encryptor::PK_KEM_Encryptor().

◆ _create_verification_op()

std::unique_ptr< PK_Ops::Verification > Botan::Public_Key::_create_verification_op ( const PK_Signature_Options_Reader & options) 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 key/params or throw

Parameters
optionswhich specify parameters of the signature beyond those implicit to the public key itself

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::SM2_PublicKey, Botan::SphincsPlus_PublicKey, Botan::TPM2::EC_PublicKey, Botan::TPM2::RSA_PublicKey, and Botan::XMSS_PublicKey.

Definition at line 119 of file pk_keys.cpp.

120 {
121 BOTAN_UNUSED(options);
122 throw Lookup_Error(fmt("{} does not support verification", algo_name()));
123}

References Botan::Asymmetric_Key::algo_name(), BOTAN_UNUSED, and Botan::fmt().

Referenced by create_verification_op(), and Botan::PK_Verifier::PK_Verifier().

◆ _default_x509_signature_format()

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

◆ _public_ec_point()

const EC_AffinePoint & Botan::EC_PublicKey::_public_ec_point ( ) const
inlineinherited

Definition at line 115 of file ecc_key.h.

115{ return public_ec_point(); }
const EC_AffinePoint & public_ec_point() const
Definition ecc_key.cpp:88

References public_ec_point().

◆ _signature_element_size_for_DER_encoding()

virtual std::optional< size_t > Botan::Asymmetric_Key::_signature_element_size_for_DER_encoding ( ) const
inlinevirtualinherited

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 in Botan::DSA_PublicKey, Botan::ECDSA_PublicKey, Botan::ECGDSA_PublicKey, Botan::ECKCDSA_PublicKey, Botan::GOST_3410_PublicKey, and Botan::SM2_PublicKey.

Definition at line 148 of file pk_keys.h.

148{ return {}; }

Referenced by _default_x509_signature_format(), Botan::Public_Key::message_part_size(), Botan::Public_Key::message_parts(), Botan::PK_Signer::PK_Signer(), Botan::PK_Verifier::PK_Verifier(), and Botan::PK_Verifier::PK_Verifier().

◆ algo_name()

std::string Botan::ECDH_PublicKey::algo_name ( ) const
inlineoverridevirtual

Get this keys algorithm name.

Returns
this keys algorithm name

Implements Botan::Asymmetric_Key.

Definition at line 50 of file ecdh.h.

50{ return "ECDH"; }

Referenced by Botan::ECDH_PrivateKey::_create_key_agreement_op().

◆ algorithm_identifier()

AlgorithmIdentifier Botan::EC_PublicKey::algorithm_identifier ( ) const
overridevirtualinherited

Return the X.509 AlgorithmIdentifier for this key

Implements Botan::Public_Key.

Reimplemented in Botan::GOST_3410_PublicKey.

Definition at line 98 of file ecc_key.cpp.

98 {
99 return AlgorithmIdentifier(object_identifier(), DER_domain());
100}
virtual OID object_identifier() const
Definition pk_keys.cpp:24
std::vector< uint8_t > DER_domain() const
Definition ecc_key.cpp:110

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

Referenced by ~EC_PublicKey().

◆ assert_algorithm_identifier()

const AlgorithmIdentifier & Botan::EC_PublicKey::assert_algorithm_identifier ( const AlgorithmIdentifier & alg_id,
std::string_view alg_name )
staticprotectedinherited

Definition at line 48 of file ecc_key.cpp.

49 {
50 if(alg_id.oid() != OID::from_string(alg_name)) {
51 throw Decoding_Error(
52 fmt("Unexpected AlgorithmIdentifier OID {} in association with {} key", alg_id.oid(), alg_name));
53 }
54
55 return alg_id; // NOLINT(*-return-const-ref-from-parameter)
56}
static OID from_string(std::string_view str)
Definition asn1_oid.cpp:80

References Botan::fmt(), Botan::OID::from_string(), and Botan::AlgorithmIdentifier::oid().

Referenced by Botan::ECDSA_PrivateKey::ECDSA_PrivateKey(), Botan::ECDSA_PublicKey::ECDSA_PublicKey(), Botan::ECGDSA_PrivateKey::ECGDSA_PrivateKey(), Botan::ECGDSA_PublicKey::ECGDSA_PublicKey(), Botan::ECKCDSA_PrivateKey::ECKCDSA_PrivateKey(), and Botan::ECKCDSA_PublicKey::ECKCDSA_PublicKey().

◆ check_key()

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

Test the key values for consistency.

Note this function is always "best effort"; for many algorithms it is not computationally possible to ensure the key is correctly formed in all respects. There is always the possibility a malformed key will be accepted; this is especially the case for public keys.

Parameters
Random Number Generatorsrng to use for randomized testing (may be ignored)
strongwhether to perform strong and lengthy version of the test, however for many algorithms this has no effect
Returns
true if the tests passed

Implements Botan::Asymmetric_Key.

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

Definition at line 93 of file ecc_key.cpp.

93 {
94 // We already checked when deserializing that the point was on the curve
95 return domain().verify_group(rng, strong) && !public_ec_point().is_identity();
96}
bool is_identity() const
Return true if this point is the identity element.
bool verify_group(RandomNumberGenerator &rng, bool strong=false) const
Definition ec_group.cpp:881
const EC_Group & domain() const
Definition ecc_key.cpp:76

References domain(), Botan::EC_AffinePoint::is_identity(), public_ec_point(), and Botan::EC_Group::verify_group().

Referenced by Botan::EC_PrivateKey::check_key(), and ~EC_PublicKey().

◆ 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
inherited

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
Random Number Generatorsa 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

Definition at line 175 of file pk_keys.cpp.

177 {
178 const auto options = parse_legacy_enc_options(*this, params).with_provider(provider);
179 const auto reader = PK_Options_Reader_Access::read(options);
180 auto op = this->_create_encryption_op(rng, reader);
182 return op;
183}
PK_Encryption_Options with_provider(std::string_view provider)
static void throw_if_unexamined(const ReaderT &reader, std::string_view algo_name)
static PK_Encryption_Options_Reader read(const PK_Encryption_Options &options)
virtual std::unique_ptr< PK_Ops::Encryption > _create_encryption_op(RandomNumberGenerator &rng, const PK_Encryption_Options_Reader &options) const
Definition pk_keys.cpp:107
PK_Encryption_Options parse_legacy_enc_options(const Public_Key &key, std::string_view params)

References _create_encryption_op(), Botan::Asymmetric_Key::algo_name(), Botan::parse_legacy_enc_options(), Botan::PK_Options_Reader_Access::read(), Botan::PK_Options_Reader_Access::throw_if_unexamined(), and Botan::PK_Encryption_Options::with_provider().

◆ 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
inherited

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

Definition at line 195 of file pk_keys.cpp.

196 {
197 const auto options = parse_legacy_kem_options(params).with_provider(provider);
198 const auto reader = PK_Options_Reader_Access::read(options);
199 auto op = this->_create_kem_encryption_op(reader);
201 return op;
202}
PK_KEM_Options with_provider(std::string_view provider)
virtual std::unique_ptr< PK_Ops::KEM_Encryption > _create_kem_encryption_op(const PK_KEM_Options_Reader &options) const
Definition pk_keys.cpp:113
PK_KEM_Options parse_legacy_kem_options(std::string_view params)

References _create_kem_encryption_op(), Botan::Asymmetric_Key::algo_name(), Botan::parse_legacy_kem_options(), Botan::PK_Options_Reader_Access::read(), Botan::PK_Options_Reader_Access::throw_if_unexamined(), and Botan::PK_KEM_Options::with_provider().

◆ create_verification_op()

std::unique_ptr< PK_Ops::Verification > Botan::Public_Key::create_verification_op ( std::string_view params,
std::string_view provider ) const
inherited

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

Definition at line 156 of file pk_keys.cpp.

157 {
158 const auto options = parse_legacy_sig_options(*this, params).with_provider(provider);
159 const auto reader = PK_Options_Reader_Access::for_verification(options);
160 auto op = this->_create_verification_op(reader);
162 return op;
163}
static PK_Signature_Options_Reader for_verification(const PK_Signature_Options &options)
PK_Signature_Options with_provider(std::string_view provider)
virtual std::unique_ptr< PK_Ops::Verification > _create_verification_op(const PK_Signature_Options_Reader &options) const
Definition pk_keys.cpp:119
PK_Signature_Options parse_legacy_sig_options(const Public_Key &key, std::string_view params)

References _create_verification_op(), Botan::Asymmetric_Key::algo_name(), Botan::PK_Options_Reader_Access::for_verification(), Botan::parse_legacy_sig_options(), Botan::PK_Options_Reader_Access::throw_if_unexamined(), and Botan::PK_Signature_Options::with_provider().

◆ 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 125 of file pk_keys.cpp.

126 {
127 throw Lookup_Error(fmt("{} does not support X.509 verification", algo_name()));
128}

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

245 {
247 }
virtual Signature_Format _default_x509_signature_format() const
Definition pk_keys.cpp:32

References Botan::Asymmetric_Key::_default_x509_signature_format(), and default_x509_signature_format().

Referenced by default_x509_signature_format().

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

110 {
111 return domain().DER_encode(domain_format());
112}
std::vector< uint8_t > DER_encode(EC_Group_Encoding form) const
Definition ec_group.cpp:831
EC_Group_Encoding domain_format() const
Definition ecc_key.h:96

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

Referenced by algorithm_identifier(), and ~EC_PublicKey().

◆ domain()

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

Get the domain parameters of this key.

Exceptions
Invalid_Stateis thrown if the domain parameters of this point are not set
Returns
the domain parameters of this key

Definition at line 76 of file ecc_key.cpp.

76 {
78 return m_public_key->group();
79}
#define BOTAN_STATE_CHECK(expr)
Definition assert.h:49
std::shared_ptr< const EC_PublicKey_Data > m_public_key
Definition ecc_key.h:148

References BOTAN_STATE_CHECK, and m_public_key.

Referenced by Botan::ECDSA_PublicKey::_signature_element_size_for_DER_encoding(), Botan::ECGDSA_PublicKey::_signature_element_size_for_DER_encoding(), Botan::ECKCDSA_PublicKey::_signature_element_size_for_DER_encoding(), Botan::GOST_3410_PublicKey::_signature_element_size_for_DER_encoding(), Botan::SM2_PublicKey::_signature_element_size_for_DER_encoding(), Botan::GOST_3410_PublicKey::algo_name(), Botan::GOST_3410_PublicKey::algorithm_identifier(), botan_ec_privkey_get_group(), botan_ec_pubkey_get_group(), botan_pubkey_ecc_key_used_explicit_encoding(), botan_pubkey_sm2_compute_za(), check_key(), Botan::SM2_PrivateKey::check_key(), DER_domain(), Botan::EC_PrivateKey::EC_PrivateKey(), Botan::EC_PrivateKey::EC_PrivateKey(), Botan::EC_PrivateKey::EC_PrivateKey(), Botan::EC_PrivateKey::EC_PrivateKey(), EC_PublicKey(), EC_PublicKey(), Botan::ECDH_PublicKey::generate_another(), Botan::ECDSA_PublicKey::generate_another(), Botan::ECGDSA_PublicKey::generate_another(), Botan::ECKCDSA_PublicKey::generate_another(), Botan::GOST_3410_PublicKey::generate_another(), Botan::SM2_PublicKey::generate_another(), get_int_field(), Botan::GOST_3410_PrivateKey::GOST_3410_PrivateKey(), Botan::GOST_3410_PrivateKey::GOST_3410_PrivateKey(), Botan::GOST_3410_PrivateKey::GOST_3410_PrivateKey(), 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::TPM2::EC_PrivateKey::public_key(), Botan::ECDSA_PublicKey::recovery_param(), set_parameter_encoding(), Botan::SM2_PrivateKey::SM2_PrivateKey(), Botan::SM2_PrivateKey::SM2_PrivateKey(), Botan::SM2_PrivateKey::SM2_PrivateKey(), and ~EC_PublicKey().

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

96{ return m_domain_encoding; }
EC_Group_Encoding m_domain_encoding
Definition ecc_key.h:149

References domain_format(), and m_domain_encoding.

Referenced by DER_domain(), and domain_format().

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

32 {
34}
size_t key_length() const override
Definition ecc_key.cpp:28
size_t ecp_work_factor(size_t bits)

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

◆ 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 96 of file pk_keys.cpp.

96 {
97 return create_hex_fingerprint(subject_public_key(), hash_algo);
98}
std::vector< uint8_t > subject_public_key() const
Definition pk_keys.cpp:65
std::string create_hex_fingerprint(std::span< const uint8_t > bits, std::string_view hash_name)
Definition pk_keys.cpp:40

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

Referenced by public_key_bits().

◆ generate_another()

std::unique_ptr< Private_Key > Botan::ECDH_PublicKey::generate_another ( RandomNumberGenerator & rng) const
finalvirtual

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 93 of file ecdh.cpp.

93 {
94 return std::make_unique<ECDH_PrivateKey>(rng, domain());
95}

References Botan::EC_PublicKey::domain().

◆ get_int_field()

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.

TODO(Botan4) Change this to return by value

Reimplemented from Botan::Asymmetric_Key.

Definition at line 252 of file ecc_key.cpp.

252 {
253 if(field == "public_x" || field == "public_y") {
254 throw Not_Implemented(fmt("EC_PublicKey::get_int_field no longer implements getter for {}", field));
255 } else if(field == "base_x") {
256 return this->domain().get_g_x();
257 } else if(field == "base_y") {
258 return this->domain().get_g_y();
259 } else if(field == "p") {
260 return this->domain().get_p();
261 } else if(field == "a") {
262 return this->domain().get_a();
263 } else if(field == "b") {
264 return this->domain().get_b();
265 } else if(field == "cofactor") {
266 return this->domain().get_cofactor();
267 } else if(field == "order") {
268 return this->domain().get_order();
269 } else {
270 return Public_Key::get_int_field(field);
271 }
272}
virtual const BigInt & get_int_field(std::string_view field) const
Definition pk_keys.cpp:20
const BigInt & get_b() const
Definition ec_group.cpp:745
const BigInt & get_a() const
Definition ec_group.cpp:741
const BigInt & get_g_y() const
Definition ec_group.cpp:793
const BigInt & get_cofactor() const
Definition ec_group.cpp:797
const BigInt & get_p() const
Definition ec_group.cpp:737
const BigInt & get_order() const
Definition ec_group.cpp:785
const BigInt & get_g_x() const
Definition ec_group.cpp:789

References domain(), Botan::fmt(), 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(), and Botan::EC_Group::get_p().

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

◆ get_oid()

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

Deprecated version of object_identifier

Definition at line 172 of file pk_keys.h.

172{ return this->object_identifier(); }

References get_oid(), and Botan::Asymmetric_Key::object_identifier().

Referenced by get_oid().

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

28 {
29 return domain().get_p_bits();
30}
size_t get_p_bits() const
Definition ec_group.cpp:721

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

Referenced by estimated_strength().

◆ message_part_size()

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

Returns how large each of the message parts referred 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 236 of file pk_keys.h.

236 {
237 return _signature_element_size_for_DER_encoding().value_or(0);
238 }

References Botan::Asymmetric_Key::_signature_element_size_for_DER_encoding(), and message_part_size().

Referenced by message_part_size().

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

223 {
225 }

References Botan::Asymmetric_Key::_signature_element_size_for_DER_encoding(), and message_parts().

Referenced by message_parts().

◆ object_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 102 of file ecc_key.h.

102{ return m_point_encoding; }
EC_Point_Format m_point_encoding
Definition ecc_key.h:150

References m_point_encoding.

Referenced by raw_public_key_bits().

◆ public_ec_point()

◆ public_key_bits()

std::vector< uint8_t > Botan::EC_PublicKey::public_key_bits ( ) const
overridevirtualinherited

Return the subject public key encoding of this public key

Note
this excludes the parameters field and may not be reliably decodable

Implements Botan::Public_Key.

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

Definition at line 106 of file ecc_key.cpp.

106 {
107 return raw_public_key_bits();
108}
std::vector< uint8_t > raw_public_key_bits() const override
Definition ecc_key.cpp:102

References raw_public_key_bits().

Referenced by Botan::EC_PrivateKey::EC_PrivateKey(), and ~EC_PublicKey().

◆ public_value() [1/2]

std::vector< uint8_t > Botan::ECDH_PublicKey::public_value ( ) const
inline
Returns
public point value

Definition at line 55 of file ecdh.h.

std::vector< uint8_t > public_value() const
Definition ecdh.h:55

References public_value(), and Botan::Uncompressed.

Referenced by Botan::ECDH_PrivateKey::public_value(), Botan::ECDH_PrivateKey::public_value(), and public_value().

◆ public_value() [2/2]

std::vector< uint8_t > Botan::ECDH_PublicKey::public_value ( EC_Point_Format format) const
Returns
public point value

Definition at line 97 of file ecdh.cpp.

97 {
98 return public_ec_point().serialize(format);
99}
std::vector< uint8_t > serialize(EC_Point_Format format) const
Return an encoding depending on the requested format.

References Botan::EC_PublicKey::public_ec_point(), and Botan::EC_AffinePoint::serialize().

◆ raw_public_key_bits()

std::vector< uint8_t > Botan::EC_PublicKey::raw_public_key_bits ( ) const
overridevirtualinherited

Return the raw public key bits (algorithm specific) with no extra 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 102 of file ecc_key.cpp.

102 {
104}
EC_Point_Format point_encoding() const
Definition ecc_key.h:102

References point_encoding(), public_ec_point(), and Botan::EC_AffinePoint::serialize().

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

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

122 {
123 if(form == EC_Group_Encoding::NamedCurve && domain().get_curve_oid().empty()) {
124 throw Invalid_Argument("Cannot used NamedCurve encoding for a curve without an OID");
125 }
126
127 m_domain_encoding = form;
128}

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

Referenced by ~EC_PublicKey().

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

114 {
116 throw Invalid_Argument("Invalid point encoding for EC_PublicKey");
117 }
118
119 m_point_encoding = enc;
120}

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

Referenced by ~EC_PublicKey().

◆ subject_public_key()

std::vector< uint8_t > Botan::Public_Key::subject_public_key ( ) const
inherited

Return the SubjectPublicKeyInfo encoding of this public key

This is the subjectPublicKey field plus the algorithm-specific parameters

Definition at line 65 of file pk_keys.cpp.

65 {
66 std::vector<uint8_t> output;
67
68 DER_Encoder(output)
69 .start_sequence()
70 .encode(algorithm_identifier())
71 .encode_octet_aligned_bitstring(public_key_bits())
72 .end_cons();
73
74 return output;
75}
virtual AlgorithmIdentifier algorithm_identifier() const =0
virtual std::vector< uint8_t > public_key_bits() const =0

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

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

◆ supports_operation()

bool Botan::ECDH_PublicKey::supports_operation ( PublicKeyOperation op) const
inlineoverridevirtual

Return true if this key could be used for the specified type of operation.

Implements Botan::Asymmetric_Key.

Definition at line 62 of file ecdh.h.

References Botan::KeyAgreement.

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

Referenced by point_encoding(), and set_point_encoding().

◆ m_public_key


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